aiotter
dbd75e3229
doc: update cmake doc for better readability
2022-07-16 19:10:31 +09:00
Robert Hensing
3c1447f807
Merge pull request #121015 from fricklerhandwerk/docs-patch-shebangs
...
docs: expand explanation of patchShebangs hook
2022-07-13 12:17:11 +02:00
Valentin Gagarin
b7b86c4f54
add stable anchor
...
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2022-07-13 10:19:23 +01:00
Randy Eckenrode
25ccd71ff8
doc: update Darwin platform doc regarding the 11.0 SDK
2022-07-07 07:52:36 -04:00
Artturin
6e6292279e
meson: add mesonEmulatorHook
...
fixes building documentation while cross-compiling and other issues
Exec format error: './gdk3-scan'
added some simple documentation
2022-06-11 04:51:04 +03:00
Valentin Gagarin
c3ea8c4dd9
do not mention trivial builders
2022-06-10 11:43:57 +02:00
Valentin Gagarin
e132e6be3c
fix heading level
2022-06-09 13:43:21 +02:00
Valentin Gagarin
f70073d72d
remove specifics on where build inputs come from in PATH
...
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-06-08 11:43:32 +02:00
Adam Joseph
81bc106e08
meta.sourceProvenance documentation: clarify it is unaffected by changes to meta.license
...
This commit clarifies that the meaning of the `meta.sourceProvenance`
field is independent of and unaffected by the value of the
`meta.license` field. This is based on the intent of the RFC author
as expressed here:
https://github.com/NixOS/nixpkgs/pull/161098#issuecomment-1081270201
This clarification is added for two reasons:
1. If in the future there should be some disagreement about what
`sourceProvenance` to assign to a package, this may help resolve
the disagreement. Any interpretation of `sourceProvenance` which
is influenced by the `meta.license` is clearly an incorrect
interpretation.
2. If it should turn out that it is impossible to disentangle
`sourceProvenance` from `meta.license`, this would indicate the
need for changes to the `sourceProvenance` scheme. That change
might be as simple as replacing the sentence added by this commit
with some other sentence explaining how the two fields influence
each other.
This commit implements the recommendation made in the paragraph of
this comments which begins with "Please say this explicitly...":
https://github.com/NixOS/nixpkgs/pull/161098#issuecomment-1081309089
2022-05-30 16:27:34 +08:00
Robert Scott
9d0784829a
add initial meta.sourceProvenance documentation
2022-05-30 16:27:34 +08:00
Artturin
c1fffdfffb
treewide: change some glibc to stdenv.cc.libc
2022-05-27 05:57:43 +03:00
Artturin
0c4d65b21e
treewide: stdenv.glibc -> glibc
2022-05-25 15:51:20 +03:00
Naïm Favier
0d6bcb513b
makeBinaryWrapper: move into its own folder
...
The derivation is complex enough to warrant moving out of
all-packages.nix
2022-05-10 22:07:56 +02:00
Robert Hensing
0e00acafe9
stdenv.mkDerivation: public -> finalPackage
2022-05-02 08:49:33 +02:00
Robert Hensing
ca83dd1ae7
stdenv.md: Clarify overrideAttrs sentence
...
I weirded my English.
2022-05-02 08:49:32 +02:00
Robert Hensing
d629ba27d9
Use finalAttrs instead of self for mkDerivation "overlay"
2022-05-02 08:49:31 +02:00
Robert Hensing
6d7efb3a16
stdenv.mkDerivation: Make self more overlay-like; use self.public
...
`self` is now arguments, like `super`. The final package is in
`self.public`.
2022-05-02 08:49:31 +02:00
Robert Hensing
2f21bc2fdb
doc/stdenv/meta: tests -> passthru.tests
...
Make the text understandable without knowing that these are identical.
Co-authored-by: Daniël de Kok <me@github.danieldk.eu>
2022-05-02 08:49:30 +02:00
Robert Hensing
a4e7085227
stdenv.mkDerivation: Allow overriding of recursive definitions
...
See updated manual for further explanation.
2022-05-02 08:49:26 +02:00
Valentin Gagarin
311d322feb
docs: sync patchShebangs
comments with manual
...
this is not an actual sync, but rather the manual taking the leading role.
right now it does not make sense to actually change `patch-shebangs.sh`
as that would cause a rebuild of the entire universe.
we should figure out how to keep them aligned with minimal effort both
in terms of maintenance as well as navigation for readers.
2022-04-21 12:21:49 +02:00
Valentin Gagarin
9a2ed65370
fix wording, remove too much specificity
...
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-04-21 09:27:11 +02:00
fricklerhandwerk
b4d9d682c8
docs: clean up and update links to source code
2022-04-21 09:27:11 +02:00
fricklerhandwerk
e3883d2ce0
docs: clarify note on existing store paths
2022-04-21 09:27:10 +02:00
fricklerhandwerk
b0fce27ce2
docs: expand explanation of patchShebangs hook
...
- clarify motivation and mechanism
- explain usage
- add interlinks
- add links to sources to enable research
based on https://discourse.nixos.org/t/what-is-the-patchshebangs-command-in-nix-build-expressions/12656
2022-04-21 09:27:09 +02:00
Samuel Ainsworth
a7fc2f6392
autoPatchelfHook: more precise dependency ignorance
2022-04-11 01:28:55 +00:00
Adam Joseph
7dbe7487b6
Update doc/stdenv/cross-compilation.chapter.md
...
Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2022-04-03 17:43:52 +00:00
Adam Joseph
c9d66a7fff
cross-compilation.chapter.md: give examples of all depFooBar cases
...
This commit describes the "->" notation for dependency types in
greater detail, and uses g++ to provide examples of all six cases
(although the host->target and target->target examples are a bit
artificial).
It also adds three more rows to the table for the "->*" dependency
types for non-compiler-like packages; these dependency types were
already present in the documentation but the "*" was not really
explained.
Lastly, this commit adds a hyperlink to the table from the place where
it is mentioned in the "specifying dependencies" chapter.
2022-04-02 19:41:49 -07:00
Jan Tojnar
e61eec13a5
Merge pull request #159344 from symphorien/doc-remove-references-to
...
doc: document remove-references-to
2022-02-19 15:17:05 +01:00
Guillaume Girol
f16a62bd63
doc: document remove-references-to
2022-02-19 12:00:00 +00:00
Guillaume Girol
02a8d5984c
doc: discourage setting phases
, document/encourage runHook instead.
...
Source:
https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$mff3KCoPY5sfgsUhKn0e4va7hnz7KMXARaO2_UaLNM4?via=nixos.org&via=matrix.org&via=nixos.dev
2022-02-12 12:00:00 +00:00
Robert Hensing
c9b3d27be0
stdenv.md: Call out that genericBuild has correct order
...
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2022-02-02 23:45:51 +01:00
Robert Hensing
0838f79f0b
stdenv.md: Document genericBuild
2022-02-01 16:58:52 +01:00
Robert Hensing
b08ee51cc7
stdenv.md: Remove off topic phase propaganda
...
Phases are cool, I get it, but the reader will enjoy it when they
see it. And they'll see it sooner if they don't have to read about
it.
2022-02-01 16:46:18 +01:00
Felix Buehler
7801f72b4c
meta.updateWalker: remove, because it is not used
2022-01-26 21:46:07 +01:00
Robert Hensing
9fb7d91888
Merge pull request #124556 from bergkvist/bergkvist/make-c-wrapper
...
Generate tiny compiled binary for wrapping executables
2021-12-10 00:45:30 +01:00
Doron Behar
ceffea674d
Small rephrase of wrapProgram documentation
...
Co-authored-by: Julian Stecklina <js@alien8.de>
2021-12-09 23:24:13 +02:00
Doron Behar
c42e6741b2
Rephrase documentation for both makeWrapper implementations
2021-12-09 16:02:02 +02:00
Doron Behar
32d566e1b9
wrapProgramBinary -> binaryWrapProgram
2021-12-08 18:59:38 +02:00
Doron Behar
2b103ab8a1
Remove TODO in documentation
2021-12-02 10:43:47 +02:00
Jan Tojnar
23f71e9427
Merge pull request #136345 from Pamplemousse/doc
...
doc: clarification of dependencies related attributes
2021-10-26 09:52:37 +02:00
Doron Behar
eb048d8fe2
Rephrase makeWrapper setup-hook
2021-10-20 08:59:29 +03:00
Doron Behar
6517e5b10f
Improve explenations for wrap*Program
2021-10-19 17:33:02 +03:00
Doron Behar
ba86a1916b
makeBinaryWrapper: Document
2021-10-19 05:30:42 -07:00
laikq
6ef3c96ddf
doc: reference sourceRoot in description of srcs
2021-10-05 08:47:08 +02:00
ppom
896623dbe9
patchelf: fix homepage
2021-09-21 13:04:09 +02:00
Pamplemousse
f48c175fb2
doc: clarification of dependencies related attributes
...
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-08-31 16:57:46 -07:00
figsoda
4b93f966c5
doc: stdenv: document meta.mainProgram
2021-08-19 14:00:04 -04:00
Arnout Engelen
d09e0be1c4
nixpkgs-docs: when to prefer passthru.tests over installCheckPhase
...
And mention you can have either lightweight 'package' or
more heavyweight 'NixOS' (module) tests.
This was suggested at
https://github.com/ryantm/nixpkgs-update/issues/260#issuecomment-821287971
and discussed further at
https://github.com/NixOS/nixpkgs/pull/119731
2021-08-14 09:47:21 +02:00
Niklas Hambüchen
7cfaba911d
manual: Hardening: Remove now-nonexistent ArchWiki link.
...
The page has been replaced by the much more general page
https://wiki.archlinux.org/title/Security#Packages
which is barely talking about hardening flags any more.
2021-07-05 22:57:52 +02:00
Niklas Hambüchen
ac36a0f9eb
manual: hardening: Fix disabled flags prose being in previous section
...
This confused the hell out of me, as I didn't spot the
> The following flags are disabled by default ...
when reading about `pie`, because that sentence was hidden in the
previous hardening flag's section.
Also explain that `pie` hardening is on by default on musl.
2021-07-05 16:32:55 +02:00