From 32ddbe3da97657fbd6ebaff27303f72f572bd41f Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Sun, 18 Nov 2018 23:10:39 -0600 Subject: [PATCH 1/9] doc: typo fixes --- doc/configuration.xml | 13 +++++++------ doc/cross-compilation.xml | 4 ++-- doc/multiple-output.xml | 2 +- doc/overlays.xml | 8 ++++---- doc/package-notes.xml | 2 +- doc/platform-notes.xml | 6 +++--- doc/reviewing-contributions.xml | 30 ++++++++++++++---------------- doc/stdenv.xml | 4 ++-- 8 files changed, 34 insertions(+), 35 deletions(-) diff --git a/doc/configuration.xml b/doc/configuration.xml index af74f3f9c01..624a5bb270a 100644 --- a/doc/configuration.xml +++ b/doc/configuration.xml @@ -132,7 +132,7 @@ - The difference between an a package being unsupported on some system and + The difference between a package being unsupported on some system and being broken is admittedly a bit fuzzy. If a program ought to work on a certain platform, but doesn't, the platform should be included in meta.platforms, but marked @@ -175,11 +175,12 @@ - A more useful example, the following configuration allows only allows - flash player and visual studio code: + For a more useful example, try the following. This configuration + only allows unfree packages named flash player and visual studio + code: { - allowUnfreePredicate = (pkg: elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]); + allowUnfreePredicate = (pkg: builtins.elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]); } @@ -286,8 +287,8 @@ You can define a function called packageOverrides in your - local ~/.config/nixpkgs/config.nix to override nix - packages. It must be a function that takes pkgs as an argument and return + local ~/.config/nixpkgs/config.nix to override Nix + packages. It must be a function that takes pkgs as an argument and returns a modified set of packages. { diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml index da664394f26..77cbf44fb20 100644 --- a/doc/cross-compilation.xml +++ b/doc/cross-compilation.xml @@ -193,7 +193,7 @@ These predicates are defined in lib.systems.inspect, - and slapped on every platform. They are superior to the ones in + and slapped onto every platform. They are superior to the ones in stdenv as they force the user to be explicit about which platform they are inspecting. Please use these instead of those. @@ -221,7 +221,7 @@ In this section we explore the relationship between both runtime and - buildtime dependencies and the 3 Autoconf platforms. + build-time dependencies and the 3 Autoconf platforms. diff --git a/doc/multiple-output.xml b/doc/multiple-output.xml index e96e84bfe72..d18e282c5bd 100644 --- a/doc/multiple-output.xml +++ b/doc/multiple-output.xml @@ -12,7 +12,7 @@ The Nix language allows a derivation to produce multiple outputs, which is similar to what is utilized by other Linux distribution packaging systems. - The outputs reside in separate nix store paths, so they can be mostly + The outputs reside in separate Nix store paths, so they can be mostly handled independently of each other, including passing to build inputs, garbage collection or binary substitution. The exception is that building from source always produces all the outputs. diff --git a/doc/overlays.xml b/doc/overlays.xml index 90dd163072d..bff2339ca93 100644 --- a/doc/overlays.xml +++ b/doc/overlays.xml @@ -3,9 +3,9 @@ xml:id="chap-overlays"> Overlays - This chapter describes how to extend and change Nixpkgs packages using - overlays. Overlays are used to add layers in the fix-point used by Nixpkgs to - compose the set of all packages. + This chapter describes how to extend and change Nixpkgs using overlays. + Overlays are used to add layers in the fixed-point used by Nixpkgs to compose + the set of all packages. Nixpkgs can be configured with a list of overlays, which are applied in @@ -60,7 +60,7 @@ First, if an overlays - argument to the nixpkgs function itself is given, then that is + argument to the Nixpkgs function itself is given, then that is used and no path lookup will be performed. diff --git a/doc/package-notes.xml b/doc/package-notes.xml index 49f94f3bd5d..803d343aa09 100644 --- a/doc/package-notes.xml +++ b/doc/package-notes.xml @@ -205,7 +205,7 @@ $ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \ Nixpkgs provides a number of packages that will install Eclipse in its - various forms, these range from the bare-bones Eclipse Platform to the more + various forms. These range from the bare-bones Eclipse Platform to the more fully featured Eclipse SDK or Scala-IDE packages and multiple version are often available. It is possible to list available Eclipse packages by issuing the command: diff --git a/doc/platform-notes.xml b/doc/platform-notes.xml index cde27b8a5ed..b27f2487575 100644 --- a/doc/platform-notes.xml +++ b/doc/platform-notes.xml @@ -6,13 +6,13 @@ Darwin (macOS) - Some common issues when packaging software for darwin: + Some common issues when packaging software for Darwin: - The darwin stdenv uses clang instead of gcc. When + The Darwin stdenv uses clang instead of gcc. When referring to the compiler $CC or cc will work in both cases. Some builds hardcode gcc/g++ in their build scripts, that can usually be fixed with using something like @@ -31,7 +31,7 @@ - On darwin libraries are linked using absolute paths, libraries are + On Darwin, libraries are linked using absolute paths, libraries are resolved by their install_name at link time. Sometimes packages won't set this correctly causing the library lookups to fail at runtime. This can be fixed by adding extra linker flags or by running diff --git a/doc/reviewing-contributions.xml b/doc/reviewing-contributions.xml index 849bb9316c6..79ebc400d36 100644 --- a/doc/reviewing-contributions.xml +++ b/doc/reviewing-contributions.xml @@ -17,27 +17,25 @@ - The nixpkgs project receives a fairly high number of contributions via GitHub + The Nixpkgs project receives a fairly high number of contributions via GitHub pull-requests. Reviewing and approving these is an important task and a way to contribute to the project. - The high change rate of nixpkgs makes any pull request that remains open for + The high change rate of Nixpkgs makes any pull-request that remains open for too long subject to conflicts that will require extra work from the submitter - or the merger. Reviewing pull requests in a timely manner and being - responsive to the comments is the key to avoid these. GitHub provides sort - filters that can be used to see the - most - recently and the - least + or the merger. Reviewing pull-requests in a timely manner and being responsive + to the comments is the key to avoid this issue. GitHub provides sort filters + that can be used to see the most + recently and the least recently updated pull-requests. We highly encourage looking at - this list of ready to merge, unreviewed pull requests. + this list of ready to merge, unreviewed pull-requests. - When reviewing a pull request, please always be nice and polite. + When reviewing a pull-request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work. @@ -230,7 +228,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" New packages - New packages are a common type of pull-requests. These pull requests + New packages are a common type of pull-requests. These pull-requests consists in adding a new nix-expression for a package. @@ -279,7 +277,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" - A maintainer must be set, this can be the package submitter or a + A maintainer must be set. This can be the package submitter or a community member that accepts to take maintainership of the package. @@ -582,7 +580,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" Container system, boot system and library changes are some examples of the - pull requests fitting this category. + pull-requests fitting this category.
@@ -590,7 +588,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" It is possible for community members that have enough knowledge and - experience on a special topic to contribute by merging pull requests. + experience on a special topic to contribute by merging pull-requests. diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 9ed9a448c61..5458b5d3181 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -581,7 +581,7 @@ let f(h, h + 1, i) = i + h - depsTargetTarget + depsTargetTargetPropagated @@ -836,7 +836,7 @@ passthru = { Zip files are unpacked using unzip. However, unzip is not in the standard environment, so you - should add it to buildInputs yourself. + should add it to nativeBuildInputs yourself. From b01613c9cedd673e834251aadb3f1e2039d961b4 Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Sun, 18 Nov 2018 23:11:22 -0600 Subject: [PATCH 2/9] doc: move checkInputs to check phase section This makes more sense in context. --- doc/stdenv.xml | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 5458b5d3181..e0d97e42e4c 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -1203,17 +1203,6 @@ passthru = { - - - checkInputs - - - - A list of dependencies used by the phase. This gets included in - buildInputs when doCheck is set. - - - makeFlags @@ -1363,6 +1352,18 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") + + + checkInputs + + + + A list of dependencies used by the phase. This gets included in + nativeBuildInputs when doCheck is + set. + + + preCheck From 4621d14b4a2dc44c60222453e59c546bbfcea792 Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Sun, 18 Nov 2018 23:12:06 -0600 Subject: [PATCH 3/9] doc/stdenv: document prefixKey This seems like a useful thing to document --- doc/stdenv.xml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index e0d97e42e4c..68f07bfe21e 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -1076,6 +1076,17 @@ passthru = { + + + prefixKey + + + + The key to use when specifying the prefix. By default, this is set to + as that is used by the majority of packages. + + + dontAddDisableDepTrack From 49e5bd0dbe534352b449f326d67bbc8a8b696c6a Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Sun, 18 Nov 2018 23:13:02 -0600 Subject: [PATCH 4/9] doc/stdenv: document more setup hook Here I document setup hooks provided by: - cmake - xcbuildHook - meson - ninja - unzip - wafHook - scons --- doc/stdenv.xml | 99 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 98 insertions(+), 1 deletion(-) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 68f07bfe21e..e38ff403e74 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2464,7 +2464,104 @@ addEnvHooks "$hostOffset" myBashFunction - + + + cmake + + + + Overrides the default configure phase to run the CMake command. By + default, we use the Make generator of CMake. In + addition, dependencies are added automatically to CMAKE_PREFIX_PATH so + that packages are correctly detected by CMake. Some additional flags + are passed in to give similar behavior to configure-based packages. You + can disable this hook’s behavior by setting configurePhase to a custom + value, or by setting dontUseCmakeConfigure. cmakeFlags controls flags + passed only to CMake. By default, parallel building is enabled as CMake + supports parallel building almost everywhere. When Ninja is also in + use, CMake will detect that and use the ninja generator. + + + + + + xcbuildHook + + + + Overrides the build and install phases to run the “xcbuild” command. + This hook is needed when a project only comes with build files for the + XCode build system. You can disable this behavior by setting buildPhase + and configurePhase to a custom value. xcbuildFlags controls flags + passed only to xcbuild. + + + + + + meson + + + + Overrides the configure phase to run meson to generate Ninja files. You + can disable this behavior by setting configurePhase to a custom value, + or by setting dontUseMesonConfigure. To run these files, you should + accompany meson with ninja. mesonFlags controls only the flags passed + to meson. By default, parallel building is enabled as Meson supports + parallel building almost everywhere. + + + + + + ninja + + + + Overrides the build, install, and check phase to run ninja instead of + make. You can disable this behavior with the dontUseNinjaBuild, + dontUseNinjaInstall, and dontUseNinjaCheck, respectively. Parallel + building is enabled by default in Ninja. + + + + + + unzip + + + + This setup hook will allow you to unzip .zip files specified in $src. + There are many similar packages like unrar, undmg, etc. + + + + + + wafHook + + + + Overrides the configure, build, and install phases. This will run the + "waf" script used by many projects. If waf doesn’t exist, it will copy + the version of waf available in Nixpkgs wafFlags can be used to pass + flags to the waf script. + + + + + + scons + + + + Overrides the build, install, and check phases. This uses the scons + build system as a replacement for make. scons does not provide a + configure phase, so everything is managed at build and install time. + + + +
From 4a49921a69a7a0980a09132eaa01eb6010c82f6a Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Sun, 18 Nov 2018 23:20:12 -0600 Subject: [PATCH 5/9] doc/stdenv: more changes Lots of reworking here. May need to be split up. --- doc/stdenv.xml | 375 ++++++++++++++++++++++++------------------------- 1 file changed, 185 insertions(+), 190 deletions(-) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index e38ff403e74..10d58f38399 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -228,18 +228,19 @@ genericBuild - The extension of PATH with dependencies, alluded to above, - proceeds according to the relative platforms alone. The process is carried - out only for dependencies whose host platform matches the new derivation's - build platform–i.e. which run on the platform where the new derivation - will be built. + The extension of PATH with dependencies, alluded to + above, proceeds according to the relative platforms alone. The + process is carried out only for dependencies whose host platform + matches the new derivation's build platform i.e. dependencies which + run on the platform where the new derivation will be built. - Currently, that means for native builds all dependencies are put on the - PATH. But in the future that may not be the case for sake - of matching cross: the platforms would be assumed to be unique for native - and cross builds alike, so only the depsBuild* and - nativeBuildDependencies dependencies would affect the + Currently, this means for native builds all dependencies are put + on the PATH. But in the future that may not be the + case for sake of matching cross: the platforms would be assumed + to be unique for native and cross builds alike, so only the + depsBuild* and + nativeBuildInputs would be added to the PATH. @@ -251,28 +252,27 @@ genericBuild The dependency is propagated when it forces some of its other-transitive (non-immediate) downstream dependencies to also take it on as an immediate - dependency. Nix itself already takes a package's transitive dependencies - into account, but this propagation ensures nixpkgs-specific infrastructure - like setup hooks (mentioned above) also are run as if the propagated - dependency. + dependency. Nix itself already takes a package's transitive dependencies into + account, but this propagation ensures nixpkgs-specific infrastructure like + setup hooks (mentioned above) also are run as if the propagated dependency. - It is important to note dependencies are not necessary propagated as the + It is important to note dependencies are not necessarily propagated as the same sort of dependency that they were before, but rather as the corresponding sort so that the platform rules still line up. The exact rules - for dependency propagation can be given by assigning each sort of dependency - two integers based one how it's host and target platforms are offset from - the depending derivation's platforms. Those offsets are given - below in the descriptions of each dependency list attribute. - Algorithmically, we traverse propagated inputs, accumulating every - propagated dep's propagated deps and adjusting them to account for the - "shift in perspective" described by the current dep's platform offsets. This - results in sort a transitive closure of the dependency relation, with the - offsets being approximately summed when two dependency links are combined. - We also prune transitive deps whose combined offsets go out-of-bounds, which - can be viewed as a filter over that transitive closure removing dependencies - that are blatantly absurd. + for dependency propagation can be given by assigning to each dependency two + integers based one how its host and target platforms are offset from the + depending derivation's platforms. Those offsets are given below in the + descriptions of each dependency list attribute. Algorithmically, we traverse + propagated inputs, accumulating every propagated dependency's propagated + dependenciess and adjusting them to account for the "shift in perspective" + described by the current dependency's platform offsets. This results in sort + a transitive closure of the dependency relation, with the offsets being + approximately summed when two dependency links are combined. We also prune + transitive dependencies whose combined offsets go out-of-bounds, which can be + viewed as a filter over that transitive closure removing dependencies that + are blatantly absurd. @@ -287,8 +287,8 @@ genericBuild propagation logic. - They're confusing in very different ways so...hopefully if something doesn't - make sense in one presentation, it does in the other! + They're confusing in very different ways so... hopefully if something doesn't + make sense in one presentation, it will in the other! let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1) @@ -307,13 +307,13 @@ dep(h0, _, A, B) propagated-dep(h1, t1, B, C) h0 + h1 in {-1, 0, 1} h0 + t1 in {-1, 0, -1} --------------------------------------- Take immediate deps' propagated deps +----------------------------- Take immediate dependencies' propagated dependencies propagated-dep(mapOffset(h0, t0, h1), mapOffset(h0, t0, t1), A, C) propagated-dep(h, t, A, B) --------------------------------------- Propagated deps count as deps +----------------------------- Propagated dependencies count as dependencies dep(h, t, A, B) Some explanation of this monstrosity is in order. In the common case, the target offset of a dependency is the successor to the target offset: @@ -324,31 +324,31 @@ let f(h, h + 1, i) = i + (if i <= 0 then h else (h + 1) - 1) let f(h, h + 1, i) = i + (if i <= 0 then h else h) let f(h, h + 1, i) = i + h - This is where the "sum-like" comes from above: We can just sum all the host - offset to get the host offset of the transitive dependency. The target - offset is the transitive dep is simply the host offset + 1, just as it was - with the dependencies composed to make this transitive one; it can be + This is where "sum-like" comes in from above: We can just sum all of the host + offsets to get the host offset of the transitive dependency. The target + offset is the transitive dependency is simply the host offset + 1, just as it + was with the dependencies composed to make this transitive one; it can be ignored as it doesn't add any new information. - Because of the bounds checks, the uncommon cases are h = - t and h + 2 = t. In the former case, the - motivation for mapOffset is that since its host and - target platforms are the same, no transitive dep of it should be able to - "discover" an offset greater than its reduced target offsets. + Because of the bounds checks, the uncommon cases are h = t + and h + 2 = t. In the former case, the motivation for + mapOffset is that since its host and target platforms + are the same, no transitive dependency of it should be able to "discover" an + offset greater than its reduced target offsets. mapOffset effectively "squashes" all its transitive dependencies' offsets so that none will ever be greater than the target offset of the original h = t package. In the other case, - h + 1 is skipped over between the host and target - offsets. Instead of squashing the offsets, we need to "rip" them apart so no + h + 1 is skipped over between the host and target offsets. + Instead of squashing the offsets, we need to "rip" them apart so no transitive dependencies' offset is that one. - Overall, the unifying theme here is that propagation shouldn't be - introducing transitive dependencies involving platforms the needing package - is unaware of. The offset bounds checking and definition of + Overall, the unifying theme here is that propagation shouldn't be introducing + transitive dependencies involving platforms the depending package is unaware + of. The offset bounds checking and definition of mapOffset together ensure that this is the case. Discovering a new offset is discovering a new platform, and since those platforms weren't in the derivation "spec" of the needing package, they @@ -369,20 +369,20 @@ let f(h, h + 1, i) = i + h A list of dependencies whose host and target platforms are the new derivation's build platform. This means a -1 host and -1 target offset from the new derivation's platforms. - They are programs/libraries used at build time that furthermore produce - programs/libraries also used at build time. If the dependency doesn't - care about the target platform (i.e. isn't a compiler or similar tool), - put it in nativeBuildInputs instead. The most common - use for this buildPackages.stdenv.cc, the default C - compiler for this role. That example crops up more than one might think - in old commonly used C libraries. + These are programs and libraries used at build time that produce programs + and libraries also used at build time. If the dependency doesn't care + about the target platform (i.e. isn't a compiler or similar tool), put it + in nativeBuildInputs instead. The most common use of + this buildPackages.stdenv.cc, the default C compiler + for this role. That example crops up more than one might think in old + commonly used C libraries. - Since these packages are able to be run at build time, that are always + Since these packages are able to be run at build-time, they are always added to the PATH, as described above. But since these packages are only guaranteed to be able to run then, they shouldn't - persist as run-time dependencies. This isn't currently enforced, but - could be in the future. + persist as run-time dependencies. This isn't currently enforced, but could + be in the future. @@ -395,21 +395,20 @@ let f(h, h + 1, i) = i + h A list of dependencies whose host platform is the new derivation's build platform, and target platform is the new derivation's host platform. This means a -1 host offset and 0 target - offset from the new derivation's platforms. They are programs/libraries - used at build time that, if they are a compiler or similar tool, produce - code to run at run time—i.e. tools used to build the new derivation. If - the dependency doesn't care about the target platform (i.e. isn't a - compiler or similar tool), put it here, rather than in + offset from the new derivation's platforms. These are programs and + libraries used at build-time that, if they are a compiler or similar tool, + produce code to run at run-time—i.e. tools used to build the new + derivation. If the dependency doesn't care about the target platform (i.e. + isn't a compiler or similar tool), put it here, rather than in depsBuildBuild or depsBuildTarget. - This would be called depsBuildHost but for historical - continuity. + This could be called depsBuildHost but + nativeBuildInputs is used for historical continuity. - Since these packages are able to be run at build time, that are added to - the PATH, as described above. But since these packages - only are guaranteed to be able to run then, they shouldn't persist as - run-time dependencies. This isn't currently enforced, but could be in the - future. + Since these packages are able to be run at build-time, they are added to + the PATH, as described above. But since these packages are + only guaranteed to be able to run then, they shouldn't persist as run-time + dependencies. This isn't currently enforced, but could be in the future. @@ -422,34 +421,33 @@ let f(h, h + 1, i) = i + h A list of dependencies whose host platform is the new derivation's build platform, and target platform is the new derivation's target platform. This means a -1 host offset and 1 - target offset from the new derivation's platforms. They are programs used - at build time that produce code to run at run with code produced by the - depending package. Most commonly, these would tools used to build the - runtime or standard library the currently-being-built compiler will - inject into any code it compiles. In many cases, the currently-being - built compiler is itself employed for that task, but when that compiler - won't run (i.e. its build and host platform differ) this is not possible. - Other times, the compiler relies on some other tool, like binutils, that - is always built separately so the dependency is unconditional. + target offset from the new derivation's platforms. These are programs used + at build time that produce code to run with code produced by the depending + package. Most commonly, these are tools used to build the runtime or + standard library taht the currently-being-built compiler will inject into + any code it compiles. In many cases, the currently-being-built-compiler is + itself employed for that task, but when that compiler won't run (i.e. its + build and host platform differ) this is not possible. Other times, the + compiler relies on some other tool, like binutils, that is always built + separately so that the dependency is unconditional. - This is a somewhat confusing dependency to wrap ones head around, and for - good reason. As the only one where the platform offsets are not adjacent - integers, it requires thinking of a bootstrapping stage - two away from the current one. It and it's use-case - go hand in hand and are both considered poor form: try not to need this - sort dependency, and try not avoid building standard libraries / runtimes + This is a somewhat confusing concept to wrap one’s head around, and for + good reason. As the only dependency type where the platform offsets are + not adjacent integers, it requires thinking of a bootstrapping stage + two away from the current one. It and its use-case go + hand in hand and are both considered poor form: try to not need this sort + of dependency, and try to avoid building standard libraries and runtimes in the same derivation as the compiler produces code using them. Instead strive to build those like a normal library, using the newly-built compiler just as a normal library would. In short, do not use this attribute unless you are packaging a compiler and are sure it is needed. - Since these packages are able to be run at build time, that are added to - the PATH, as described above. But since these packages - only are guaranteed to be able to run then, they shouldn't persist as - run-time dependencies. This isn't currently enforced, but could be in the - future. + Since these packages are able to run at build time, they are added to the + PATH, as described above. But since these packages are only + guaranteed to be able to run then, they shouldn't persist as run-time + dependencies. This isn't currently enforced, but could be in the future. @@ -460,15 +458,15 @@ let f(h, h + 1, i) = i + h A list of dependencies whose host and target platforms match the new - derivation's host platform. This means a both 0 host - offset and 0 target offset from the new derivation's - host platform. These are packages used at run-time to generate code also - used at run-time. In practice, that would usually be tools used by - compilers for metaprogramming/macro systems, or libraries used by the - macros/metaprogramming code itself. It's always preferable to use a - depsBuildBuild dependency in the derivation being - built than a depsHostHost on the tool doing the - building for this purpose. + derivation's host platform. This means a 0 host offset + and 0 target offset from the new derivation's host + platform. These are packages used at run-time to generate code also used + at run-time. In practice, this would usually be tools used by compilers + for macros or a metaprogramming system, or libraries used by the macros or + metaprogramming code itself. It's always preferable to use a + depsBuildBuild dependency in the derivation being built + over a depsHostHost on the tool doing the building for + this purpose. @@ -479,20 +477,20 @@ let f(h, h + 1, i) = i + h A list of dependencies whose host platform and target platform match the - new derivation's. This means a 0 host offset and + new derivation's. This means a 0 host offset and a 1 target offset from the new derivation's host platform. This would be called depsHostTarget but for historical continuity. If the dependency doesn't care about the target - platform (i.e. isn't a compiler or similar tool), put it here, rather - than in depsBuildBuild. + platform (i.e. isn't a compiler or similar tool), put it here, rather than + in depsBuildBuild. - These often are programs/libraries used by the new derivation at + These are often programs and libraries used by the new derivation at run-time, but that isn't always the case. For - example, the machine code in a statically linked library is only used at - run time, but the derivation containing the library is only needed at - build time. Even in the dynamic case, the library may also be needed at - build time to appease the linker. + example, the machine code in a statically-linked library is only used at + run-time, but the derivation containing the library is only needed at + build-time. Even in the dynamic case, the library may also be needed at + build-time to appease the linker. @@ -604,10 +602,10 @@ let f(h, h + 1, i) = i + h A natural number indicating how much information to log. If set to 1 or - higher, stdenv will print moderate debug information - during the build. In particular, the gcc and - ld wrapper scripts will print out the complete command - line passed to the wrapped tools. If set to 6 or higher, the + higher, stdenv will print moderate debugging + information during the build. In particular, the gcc + and ld wrapper scripts will print out the complete + command line passed to the wrapped tools. If set to 6 or higher, the stdenv setup script will be run with set -x tracing. If set to 7 or higher, the gcc and ld wrapper scripts will also be run with @@ -666,11 +664,10 @@ passthru = { hello.baz.value1. We don't specify any usage or schema of passthru - it is meant for values that would be useful outside the derivation in other parts of a Nix expression (e.g. in - other derivations). An example would be to convey some specific - dependency of your derivation which contains a program with plugins - support. Later, others who make derivations with plugins can use - passed-through dependency to ensure that their plugin would be - binary-compatible with built program. + other derivations). An example would be to convey some specific dependency + of your derivation which contains a program with plugins support. Later, + others who make derivations with plugins can use passed-through dependency + to ensure that their plugin would be binary-compatible with built program. @@ -1144,12 +1141,11 @@ passthru = { By default, when cross compiling, the configure script has and passed. Packages can instead pass [ "build" "host" "target" ] - or a subset to control exactly which platform flags are passed. - Compilers and other tools should use this to also pass the target - platform, for example. + or a subset to control exactly which platform flags are passed. Compilers + and other tools can use this to also pass the target platform. - Eventually these will be passed when in native builds too, to improve + Eventually these will be passed building natively as well, to improve determinism: build-time guessing, as is done today, is a risk of impurity. @@ -1647,13 +1643,11 @@ installTargets = "install-bin install-doc"; - A package can export a setup - hook by setting this variable. The setup hook, if defined, is - copied to $out/nix-support/setup-hook. Environment - variables are then substituted in it using - substituteAll. + A package can export a setup hook + by setting this variable. The setup hook, if defined, is copied to + $out/nix-support/setup-hook. Environment variables + are then substituted in it using substituteAll. @@ -2086,12 +2080,12 @@ someVar=$(stripHash $name) Package setup hooks - Nix itself considers a build-time dependency merely something that should + Nix itself considers a build-time dependency as merely something that should previously be built and accessible at build time—packages themselves are on their own to perform any additional setup. In most cases, that is fine, and the downstream derivation can deal with its own dependencies. But for a few common tasks, that would result in almost every package doing the same - sort of setup work---depending not on the package itself, but entirely on + sort of setup work—depending not on the package itself, but entirely on which dependencies were used. @@ -2106,20 +2100,19 @@ someVar=$(stripHash $name) - The Setup hook mechanism is a bit of a sledgehammer though: a powerful + The setup hook mechanism is a bit of a sledgehammer though: a powerful feature with a broad and indiscriminate area of effect. The combination of its power and implicit use may be expedient, but isn't without costs. Nix - itself is unchanged, but the spirit of adding dependencies being effect-free + itself is unchanged, but the spirit of added dependencies being effect-free is violated even if the letter isn't. For example, if a derivation path is mentioned more than once, Nix itself doesn't care and simply makes sure the dependency derivation is already built just the same—depending is just needing something to exist, and needing is idempotent. However, a dependency specified twice will have its setup hook run twice, and that could easily - change the build environment (though a well-written setup hook will - therefore strive to be idempotent so this is in fact not observable). More - broadly, setup hooks are anti-modular in that multiple dependencies, whether - the same or different, should not interfere and yet their setup hooks may - well do so. + change the build environment (though a well-written setup hook will therefore + strive to be idempotent so this is in fact not observable). More broadly, + setup hooks are anti-modular in that multiple dependencies, whether the same + or different, should not interfere and yet their setup hooks may well do so. @@ -2138,15 +2131,14 @@ someVar=$(stripHash $name) Packages adding a hook should not hard code a specific hook, but rather choose a variable relative to how they are included. - Returning to the C compiler wrapper example, if it itself is an + Returning to the C compiler wrapper example, if the wrapper itself is an n dependency, then it only wants to accumulate flags from n + 1 dependencies, as only those ones match the - compiler's target platform. The hostOffset variable is - defined with the current dependency's host offset - targetOffset with its target offset, before its setup hook is - sourced. Additionally, since most environment hooks don't care about the - target platform, That means the setup hook can append to the right bash array - by doing something like + compiler's target platform. The hostOffset variable is defined + with the current dependency's host offset targetOffset with + its target offset, before its setup hook is sourced. Additionally, since most + environment hooks don't care about the target platform, that means the setup + hook can append to the right bash array by doing something like addEnvHooks "$hostOffset" myBashFunction @@ -2171,19 +2163,19 @@ addEnvHooks "$hostOffset" myBashFunction - Bintools Wrapper wraps the binary utilities for a bunch of miscellaneous - purposes. These are GNU Binutils when targetting Linux, and a mix of - cctools and GNU binutils for Darwin. [The "Bintools" name is supposed to - be a compromise between "Binutils" and "cctools" not denoting any - specific implementation.] Specifically, the underlying bintools package, - and a C standard library (glibc or Darwin's libSystem, just for the - dynamic loader) are all fed in, and dependency finding, hardening (see - below), and purity checks for each are handled by Bintools Wrapper. - Packages typically depend on CC Wrapper, which in turn (at run time) - depends on Bintools Wrapper. + The Bintools Wrapper wraps the binary utilities for a bunch of + miscellaneous purposes. These are GNU Binutils when targetting Linux, and + a mix of cctools and GNU binutils for Darwin. [The "Bintools" name is + supposed to be a compromise between "Binutils" and "cctools" not denoting + any specific implementation.] Specifically, the underlying bintools + package, and a C standard library (glibc or Darwin's libSystem, just for + the dynamic loader) are all fed in, and dependency finding, hardening + (see below), and purity checks for each are handled by the Bintools + Wrapper. Packages typically depend on CC Wrapper, which in turn (at run + time) depends on the Bintools Wrapper. - Bintools Wrapper was only just recently split off from CC Wrapper, so + The Bintools Wrapper was only just recently split off from CC Wrapper, so the division of labor is still being worked out. For example, it shouldn't care about about the C standard library, but just take a derivation with the dynamic loader (which happens to be the glibc on @@ -2191,24 +2183,24 @@ addEnvHooks "$hostOffset" myBashFunction to need to share, and probably the most important to understand. It is currently accomplished by collecting directories of host-platform dependencies (i.e. buildInputs and - nativeBuildInputs) in environment variables. Bintools - Wrapper's setup hook causes any lib and + nativeBuildInputs) in environment variables. The + Bintools Wrapper's setup hook causes any lib and lib64 subdirectories to be added to - NIX_LDFLAGS. Since CC Wrapper and Bintools Wrapper use - the same strategy, most of the Bintools Wrapper code is sparsely - commented and refers to CC Wrapper. But CC Wrapper's code, by contrast, - has quite lengthy comments. Bintools Wrapper merely cites those, rather - than repeating them, to avoid falling out of sync. + NIX_LDFLAGS. Since the CC Wrapper and the Bintools Wrapper + use the same strategy, most of the Bintools Wrapper code is sparsely + commented and refers to the CC Wrapper. But the CC Wrapper's code, by + contrast, has quite lengthy comments. The Bintools Wrapper merely cites + those, rather than repeating them, to avoid falling out of sync. A final task of the setup hook is defining a number of standard - environment variables to tell build systems which executables full-fill + environment variables to tell build systems which executables fulfill which purpose. They are defined to just be the base name of the tools, - under the assumption that Bintools Wrapper's binaries will be on the + under the assumption that the Bintools Wrapper's binaries will be on the path. Firstly, this helps poorly-written packages, e.g. ones that look for just gcc when CC isn't defined yet - clang is to be used. Secondly, this helps packages - not get confused when cross-compiling, in which case multiple Bintools + clang is to be used. Secondly, this helps packages not + get confused when cross-compiling, in which case multiple Bintools Wrappers may simultaneously be in use. @@ -2220,20 +2212,20 @@ addEnvHooks "$hostOffset" myBashFunction BUILD_- and TARGET_-prefixed versions of - the normal environment variable are defined for the additional Bintools + the normal environment variable are defined for additional Bintools Wrappers, properly disambiguating them. - A problem with this final task is that Bintools Wrapper is honest and + A problem with this final task is that the Bintools Wrapper is honest and defines LD as ld. Most packages, however, firstly use the C compiler for linking, secondly use LD anyways, defining it as the C compiler, and thirdly, - only so define LD when it is undefined as a fallback. - This triple-threat means Bintools Wrapper will break those packages, as - LD is already defined as the actual linker which the package won't - override yet doesn't want to use. The workaround is to define, just for - the problematic package, LD as the C compiler. A good way - to do this would be preConfigure = "LD=$CC". + only so define LD when it is undefined as a fallback. This + triple-threat means Bintools Wrapper will break those packages, as LD is + already defined as the actual linker which the package won't override yet + doesn't want to use. The workaround is to define, just for the + problematic package, LD as the C compiler. A good way to + do this would be preConfigure = "LD=$CC". @@ -2243,30 +2235,31 @@ addEnvHooks "$hostOffset" myBashFunction - CC Wrapper wraps a C toolchain for a bunch of miscellaneous purposes. + The CC Wrapper wraps a C toolchain for a bunch of miscellaneous purposes. Specifically, a C compiler (GCC or Clang), wrapped binary tools, and a C standard library (glibc or Darwin's libSystem, just for the dynamic loader) are all fed in, and dependency finding, hardening (see below), - and purity checks for each are handled by CC Wrapper. Packages typically - depend on CC Wrapper, which in turn (at run time) depends on Bintools - Wrapper. + and purity checks for each are handled by the CC Wrapper. Packages + typically depend on the CC Wrapper, which in turn (at run-time) depends + on the Bintools Wrapper. - Dependency finding is undoubtedly the main task of CC Wrapper. This - works just like Bintools Wrapper, except that any + Dependency finding is undoubtedly the main task of the CC Wrapper. This + works just like the Bintools Wrapper, except that any include subdirectory of any relevant dependency is added to NIX_CFLAGS_COMPILE. The setup hook itself contains some lengthy comments describing the exact convoluted mechanism by which this is accomplished. - CC Wrapper also like Bintools Wrapper defines standard environment - variables with the names of the tools it wraps, for the same reasons - described above. Importantly, while it includes a cc - symlink to the c compiler for portability, the CC will be - defined using the compiler's "real name" (i.e. gcc or - clang). This helps lousy build systems that inspect - on the name of the compiler rather than run it. + Similarly, the CC Wrapper follows the Bintools Wrapper in defining + standard environment variables with the names of the tools it wraps, for + the same reasons described above. Importantly, while it includes a + cc symlink to the c compiler for portability, the + CC will be defined using the compiler's "real name" (i.e. + gcc or clang). This helps lousy + build systems that inspect on the name of the compiler rather than run + it. @@ -2326,9 +2319,11 @@ addEnvHooks "$hostOffset" myBashFunction The autoreconfHook derivation adds - autoreconfPhase, which runs autoreconf, libtoolize - and automake, essentially preparing the configure script in - autotools-based builds. + autoreconfPhase, which runs autoreconf, libtoolize and + automake, essentially preparing the configure script in autotools-based + builds. Most autotools-based packages come with the configure script + pre-generated, but this hook is necessary for a few packages and when you + need to patch the package’s configure scripts. @@ -2372,9 +2367,9 @@ addEnvHooks "$hostOffset" myBashFunction - Exports GDK_PIXBUF_MODULE_FILE environment variable the - the builder. Add librsvg package to buildInputs to - get svg support. + Exports GDK_PIXBUF_MODULE_FILE environment variable to the + builder. Add librsvg package to buildInputs to get svg + support. @@ -2411,7 +2406,7 @@ addEnvHooks "$hostOffset" myBashFunction PaX flags on Linux (where it is available by default; on all other platforms, paxmark is a no-op). For example, to disable secure memory protections on the executable - foo: + foo postFixup = '' paxmark m $out/bin/foo From ee58ab3cb9e727444e92ed992c02ef75d4356d6a Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Sun, 18 Nov 2018 23:20:47 -0600 Subject: [PATCH 6/9] doc/platform-notes: reword xcode warning MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit xcbuild doesn’t work exactly like xcode in some ways. --- doc/platform-notes.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/platform-notes.xml b/doc/platform-notes.xml index b27f2487575..6050271dbf6 100644 --- a/doc/platform-notes.xml +++ b/doc/platform-notes.xml @@ -96,8 +96,8 @@ The package xcbuild can be used to build projects that - really depend on Xcode, however projects that build some kind of graphical - interface won't work without using Xcode in an impure way. + really depend on Xcode. However, this replacement is not 100% + compatible with Xcode and can occasionally cause issues. From 9d3108c3aee8214d26218e8c2be3b4d497246fbe Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Sun, 18 Nov 2018 23:23:22 -0600 Subject: [PATCH 7/9] doc/cross-compilation: fixup More cleanups and stuff. May need to be split up. --- doc/cross-compilation.xml | 188 +++++++++++++++++++------------------- doc/stdenv.xml | 8 +- 2 files changed, 98 insertions(+), 98 deletions(-) diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml index 77cbf44fb20..ac68e6760bb 100644 --- a/doc/cross-compilation.xml +++ b/doc/cross-compilation.xml @@ -6,17 +6,17 @@ Introduction - "Cross-compilation" means compiling a program on one machine for another - type of machine. For example, a typical use of cross compilation is to - compile programs for embedded devices. These devices often don't have the - computing power and memory to compile their own programs. One might think - that cross-compilation is a fairly niche concern, but there are advantages - to being rigorous about distinguishing build-time vs run-time environments - even when one is developing and deploying on the same machine. Nixpkgs is - increasingly adopting the opinion that packages should be written with - cross-compilation in mind, and nixpkgs should evaluate in a similar way (by - minimizing cross-compilation-specific special cases) whether or not one is - cross-compiling. + "Cross-compilation" means compiling a program on one machine for another type + of machine. For example, a typical use of cross-compilation is to compile + programs for embedded devices. These devices often don't have the computing + power and memory to compile their own programs. One might think that + cross-compilation is a fairly niche concern. However, there are significant + advantages to rigorously distinguishing between build-time and run-time + environments! This applies even when one is developing and deploying on the + same machine. Nixpkgs is increasingly adopting the opinion that packages + should be written with cross-compilation in mind, and nixpkgs should evaluate + in a similar way (by minimizing cross-compilation-specific special cases) + whether or not one is cross-compiling. @@ -34,15 +34,15 @@ Platform parameters - Nixpkgs follows the - common - historical convention of GNU autoconf of distinguishing between 3 - types of platform: build, - host, and target. In - summary, build is the platform on which a package - is being built, host is the platform on which it - is to run. The third attribute, target, is - relevant only for certain specific compilers and build tools. + Nixpkgs follows the conventions + of GNU autoconf. We distinguish between 3 types of platforms when + building a derivation: build, + host, and target. In + summary, build is the platform on which a package + is being built, host is the platform on which it + will run. The third attribute, target, is relevant + only for certain specific compilers and build tools. @@ -64,7 +64,7 @@ The "build platform" is the platform on which a package is built. Once someone has a built package, or pre-built binary package, the build - platform should not matter and be safe to ignore. + platform should not matter and can be ignored. @@ -94,11 +94,11 @@ The build process of certain compilers is written in such a way that the compiler resulting from a single build can itself only produce binaries - for a single platform. The task specifying this single "target platform" - is thus pushed to build time of the compiler. The root cause of this - mistake is often that the compiler (which will be run on the host) and - the the standard library/runtime (which will be run on the target) are - built by a single build process. + for a single platform. The task of specifying this single "target + platform" is thus pushed to build time of the compiler. The root cause of + this that the compiler (which will be run on the host) and the standard + library/runtime (which will be run on the target) are built by a single + build process. There is no fundamental need to think about a single target ahead of @@ -135,8 +135,10 @@ This is a two-component shorthand for the platform. Examples of this would be "x86_64-darwin" and "i686-linux"; see - lib.systems.doubles for more. This format isn't very - standard, but has built-in support in Nix, such as the + lib.systems.doubles for more. The first component + corresponds to the CPU architecture of the platform and the second to the + operating system of the platform ([cpu]-[os]). This + format has built-in support in Nix, such as the builtins.currentSystem impure string. @@ -147,12 +149,13 @@ - This is a 3- or 4- component shorthand for the platform. Examples of - this would be "x86_64-unknown-linux-gnu" and "aarch64-apple-darwin14". - This is a standard format called the "LLVM target triple", as they are - pioneered by LLVM and traditionally just used for the - targetPlatform. This format is strictly more - informative than the "Nix host double", as the previous format could + This is a 3- or 4- component shorthand for the platform. Examples of this + would be x86_64-unknown-linux-gnu and + aarch64-apple-darwin14. This is a standard format + called the "LLVM target triple", as they are pioneered by LLVM. In the + 4-part form, this corresponds to + [cpu]-[vendor]-[os]-[abi]. This format is strictly + more informative than the "Nix host double", as the previous format could analogously be termed. This needs a better name than config! @@ -164,12 +167,11 @@ - This is a nix representation of a parsed LLVM target triple with - white-listed components. This can be specified directly, or actually - parsed from the config. [Technically, only one need - be specified and the others can be inferred, though the precision of - inference may not be very good.] See - lib.systems.parse for the exact representation. + This is a Nix representation of a parsed LLVM target triple + with white-listed components. This can be specified directly, + or actually parsed from the config. See + lib.systems.parse for the exact + representation. @@ -249,17 +251,17 @@ - Some examples will probably make this clearer. If a package is being built - with a (build, host, target) platform triple of - (foo, bar, bar), then its build-time dependencies would - have a triple of (foo, foo, bar), and those - packages' build-time dependencies would have triple of - (foo, foo, foo). In other words, it should take two - "rounds" of following build-time dependency edges before one reaches a - fixed point where, by the sliding window principle, the platform triple no - longer changes. Indeed, this happens with cross compilation, where only - rounds of native dependencies starting with the second necessarily coincide - with native packages. + Some examples will make this clearer. If a package is being built with a + (build, host, target) platform triple of (foo, + bar, bar), then its build-time dependencies would have a triple of + (foo, foo, bar), and those packages' + build-time dependencies would have a triple of (foo, foo, + foo). In other words, it should take two "rounds" of following + build-time dependency edges before one reaches a fixed point where, by the + sliding window principle, the platform triple no longer changes. Indeed, + this happens with cross-compilation, where only rounds of native + dependencies starting with the second necessarily coincide with native + packages. @@ -271,23 +273,23 @@ - How does this work in practice? Nixpkgs is now structured so that - build-time dependencies are taken from buildPackages, - whereas run-time dependencies are taken from the top level attribute set. - For example, buildPackages.gcc should be used at build - time, while gcc should be used at run time. Now, for - most of Nixpkgs's history, there was no buildPackages, - and most packages have not been refactored to use it explicitly. Instead, - one can use the six (gasp) attributes used for - specifying dependencies as documented in - . We "splice" together the - run-time and build-time package sets with callPackage, - and then mkDerivation for each of four attributes pulls - the right derivation out. This splicing can be skipped when not cross - compiling as the package sets are the same, but is a bit slow for cross - compiling. Because of this, a best-of-both-worlds solution is in the works - with no splicing or explicit access of buildPackages - needed. For now, feel free to use either method. + How does this work in practice? Nixpkgs is now structured so that build-time + dependencies are taken from buildPackages, whereas + run-time dependencies are taken from the top level attribute set. For + example, buildPackages.gcc should be used at build-time, + while gcc should be used at run-time. Now, for most of + Nixpkgs's history, there was no buildPackages, and most + packages have not been refactored to use it explicitly. Instead, one can use + the six (gasp) attributes used for specifying + dependencies as documented in . We + "splice" together the run-time and build-time package sets with + callPackage, and then mkDerivation for + each of four attributes pulls the right derivation out. This splicing can be + skipped when not cross-compiling as the package sets are the same, but is a + bit slow for cross-compiling. Because of this, a best-of-both-worlds + solution is in the works with no splicing or explicit access of + buildPackages needed. For now, feel free to use either + method. @@ -305,11 +307,11 @@ Cross packaging cookbook - Some frequently problems when packaging for cross compilation are good to - just spell and answer. Ideally the information above is exhaustive, so this - section cannot provide any new information, but its ludicrous and cruel to - expect everyone to spend effort working through the interaction of many - features just to figure out the same answer to the same common problem. + Some frequently encountered problems when packaging for cross-compilation + should be answered here. Ideally, the information above is exhaustive, so + this section cannot provide any new information, but it is ludicrous and + cruel to expect everyone to spend effort working through the interaction of + many features just to figure out the same answer to the same common problem. Feel free to add to this list! @@ -366,15 +368,14 @@ - More information needs to moved from the old wiki, especially - , for this - section. + More information needs to be moved from the old wiki, especially , for this section. Nixpkgs can be instantiated with localSystem alone, in - which case there is no cross compiling and everything is built by and for + which case there is no cross-compiling and everything is built by and for that system, or also with crossSystem, in which case packages run on the latter, but all building happens on the former. Both parameters take the same schema as the 3 (build, host, and target) platforms @@ -440,15 +441,14 @@ nix-build <nixpkgs> --arg crossSystem.config '<arch>-<os>-< build plan or package set. A simple "build vs deploy" dichotomy is adequate: the sliding window principle described in the previous section shows how to interpolate between the these two "end points" to get the 3 platform triple - for each bootstrapping stage. That means for any package a given package - set, even those not bound on the top level but only reachable via - dependencies or buildPackages, the three platforms will - be defined as one of localSystem or - crossSystem, with the former replacing the latter as one - traverses build-time dependencies. A last simple difference then is - crossSystem should be null when one doesn't want to - cross-compile, while the *Platforms are always non-null. - localSystem is always non-null. + for each bootstrapping stage. That means for any package a given package set, + even those not bound on the top level but only reachable via dependencies or + buildPackages, the three platforms will be defined as one + of localSystem or crossSystem, with the + former replacing the latter as one traverses build-time dependencies. A last + simple difference is that crossSystem should be null when + one doesn't want to cross-compile, while the *Platforms + are always non-null. localSystem is always non-null.
@@ -461,14 +461,14 @@ nix-build <nixpkgs> --arg crossSystem.config '<arch>-<os>-< - If one explores nixpkgs, they will see derivations with names like - gccCross. Such *Cross derivations is - a holdover from before we properly distinguished between the host and - target platforms —the derivation with "Cross" in the name covered the - build = host != target case, while the other covered the - host = target, with build platform the same or not based - on whether one was using its .nativeDrv or - .crossDrv. This ugliness will disappear soon. + If one explores Nixpkgs, they will see derivations with names like + gccCross. Such *Cross derivations is a + holdover from before we properly distinguished between the host and target + platforms—the derivation with "Cross" in the name covered the build + = host != target case, while the other covered the host = + target, with build platform the same or not based on whether one + was using its .nativeDrv or .crossDrv. + This ugliness will disappear soon. diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 10d58f38399..208b5e9cf30 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -258,15 +258,15 @@ genericBuild - It is important to note dependencies are not necessarily propagated as the - same sort of dependency that they were before, but rather as the + It is important to note that dependencies are not necessarily propagated as + the same sort of dependency that they were before, but rather as the corresponding sort so that the platform rules still line up. The exact rules for dependency propagation can be given by assigning to each dependency two integers based one how its host and target platforms are offset from the depending derivation's platforms. Those offsets are given below in the descriptions of each dependency list attribute. Algorithmically, we traverse propagated inputs, accumulating every propagated dependency's propagated - dependenciess and adjusting them to account for the "shift in perspective" + dependencies and adjusting them to account for the "shift in perspective" described by the current dependency's platform offsets. This results in sort a transitive closure of the dependency relation, with the offsets being approximately summed when two dependency links are combined. We also prune @@ -424,7 +424,7 @@ let f(h, h + 1, i) = i + h target offset from the new derivation's platforms. These are programs used at build time that produce code to run with code produced by the depending package. Most commonly, these are tools used to build the runtime or - standard library taht the currently-being-built compiler will inject into + standard library that the currently-being-built compiler will inject into any code it compiles. In many cases, the currently-being-built-compiler is itself employed for that task, but when that compiler won't run (i.e. its build and host platform differ) this is not possible. Other times, the From 5e9f452385e46058abde6011e902adf070ba86c3 Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Mon, 19 Nov 2018 12:51:28 -0600 Subject: [PATCH 8/9] doc/reviewing-contributions: pull-requests -> pull requests MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This makes things more consistent. It’s also how GitHub refers to pull requests. --- README.md | 2 +- doc/reviewing-contributions.xml | 56 ++++++++++++++++----------------- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 278ef66cf7e..29c023e4dcd 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ release and `nixos-unstable` for the latest successful build of master: % git rebase channels/nixos-18.09 ``` -For pull-requests, please rebase onto nixpkgs `master`. +For pull requests, please rebase onto nixpkgs `master`. [NixOS](https://nixos.org/nixos/) Linux distribution source code is located inside `nixos/` folder. diff --git a/doc/reviewing-contributions.xml b/doc/reviewing-contributions.xml index 79ebc400d36..0bf3dc9e9f8 100644 --- a/doc/reviewing-contributions.xml +++ b/doc/reviewing-contributions.xml @@ -18,35 +18,35 @@ The Nixpkgs project receives a fairly high number of contributions via GitHub - pull-requests. Reviewing and approving these is an important task and a way + pull requests. Reviewing and approving these is an important task and a way to contribute to the project. - The high change rate of Nixpkgs makes any pull-request that remains open for + The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter - or the merger. Reviewing pull-requests in a timely manner and being responsive + or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the most recently and the least - recently updated pull-requests. We highly encourage looking at + recently updated pull requests. We highly encourage looking at - this list of ready to merge, unreviewed pull-requests. + this list of ready to merge, unreviewed pull requests. - When reviewing a pull-request, please always be nice and polite. + When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work. GitHub provides reactions as a simple and quick way to provide feedback to - pull-requests or any comments. The thumb-down reaction should be used with + pull requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanation so the submitter has directions to improve their contribution. - Pull-request reviews should include a list of what has been reviewed in a + pull request reviews should include a list of what has been reviewed in a comment, so other reviewers and mergers can know the state of the review. @@ -58,8 +58,8 @@ Package updates - A package update is the most trivial and common type of pull-request. These - pull-requests mainly consist of updating the version part of the package + A package update is the most trivial and common type of pull request. These + pull requests mainly consist of updating the version part of the package name and the source hash. @@ -75,7 +75,7 @@ - Add labels to the pull-request. (Requires commit rights) + Add labels to the pull request. (Requires commit rights) @@ -142,8 +142,8 @@ - Pull-requests are often targeted to the master or staging branch, and - building the pull-request locally when it is submitted can trigger many + pull requests are often targeted to the master or staging branch, and + building the pull request locally when it is submitted can trigger many source builds. @@ -172,14 +172,14 @@ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD - Fetching the pull-request changes, PRNUMBER is the - number at the end of the pull-request title and - BASEBRANCH the base branch of the pull-request. + Fetching the pull request changes, PRNUMBER is the + number at the end of the pull request title and + BASEBRANCH the base branch of the pull request. - Rebasing the pull-request changes to the nixos-unstable branch. + Rebasing the pull request changes to the nixos-unstable branch. @@ -188,10 +188,10 @@ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD The nox tool can - be used to review a pull-request content in a single command. It doesn't + be used to review a pull request content in a single command. It doesn't rebase on a channel branch so it might trigger multiple source builds. PRNUMBER should be replaced by the number at the end - of the pull-request title. + of the pull request title. $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" @@ -228,7 +228,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" New packages - New packages are a common type of pull-requests. These pull-requests + New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package. @@ -239,7 +239,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" - Add labels to the pull-request. (Requires commit rights) + Add labels to the pull request. (Requires commit rights) @@ -359,7 +359,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" - Add labels to the pull-request. (Requires commit rights) + Add labels to the pull request. (Requires commit rights) @@ -472,7 +472,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" - Add labels to the pull-request. (Requires commit rights) + Add labels to the pull request. (Requires commit rights) @@ -574,21 +574,21 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" like to be a long-term reviewer for related submissions, please contact the current reviewers for that topic. They will give you information about the reviewing process. The main reviewers for a topic can be hard to find as - there is no list, but checking past pull-requests to see who reviewed or + there is no list, but checking past pull requests to see who reviewed or git-blaming the code to see who committed to that topic can give some hints. Container system, boot system and library changes are some examples of the - pull-requests fitting this category. + pull requests fitting this category. -
- Merging pull-requests +
+ Merging pull requests It is possible for community members that have enough knowledge and - experience on a special topic to contribute by merging pull-requests. + experience on a special topic to contribute by merging pull requests. From c2e6a4362a5d2b1e4dfe985ae8a40f3486d1ee38 Mon Sep 17 00:00:00 2001 From: Matthew Bauer Date: Mon, 19 Nov 2018 12:53:26 -0600 Subject: [PATCH 9/9] doc/cross-compilation: remove reference to old wiki MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The link doesn’t work and it’s not very important to the documentation anyway. --- doc/cross-compilation.xml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml index ac68e6760bb..a41240570c6 100644 --- a/doc/cross-compilation.xml +++ b/doc/cross-compilation.xml @@ -366,13 +366,6 @@
Cross-building packages - - - More information needs to be moved from the old wiki, especially , for this section. - - - Nixpkgs can be instantiated with localSystem alone, in which case there is no cross-compiling and everything is built by and for