about summary refs log tree commit diff
path: root/doc/stdenv
AgeCommit message (Collapse)AuthorFilesLines
2022-05-30meta.sourceProvenance documentation: clarify it is unaffected by changes to ↵Adam Joseph1-0/+2
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-30add initial meta.sourceProvenance documentationRobert Scott1-0/+26
2022-05-27treewide: change some glibc to stdenv.cc.libcArtturin1-1/+1
2022-05-25treewide: stdenv.glibc -> glibcArtturin1-1/+1
2022-05-10makeBinaryWrapper: move into its own folderNaïm Favier1-1/+1
The derivation is complex enough to warrant moving out of all-packages.nix
2022-05-02stdenv.mkDerivation: public -> finalPackageRobert Hensing2-7/+6
2022-05-02stdenv.md: Clarify overrideAttrs sentenceRobert Hensing1-1/+1
I weirded my English.
2022-05-02Use finalAttrs instead of self for mkDerivation "overlay"Robert Hensing2-15/+18
2022-05-02stdenv.mkDerivation: Make self more overlay-like; use self.publicRobert Hensing2-7/+10
`self` is now arguments, like `super`. The final package is in `self.public`.
2022-05-02doc/stdenv/meta: tests -> passthru.testsRobert Hensing1-0/+1
Make the text understandable without knowing that these are identical. Co-authored-by: Daniël de Kok <me@github.danieldk.eu>
2022-05-02stdenv.mkDerivation: Allow overriding of recursive definitionsRobert Hensing2-0/+82
See updated manual for further explanation.
2022-04-11autoPatchelfHook: more precise dependency ignoranceSamuel Ainsworth1-1/+1
2022-04-03Update doc/stdenv/cross-compilation.chapter.mdAdam Joseph1-11/+11
Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2022-04-02cross-compilation.chapter.md: give examples of all depFooBar casesAdam Joseph2-11/+36
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-02-19Merge pull request #159344 from symphorien/doc-remove-references-toJan Tojnar1-1/+14
doc: document remove-references-to
2022-02-19doc: document remove-references-toGuillaume Girol1-1/+14
2022-02-12doc: discourage setting `phases`, document/encourage runHook instead.Guillaume Girol1-1/+4
Source: https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$mff3KCoPY5sfgsUhKn0e4va7hnz7KMXARaO2_UaLNM4?via=nixos.org&via=matrix.org&via=nixos.dev
2022-02-02stdenv.md: Call out that genericBuild has correct orderRobert Hensing1-1/+1
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2022-02-01stdenv.md: Document genericBuildRobert Hensing1-1/+5
2022-02-01stdenv.md: Remove off topic phase propagandaRobert Hensing1-1/+1
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-01-26meta.updateWalker: remove, because it is not usedFelix Buehler1-4/+0
2021-12-10Merge pull request #124556 from bergkvist/bergkvist/make-c-wrapperRobert Hensing1-5/+7
Generate tiny compiled binary for wrapping executables
2021-12-09Small rephrase of wrapProgram documentationDoron Behar1-1/+1
Co-authored-by: Julian Stecklina <js@alien8.de>
2021-12-09Rephrase documentation for both makeWrapper implementationsDoron Behar1-17/+5
2021-12-08wrapProgramBinary -> binaryWrapProgramDoron Behar1-2/+2
2021-12-02Remove TODO in documentationDoron Behar1-1/+1
2021-10-26Merge pull request #136345 from Pamplemousse/docJan Tojnar2-12/+25
doc: clarification of dependencies related attributes
2021-10-20Rephrase makeWrapper setup-hookDoron Behar1-2/+2
2021-10-19Improve explenations for wrap*ProgramDoron Behar1-4/+4
2021-10-19makeBinaryWrapper: DocumentDoron Behar1-2/+16
2021-10-05doc: reference sourceRoot in description of srcslaikq1-2/+2
2021-09-21patchelf: fix homepageppom1-1/+1
2021-08-31doc: clarification of dependencies related attributesPamplemousse2-12/+25
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-08-19doc: stdenv: document meta.mainProgramfigsoda1-0/+4
2021-08-14nixpkgs-docs: when to prefer passthru.tests over installCheckPhaseArnout Engelen2-1/+26
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-07-05manual: Hardening: Remove now-nonexistent ArchWiki link.Niklas Hambüchen1-1/+1
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-05manual: hardening: Fix disabled flags prose being in previous sectionNiklas Hambüchen1-9/+18
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-06-11stdenv: introduce dontAddStaticConfigureFlagsAlyssa Ross1-1/+7
With removeUnknownConfigureFlags, it's impossible to express a package that needs --enable-static, but will not accept --disable-shared, without overriding the result of removeUnknownConfigureFlags _again_ in pkgs/top-level/static.nix. It would be much better (and more in line with the rest of Nixpkgs) if we encoded changes needed for static builds in package definitions themselves, rather than in an ever-expanding list in static.nix. This is especially true when doing it in static.nix is going to require multiple overrides to express what could be expressed with stdenv options. So as a step in that direction, and to fix the problem described above, here I replace removeUnknownConfigureFlags with a new stdenv option, dontAddStaticConfigureFlags. With this mechanism, a package that needs one but not both of the flags just needs to set dontAddStaticConfigureFlags and then set up configureFlags manually based on stdenv.hostPlatform.isStatic.
2021-06-07doc: Use markdown syntax for xrefsJan Tojnar3-12/+12
Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07doc: prepare for commonmarkJan Tojnar4-95/+100
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
2021-04-10Fix "platfrom" typosEmery Hemingway1-1/+1
2021-04-02doc/stdenv/cross: fix typosternenseemann1-1/+1
2021-03-14doc: Port stdenv to MarkdownJan Tojnar2-2419/+1215
Added the following ids to avoid possible id conflicts from ids auto-generated from titles: - setup-hook-perl - setup-hook-python - setup-hook-pkg-config - setup-hook-automake - setup-hook-autoconf - setup-hook-libxml2 - setup-hook-gdk-pixbuf
2021-03-14doc: Port stdenv/multiple-output to MarkdownJan Tojnar2-261/+128
2021-03-14doc: Port stdenv/meta to MarkdownJan Tojnar2-349/+194
2021-03-04doc: FormatRobert Hensing2-9/+4
2021-03-03Merge pull request #113062 from SuperSandro2000/outputs-updateSandro1-6/+6
doc: update multiple output section with more example paths
2021-02-22stdenv/cross-compilation: add section on avoiding cross-compiling GCCBen Siraphob1-0/+7
2021-02-21docs/stdenv/cross-compilation: add binutils command section to cookbookBen Siraphob1-4/+8
2021-02-21doc/stdenv/platform-notes: convert to markdownBen Siraphob2-83/+62
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-08-12 19:26:42 +0000