18.03 release notes: final edits

(cherry picked from commit 0bee079d97)

.dir-locals.el

@@ -1,8 +0,0 @@
-;;; Directory Local Variables
-;;; For more information see (info "(emacs) Directory Variables")
-
-((nil
-  (bug-reference-bug-regexp . "\\(\\(?:[Ii]ssue \\|[Ff]ixe[ds] \\|[Rr]esolve[ds]? \\|[Cc]lose[ds]? \\|[Pp]\\(?:ull [Rr]equest\\|[Rr]\\) \\|(\\)#\\([0-9]+\\))?\\)")
-  (bug-reference-url-format . "https://github.com/NixOS/nixpkgs/issues/%s"))
- (nix-mode
-  (tab-width . 2)))

.editorconfig

@@ -13,8 +13,8 @@ charset = utf-8
 
 # see https://nixos.org/nixpkgs/manual/#chap-conventions
 
-# Match nix/ruby/docbook files, set indent to spaces with width of two
-[*.{nix,rb,xml}]
+# Match nix/ruby files, set indent to spaces with width of two
+[*.{nix,rb}]
 indent_style = space
 indent_size = 2
 

.gitattributes

@@ -1,16 +0,0 @@
-**/deps.nix linguist-generated
-**/node-packages.nix linguist-generated
-
-pkgs/applications/editors/emacs-modes/*-generated.nix linguist-generated
-pkgs/development/r-modules/*-packages.nix linguist-generated
-pkgs/development/haskell-modules/hackage-packages.nix linguist-generated
-pkgs/development/beam-modules/hex-packages.nix linguist-generated
-
-doc/** linguist-documentation
-doc/default.nix linguist-documentation=false
-
-nixos/doc/** linguist-documentation
-nixos/doc/default.nix linguist-documentation=false
-
-nixos/modules/module-list.nix merge=union
-# pkgs/top-level/all-packages.nix merge=union

.github/CODEOWNERS

@@ -13,16 +13,13 @@
 # Libraries
 /lib                        @edolstra @nbp
 /lib/systems                @nbp @ericson2314
-/lib/generators.nix         @edolstra @nbp @Profpatsch
-/lib/debug.nix              @edolstra @nbp @Profpatsch
 
 # Nixpkgs Internals
 /default.nix                          @nbp
 /pkgs/top-level/default.nix           @nbp @Ericson2314
 /pkgs/top-level/impure.nix            @nbp @Ericson2314
 /pkgs/top-level/stage.nix             @nbp @Ericson2314
-/pkgs/stdenv/generic                  @Ericson2314
-/pkgs/stdenv/cross                    @Ericson2314
+/pkgs/stdenv
 /pkgs/build-support/cc-wrapper        @Ericson2314 @orivej
 /pkgs/build-support/bintools-wrapper  @Ericson2314 @orivej
 /pkgs/build-support/setup-hooks       @Ericson2314
@@ -46,18 +43,17 @@
 /nixos/modules/installer/tools/nixos-option.sh        @nbp
 
 # Python-related code and docs
-/maintainers/scripts/update-python-libraries	@FRidh
 /pkgs/top-level/python-packages.nix     @FRidh
 /pkgs/development/interpreters/python   @FRidh
 /pkgs/development/python-modules        @FRidh
 /doc/languages-frameworks/python.md     @FRidh
 
 # Haskell
-/pkgs/development/compilers/ghc                       @peti @ryantm @basvandijk
-/pkgs/development/haskell-modules                     @peti @ryantm @basvandijk
-/pkgs/development/haskell-modules/default.nix         @peti @ryantm @basvandijk
-/pkgs/development/haskell-modules/generic-builder.nix @peti @ryantm @basvandijk
-/pkgs/development/haskell-modules/hoogle.nix          @peti @ryantm @basvandijk
+/pkgs/development/compilers/ghc                       @peti
+/pkgs/development/haskell-modules                     @peti
+/pkgs/development/haskell-modules/default.nix         @peti
+/pkgs/development/haskell-modules/generic-builder.nix @peti
+/pkgs/development/haskell-modules/hoogle.nix          @peti
 
 # R
 /pkgs/applications/science/math/R   @peti
@@ -67,9 +63,6 @@
 /pkgs/development/interpreters/ruby @zimbatm
 /pkgs/development/ruby-modules      @zimbatm
 
-# Rust
-/pkgs/development/compilers/rust @Mic92 @LnL7
-
 # Darwin-related
 /pkgs/stdenv/darwin         @NixOS/darwin-maintainers
 /pkgs/os-specific/darwin    @NixOS/darwin-maintainers
@@ -90,6 +83,7 @@
 /pkgs/applications/editors/eclipse @rycee
 
 # https://github.com/NixOS/nixpkgs/issues/31401
+/lib/maintainers.nix @ghost
 /lib/licenses.nix @ghost
 
 # Qt / KDE

.github/CONTRIBUTING.md

@@ -43,7 +43,7 @@ See the nixpkgs manual for more details on [standard meta-attributes](https://ni
 
 ## Writing good commit messages
 
-In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list/Discourse archives, pull request discussions or upstream changes, it may require a lot of work.
+In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list archives, pull request discussions or upstream changes, it may require a lot of work.
 
 For package version upgrades and such a one-line commit message is usually sufficient.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,7 +5,7 @@
 
 <!-- Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers. -->
 
-- [ ] Tested using sandboxing ([nix.useSandbox](http://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](http://nixos.org/nix/manual/#sec-conf-file) on non-NixOS)
+- [ ] Tested using sandboxing ([nix.useSandbox](http://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `build-use-sandbox` in [`nix.conf`](http://nixos.org/nix/manual/#sec-conf-file) on non-NixOS)
 - Built on platform(s)
    - [ ] NixOS
    - [ ] macOS
@@ -13,7 +13,6 @@
 - [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests))
 - [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nox --run "nox-review wip"`
 - [ ] Tested execution of all binary files (usually in `./result/bin/`)
-- [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after)
 - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
 
 ---

.version

@@ -1 +1 @@
-18.09
+18.03

README.md

@@ -8,16 +8,16 @@ build daemon as so-called channels. To get channel information via git, add
 [nixpkgs-channels](https://github.com/NixOS/nixpkgs-channels.git) as a remote:
 
 ```
-% git remote add channels https://github.com/NixOS/nixpkgs-channels.git
+% git remote add channels git://github.com/NixOS/nixpkgs-channels.git
 ```
 
 For stability and maximum binary package support, it is recommended to maintain
-custom changes on top of one of the channels, e.g. `nixos-18.09` for the latest
+custom changes on top of one of the channels, e.g. `nixos-17.09` for the latest
 release and `nixos-unstable` for the latest successful build of master:
 
 ```
 % git remote update channels
-% git rebase channels/nixos-18.09
+% git rebase channels/nixos-17.09
 ```
 
 For pull-requests, please rebase onto nixpkgs `master`.
@@ -31,11 +31,11 @@ For pull-requests, please rebase onto nixpkgs `master`.
 * [Manual (NixOS)](https://nixos.org/nixos/manual/)
 * [Community maintained wiki](https://nixos.wiki/)
 * [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)
-* [Continuous package builds for 18.09 release](https://hydra.nixos.org/jobset/nixos/release-18.09)
+* [Continuous package builds for 17.09 release](https://hydra.nixos.org/jobset/nixos/release-17.09)
 * [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
-* [Tests for 18.09 release](https://hydra.nixos.org/job/nixos/release-18.09/tested#tabs-constituents)
+* [Tests for 17.09 release](https://hydra.nixos.org/job/nixos/release-17.09/tested#tabs-constituents)
 
 Communication:
 
-* [Discourse Forum](https://discourse.nixos.org/)
+* [Mailing list](https://groups.google.com/forum/#!forum/nix-devel)
 * [IRC - #nixos on freenode.net](irc://irc.freenode.net/#nixos)

default.nix

@@ -6,21 +6,12 @@ if ! builtins ? nixVersion || builtins.compareVersions requiredVersion builtins.
 
     This version of Nixpkgs requires Nix >= ${requiredVersion}, please upgrade:
 
-    - If you are running NixOS, `nixos-rebuild' can be used to upgrade your system.
-
-    - Alternatively, with Nix > 2.0 `nix upgrade-nix' can be used to imperatively
-      upgrade Nix. You may use `nix-env --version' to check which version you have.
+    - If you are running NixOS, use `nixos-rebuild' to upgrade your system.
 
     - If you installed Nix using the install script (https://nixos.org/nix/install),
       it is safe to upgrade by running it again:
 
           curl https://nixos.org/nix/install | sh
-
-    For more information, please see the NixOS release notes at
-    https://nixos.org/nixos/manual or locally at
-    ${toString ./doc/manual/release-notes}.
-
-    If you need further help, see https://nixos.org/nixos/support.html
   ''
 
 else

doc/.gitignore

@@ -4,4 +4,3 @@
 out
 manual-full.xml
 highlightjs
-functions/library/locations.xml

doc/Makefile

@@ -1,25 +1,15 @@
 MD_TARGETS=$(addsuffix .xml, $(basename $(wildcard ./*.md ./**/*.md)))
 
 .PHONY: all
-all: validate format out/html/index.html out/epub/manual.epub
+all: validate out/html/index.html out/epub/manual.epub
 
 .PHONY: debug
 debug:
 	nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml"
 
-.PHONY: format
-format:
-	find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \
-		xmlformat --config-file "$$XMLFORMAT_CONFIG" -i {}
-
-.PHONY: fix-misc-xml
-fix-misc-xml:
-	find . -iname '*.xml' -type f \
-		-exec ../nixos/doc/varlistentry-fixer.rb {} ';'
-
 .PHONY: clean
 clean:
-	rm -f ${MD_TARGETS} .version manual-full.xml functions/library/locations.xml
+	rm -f ${MD_TARGETS} .version manual-full.xml
 	rm -rf ./out/ ./highlightjs
 
 .PHONY: validate
@@ -35,6 +25,13 @@ out/html/index.html: manual-full.xml style.css highlightjs
 		./manual-full.xml
 
 	mkdir -p out/html/highlightjs/
+	echo "document.onreadystatechange = function () { \
+	  var listings = document.querySelectorAll('.programlisting, .screen'); \
+	  for (i = 0; i < listings.length; ++i) { \
+	     hljs.highlightBlock(listings[i]); \
+	  } \
+	} " > out/html/highlightjs/loader.js
+
 	cp -r highlightjs out/html/
 
 	cp ./overrides.css out/html/
@@ -66,19 +63,14 @@ highlightjs:
 	cp -r "$$HIGHLIGHTJS/highlight.pack.js" highlightjs/
 	cp -r "$$HIGHLIGHTJS/LICENSE" highlightjs/
 	cp -r "$$HIGHLIGHTJS/mono-blue.css" highlightjs/
-	cp -r "$$HIGHLIGHTJS/loader.js" highlightjs/
 
 
-manual-full.xml: ${MD_TARGETS} .version functions/library/locations.xml *.xml **/*.xml **/**/*.xml
+manual-full.xml: ${MD_TARGETS} .version *.xml
 	xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
 
 .version:
 	nix-instantiate --eval \
-		-E '(import ../lib).version' > .version
-
-functions/library/locations.xml:
-	nix-build ./lib-function-locations.nix \
-		--out-link ./functions/library/locations.xml
+		-E '(import ../lib).nixpkgsVersion' > .version
 
 %.section.xml: %.section.md
 	pandoc $^ -w docbook+smart \

doc/configuration.xml

@@ -1,51 +1,40 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-packageconfig">
- <title>Global configuration</title>
- <para>
-  Nix comes with certain defaults about what packages can and cannot be
-  installed, based on a package's metadata. By default, Nix will prevent
-  installation if any of the following criteria are true:
- </para>
- <itemizedlist>
-  <listitem>
-   <para>
-    The package is thought to be broken, and has had its
-    <literal>meta.broken</literal> set to <literal>true</literal>.
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    The package isn't intended to run on the given system, as none of its
-    <literal>meta.platforms</literal> match the given system.
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    The package's <literal>meta.license</literal> is set to a license which is
-    considered to be unfree.
-   </para>
-  </listitem>
-  <listitem>
-   <para>
-    The package has known security vulnerabilities but has not or can not be
-    updated for some reason, and a list of issues has been entered in to the
-    package's <literal>meta.knownVulnerabilities</literal>.
-   </para>
-  </listitem>
- </itemizedlist>
- <para>
-  Note that all this is checked during evaluation already, and the check
-  includes any package that is evaluated. In particular, all build-time
-  dependencies are checked. <literal>nix-env -qa</literal> will (attempt to)
-  hide any packages that would be refused.
- </para>
- <para>
-  Each of these criteria can be altered in the nixpkgs configuration.
- </para>
- <para>
-  The nixpkgs configuration for a NixOS system is set in the
-  <literal>configuration.nix</literal>, as in the following example:
+
+<title>Global configuration</title>
+
+<para>Nix comes with certain defaults about what packages can and
+cannot be installed, based on a package's metadata. By default, Nix
+will prevent installation if any of the following criteria are
+true:</para>
+
+<itemizedlist>
+  <listitem><para>The package is thought to be broken, and has had
+  its <literal>meta.broken</literal> set to
+  <literal>true</literal>.</para></listitem>
+
+  <listitem><para>The package's <literal>meta.license</literal> is set
+  to a license which is considered to be unfree.</para></listitem>
+
+  <listitem><para>The package has known security vulnerabilities but
+  has not or can not be updated for some reason, and a list of issues
+  has been entered in to the package's
+  <literal>meta.knownVulnerabilities</literal>.</para></listitem>
+</itemizedlist>
+
+<para>Note that all this is checked during evaluation already,
+and the check includes any package that is evaluated.
+In particular, all build-time dependencies are checked.
+<literal>nix-env -qa</literal> will (attempt to) hide any packages
+that would be refused.
+</para>
+
+<para>Each of these criteria can be altered in the nixpkgs
+configuration.</para>
+
+<para>The nixpkgs configuration for a NixOS system is set in the
+<literal>configuration.nix</literal>, as in the following example:
 <programlisting>
 {
   nixpkgs.config = {
@@ -53,197 +42,151 @@
   };
 }
 </programlisting>
-  However, this does not allow unfree software for individual users. Their
-  configurations are managed separately.
- </para>
- <para>
-  A user's of nixpkgs configuration is stored in a user-specific configuration
-  file located at <filename>~/.config/nixpkgs/config.nix</filename>. For
-  example:
+However, this does not allow unfree software for individual users.
+Their configurations are managed separately.</para>
+
+<para>A user's of nixpkgs configuration is stored in a user-specific
+configuration file located at
+<filename>~/.config/nixpkgs/config.nix</filename>. For example:
 <programlisting>
 {
   allowUnfree = true;
 }
 </programlisting>
- </para>
- <para>
-  Note that we are not able to test or build unfree software on Hydra due to
-  policy. Most unfree licenses prohibit us from either executing or
-  distributing the software.
- </para>
- <section xml:id="sec-allow-broken">
+</para>
+
+<para>Note that we are not able to test or build unfree software on Hydra
+due to policy. Most unfree licenses prohibit us from either executing or
+distributing the software.</para>
+
+<section xml:id="sec-allow-broken">
   <title>Installing broken packages</title>
 
-  <para>
-   There are two ways to try compiling a package which has been marked as
-   broken.
-  </para>
+
+  <para>There are two ways to try compiling a package which has been
+  marked as broken.</para>
 
   <itemizedlist>
-   <listitem>
-    <para>
-     For allowing the build of a broken package once, you can use an
-     environment variable for a single invocation of the nix tools:
-<programlisting>$ export NIXPKGS_ALLOW_BROKEN=1</programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     For permanently allowing broken packages to be built, you may add
-     <literal>allowBroken = true;</literal> to your user's configuration file,
-     like this:
+    <listitem><para>
+      For allowing the build of a broken package once, you can use an
+      environment variable for a single invocation of the nix tools:
+
+      <programlisting>$ export NIXPKGS_ALLOW_BROKEN=1</programlisting>
+    </para></listitem>
+
+    <listitem><para>
+      For permanently allowing broken packages to be built, you may
+      add <literal>allowBroken = true;</literal> to your user's
+      configuration file, like this:
+
 <programlisting>
 {
   allowBroken = true;
 }
 </programlisting>
-    </para>
-   </listitem>
+    </para></listitem>
   </itemizedlist>
- </section>
- <section xml:id="sec-allow-unsupported-system">
-  <title>Installing packages on unsupported systems</title>
+</section>
 
-  <para>
-   There are also two ways to try compiling a package which has been marked as
-   unsuported for the given system.
-  </para>
-
-  <itemizedlist>
-   <listitem>
-    <para>
-     For allowing the build of a broken package once, you can use an
-     environment variable for a single invocation of the nix tools:
-<programlisting>$ export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1</programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     For permanently allowing broken packages to be built, you may add
-     <literal>allowUnsupportedSystem = true;</literal> to your user's
-     configuration file, like this:
-<programlisting>
-{
-  allowUnsupportedSystem = true;
-}
-</programlisting>
-    </para>
-   </listitem>
-  </itemizedlist>
-
-  <para>
-   The difference between an a package being unsupported on some system and
-   being broken is admittedly a bit fuzzy. If a program
-   <emphasis>ought</emphasis> to work on a certain platform, but doesn't, the
-   platform should be included in <literal>meta.platforms</literal>, but marked
-   as broken with e.g. <literal>meta.broken =
-   !hostPlatform.isWindows</literal>. Of course, this begs the question of what
-   "ought" means exactly. That is left to the package maintainer.
-  </para>
- </section>
- <section xml:id="sec-allow-unfree">
+<section xml:id="sec-allow-unfree">
   <title>Installing unfree packages</title>
 
-  <para>
-   There are several ways to tweak how Nix handles a package which has been
-   marked as unfree.
-  </para>
+  <para>There are several ways to tweak how Nix handles a package
+  which has been marked as unfree.</para>
 
   <itemizedlist>
-   <listitem>
-    <para>
-     To temporarily allow all unfree packages, you can use an environment
-     variable for a single invocation of the nix tools:
-<programlisting>$ export NIXPKGS_ALLOW_UNFREE=1</programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     It is possible to permanently allow individual unfree packages, while
-     still blocking unfree packages by default using the
-     <literal>allowUnfreePredicate</literal> configuration option in the user
-     configuration file.
-    </para>
-    <para>
-     This option is a function which accepts a package as a parameter, and
-     returns a boolean. The following example configuration accepts a package
-     and always returns false:
+    <listitem><para>
+      To temporarily allow all unfree packages, you can use an
+      environment variable for a single invocation of the nix tools:
+
+      <programlisting>$ export NIXPKGS_ALLOW_UNFREE=1</programlisting>
+    </para></listitem>
+
+    <listitem><para>
+      It is possible to permanently allow individual unfree packages,
+      while still blocking unfree packages by default using the
+      <literal>allowUnfreePredicate</literal> configuration
+      option in the user configuration file.</para>
+
+      <para>This option is a function which accepts a package as a
+      parameter, and returns a boolean. The following example
+      configuration accepts a package and always returns false:
 <programlisting>
 {
   allowUnfreePredicate = (pkg: false);
 }
 </programlisting>
-    </para>
-    <para>
-     A more useful example, the following configuration allows only allows
-     flash player and visual studio code:
+      </para>
+
+      <para>A more useful example, the following configuration allows
+      only allows flash player and visual studio code:
+
 <programlisting>
 {
   allowUnfreePredicate = (pkg: elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]);
 }
 </programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     It is also possible to whitelist and blacklist licenses that are
-     specifically acceptable or not acceptable, using
-     <literal>whitelistedLicenses</literal> and
-     <literal>blacklistedLicenses</literal>, respectively.
-    </para>
-    <para>
-     The following example configuration whitelists the licenses
-     <literal>amd</literal> and <literal>wtfpl</literal>:
+    </para></listitem>
+
+    <listitem>
+      <para>It is also possible to whitelist and blacklist licenses
+      that are specifically acceptable or not acceptable, using
+      <literal>whitelistedLicenses</literal> and
+      <literal>blacklistedLicenses</literal>, respectively.
+      </para>
+
+      <para>The following example configuration whitelists the
+      licenses <literal>amd</literal> and <literal>wtfpl</literal>:
+
 <programlisting>
 {
   whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ];
 }
 </programlisting>
-    </para>
-    <para>
-     The following example configuration blacklists the <literal>gpl3</literal>
-     and <literal>agpl3</literal> licenses:
+      </para>
+
+      <para>The following example configuration blacklists the
+      <literal>gpl3</literal> and <literal>agpl3</literal> licenses:
+
 <programlisting>
 {
   blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ];
 }
 </programlisting>
-    </para>
-   </listitem>
+      </para>
+    </listitem>
   </itemizedlist>
 
-  <para>
-   A complete list of licenses can be found in the file
-   <filename>lib/licenses.nix</filename> of the nixpkgs tree.
-  </para>
- </section>
- <section xml:id="sec-allow-insecure">
-  <title>Installing insecure packages</title>
+  <para>A complete list of licenses can be found in the file
+  <filename>lib/licenses.nix</filename> of the nixpkgs tree.</para>
+</section>
 
-  <para>
-   There are several ways to tweak how Nix handles a package which has been
-   marked as insecure.
-  </para>
+
+<section xml:id="sec-allow-insecure">
+  <title>
+    Installing insecure packages
+  </title>
+
+  <para>There are several ways to tweak how Nix handles a package
+  which has been marked as insecure.</para>
 
   <itemizedlist>
-   <listitem>
-    <para>
-     To temporarily allow all insecure packages, you can use an environment
-     variable for a single invocation of the nix tools:
-<programlisting>$ export NIXPKGS_ALLOW_INSECURE=1</programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     It is possible to permanently allow individual insecure packages, while
-     still blocking other insecure packages by default using the
-     <literal>permittedInsecurePackages</literal> configuration option in the
-     user configuration file.
-    </para>
-    <para>
-     The following example configuration permits the installation of the
-     hypothetically insecure package <literal>hello</literal>, version
-     <literal>1.2.3</literal>:
+    <listitem><para>
+      To temporarily allow all insecure packages, you can use an
+      environment variable for a single invocation of the nix tools:
+
+      <programlisting>$ export NIXPKGS_ALLOW_INSECURE=1</programlisting>
+    </para></listitem>
+
+    <listitem><para>
+      It is possible to permanently allow individual insecure
+      packages, while still blocking other insecure packages by
+      default using the <literal>permittedInsecurePackages</literal>
+      configuration option in the user configuration file.</para>
+
+      <para>The following example configuration permits the
+      installation of the hypothetically insecure package
+      <literal>hello</literal>, version <literal>1.2.3</literal>:
 <programlisting>
 {
   permittedInsecurePackages = [
@@ -251,44 +194,47 @@
   ];
 }
 </programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     It is also possible to create a custom policy around which insecure
-     packages to allow and deny, by overriding the
-     <literal>allowInsecurePredicate</literal> configuration option.
-    </para>
-    <para>
-     The <literal>allowInsecurePredicate</literal> option is a function which
-     accepts a package and returns a boolean, much like
-     <literal>allowUnfreePredicate</literal>.
-    </para>
-    <para>
-     The following configuration example only allows insecure packages with
-     very short names:
+      </para>
+    </listitem>
+
+    <listitem><para>
+      It is also possible to create a custom policy around which
+      insecure packages to allow and deny, by overriding the
+      <literal>allowInsecurePredicate</literal> configuration
+      option.</para>
+
+      <para>The <literal>allowInsecurePredicate</literal> option is a
+      function which accepts a package and returns a boolean, much
+      like <literal>allowUnfreePredicate</literal>.</para>
+
+      <para>The following configuration example only allows insecure
+      packages with very short names:
+
 <programlisting>
 {
   allowInsecurePredicate = (pkg: (builtins.stringLength (builtins.parseDrvName pkg.name).name) &lt;= 5);
 }
 </programlisting>
-    </para>
-    <para>
-     Note that <literal>permittedInsecurePackages</literal> is only checked if
-     <literal>allowInsecurePredicate</literal> is not specified.
-    </para>
-   </listitem>
-  </itemizedlist>
- </section>
-<!--============================================================-->
- <section xml:id="sec-modify-via-packageOverrides">
-  <title>Modify packages via <literal>packageOverrides</literal></title>
+      </para>
+
+      <para>Note that <literal>permittedInsecurePackages</literal> is
+      only checked if <literal>allowInsecurePredicate</literal> is not
+      specified.
+    </para></listitem>
+  </itemizedlist>
+</section>
+
+<!--============================================================-->
+
+<section xml:id="sec-modify-via-packageOverrides"><title>Modify
+packages via <literal>packageOverrides</literal></title>
+
+<para>You can define a function called
+<varname>packageOverrides</varname> in your local
+<filename>~/.config/nixpkgs/config.nix</filename> to override nix packages.  It
+must be a function that takes pkgs as an argument and return modified
+set of packages.
 
-  <para>
-   You can define a function called <varname>packageOverrides</varname> in your
-   local <filename>~/.config/nixpkgs/config.nix</filename> to override nix
-   packages. It must be a function that takes pkgs as an argument and return
-   modified set of packages.
 <programlisting>
 {
   packageOverrides = pkgs: rec {
@@ -296,27 +242,30 @@
   };
 }
 </programlisting>
-  </para>
- </section>
- <section xml:id="sec-declarative-package-management">
+
+</para>
+
+</section>
+
+<section xml:id="sec-declarative-package-management">
   <title>Declarative Package Management</title>
 
   <section xml:id="sec-building-environment">
-   <title>Build an environment</title>
+    <title>Build an environment</title>
 
-   <para>
-    Using <literal>packageOverrides</literal>, it is possible to manage
-    packages declaratively. This means that we can list all of our desired
-    packages within a declarative Nix expression. For example, to have
-    <literal>aspell</literal>, <literal>bc</literal>,
-    <literal>ffmpeg</literal>, <literal>coreutils</literal>,
-    <literal>gdb</literal>, <literal>nixUnstable</literal>,
-    <literal>emscripten</literal>, <literal>jq</literal>,
-    <literal>nox</literal>, and <literal>silver-searcher</literal>, we could
-    use the following in <filename>~/.config/nixpkgs/config.nix</filename>:
-   </para>
+    <para>
+      Using <literal>packageOverrides</literal>, it is possible to manage
+      packages declaratively. This means that we can list all of our desired
+      packages within a declarative Nix expression. For example, to have
+      <literal>aspell</literal>, <literal>bc</literal>,
+      <literal>ffmpeg</literal>, <literal>coreutils</literal>,
+      <literal>gdb</literal>, <literal>nixUnstable</literal>,
+      <literal>emscripten</literal>, <literal>jq</literal>,
+      <literal>nox</literal>, and <literal>silver-searcher</literal>, we could
+      use the following in <filename>~/.config/nixpkgs/config.nix</filename>:
+    </para>
 
-<screen>
+    <screen>
 {
   packageOverrides = pkgs: with pkgs; {
     myPackages = pkgs.buildEnv {
@@ -327,17 +276,17 @@
 }
     </screen>
 
-   <para>
-    To install it into our environment, you can just run <literal>nix-env -iA
-    nixpkgs.myPackages</literal>. If you want to load the packages to be built
-    from a working copy of <literal>nixpkgs</literal> you just run
-    <literal>nix-env -f. -iA myPackages</literal>. To explore what's been
-    installed, just look through <filename>~/.nix-profile/</filename>. You can
-    see that a lot of stuff has been installed. Some of this stuff is useful
-    some of it isn't. Let's tell Nixpkgs to only link the stuff that we want:
-   </para>
+    <para>
+      To install it into our environment, you can just run <literal>nix-env -iA
+      nixpkgs.myPackages</literal>. If you want to load the packages to be built
+      from a working copy of <literal>nixpkgs</literal> you just run
+      <literal>nix-env -f. -iA myPackages</literal>. To explore what's been
+      installed, just look through <filename>~/.nix-profile/</filename>. You can
+      see that a lot of stuff has been installed. Some of this stuff is useful
+      some of it isn't. Let's tell Nixpkgs to only link the stuff that we want:
+    </para>
 
-<screen>
+    <screen>
 {
   packageOverrides = pkgs: with pkgs; {
     myPackages = pkgs.buildEnv {
@@ -349,49 +298,51 @@
 }
     </screen>
 
-   <para>
-    <literal>pathsToLink</literal> tells Nixpkgs to only link the paths listed
-    which gets rid of the extra stuff in the profile. <filename>/bin</filename>
-    and <filename>/share</filename> are good defaults for a user environment,
-    getting rid of the clutter. If you are running on Nix on MacOS, you may
-    want to add another path as well, <filename>/Applications</filename>, that
-    makes GUI apps available.
-   </para>
+    <para>
+      <literal>pathsToLink</literal> tells Nixpkgs to only link the paths listed
+      which gets rid of the extra stuff in the profile.
+      <filename>/bin</filename> and <filename>/share</filename> are good
+      defaults for a user environment, getting rid of the clutter. If you are
+      running on Nix on MacOS, you may want to add another path as well,
+      <filename>/Applications</filename>, that makes GUI apps available.
+    </para>
+
   </section>
 
   <section xml:id="sec-getting-documentation">
-   <title>Getting documentation</title>
+    <title>Getting documentation</title>
 
-   <para>
-    After building that new environment, look through
-    <filename>~/.nix-profile</filename> to make sure everything is there that
-    we wanted. Discerning readers will note that some files are missing. Look
-    inside <filename>~/.nix-profile/share/man/man1/</filename> to verify this.
-    There are no man pages for any of the Nix tools! This is because some
-    packages like Nix have multiple outputs for things like documentation (see
-    section 4). Let's make Nix install those as well.
-   </para>
+    <para>
+      After building that new environment, look through
+      <filename>~/.nix-profile</filename> to make sure everything is there that
+      we wanted. Discerning readers will note that some files are missing. Look
+      inside <filename>~/.nix-profile/share/man/man1/</filename> to verify this.
+      There are no man pages for any of the Nix tools! This is because some
+      packages like Nix have multiple outputs for things like documentation (see
+      section 4). Let's make Nix install those as well.
+    </para>
 
-<screen>
+    <screen>
 {
   packageOverrides = pkgs: with pkgs; {
     myPackages = pkgs.buildEnv {
       name = "my-packages";
       paths = [ aspell bc coreutils ffmpeg nixUnstable emscripten jq nox silver-searcher ];
-      pathsToLink = [ "/share/man" "/share/doc" "/bin" ];
+      pathsToLink = [ "/share/man" "/share/doc" /bin" ];
       extraOutputsToInstall = [ "man" "doc" ];
     };
   };
 }
     </screen>
 
-   <para>
-    This provides us with some useful documentation for using our packages.
-    However, if we actually want those manpages to be detected by man, we need
-    to set up our environment. This can also be managed within Nix expressions.
-   </para>
+    <para>
+      This provides us with some useful documentation for using our packages.
+      However, if we actually want those manpages to be detected by man, we need
+      to set up our environment. This can also be managed within Nix
+      expressions.
+    </para>
 
-<screen>
+    <screen>
 {
   packageOverrides = pkgs: with pkgs; rec {
     myProfile = writeText "my-profile" ''
@@ -416,20 +367,20 @@ cp ${myProfile} $out/etc/profile.d/my-profile.sh
         nox
         silver-searcher
       ];
-      pathsToLink = [ "/share/man" "/share/doc" "/bin" "/etc" ];
+      pathsToLink = [ "/share/man" "/share/doc" /bin" "/etc" ];
       extraOutputsToInstall = [ "man" "doc" ];
     };
   };
 }
     </screen>
 
-   <para>
-    For this to work fully, you must also have this script sourced when you are
-    logged in. Try adding something like this to your
-    <filename>~/.profile</filename> file:
-   </para>
+    <para>
+      For this to work fully, you must also have this script sourced when you
+      are logged in. Try adding something like this to your
+      <filename>~/.profile</filename> file:
+    </para>
 
-<screen>
+    <screen>
 #!/bin/sh
 if [ -d $HOME/.nix-profile/etc/profile.d ]; then
   for i in $HOME/.nix-profile/etc/profile.d/*.sh; do
@@ -440,22 +391,23 @@ if [ -d $HOME/.nix-profile/etc/profile.d ]; then
 fi
     </screen>
 
-   <para>
-    Now just run <literal>source $HOME/.profile</literal> and you can starting
-    loading man pages from your environent.
-   </para>
+    <para>
+      Now just run <literal>source $HOME/.profile</literal> and you can starting
+      loading man pages from your environent.
+    </para>
+
   </section>
-
+    
   <section xml:id="sec-gnu-info-setup">
-   <title>GNU info setup</title>
+    <title>GNU info setup</title>
 
-   <para>
-    Configuring GNU info is a little bit trickier than man pages. To work
-    correctly, info needs a database to be generated. This can be done with
-    some small modifications to our environment scripts.
-   </para>
+    <para>
+      Configuring GNU info is a little bit trickier than man pages. To work
+      correctly, info needs a database to be generated. This can be done with
+      some small modifications to our environment scripts.
+    </para>
 
-<screen>
+    <screen>
 {
   packageOverrides = pkgs: with pkgs; rec {
     myProfile = writeText "my-profile" ''
@@ -497,13 +449,16 @@ cp ${myProfile} $out/etc/profile.d/my-profile.sh
 }
     </screen>
 
-   <para>
-    <literal>postBuild</literal> tells Nixpkgs to run a command after building
-    the environment. In this case, <literal>install-info</literal> adds the
-    installed info pages to <literal>dir</literal> which is GNU info's default
-    root node. Note that <literal>texinfoInteractive</literal> is added to the
-    environment to give the <literal>install-info</literal> command.
-   </para>
+    <para>
+      <literal>postBuild</literal> tells Nixpkgs to run a command after building
+      the environment. In this case, <literal>install-info</literal> adds the
+      installed info pages to <literal>dir</literal> which is GNU info's default
+      root node. Note that <literal>texinfoInteractive</literal> is added to the
+      environment to give the <literal>install-info</literal> command.
+    </para>
+
   </section>
- </section>
+
+</section>
+
 </chapter>

doc/contributing.xml

@@ -1,35 +1,35 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-contributing">
- <title>Contributing to this documentation</title>
- <para>
-  The DocBook sources of the Nixpkgs manual are in the
-  <filename
+
+<title>Contributing to this documentation</title>
+
+<para>The DocBook sources of the Nixpkgs manual are in the <filename
 xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename>
-  subdirectory of the Nixpkgs repository.
- </para>
- <para>
-  You can quickly check your edits with <command>make</command>:
- </para>
+subdirectory of the Nixpkgs repository.</para>
+
+<para>You can quickly check your edits with <command>make</command>:</para>
+
 <screen>
   $ cd /path/to/nixpkgs/doc
   $ nix-shell
   [nix-shell]$ make
 </screen>
- <para>
-  If you experience problems, run <command>make debug</command> to help
-  understand the docbook errors.
- </para>
- <para>
-  After making modifications to the manual, it's important to build it before
-  committing. You can do that as follows:
+
+<para>If you experience problems, run <command>make debug</command>
+to help understand the docbook errors.</para>
+
+<para>After making modifications to the manual, it's important to
+build it before committing. You can do that as follows:
+
 <screen>
   $ cd /path/to/nixpkgs/doc
   $ nix-shell
   [nix-shell]$ make clean
   [nix-shell]$ nix-build .
 </screen>
-  If the build succeeds, the manual will be in
-  <filename>./result/share/doc/nixpkgs/manual.html</filename>.
- </para>
+
+If the build succeeds, the manual will be in
+<filename>./result/share/doc/nixpkgs/manual.html</filename>.</para>
+
 </chapter>

doc/cross-compilation.xml

@@ -1,475 +1,308 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-cross">
- <title>Cross-compilation</title>
- <section xml:id="sec-cross-intro">
+
+<title>Cross-compilation</title>
+
+<section xml:id="sec-cross-intro">
   <title>Introduction</title>
-
   <para>
-   "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, 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.
   </para>
 
   <para>
-   This chapter will be organized in three parts. First, it will describe the
-   basics of how to package software in a way that supports cross-compilation.
-   Second, it will describe how to use Nixpkgs when cross-compiling. Third, it
-   will describe the internal infrastructure supporting cross-compilation.
+    This chapter will be organized in three parts.
+    First, it will describe the basics of how to package software in a way that supports cross-compilation.
+    Second, it will describe how to use Nixpkgs when cross-compiling.
+    Third, it will describe the internal infrastructure supporting cross-compilation.
   </para>
- </section>
+</section>
+
 <!--============================================================-->
- <section xml:id="sec-cross-packaging">
+
+<section xml:id="sec-cross-packaging">
   <title>Packaging in a cross-friendly manner</title>
 
-  <section xml:id="sec-cross-platform-parameters">
-   <title>Platform parameters</title>
-
-   <para>
-    Nixpkgs follows the
-    <link xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">common
-    historical convention of GNU autoconf</link> of distinguishing between 3
-    types of platform: <wordasword>build</wordasword>,
-    <wordasword>host</wordasword>, and <wordasword>target</wordasword>. In
-    summary, <wordasword>build</wordasword> is the platform on which a package
-    is being built, <wordasword>host</wordasword> is the platform on which it
-    is to run. The third attribute, <wordasword>target</wordasword>, is
-    relevant only for certain specific compilers and build tools.
-   </para>
-
-   <para>
-    In Nixpkgs, these three platforms are defined as attribute sets under the
-    names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>,
-    and <literal>targetPlatform</literal>. They are always defined as
-    attributes in the standard environment. That means one can access them
-    like:
-<programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>
-    .
-   </para>
-
-   <variablelist>
-    <varlistentry>
-     <term>
-      <varname>buildPlatform</varname>
-     </term>
-     <listitem>
-      <para>
-       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.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>hostPlatform</varname>
-     </term>
-     <listitem>
-      <para>
-       The "host platform" is the platform on which a package will be run. This
-       is the simplest platform to understand, but also the one with the worst
-       name.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>targetPlatform</varname>
-     </term>
-     <listitem>
-      <para>
-       The "target platform" attribute is, unlike the other two attributes, not
-       actually fundamental to the process of building software. Instead, it is
-       only relevant for compatibility with building certain specific compilers
-       and build tools. It can be safely ignored for all other packages.
-      </para>
-      <para>
-       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.
-      </para>
-      <para>
-       There is no fundamental need to think about a single target ahead of
-       time like this. If the tool supports modular or pluggable backends, both
-       the need to specify the target at build time and the constraint of
-       having only a single target disappear. An example of such a tool is
-       LLVM.
-      </para>
-      <para>
-       Although the existence of a "target platfom" is arguably a historical
-       mistake, it is a common one: examples of tools that suffer from it are
-       GCC, Binutils, GHC and Autoconf. Nixpkgs tries to avoid sharing in the
-       mistake where possible. Still, because the concept of a target platform
-       is so ingrained, it is best to support it as is.
-      </para>
-     </listitem>
-    </varlistentry>
-   </variablelist>
-
-   <para>
-    The exact schema these fields follow is a bit ill-defined due to a long and
-    convoluted evolution, but this is slowly being cleaned up. You can see
-    examples of ones used in practice in
-    <literal>lib.systems.examples</literal>; note how they are not all very
-    consistent. For now, here are few fields can count on them containing:
-   </para>
-
-   <variablelist>
-    <varlistentry>
-     <term>
-      <varname>system</varname>
-     </term>
-     <listitem>
-      <para>
-       This is a two-component shorthand for the platform. Examples of this
-       would be "x86_64-darwin" and "i686-linux"; see
-       <literal>lib.systems.doubles</literal> for more. This format isn't very
-       standard, but has built-in support in Nix, such as the
-       <varname>builtins.currentSystem</varname> impure string.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>config</varname>
-     </term>
-     <listitem>
-      <para>
-       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
-       <varname>targetPlatform</varname>. 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
-       <varname>config</varname>!
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>parsed</varname>
-     </term>
-     <listitem>
-      <para>
-       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 <varname>config</varname>. [Technically, only one need
-       be specified and the others can be inferred, though the precision of
-       inference may not be very good.] See
-       <literal>lib.systems.parse</literal> for the exact representation.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>libc</varname>
-     </term>
-     <listitem>
-      <para>
-       This is a string identifying the standard C library used. Valid
-       identifiers include "glibc" for GNU libc, "libSystem" for Darwin's
-       Libsystem, and "uclibc" for µClibc. It should probably be refactored to
-       use the module system, like <varname>parse</varname>.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>is*</varname>
-     </term>
-     <listitem>
-      <para>
-       These predicates are defined in <literal>lib.systems.inspect</literal>,
-       and slapped on every platform. They are superior to the ones in
-       <varname>stdenv</varname> as they force the user to be explicit about
-       which platform they are inspecting. Please use these instead of those.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>platform</varname>
-     </term>
-     <listitem>
-      <para>
-       This is, quite frankly, a dumping ground of ad-hoc settings (it's an
-       attribute set). See <literal>lib.systems.platforms</literal> for
-       examples—there's hopefully one in there that will work verbatim for
-       each platform that is working. Please help us triage these flags and
-       give them better homes!
-      </para>
-     </listitem>
-    </varlistentry>
-   </variablelist>
-  </section>
-
-  <section xml:id="sec-cross-specifying-dependencies">
-   <title>Specifying Dependencies</title>
-
-   <para>
-    In this section we explore the relationship between both runtime and
-    buildtime dependencies and the 3 Autoconf platforms.
-   </para>
-
-   <para>
-    A runtime dependency between 2 packages implies that between them both the
-    host and target platforms match. This is directly implied by the meaning of
-    "host platform" and "runtime dependency": The package dependency exists
-    while both packages are running on a single host platform.
-   </para>
-
-   <para>
-    A build time dependency, however, implies a shift in platforms between the
-    depending package and the depended-on package. The meaning of a build time
-    dependency is that to build the depending package we need to be able to run
-    the depended-on's package. The depending package's build platform is
-    therefore equal to the depended-on package's host platform. Analogously,
-    the depending package's host platform is equal to the depended-on package's
-    target platform.
-   </para>
-
-   <para>
-    In this manner, given the 3 platforms for one package, we can determine the
-    three platforms for all its transitive dependencies. This is the most
-    important guiding principle behind cross-compilation with Nixpkgs, and will
-    be called the <wordasword>sliding window principle</wordasword>.
-   </para>
-
-   <para>
-    Some examples will probably make this clearer. If a package is being built
-    with a <literal>(build, host, target)</literal> platform triple of
-    <literal>(foo, bar, bar)</literal>, then its build-time dependencies would
-    have a triple of <literal>(foo, foo, bar)</literal>, and <emphasis>those
-    packages'</emphasis> build-time dependencies would have triple of
-    <literal>(foo, foo, foo)</literal>. 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.
-   </para>
-
-   <note>
+  <section>
+    <title>Platform parameters</title>
     <para>
-     The depending package's target platform is unconstrained by the sliding
-     window principle, which makes sense in that one can in principle build
-     cross compilers targeting arbitrary platforms.
+      Nixpkgs follows the <link xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">common historical convention of GNU autoconf</link> of distinguishing between 3 types of platform: <wordasword>build</wordasword>, <wordasword>host</wordasword>, and <wordasword>target</wordasword>.
+
+      In summary, <wordasword>build</wordasword> is the platform on which a package is being built, <wordasword>host</wordasword> is the platform on which it is to run. The third attribute, <wordasword>target</wordasword>, is relevant only for certain specific compilers and build tools.
     </para>
-   </note>
 
-   <para>
-    How does this work in practice? Nixpkgs is now structured so that
-    build-time dependencies are taken from <varname>buildPackages</varname>,
-    whereas run-time dependencies are taken from the top level attribute set.
-    For example, <varname>buildPackages.gcc</varname> should be used at build
-    time, while <varname>gcc</varname> should be used at run time. Now, for
-    most of Nixpkgs's history, there was no <varname>buildPackages</varname>,
-    and most packages have not been refactored to use it explicitly. Instead,
-    one can use the six (<emphasis>gasp</emphasis>) attributes used for
-    specifying dependencies as documented in
-    <xref linkend="ssec-stdenv-dependencies"/>. We "splice" together the
-    run-time and build-time package sets with <varname>callPackage</varname>,
-    and then <varname>mkDerivation</varname> 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 <varname>buildPackages</varname>
-    needed. For now, feel free to use either method.
-   </para>
-
-   <note>
     <para>
-     There is also a "backlink" <varname>targetPackages</varname>, yielding a
-     package set whose <varname>buildPackages</varname> is the current package
-     set. This is a hack, though, to accommodate compilers with lousy build
-     systems. Please do not use this unless you are absolutely sure you are
-     packaging such a compiler and there is no other way.
+      In Nixpkgs, these three platforms are defined as attribute sets under the names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and <literal>targetPlatform</literal>.
+      All three are always defined as attributes in the standard environment, and at the top level. That means one can get at them just like a dependency in a function that is imported with <literal>callPackage</literal>:
+      <programlisting>{ stdenv, buildPlatform, hostPlatform, fooDep, barDep, .. }: ...buildPlatform...</programlisting>, or just off <varname>stdenv</varname>:
+      <programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>.
     </para>
-   </note>
+    <variablelist>
+      <varlistentry>
+        <term><varname>buildPlatform</varname></term>
+        <listitem><para>
+          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.
+        </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><varname>hostPlatform</varname></term>
+        <listitem><para>
+          The "host platform" is the platform on which a package will be run.
+          This is the simplest platform to understand, but also the one with the worst name.
+        </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><varname>targetPlatform</varname></term>
+        <listitem>
+          <para>
+            The "target platform" attribute is, unlike the other two attributes, not actually fundamental to the process of building software.
+            Instead, it is only relevant for compatibility with building certain specific compilers and build tools.
+            It can be safely ignored for all other packages.
+          </para>
+          <para>
+            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.
+          </para>
+          <para>
+            There is no fundamental need to think about a single target ahead of time like this.
+            If the tool supports modular or pluggable backends, both the need to specify the target at build time and the constraint of having only a single target disappear.
+            An example of such a tool is LLVM.
+          </para>
+          <para>
+            Although the existance of a "target platfom" is arguably a historical mistake, it is a common one: examples of tools that suffer from it are GCC, Binutils, GHC and Autoconf.
+            Nixpkgs tries to avoid sharing in the mistake where possible.
+            Still, because the concept of a target platform is so ingrained, it is best to support it as is.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+    <para>
+      The exact schema these fields follow is a bit ill-defined due to a long and convoluted evolution, but this is slowly being cleaned up.
+      You can see examples of ones used in practice in <literal>lib.systems.examples</literal>; note how they are not all very consistent.
+      For now, here are few fields can count on them containing:
+    </para>
+    <variablelist>
+      <varlistentry>
+        <term><varname>system</varname></term>
+        <listitem>
+          <para>
+            This is a two-component shorthand for the platform.
+            Examples of this would be "x86_64-darwin" and "i686-linux"; see <literal>lib.systems.doubles</literal> for more.
+            This format isn't very standard, but has built-in support in Nix, such as the <varname>builtins.currentSystem</varname> impure string.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><varname>config</varname></term>
+        <listitem>
+          <para>
+            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 <varname>targetPlatform</varname>.
+            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 <varname>config</varname>!
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><varname>parsed</varname></term>
+        <listitem>
+          <para>
+            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 <varname>config</varname>.
+            [Technically, only one need be specified and the others can be inferred, though the precision of inference may not be very good.]
+            See <literal>lib.systems.parse</literal> for the exact representation.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><varname>libc</varname></term>
+        <listitem>
+          <para>
+            This is a string identifying the standard C library used.
+            Valid identifiers include "glibc" for GNU libc, "libSystem" for Darwin's Libsystem, and "uclibc" for µClibc.
+            It should probably be refactored to use the module system, like <varname>parse</varname>.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><varname>is*</varname></term>
+        <listitem>
+          <para>
+            These predicates are defined in <literal>lib.systems.inspect</literal>, and slapped on every platform.
+            They are superior to the ones in <varname>stdenv</varname> as they force the user to be explicit about which platform they are inspecting.
+            Please use these instead of those.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><varname>platform</varname></term>
+        <listitem>
+          <para>
+            This is, quite frankly, a dumping ground of ad-hoc settings (it's an attribute set).
+            See <literal>lib.systems.platforms</literal> for examples—there's hopefully one in there that will work verbatim for each platform that is working.
+            Please help us triage these flags and give them better homes!
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
   </section>
 
-  <section xml:id="sec-cross-cookbook">
-   <title>Cross packaging cookbook</title>
-
-   <para>
-    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.
-    Feel free to add to this list!
-   </para>
-
-   <qandaset>
-    <qandaentry xml:id="cross-qa-build-c-program-in-build-environment">
-     <question>
-      <para>
-       What if my package's build system needs to build a C program to be run
-       under the build environment?
-      </para>
-     </question>
-     <answer>
-      <para>
-<programlisting>depsBuildBuild = [ buildPackages.stdenv.cc ];</programlisting>
-       Add it to your <function>mkDerivation</function> invocation.
-      </para>
-     </answer>
-    </qandaentry>
-    <qandaentry xml:id="cross-qa-fails-to-find-ar">
-     <question>
-      <para>
-       My package fails to find <command>ar</command>.
-      </para>
-     </question>
-     <answer>
-      <para>
-       Many packages assume that an unprefixed <command>ar</command> is
-       available, but Nix doesn't provide one. It only provides a prefixed one,
-       just as it only does for all the other binutils programs. It may be
-       necessary to patch the package to fix the build system to use a prefixed
-       `ar`.
-      </para>
-     </answer>
-    </qandaentry>
-    <qandaentry xml:id="cross-testsuite-runs-host-code">
-     <question>
-      <para>
-       My package's testsuite needs to run host platform code.
-      </para>
-     </question>
-     <answer>
-      <para>
-<programlisting>doCheck = stdenv.hostPlatform != stdenv.buildPlatfrom;</programlisting>
-       Add it to your <function>mkDerivation</function> invocation.
-      </para>
-     </answer>
-    </qandaentry>
-   </qandaset>
+  <section>
+    <title>Specifying Dependencies</title>
+    <para>
+      In this section we explore the relationship between both runtime and buildtime dependencies and the 3 Autoconf platforms.
+    </para>
+    <para>
+      A runtime dependency between 2 packages implies that between them both the host and target platforms match.
+      This is directly implied by the meaning of "host platform" and "runtime dependency":
+      The package dependency exists while both packages are running on a single host platform.
+    </para>
+    <para>
+      A build time dependency, however, implies a shift in platforms between the depending package and the depended-on package.
+      The meaning of a build time dependency is that to build the depending package we need to be able to run the depended-on's package.
+      The depending package's build platform is therefore equal to the depended-on package's host platform.
+      Analogously, the depending package's host platform is equal to the depended-on package's target platform.
+    </para>
+    <para>
+      In this manner, given the 3 platforms for one package, we can determine the three platforms for all its transitive dependencies.
+      This is the most important guiding principle behind cross-compilation with Nixpkgs, and will be called the <wordasword>sliding window principle</wordasword>.
+    </para>
+    <para>
+      Some examples will probably make this clearer.
+      If a package is being built with a <literal>(build, host, target)</literal> platform triple of <literal>(foo, bar, bar)</literal>, then its build-time dependencies would have a triple of <literal>(foo, foo, bar)</literal>, and <emphasis>those packages'</emphasis> build-time dependencies would have triple of <literal>(foo, foo, foo)</literal>.
+      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.
+    </para>
+    <note><para>
+      The depending package's target platform is unconstrained by the sliding window principle, which makes sense in that one can in principle build cross compilers targeting arbitrary platforms.
+    </para></note>
+    <para>
+      How does this work in practice? Nixpkgs is now structured so that build-time dependencies are taken from <varname>buildPackages</varname>, whereas run-time dependencies are taken from the top level attribute set.
+      For example, <varname>buildPackages.gcc</varname> should be used at build time, while <varname>gcc</varname> should be used at run time.
+      Now, for most of Nixpkgs's history, there was no <varname>buildPackages</varname>, and most packages have not been refactored to use it explicitly.
+      Instead, one can use the six (<emphasis>gasp</emphasis>) attributes used for specifying dependencies as documented in <xref linkend="ssec-stdenv-dependencies"/>.
+      We "splice" together the run-time and build-time package sets with <varname>callPackage</varname>, and then <varname>mkDerivation</varname> 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 <varname>buildPackages</varname> needed.
+      For now, feel free to use either method.
+    </para>
+    <note><para>
+      There is also a "backlink" <varname>targetPackages</varname>, yielding a package set whose <varname>buildPackages</varname> is the current package set.
+      This is a hack, though, to accommodate compilers with lousy build systems.
+      Please do not use this unless you are absolutely sure you are packaging such a compiler and there is no other way.
+    </para></note>
   </section>
- </section>
+
+  <section>
+    <title>Cross packagaing cookbook</title>
+    <para>
+      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.
+      Feel free to add to this list!
+    </para>
+    <qandaset>
+      <qandaentry>
+        <question><para>
+          What if my package's build system needs to build a C program to be run under the build environment?
+        </para></question>
+        <answer><para>
+          <programlisting>depsBuildBuild = [ buildPackages.stdenv.cc ];</programlisting>
+          Add it to your <function>mkDerivation</function> invocation.
+        </para></answer>
+      </qandaentry>
+      <qandaentry>
+        <question><para>
+          My package fails to find <command>ar</command>.
+        </para></question>
+        <answer><para>
+          Many packages assume that an unprefixed <command>ar</command> is available, but Nix doesn't provide one.
+          It only provides a prefixed one, just as it only does for all the other binutils programs.
+          It may be necessary to patch the package to fix the build system to use a prefixed `ar`.
+        </para></answer>
+      </qandaentry>
+      <qandaentry>
+        <question><para>
+          My package's testsuite needs to run host platform code.
+        </para></question>
+        <answer><para>
+          <programlisting>doCheck = stdenv.hostPlatform != stdenv.buildPlatfrom;</programlisting>
+          Add it to your <function>mkDerivation</function> invocation.
+        </para></answer>
+      </qandaentry>
+    </qandaset>
+  </section>
+</section>
+
 <!--============================================================-->
- <section xml:id="sec-cross-usage">
+
+<section xml:id="sec-cross-usage">
   <title>Cross-building packages</title>
-
-  <note>
-   <para>
-    More information needs to moved from the old wiki, especially
-    <link xlink:href="https://nixos.org/wiki/CrossCompiling" />, for this
-    section.
-   </para>
-  </note>
-
+  <note><para>
+    More information needs to moved from the old wiki, especially <link xlink:href="https://nixos.org/wiki/CrossCompiling" />, for this section.
+  </para></note>
   <para>
-   Nixpkgs can be instantiated with <varname>localSystem</varname> alone, in
-   which case there is no cross compiling and everything is built by and for
-   that system, or also with <varname>crossSystem</varname>, 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
-   defined in the previous section. As mentioned above,
-   <literal>lib.systems.examples</literal> has some platforms which are used as
-   arguments for these parameters in practice. You can use them
-   programmatically, or on the command line:
-<programlisting>
+    Nixpkgs can be instantiated with <varname>localSystem</varname> alone, in which case there is no cross compiling and everything is built by and for that system,
+    or also with <varname>crossSystem</varname>, 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 defined in the previous section.
+    As mentioned above, <literal>lib.systems.examples</literal> has some platforms which are used as arguments for these parameters in practice.
+    You can use them programmatically, or on the command line: <programlisting>
 nix-build &lt;nixpkgs&gt; --arg crossSystem '(import &lt;nixpkgs/lib&gt;).systems.examples.fooBarBaz' -A whatever</programlisting>
   </para>
-
   <note>
-   <para>
-    Eventually we would like to make these platform examples an unnecessary
-    convenience so that
-<programlisting>
+    <para>
+      Eventually we would like to make these platform examples an unnecessary convenience so that <programlisting>
 nix-build &lt;nixpkgs&gt; --arg crossSystem.config '&lt;arch&gt;-&lt;os&gt;-&lt;vendor&gt;-&lt;abi&gt;' -A whatever</programlisting>
-    works in the vast majority of cases. The problem today is dependencies on
-    other sorts of configuration which aren't given proper defaults. We rely on
-    the examples to crudely to set those configuration parameters in some
-    vaguely sane manner on the users behalf. Issue
-    <link xlink:href="https://github.com/NixOS/nixpkgs/issues/34274">#34274</link>
-    tracks this inconvenience along with its root cause in crufty configuration
-    options.
-   </para>
+      works in the vast majority of cases.
+      The problem today is dependencies on other sorts of configuration which aren't given proper defaults.
+      We rely on the examples to crudely to set those configuration parameters in some vaguely sane manner on the users behalf.
+      Issue <link xlink:href="https://github.com/NixOS/nixpkgs/issues/34274">#34274</link> tracks this inconvenience along with its root cause in crufty configuration options.
+    </para>
   </note>
-
   <para>
-   While one is free to pass both parameters in full, there's a lot of logic to
-   fill in missing fields. As discussed in the previous section, only one of
-   <varname>system</varname>, <varname>config</varname>, and
-   <varname>parsed</varname> is needed to infer the other two. Additionally,
-   <varname>libc</varname> will be inferred from <varname>parse</varname>.
-   Finally, <literal>localSystem.system</literal> is also
-   <emphasis>impurely</emphasis> inferred based on the platform evaluation
-   occurs. This means it is often not necessary to pass
-   <varname>localSystem</varname> at all, as in the command-line example in the
-   previous paragraph.
+    While one is free to pass both parameters in full, there's a lot of logic to fill in missing fields.
+    As discussed in the previous section, only one of <varname>system</varname>, <varname>config</varname>, and <varname>parsed</varname> is needed to infer the other two.
+    Additionally, <varname>libc</varname> will be inferred from <varname>parse</varname>.
+    Finally, <literal>localSystem.system</literal> is also <emphasis>impurely</emphasis> inferred based on the platform evaluation occurs.
+    This means it is often not necessary to pass <varname>localSystem</varname> at all, as in the command-line example in the previous paragraph.
   </para>
-
   <note>
-   <para>
-    Many sources (manual, wiki, etc) probably mention passing
-    <varname>system</varname>, <varname>platform</varname>, along with the
-    optional <varname>crossSystem</varname> to nixpkgs: <literal>import
-    &lt;nixpkgs&gt; { system = ..; platform = ..; crossSystem = ..;
-    }</literal>. Passing those two instead of <varname>localSystem</varname> is
-    still supported for compatibility, but is discouraged. Indeed, much of the
-    inference we do for these parameters is motivated by compatibility as much
-    as convenience.
-   </para>
+    <para>
+      Many sources (manual, wiki, etc) probably mention passing <varname>system</varname>, <varname>platform</varname>, along with the optional <varname>crossSystem</varname> to nixpkgs:
+      <literal>import &lt;nixpkgs&gt; { system = ..; platform = ..; crossSystem = ..; }</literal>.
+      Passing those two instead of <varname>localSystem</varname> is still supported for compatibility, but is discouraged.
+      Indeed, much of the inference we do for these parameters is motivated by compatibility as much as convenience.
+    </para>
   </note>
-
   <para>
-   One would think that <varname>localSystem</varname> and
-   <varname>crossSystem</varname> overlap horribly with the three
-   <varname>*Platforms</varname> (<varname>buildPlatform</varname>,
-   <varname>hostPlatform,</varname> and <varname>targetPlatform</varname>; see
-   <varname>stage.nix</varname> or the manual). Actually, those identifiers are
-   purposefully not used here to draw a subtle but important distinction: While
-   the granularity of having 3 platforms is necessary to properly *build*
-   packages, it is overkill for specifying the user's *intent* when making a
-   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 <varname>buildPackages</varname>, the three platforms will
-   be defined as one of <varname>localSystem</varname> or
-   <varname>crossSystem</varname>, with the former replacing the latter as one
-   traverses build-time dependencies. A last simple difference then is
-   <varname>crossSystem</varname> should be null when one doesn't want to
-   cross-compile, while the <varname>*Platform</varname>s are always non-null.
-   <varname>localSystem</varname> is always non-null.
+    One would think that <varname>localSystem</varname> and <varname>crossSystem</varname> overlap horribly with the three <varname>*Platforms</varname> (<varname>buildPlatform</varname>, <varname>hostPlatform,</varname> and <varname>targetPlatform</varname>; see <varname>stage.nix</varname> or the manual).
+    Actually, those identifiers are purposefully not used here to draw a subtle but important distinction:
+    While the granularity of having 3 platforms is necessary to properly *build* packages, it is overkill for specifying the user's *intent* when making a 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 <varname>buildPackages</varname>, the three platforms will be defined as one of <varname>localSystem</varname> or <varname>crossSystem</varname>, with the former replacing the latter as one traverses build-time dependencies.
+    A last simple difference then is <varname>crossSystem</varname> should be null when one doesn't want to cross-compile, while the <varname>*Platform</varname>s are always non-null.
+    <varname>localSystem</varname> is always non-null.
   </para>
- </section>
+</section>
+
 <!--============================================================-->
- <section xml:id="sec-cross-infra">
+
+<section xml:id="sec-cross-infra">
   <title>Cross-compilation infrastructure</title>
+  <para>To be written.</para>
+  <note><para>
+    If one explores nixpkgs, they will see derivations with names like <literal>gccCross</literal>.
+    Such <literal>*Cross</literal> derivations is a holdover from before we properly distinguished between the host and target platforms
+    —the derivation with "Cross" in the name covered the <literal>build = host != target</literal> case, while the other covered the <literal>host = target</literal>, with build platform the same or not based on whether one was using its <literal>.nativeDrv</literal> or <literal>.crossDrv</literal>.
+    This ugliness will disappear soon.
+  </para></note>
+</section>
 
-  <para>
-   To be written.
-  </para>
-
-  <note>
-   <para>
-    If one explores nixpkgs, they will see derivations with names like
-    <literal>gccCross</literal>. Such <literal>*Cross</literal> derivations is
-    a holdover from before we properly distinguished between the host and
-    target platforms —the derivation with "Cross" in the name covered the
-    <literal>build = host != target</literal> case, while the other covered the
-    <literal>host = target</literal>, with build platform the same or not based
-    on whether one was using its <literal>.nativeDrv</literal> or
-    <literal>.crossDrv</literal>. This ugliness will disappear soon.
-   </para>
-  </note>
- </section>
 </chapter>

doc/default.nix

@@ -1,12 +1,13 @@
-{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
 let
+  pkgs = import ./.. { };
   lib = pkgs.lib;
-  locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; };
+  sources = lib.sourceFilesBySuffices ./. [".xml"];
+  sources-langs = ./languages-frameworks;
 in
 pkgs.stdenv.mkDerivation {
   name = "nixpkgs-manual";
 
-  buildInputs = with pkgs; [ pandoc libxml2 libxslt zip jing  xmlformat ];
+  buildInputs = with pkgs; [ pandoc libxml2 libxslt zip jing ];
 
   src = ./.;
 
@@ -15,9 +16,8 @@ pkgs.stdenv.mkDerivation {
   # $ nix-shell --run "make clean all"
   # otherwise they won't reapply :)
   HIGHLIGHTJS = pkgs.documentation-highlighter;
-  XSL = "${pkgs.docbook_xsl_ns}/xml/xsl";
+  XSL = "${pkgs.docbook5_xsl}/xml/xsl";
   RNG = "${pkgs.docbook5}/xml/rng/docbook/docbook.rng";
-  XMLFORMAT_CONFIG = ../nixos/doc/xmlformat.conf;
   xsltFlags = lib.concatStringsSep " " [
     "--param section.autolabel 1"
     "--param section.label.includes.component.label 1"
@@ -30,9 +30,7 @@ pkgs.stdenv.mkDerivation {
   ];
 
   postPatch = ''
-    rm -rf ./functions/library/locations.xml
-    ln -s ${locationsXml} ./functions/library/locations.xml
-    echo ${lib.version} > .version
+    echo ${lib.nixpkgsVersion} > .version
   '';
 
   installPhase = ''
@@ -45,6 +43,5 @@ pkgs.stdenv.mkDerivation {
 
     mkdir -p $out/nix-support/
     echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products
-    echo "doc manual $dest nixpkgs-manual.epub" >> $out/nix-support/hydra-build-products
   '';
 }

doc/functions.xml

@@ -1,18 +1,706 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
 	 xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
 	 xml:id="chap-functions">
- <title>Functions reference</title>
- <para>
-  The nixpkgs repository has several utility functions to manipulate Nix
-  expressions.
- </para>
 
- <xi:include href="functions/library.xml" />
- <xi:include href="functions/overrides.xml" />
- <xi:include href="functions/generators.xml" />
- <xi:include href="functions/debug.xml" />
- <xi:include href="functions/fhs-environments.xml" />
- <xi:include href="functions/shell.xml" />
- <xi:include href="functions/dockertools.xml" />
+<title>Functions reference</title>
+
+<para>
+  The nixpkgs repository has several utility functions to manipulate Nix expressions.
+</para>
+
+<section xml:id="sec-overrides">
+  <title>Overriding</title>
+
+  <para>
+    Sometimes one wants to override parts of
+    <literal>nixpkgs</literal>, e.g. derivation attributes, the results of
+    derivations or even the whole package set.
+  </para>
+
+  <section xml:id="sec-pkg-override">
+    <title>&lt;pkg&gt;.override</title>
+
+    <para>
+      The function <varname>override</varname> is usually available for all the
+      derivations in the nixpkgs expression (<varname>pkgs</varname>).
+    </para>
+    <para>
+      It is used to override the arguments passed to a function.
+    </para>
+    <para>
+      Example usages:
+
+      <programlisting>pkgs.foo.override { arg1 = val1; arg2 = val2; ... }</programlisting>
+      <programlisting>import pkgs.path { overlays = [ (self: super: {
+    foo = super.foo.override { barSupport = true ; };
+  })]};</programlisting>
+      <programlisting>mypkg = pkgs.callPackage ./mypkg.nix {
+    mydep = pkgs.mydep.override { ... };
+  }</programlisting>
+    </para>
+
+    <para>
+      In the first example, <varname>pkgs.foo</varname> is the result of a function call
+      with some default arguments, usually a derivation.
+      Using <varname>pkgs.foo.override</varname> will call the same function with
+      the given new arguments.
+    </para>
+
+  </section>
+
+  <section xml:id="sec-pkg-overrideAttrs">
+    <title>&lt;pkg&gt;.overrideAttrs</title>
+
+    <para>
+      The function <varname>overrideAttrs</varname> allows overriding the
+      attribute set passed to a <varname>stdenv.mkDerivation</varname> call,
+      producing a new derivation based on the original one.
+      This function is available on all derivations produced by the
+      <varname>stdenv.mkDerivation</varname> function, which is most packages
+      in the nixpkgs expression <varname>pkgs</varname>.
+    </para>
+
+    <para>
+      Example usage:
+
+      <programlisting>helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
+    separateDebugInfo = true;
+  });</programlisting>
+    </para>
+
+    <para>
+      In the above example, the <varname>separateDebugInfo</varname> attribute is
+      overridden to be true, thus building debug info for
+      <varname>helloWithDebug</varname>, while all other attributes will be
+      retained from the original <varname>hello</varname> package.
+    </para>
+
+    <para>
+      The argument <varname>oldAttrs</varname> is conventionally used to refer to
+      the attr set originally passed to <varname>stdenv.mkDerivation</varname>.
+    </para>
+
+    <note>
+      <para>
+        Note that <varname>separateDebugInfo</varname> is processed only by the
+        <varname>stdenv.mkDerivation</varname> function, not the generated, raw
+        Nix derivation. Thus, using <varname>overrideDerivation</varname> will
+        not work in this case, as it overrides only the attributes of the final
+        derivation. It is for this reason that <varname>overrideAttrs</varname>
+        should be preferred in (almost) all cases to
+        <varname>overrideDerivation</varname>, i.e. to allow using
+        <varname>sdenv.mkDerivation</varname> to process input arguments, as well
+        as the fact that it is easier to use (you can use the same attribute
+        names you see in your Nix code, instead of the ones generated (e.g.
+        <varname>buildInputs</varname> vs <varname>nativeBuildInputs</varname>,
+        and involves less typing.
+      </para>
+    </note>
+
+  </section>
+
+
+  <section xml:id="sec-pkg-overrideDerivation">
+    <title>&lt;pkg&gt;.overrideDerivation</title>
+
+    <warning>
+      <para>You should prefer <varname>overrideAttrs</varname> in almost all
+      cases, see its documentation for the reasons why.
+      <varname>overrideDerivation</varname> is not deprecated and will continue
+      to work, but is less nice to use and does not have as many abilities as
+      <varname>overrideAttrs</varname>.
+      </para>
+    </warning>
+
+    <warning>
+      <para>Do not use this function in Nixpkgs as it evaluates a Derivation
+      before modifying it, which breaks package abstraction and removes
+      error-checking of function arguments. In addition, this
+      evaluation-per-function application incurs a performance penalty,
+      which can become a problem if many overrides are used.
+      It is only intended for ad-hoc customisation, such as in
+      <filename>~/.config/nixpkgs/config.nix</filename>.
+    </para>
+    </warning>
+
+    <para>
+      The function <varname>overrideDerivation</varname> creates a new derivation
+      based on an existing one by overriding the original's attributes with
+      the attribute set produced by the specified function.
+      This function is available on all
+      derivations defined using the <varname>makeOverridable</varname> function.
+      Most standard derivation-producing functions, such as
+      <varname>stdenv.mkDerivation</varname>, are defined using this
+      function, which means most packages in the nixpkgs expression,
+      <varname>pkgs</varname>, have this function.
+    </para>
+
+    <para>
+      Example usage:
+
+      <programlisting>mySed = pkgs.gnused.overrideDerivation (oldAttrs: {
+    name = "sed-4.2.2-pre";
+    src = fetchurl {
+      url = ftp://alpha.gnu.org/gnu/sed/sed-4.2.2-pre.tar.bz2;
+      sha256 = "11nq06d131y4wmf3drm0yk502d2xc6n5qy82cg88rb9nqd2lj41k";
+    };
+    patches = [];
+  });</programlisting>
+    </para>
+
+    <para>
+      In the above example, the <varname>name</varname>, <varname>src</varname>,
+      and <varname>patches</varname> of the derivation will be overridden, while
+      all other attributes will be retained from the original derivation.
+    </para>
+
+    <para>
+      The argument <varname>oldAttrs</varname> is used to refer to the attribute set of
+      the original derivation.
+    </para>
+
+    <note>
+      <para>
+        A package's attributes are evaluated *before* being modified by
+        the <varname>overrideDerivation</varname> function.
+        For example, the <varname>name</varname> attribute reference
+        in <varname>url = "mirror://gnu/hello/${name}.tar.gz";</varname>
+        is filled-in *before* the <varname>overrideDerivation</varname> function
+        modifies the attribute set. This means that overriding the
+        <varname>name</varname> attribute, in this example, *will not* change the
+        value of the <varname>url</varname> attribute. Instead, we need to override
+        both the <varname>name</varname> *and* <varname>url</varname> attributes.
+      </para>
+    </note>
+
+  </section>
+
+  <section xml:id="sec-lib-makeOverridable">
+    <title>lib.makeOverridable</title>
+
+    <para>
+      The function <varname>lib.makeOverridable</varname> is used to make the result
+      of a function easily customizable. This utility only makes sense for functions
+      that accept an argument set and return an attribute set.
+    </para>
+
+    <para>
+      Example usage:
+
+      <programlisting>f = { a, b }: { result = a+b; }
+  c = lib.makeOverridable f { a = 1; b = 2; }</programlisting>
+
+    </para>
+
+    <para>
+      The variable <varname>c</varname> is the value of the <varname>f</varname> function
+      applied with some default arguments. Hence the value of <varname>c.result</varname>
+      is <literal>3</literal>, in this example.
+    </para>
+
+    <para>
+      The variable <varname>c</varname> however also has some additional functions, like
+      <link linkend="sec-pkg-override">c.override</link> which can be used to
+      override the default arguments. In this example the value of
+      <varname>(c.override { a = 4; }).result</varname> is 6.
+    </para>
+
+  </section>
+
+</section>
+
+<section xml:id="sec-generators">
+  <title>Generators</title>
+
+  <para>
+    Generators are functions that create file formats from nix
+    data structures, e. g. for configuration files.
+    There are generators available for: <literal>INI</literal>,
+    <literal>JSON</literal> and <literal>YAML</literal>
+  </para>
+
+  <para>
+    All generators follow a similar call interface: <code>generatorName
+    configFunctions data</code>, where <literal>configFunctions</literal> is a
+    set of user-defined functions that format variable parts of the content.
+    They each have common defaults, so often they do not need to be set
+    manually. An example is <code>mkSectionName ? (name: libStr.escape [ "[" "]"
+    ] name)</code> from the <literal>INI</literal> generator. It gets the name
+    of a section and returns a sanitized name. The default
+    <literal>mkSectionName</literal> escapes <literal>[</literal> and
+    <literal>]</literal> with a backslash.
+  </para>
+
+  <note><para>Nix store paths can be converted to strings by enclosing a
+  derivation attribute like so: <code>"${drv}"</code>.</para></note>
+
+  <para>
+    Detailed documentation for each generator can be found in
+    <literal>lib/generators.nix</literal>.
+  </para>
+
+</section>
+
+
+<section xml:id="sec-fhs-environments">
+  <title>buildFHSUserEnv</title>
+
+  <para>
+    <function>buildFHSUserEnv</function> provides a way to build and run
+    FHS-compatible lightweight sandboxes. It creates an isolated root with
+    bound <filename>/nix/store</filename>, so its footprint in terms of disk
+    space needed is quite small. This allows one to run software which is hard or
+    unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions,
+    games distributed as tarballs, software with integrity checking and/or external
+    self-updated binaries. It uses Linux namespaces feature to create
+    temporary lightweight environments which are destroyed after all child
+    processes exit, without root user rights requirement. Accepted arguments are:
+  </para>
+
+  <variablelist>
+    <varlistentry>
+    <term><literal>name</literal></term>
+
+    <listitem><para>Environment name.</para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><literal>targetPkgs</literal></term>
+
+    <listitem><para>Packages to be installed for the main host's architecture
+    (i.e. x86_64 on x86_64 installations). Along with libraries binaries are also
+    installed.</para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><literal>multiPkgs</literal></term>
+
+    <listitem><para>Packages to be installed for all architectures supported by
+    a host (i.e. i686 and x86_64 on x86_64 installations). Only libraries are
+    installed by default.</para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><literal>extraBuildCommands</literal></term>
+
+    <listitem><para>Additional commands to be executed for finalizing the
+    directory structure.</para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><literal>extraBuildCommandsMulti</literal></term>
+
+    <listitem><para>Like <literal>extraBuildCommands</literal>, but
+    executed only on multilib architectures.</para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><literal>extraOutputsToInstall</literal></term>
+
+    <listitem><para>Additional derivation outputs to be linked for both
+    target and multi-architecture packages.</para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><literal>extraInstallCommands</literal></term>
+
+    <listitem><para>Additional commands to be executed for finalizing the
+    derivation with runner script.</para></listitem>
+    </varlistentry>
+
+    <varlistentry>
+    <term><literal>runScript</literal></term>
+
+    <listitem><para>A command that would be executed inside the sandbox and
+    passed all the command line arguments. It defaults to
+    <literal>bash</literal>.</para></listitem>
+    </varlistentry>
+  </variablelist>
+
+  <para>
+    One can create a simple environment using a <literal>shell.nix</literal>
+    like that:
+  </para>
+
+<programlisting><![CDATA[
+{ pkgs ? import <nixpkgs> {} }:
+
+(pkgs.buildFHSUserEnv {
+  name = "simple-x11-env";
+  targetPkgs = pkgs: (with pkgs;
+    [ udev
+      alsaLib
+    ]) ++ (with pkgs.xorg;
+    [ libX11
+      libXcursor
+      libXrandr
+    ]);
+  multiPkgs = pkgs: (with pkgs;
+    [ udev
+      alsaLib
+    ]);
+  runScript = "bash";
+}).env
+]]></programlisting>
+
+  <para>
+    Running <literal>nix-shell</literal> would then drop you into a shell with
+    these libraries and binaries available. You can use this to run
+    closed-source applications which expect FHS structure without hassles:
+    simply change <literal>runScript</literal> to the application path,
+    e.g. <filename>./bin/start.sh</filename> -- relative paths are supported.
+  </para>
+</section>
+
+<section xml:id="sec-pkgs-dockerTools">
+<title>pkgs.dockerTools</title>
+
+<para>
+  <varname>pkgs.dockerTools</varname> is a set of functions for creating and
+  manipulating Docker images according to the
+  <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120">
+  Docker Image Specification v1.2.0
+  </link>. Docker itself is not used to perform any of the operations done by these
+  functions.
+</para>
+
+<warning>
+  <para>
+  The <varname>dockerTools</varname> API is unstable and may be subject to
+  backwards-incompatible changes in the future.
+  </para>
+</warning>
+
+<section xml:id="ssec-pkgs-dockerTools-buildImage">
+  <title>buildImage</title>
+
+  <para>
+  This function is analogous to the <command>docker build</command> command,
+  in that can used to build a Docker-compatible repository tarball containing
+  a single image with one or multiple layers. As such, the result
+  is suitable for being loaded in Docker with <command>docker load</command>.
+  </para>
+
+  <para>
+  The parameters of <varname>buildImage</varname> with relative example values are
+  described below:
+  </para>
+
+  <example xml:id='ex-dockerTools-buildImage'><title>Docker build</title>
+  <programlisting>
+  buildImage {
+    name = "redis"; <co xml:id='ex-dockerTools-buildImage-1' />
+    tag = "latest"; <co xml:id='ex-dockerTools-buildImage-2' />
+
+    fromImage = someBaseImage; <co xml:id='ex-dockerTools-buildImage-3' />
+    fromImageName = null; <co xml:id='ex-dockerTools-buildImage-4' />
+    fromImageTag = "latest"; <co xml:id='ex-dockerTools-buildImage-5' />
+
+    contents = pkgs.redis; <co xml:id='ex-dockerTools-buildImage-6' />
+    runAsRoot = '' <co xml:id='ex-dockerTools-buildImage-runAsRoot' />
+      #!${stdenv.shell}
+      mkdir -p /data
+    '';
+
+    config = { <co xml:id='ex-dockerTools-buildImage-8' />
+      Cmd = [ "/bin/redis-server" ];
+      WorkingDir = "/data";
+      Volumes = {
+        "/data" = {};
+      };
+    };
+  }
+  </programlisting>
+  </example>
+
+  <para>The above example will build a Docker image <literal>redis/latest</literal>
+  from the given base image. Loading and running this image in Docker results in
+  <literal>redis-server</literal> being started automatically.
+  </para>
+
+  <calloutlist>
+  <callout arearefs='ex-dockerTools-buildImage-1'>
+    <para>
+    <varname>name</varname> specifies the name of the resulting image.
+    This is the only required argument for <varname>buildImage</varname>.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-buildImage-2'>
+    <para>
+    <varname>tag</varname> specifies the tag of the resulting image.
+    By default it's <literal>latest</literal>.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-buildImage-3'>
+    <para>
+    <varname>fromImage</varname> is the repository tarball containing the base image.
+    It must be a valid Docker image, such as exported by <command>docker save</command>.
+    By default it's <literal>null</literal>, which can be seen as equivalent
+    to <literal>FROM scratch</literal> of a <filename>Dockerfile</filename>.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-buildImage-4'>
+    <para>
+    <varname>fromImageName</varname> can be used to further specify
+    the base image within the repository, in case it contains multiple images.
+    By default it's <literal>null</literal>, in which case
+    <varname>buildImage</varname> will peek the first image available
+    in the repository.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-buildImage-5'>
+    <para>
+    <varname>fromImageTag</varname> can be used to further specify the tag
+    of the base image within the repository, in case an image contains multiple tags.
+    By default it's <literal>null</literal>, in which case
+    <varname>buildImage</varname> will peek the first tag available for the base image.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-buildImage-6'>
+    <para>
+    <varname>contents</varname> is a derivation that will be copied in the new
+    layer of the resulting image. This can be similarly seen as
+    <command>ADD contents/ /</command> in a <filename>Dockerfile</filename>.
+    By default it's <literal>null</literal>.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-buildImage-runAsRoot'>
+    <para>
+    <varname>runAsRoot</varname> is a bash script that will run as root
+    in an environment that overlays the existing layers of the base image with
+    the new resulting layer, including the previously copied
+    <varname>contents</varname> derivation.
+    This can be similarly seen as
+    <command>RUN ...</command> in a <filename>Dockerfile</filename>.
+
+    <note>
+      <para>
+      Using this parameter requires the <literal>kvm</literal>
+      device to be available.
+      </para>
+    </note>
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-buildImage-8'>
+    <para>
+    <varname>config</varname> is used to specify the configuration of the
+    containers that will be started off the built image in Docker.
+    The available options are listed in the
+    <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions">
+      Docker Image Specification v1.2.0
+    </link>.
+    </para>
+  </callout>
+
+  </calloutlist>
+
+  <para>
+  After the new layer has been created, its closure
+  (to which <varname>contents</varname>, <varname>config</varname> and
+  <varname>runAsRoot</varname> contribute) will be copied in the layer itself.
+  Only new dependencies that are not already in the existing layers will be copied.
+  </para>
+
+  <para>
+  At the end of the process, only one new single layer will be produced and
+  added to the resulting image.
+  </para>
+
+  <para>
+  The resulting repository will only list the single image
+  <varname>image/tag</varname>. In the case of <xref linkend='ex-dockerTools-buildImage'/>
+  it would be <varname>redis/latest</varname>.
+  </para>
+
+  <para>
+  It is possible to inspect the arguments with which an image was built
+  using its <varname>buildArgs</varname> attribute.
+  </para>
+
+
+
+  <note>
+  <para>
+  If you see errors similar to <literal>getProtocolByName: does not exist (no such protocol name: tcp)</literal>
+  you may need to add <literal>pkgs.iana-etc</literal> to <varname>contents</varname>.
+  </para>
+  </note>
+
+  <note>
+  <para>
+  If you see errors similar to <literal>Error_Protocol ("certificate has unknown CA",True,UnknownCa)</literal>
+  you may need to add <literal>pkgs.cacert</literal> to <varname>contents</varname>.
+  </para>
+  </note>
+
+</section>
+
+<section xml:id="ssec-pkgs-dockerTools-fetchFromRegistry">
+  <title>pullImage</title>
+
+  <para>
+  This function is analogous to the <command>docker pull</command> command,
+  in that can be used to fetch a Docker image from a Docker registry.
+  Currently only registry <literal>v1</literal> is supported.
+  By default <link xlink:href="https://hub.docker.com/">Docker Hub</link>
+  is used to pull images.
+  </para>
+
+  <para>
+  Its parameters are described in the example below:
+  </para>
+
+  <example xml:id='ex-dockerTools-pullImage'><title>Docker pull</title>
+  <programlisting>
+  pullImage {
+    imageName = "debian"; <co xml:id='ex-dockerTools-pullImage-1' />
+    imageTag = "jessie"; <co xml:id='ex-dockerTools-pullImage-2' />
+    imageId = null; <co xml:id='ex-dockerTools-pullImage-3' />
+    sha256 = "1bhw5hkz6chrnrih0ymjbmn69hyfriza2lr550xyvpdrnbzr4gk2"; <co xml:id='ex-dockerTools-pullImage-4' />
+
+    indexUrl = "https://index.docker.io"; <co xml:id='ex-dockerTools-pullImage-5' />
+    registryVersion = "v1";
+  }
+  </programlisting>
+  </example>
+
+  <calloutlist>
+  <callout arearefs='ex-dockerTools-pullImage-1'>
+    <para>
+    <varname>imageName</varname> specifies the name of the image to be downloaded,
+    which can also include the registry namespace (e.g. <literal>library/debian</literal>).
+    This argument is required.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-pullImage-2'>
+    <para>
+    <varname>imageTag</varname> specifies the tag of the image to be downloaded.
+    By default it's <literal>latest</literal>.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-pullImage-3'>
+    <para>
+    <varname>imageId</varname>, if specified this exact image will be fetched, instead
+    of <varname>imageName/imageTag</varname>. However, the resulting repository
+    will still be named <varname>imageName/imageTag</varname>.
+    By default it's <literal>null</literal>.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-dockerTools-pullImage-4'>
+    <para>
+    <varname>sha256</varname> is the checksum of the whole fetched image.
+    This argument is required.
+    </para>
+
+    <note>
+    <para>The checksum is computed on the unpacked directory, not on the final tarball.</para>
+    </note>
+
+  </callout>
+
+  <callout arearefs='ex-dockerTools-pullImage-5'>
+    <para>
+    In the above example the default values are shown for the variables
+    <varname>indexUrl</varname> and <varname>registryVersion</varname>.
+    Hence by default the Docker.io registry is used to pull the images.
+    </para>
+  </callout>
+  </calloutlist>
+
+</section>
+
+<section xml:id="ssec-pkgs-dockerTools-exportImage">
+  <title>exportImage</title>
+
+  <para>
+  This function is analogous to the <command>docker export</command> command,
+  in that can used to flatten a Docker image that contains multiple layers.
+  It is in fact the result of the merge of all the layers of the image.
+  As such, the result is suitable for being imported in Docker
+  with <command>docker import</command>.
+  </para>
+
+  <note>
+  <para>
+    Using this function requires the <literal>kvm</literal>
+    device to be available.
+  </para>
+  </note>
+
+  <para>
+  The parameters of <varname>exportImage</varname> are the following:
+  </para>
+
+  <example xml:id='ex-dockerTools-exportImage'><title>Docker export</title>
+  <programlisting>
+  exportImage {
+    fromImage = someLayeredImage;
+    fromImageName = null;
+    fromImageTag = null;
+
+    name = someLayeredImage.name;
+  }
+  </programlisting>
+  </example>
+
+  <para>
+  The parameters relative to the base image have the same synopsis as
+  described in <xref linkend='ssec-pkgs-dockerTools-buildImage'/>, except that
+  <varname>fromImage</varname> is the only required argument in this case.
+  </para>
+
+  <para>
+  The <varname>name</varname> argument is the name of the derivation output,
+  which defaults to <varname>fromImage.name</varname>.
+  </para>
+</section>
+
+<section xml:id="ssec-pkgs-dockerTools-shadowSetup">
+  <title>shadowSetup</title>
+
+  <para>
+  This constant string is a helper for setting up the base files for managing
+  users and groups, only if such files don't exist already.
+  It is suitable for being used in a
+  <varname>runAsRoot</varname> <xref linkend='ex-dockerTools-buildImage-runAsRoot'/> script for cases like
+  in the example below:
+  </para>
+
+  <example xml:id='ex-dockerTools-shadowSetup'><title>Shadow base files</title>
+  <programlisting>
+  buildImage {
+    name = "shadow-basic";
+
+    runAsRoot = ''
+      #!${stdenv.shell}
+      ${shadowSetup}
+      groupadd -r redis
+      useradd -r -g redis redis
+      mkdir /data
+      chown redis:redis /data
+    '';
+  }
+  </programlisting>
+  </example>
+
+  <para>
+  Creating base files like <literal>/etc/passwd</literal> or
+  <literal>/etc/login.defs</literal> are necessary for shadow-utils to
+  manipulate users and groups.
+  </para>
+
+</section>
+
+</section>
+
 </chapter>

doc/functions/debug.xml

@@ -1,21 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-debug">
- <title>Debugging Nix Expressions</title>
-
- <para>
-  Nix is a unityped, dynamic language, this means every value can potentially
-  appear anywhere. Since it is also non-strict, evaluation order and what
-  ultimately is evaluated might surprise you. Therefore it is important to be
-  able to debug nix expressions.
- </para>
-
- <para>
-  In the <literal>lib/debug.nix</literal> file you will find a number of
-  functions that help (pretty-)printing values while evaluation is runnnig. You
-  can even specify how deep these values should be printed recursively, and
-  transform them on the fly. Please consult the docstrings in
-  <literal>lib/debug.nix</literal> for usage information.
- </para>
-</section>

doc/functions/dockertools.xml

@@ -1,393 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-pkgs-dockerTools">
- <title>pkgs.dockerTools</title>
-
- <para>
-  <varname>pkgs.dockerTools</varname> is a set of functions for creating and
-  manipulating Docker images according to the
-  <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120">
-  Docker Image Specification v1.2.0 </link>. Docker itself is not used to
-  perform any of the operations done by these functions.
- </para>
-
- <warning>
-  <para>
-   The <varname>dockerTools</varname> API is unstable and may be subject to
-   backwards-incompatible changes in the future.
-  </para>
- </warning>
-
- <section xml:id="ssec-pkgs-dockerTools-buildImage">
-  <title>buildImage</title>
-
-  <para>
-   This function is analogous to the <command>docker build</command> command,
-   in that can used to build a Docker-compatible repository tarball containing
-   a single image with one or multiple layers. As such, the result is suitable
-   for being loaded in Docker with <command>docker load</command>.
-  </para>
-
-  <para>
-   The parameters of <varname>buildImage</varname> with relative example values
-   are described below:
-  </para>
-
-  <example xml:id='ex-dockerTools-buildImage'>
-   <title>Docker build</title>
-<programlisting>
-  buildImage {
-    name = "redis"; <co xml:id='ex-dockerTools-buildImage-1' />
-    tag = "latest"; <co xml:id='ex-dockerTools-buildImage-2' />
-
-    fromImage = someBaseImage; <co xml:id='ex-dockerTools-buildImage-3' />
-    fromImageName = null; <co xml:id='ex-dockerTools-buildImage-4' />
-    fromImageTag = "latest"; <co xml:id='ex-dockerTools-buildImage-5' />
-
-    contents = pkgs.redis; <co xml:id='ex-dockerTools-buildImage-6' />
-    runAsRoot = '' <co xml:id='ex-dockerTools-buildImage-runAsRoot' />
-      #!${stdenv.shell}
-      mkdir -p /data
-    '';
-
-    config = { <co xml:id='ex-dockerTools-buildImage-8' />
-      Cmd = [ "/bin/redis-server" ];
-      WorkingDir = "/data";
-      Volumes = {
-        "/data" = {};
-      };
-    };
-  }
-  </programlisting>
-  </example>
-
-  <para>
-   The above example will build a Docker image <literal>redis/latest</literal>
-   from the given base image. Loading and running this image in Docker results
-   in <literal>redis-server</literal> being started automatically.
-  </para>
-
-  <calloutlist>
-   <callout arearefs='ex-dockerTools-buildImage-1'>
-    <para>
-     <varname>name</varname> specifies the name of the resulting image. This is
-     the only required argument for <varname>buildImage</varname>.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-buildImage-2'>
-    <para>
-     <varname>tag</varname> specifies the tag of the resulting image. By
-     default it's <literal>null</literal>, which indicates that the nix output
-     hash will be used as tag.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-buildImage-3'>
-    <para>
-     <varname>fromImage</varname> is the repository tarball containing the base
-     image. It must be a valid Docker image, such as exported by
-     <command>docker save</command>. By default it's <literal>null</literal>,
-     which can be seen as equivalent to <literal>FROM scratch</literal> of a
-     <filename>Dockerfile</filename>.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-buildImage-4'>
-    <para>
-     <varname>fromImageName</varname> can be used to further specify the base
-     image within the repository, in case it contains multiple images. By
-     default it's <literal>null</literal>, in which case
-     <varname>buildImage</varname> will peek the first image available in the
-     repository.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-buildImage-5'>
-    <para>
-     <varname>fromImageTag</varname> can be used to further specify the tag of
-     the base image within the repository, in case an image contains multiple
-     tags. By default it's <literal>null</literal>, in which case
-     <varname>buildImage</varname> will peek the first tag available for the
-     base image.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-buildImage-6'>
-    <para>
-     <varname>contents</varname> is a derivation that will be copied in the new
-     layer of the resulting image. This can be similarly seen as <command>ADD
-     contents/ /</command> in a <filename>Dockerfile</filename>. By default
-     it's <literal>null</literal>.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-buildImage-runAsRoot'>
-    <para>
-     <varname>runAsRoot</varname> is a bash script that will run as root in an
-     environment that overlays the existing layers of the base image with the
-     new resulting layer, including the previously copied
-     <varname>contents</varname> derivation. This can be similarly seen as
-     <command>RUN ...</command> in a <filename>Dockerfile</filename>.
-     <note>
-      <para>
-       Using this parameter requires the <literal>kvm</literal> device to be
-       available.
-      </para>
-     </note>
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-buildImage-8'>
-    <para>
-     <varname>config</varname> is used to specify the configuration of the
-     containers that will be started off the built image in Docker. The
-     available options are listed in the
-     <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions">
-     Docker Image Specification v1.2.0 </link>.
-    </para>
-   </callout>
-  </calloutlist>
-
-  <para>
-   After the new layer has been created, its closure (to which
-   <varname>contents</varname>, <varname>config</varname> and
-   <varname>runAsRoot</varname> contribute) will be copied in the layer itself.
-   Only new dependencies that are not already in the existing layers will be
-   copied.
-  </para>
-
-  <para>
-   At the end of the process, only one new single layer will be produced and
-   added to the resulting image.
-  </para>
-
-  <para>
-   The resulting repository will only list the single image
-   <varname>image/tag</varname>. In the case of
-   <xref linkend='ex-dockerTools-buildImage'/> it would be
-   <varname>redis/latest</varname>.
-  </para>
-
-  <para>
-   It is possible to inspect the arguments with which an image was built using
-   its <varname>buildArgs</varname> attribute.
-  </para>
-
-  <note>
-   <para>
-    If you see errors similar to <literal>getProtocolByName: does not exist (no
-    such protocol name: tcp)</literal> you may need to add
-    <literal>pkgs.iana-etc</literal> to <varname>contents</varname>.
-   </para>
-  </note>
-
-  <note>
-   <para>
-    If you see errors similar to <literal>Error_Protocol ("certificate has
-    unknown CA",True,UnknownCa)</literal> you may need to add
-    <literal>pkgs.cacert</literal> to <varname>contents</varname>.
-   </para>
-  </note>
-
-  <example xml:id="example-pkgs-dockerTools-buildImage-creation-date">
-   <title>Impurely Defining a Docker Layer's Creation Date</title>
-   <para>
-    By default <function>buildImage</function> will use a static date of one
-    second past the UNIX Epoch. This allows <function>buildImage</function> to
-    produce binary reproducible images. When listing images with
-    <command>docker list images</command>, the newly created images will be
-    listed like this:
-   </para>
-<screen><![CDATA[
-$ docker image list
-REPOSITORY   TAG      IMAGE ID       CREATED        SIZE
-hello        latest   08c791c7846e   48 years ago   25.2MB
-]]></screen>
-   <para>
-    You can break binary reproducibility but have a sorted, meaningful
-    <literal>CREATED</literal> column by setting <literal>created</literal> to
-    <literal>now</literal>.
-   </para>
-<programlisting><![CDATA[
-pkgs.dockerTools.buildImage {
-  name = "hello";
-  tag = "latest";
-  created = "now";
-  contents = pkgs.hello;
-
-  config.Cmd = [ "/bin/hello" ];
-}
-]]></programlisting>
-   <para>
-    and now the Docker CLI will display a reasonable date and sort the images
-    as expected:
-<screen><![CDATA[
-$ docker image list
-REPOSITORY   TAG      IMAGE ID       CREATED              SIZE
-hello        latest   de2bf4786de6   About a minute ago   25.2MB
-]]></screen>
-    however, the produced images will not be binary reproducible.
-   </para>
-  </example>
- </section>
-
- <section xml:id="ssec-pkgs-dockerTools-fetchFromRegistry">
-  <title>pullImage</title>
-
-  <para>
-   This function is analogous to the <command>docker pull</command> command, in
-   that can be used to pull a Docker image from a Docker registry. By default
-   <link xlink:href="https://hub.docker.com/">Docker Hub</link> is used to pull
-   images.
-  </para>
-
-  <para>
-   Its parameters are described in the example below:
-  </para>
-
-  <example xml:id='ex-dockerTools-pullImage'>
-   <title>Docker pull</title>
-<programlisting>
-  pullImage {
-    imageName = "nixos/nix"; <co xml:id='ex-dockerTools-pullImage-1' />
-    imageDigest = "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b"; <co xml:id='ex-dockerTools-pullImage-2' />
-    finalImageTag = "1.11";  <co xml:id='ex-dockerTools-pullImage-3' />
-    sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; <co xml:id='ex-dockerTools-pullImage-4' />
-    os = "linux"; <co xml:id='ex-dockerTools-pullImage-5' />
-    arch = "x86_64"; <co xml:id='ex-dockerTools-pullImage-6' />
-  }
-  </programlisting>
-  </example>
-
-  <calloutlist>
-   <callout arearefs='ex-dockerTools-pullImage-1'>
-    <para>
-     <varname>imageName</varname> specifies the name of the image to be
-     downloaded, which can also include the registry namespace (e.g.
-     <literal>nixos</literal>). This argument is required.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-2'>
-    <para>
-     <varname>imageDigest</varname> specifies the digest of the image to be
-     downloaded. Skopeo can be used to get the digest of an image, with its
-     <varname>inspect</varname> subcommand. Since a given
-     <varname>imageName</varname> may transparently refer to a manifest list of
-     images which support multiple architectures and/or operating systems,
-     supply the `--override-os` and `--override-arch` arguments to specify
-     exactly which image you want. By default it will match the OS and
-     architecture of the host the command is run on.
-<programlisting>
-  $ nix-shell --packages skopeo jq --command "skopeo --override-os linux --override-arch x86_64 inspect docker://docker.io/nixos/nix:1.11 | jq -r '.Digest'"
-  sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b
-  </programlisting>
-     This argument is required.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-3'>
-    <para>
-     <varname>finalImageTag</varname>, if specified, this is the tag of the
-     image to be created. Note it is never used to fetch the image since we
-     prefer to rely on the immutable digest ID. By default it's
-     <literal>latest</literal>.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-4'>
-    <para>
-     <varname>sha256</varname> is the checksum of the whole fetched image. This
-     argument is required.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-5'>
-    <para>
-     <varname>os</varname>, if specified, is the operating system of the
-     fetched image. By default it's <literal>linux</literal>.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-6'>
-    <para>
-     <varname>arch</varname>, if specified, is the cpu architecture of the
-     fetched image. By default it's <literal>x86_64</literal>.
-    </para>
-   </callout>
-  </calloutlist>
- </section>
-
- <section xml:id="ssec-pkgs-dockerTools-exportImage">
-  <title>exportImage</title>
-
-  <para>
-   This function is analogous to the <command>docker export</command> command,
-   in that can used to flatten a Docker image that contains multiple layers. It
-   is in fact the result of the merge of all the layers of the image. As such,
-   the result is suitable for being imported in Docker with <command>docker
-   import</command>.
-  </para>
-
-  <note>
-   <para>
-    Using this function requires the <literal>kvm</literal> device to be
-    available.
-   </para>
-  </note>
-
-  <para>
-   The parameters of <varname>exportImage</varname> are the following:
-  </para>
-
-  <example xml:id='ex-dockerTools-exportImage'>
-   <title>Docker export</title>
-<programlisting>
-  exportImage {
-    fromImage = someLayeredImage;
-    fromImageName = null;
-    fromImageTag = null;
-
-    name = someLayeredImage.name;
-  }
-  </programlisting>
-  </example>
-
-  <para>
-   The parameters relative to the base image have the same synopsis as
-   described in <xref linkend='ssec-pkgs-dockerTools-buildImage'/>, except that
-   <varname>fromImage</varname> is the only required argument in this case.
-  </para>
-
-  <para>
-   The <varname>name</varname> argument is the name of the derivation output,
-   which defaults to <varname>fromImage.name</varname>.
-  </para>
- </section>
-
- <section xml:id="ssec-pkgs-dockerTools-shadowSetup">
-  <title>shadowSetup</title>
-
-  <para>
-   This constant string is a helper for setting up the base files for managing
-   users and groups, only if such files don't exist already. It is suitable for
-   being used in a <varname>runAsRoot</varname>
-   <xref linkend='ex-dockerTools-buildImage-runAsRoot'/> script for cases like
-   in the example below:
-  </para>
-
-  <example xml:id='ex-dockerTools-shadowSetup'>
-   <title>Shadow base files</title>
-<programlisting>
-  buildImage {
-    name = "shadow-basic";
-
-    runAsRoot = ''
-      #!${stdenv.shell}
-      ${shadowSetup}
-      groupadd -r redis
-      useradd -r -g redis redis
-      mkdir /data
-      chown redis:redis /data
-    '';
-  }
-  </programlisting>
-  </example>
-
-  <para>
-   Creating base files like <literal>/etc/passwd</literal> or
-   <literal>/etc/login.defs</literal> are necessary for shadow-utils to
-   manipulate users and groups.
-  </para>
- </section>
-</section>

doc/functions/fhs-environments.xml

@@ -1,142 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-fhs-environments">
- <title>buildFHSUserEnv</title>
-
- <para>
-  <function>buildFHSUserEnv</function> provides a way to build and run
-  FHS-compatible lightweight sandboxes. It creates an isolated root with bound
-  <filename>/nix/store</filename>, so its footprint in terms of disk space
-  needed is quite small. This allows one to run software which is hard or
-  unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions,
-  games distributed as tarballs, software with integrity checking and/or
-  external self-updated binaries. It uses Linux namespaces feature to create
-  temporary lightweight environments which are destroyed after all child
-  processes exit, without root user rights requirement. Accepted arguments are:
- </para>
-
- <variablelist>
-  <varlistentry>
-   <term>
-    <literal>name</literal>
-   </term>
-   <listitem>
-    <para>
-     Environment name.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>targetPkgs</literal>
-   </term>
-   <listitem>
-    <para>
-     Packages to be installed for the main host's architecture (i.e. x86_64 on
-     x86_64 installations). Along with libraries binaries are also installed.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>multiPkgs</literal>
-   </term>
-   <listitem>
-    <para>
-     Packages to be installed for all architectures supported by a host (i.e.
-     i686 and x86_64 on x86_64 installations). Only libraries are installed by
-     default.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>extraBuildCommands</literal>
-   </term>
-   <listitem>
-    <para>
-     Additional commands to be executed for finalizing the directory structure.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>extraBuildCommandsMulti</literal>
-   </term>
-   <listitem>
-    <para>
-     Like <literal>extraBuildCommands</literal>, but executed only on multilib
-     architectures.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>extraOutputsToInstall</literal>
-   </term>
-   <listitem>
-    <para>
-     Additional derivation outputs to be linked for both target and
-     multi-architecture packages.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>extraInstallCommands</literal>
-   </term>
-   <listitem>
-    <para>
-     Additional commands to be executed for finalizing the derivation with
-     runner script.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>runScript</literal>
-   </term>
-   <listitem>
-    <para>
-     A command that would be executed inside the sandbox and passed all the
-     command line arguments. It defaults to <literal>bash</literal>.
-    </para>
-   </listitem>
-  </varlistentry>
- </variablelist>
-
- <para>
-  One can create a simple environment using a <literal>shell.nix</literal> like
-  that:
- </para>
-
-<programlisting><![CDATA[
-{ pkgs ? import <nixpkgs> {} }:
-
-(pkgs.buildFHSUserEnv {
-  name = "simple-x11-env";
-  targetPkgs = pkgs: (with pkgs;
-    [ udev
-      alsaLib
-    ]) ++ (with pkgs.xorg;
-    [ libX11
-      libXcursor
-      libXrandr
-    ]);
-  multiPkgs = pkgs: (with pkgs;
-    [ udev
-      alsaLib
-    ]);
-  runScript = "bash";
-}).env
-]]></programlisting>
-
- <para>
-  Running <literal>nix-shell</literal> would then drop you into a shell with
-  these libraries and binaries available. You can use this to run closed-source
-  applications which expect FHS structure without hassles: simply change
-  <literal>runScript</literal> to the application path, e.g.
-  <filename>./bin/start.sh</filename> -- relative paths are supported.
- </para>
-</section>

doc/functions/generators.xml

@@ -1,89 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-generators">
- <title>Generators</title>
-
- <para>
-  Generators are functions that create file formats from nix data structures,
-  e. g. for configuration files. There are generators available for:
-  <literal>INI</literal>, <literal>JSON</literal> and <literal>YAML</literal>
- </para>
-
- <para>
-  All generators follow a similar call interface: <code>generatorName
-  configFunctions data</code>, where <literal>configFunctions</literal> is an
-  attrset of user-defined functions that format nested parts of the content.
-  They each have common defaults, so often they do not need to be set manually.
-  An example is <code>mkSectionName ? (name: libStr.escape [ "[" "]" ]
-  name)</code> from the <literal>INI</literal> generator. It receives the name
-  of a section and sanitizes it. The default <literal>mkSectionName</literal>
-  escapes <literal>[</literal> and <literal>]</literal> with a backslash.
- </para>
-
- <para>
-  Generators can be fine-tuned to produce exactly the file format required by
-  your application/service. One example is an INI-file format which uses
-  <literal>: </literal> as separator, the strings
-  <literal>"yes"</literal>/<literal>"no"</literal> as boolean values and
-  requires all string values to be quoted:
- </para>
-
-<programlisting>
-with lib;
-let
-  customToINI = generators.toINI {
-    # specifies how to format a key/value pair
-    mkKeyValue = generators.mkKeyValueDefault {
-      # specifies the generated string for a subset of nix values
-      mkValueString = v:
-             if v == true then ''"yes"''
-        else if v == false then ''"no"''
-        else if isString v then ''"${v}"''
-        # and delegats all other values to the default generator
-        else generators.mkValueStringDefault {} v;
-    } ":";
-  };
-
-# the INI file can now be given as plain old nix values
-in customToINI {
-  main = {
-    pushinfo = true;
-    autopush = false;
-    host = "localhost";
-    port = 42;
-  };
-  mergetool = {
-    merge = "diff3";
-  };
-}
-</programlisting>
-
- <para>
-  This will produce the following INI file as nix string:
- </para>
-
-<programlisting>
-[main]
-autopush:"no"
-host:"localhost"
-port:42
-pushinfo:"yes"
-str\:ange:"very::strange"
-
-[mergetool]
-merge:"diff3"
-</programlisting>
-
- <note>
-  <para>
-   Nix store paths can be converted to strings by enclosing a derivation
-   attribute like so: <code>"${drv}"</code>.
-  </para>
- </note>
-
- <para>
-  Detailed documentation for each generator can be found in
-  <literal>lib/generators.nix</literal>.
- </para>
-</section>

doc/functions/library.xml

@@ -1,13 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-functions-library">
- <title>Nixpkgs Library Functions</title>
-
- <para>
-  Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or
-  through <code>import &lt;nixpkgs/lib&gt;</code>.
- </para>
-
- <xi:include href="./library/attrsets.xml" />
-</section>

doc/functions/library/attrsets.xml

@@ -1,970 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-functions-library-attrset">
- <title>Attribute-Set Functions</title>
-
- <section xml:id="function-library-lib.attrsets.attrByPath">
-  <title><function>lib.attrset.attrByPath</function></title>
-
-  <subtitle><literal>attrByPath :: [String] -> Any -> AttrSet</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.attrByPath" />
-
-  <para>
-   Return an attribute from within nested attribute sets.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>attrPath</varname>
-    </term>
-    <listitem>
-     <para>
-      A list of strings representing the path through the nested attribute set
-      <varname>set</varname>.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>default</varname>
-    </term>
-    <listitem>
-     <para>
-      Default value if <varname>attrPath</varname> does not resolve to an
-      existing value.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The nested attributeset to select values from.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrset.attrByPath-example-value-exists">
-   <title>Extracting a value from a nested attribute set</title>
-<programlisting><![CDATA[
-let set = { a = { b = 3; }; };
-in lib.attrsets.attrByPath [ "a" "b" ] 0 set
-=> 3
-]]></programlisting>
-  </example>
-
-  <example xml:id="function-library-lib.attrset.attrByPath-example-default-value">
-   <title>No value at the path, instead using the default</title>
-<programlisting><![CDATA[
-lib.attrsets.attrByPath [ "a" "b" ] 0 {}
-=> 0
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.hasAttrByPath">
-  <title><function>lib.attrsets.hasAttrByPath</function></title>
-
-  <subtitle><literal>hasAttrByPath :: [String] -> AttrSet -> Bool</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.hasAttrByPath" />
-
-  <para>
-   Determine if an attribute exists within a nested attribute set.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>attrPath</varname>
-    </term>
-    <listitem>
-     <para>
-      A list of strings representing the path through the nested attribute set
-      <varname>set</varname>.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The nested attributeset to check.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.hasAttrByPath-example">
-   <title>A nested value does exist inside a set</title>
-<programlisting><![CDATA[
-lib.attrsets.hasAttrByPath
-  [ "a" "b" "c" "d" ]
-  { a = { b = { c = { d = 123; }; }; }; }
-=> true
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.setAttrByPath">
-  <title><function>lib.attrsets.setAttrByPath</function></title>
-
-  <subtitle><literal>setAttrByPath :: [String] -> Any -> AttrSet</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.setAttrByPath" />
-
-  <para>
-   Create a new attribute set with <varname>value</varname> set at the nested
-   attribute location specified in <varname>attrPath</varname>.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>attrPath</varname>
-    </term>
-    <listitem>
-     <para>
-      A list of strings representing the path through the nested attribute set.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>value</varname>
-    </term>
-    <listitem>
-     <para>
-      The value to set at the location described by
-      <varname>attrPath</varname>.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.setAttrByPath-example">
-   <title>Creating a new nested attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.setAttrByPath [ "a" "b" ] 3
-=> { a = { b = 3; }; }
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.getAttrFromPath">
-  <title><function>lib.attrsets.getAttrFromPath</function></title>
-
-  <subtitle><literal>getAttrFromPath :: [String] -> AttrSet -> Value</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.getAttrFromPath" />
-
-  <para>
-   Like <xref linkend="function-library-lib.attrsets.attrByPath" /> except
-   without a default, and it will throw if the value doesn't exist.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>attrPath</varname>
-    </term>
-    <listitem>
-     <para>
-      A list of strings representing the path through the nested attribute set
-      <varname>set</varname>.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The nested attribute set to find the value in.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.getAttrPath-example-success">
-   <title>Succesfully getting a value from an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.getAttrFromPath [ "a" "b" ] { a = { b = 3; }; }
-=> 3
-]]></programlisting>
-  </example>
-
-  <example xml:id="function-library-lib.attrsets.getAttrPath-example-throw">
-   <title>Throwing after failing to get a value from an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.getAttrFromPath [ "x" "y" ] { }
-=> error: cannot find attribute `x.y'
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.attrVals">
-  <title><function>lib.attrsets.attrVals</function></title>
-
-  <subtitle><literal>attrVals :: [String] -> AttrSet -> [Any]</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.attrVals" />
-
-  <para>
-   Return the specified attributes from a set. All values must exist.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>nameList</varname>
-    </term>
-    <listitem>
-     <para>
-      The list of attributes to fetch from <varname>set</varname>. Each
-      attribute name must exist on the attrbitue set.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The set to get attribute values from.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.attrVals-example-success">
-   <title>Getting several values from an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.attrVals [ "a" "b" "c" ] { a = 1; b = 2; c = 3; }
-=> [ 1 2 3 ]
-]]></programlisting>
-  </example>
-
-  <example xml:id="function-library-lib.attrsets.attrVals-failure">
-   <title>Getting missing values from an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.attrVals [ "d" ] { }
-error: attribute 'd' missing
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.attrValues">
-  <title><function>lib.attrsets.attrValues</function></title>
-
-  <subtitle><literal>attrValues :: AttrSet -> [Any]</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.attrValues" />
-
-  <para>
-   Get all the attribute values from an attribute set.
-  </para>
-
-  <para>
-   Provides a backwards-compatible interface of
-   <function>builtins.attrValues</function> for Nix version older than 1.8.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>attrs</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute set.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.attrValues-example">
-   <title></title>
-<programlisting><![CDATA[
-lib.attrsets.attrValues { a = 1; b = 2; c = 3; }
-=> [ 1 2 3 ]
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.catAttrs">
-  <title><function>lib.attrsets.catAttrs</function></title>
-
-  <subtitle><literal>catAttrs :: String -> AttrSet -> [Any]</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.catAttrs" />
-
-  <para>
-   Collect each attribute named `attr' from the list of attribute sets,
-   <varname>sets</varname>. Sets that don't contain the named attribute are
-   ignored.
-  </para>
-
-  <para>
-   Provides a backwards-compatible interface of
-   <function>builtins.catAttrs</function> for Nix version older than 1.9.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>attr</varname>
-    </term>
-    <listitem>
-     <para>
-      Attribute name to select from each attribute set in
-      <varname>sets</varname>.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>sets</varname>
-    </term>
-    <listitem>
-     <para>
-      The list of attribute sets to select <varname>attr</varname> from.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.catAttrs-example">
-   <title>Collect an attribute from a list of attribute sets.</title>
-   <para>
-    Attribute sets which don't have the attribute are ignored.
-   </para>
-<programlisting><![CDATA[
-catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}]
-=> [ 1 2 ]
-      ]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.filterAttrs">
-  <title><function>lib.attrsets.filterAttrs</function></title>
-
-  <subtitle><literal>filterAttrs :: (String -> Any -> Bool) -> AttrSet -> AttrSet</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrs" />
-
-  <para>
-   Filter an attribute set by removing all attributes for which the given
-   predicate return false.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>pred</varname>
-    </term>
-    <listitem>
-     <para>
-      <literal>String -> Any -> Bool</literal>
-     </para>
-     <para>
-      Predicate which returns true to include an attribute, or returns false to
-      exclude it.
-     </para>
-     <variablelist>
-      <varlistentry>
-       <term>
-        <varname>name</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute's name
-        </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term>
-        <varname>value</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute's value
-        </para>
-       </listitem>
-      </varlistentry>
-     </variablelist>
-     <para>
-      Returns <literal>true</literal> to include the attribute,
-      <literal>false</literal> to exclude the attribute.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute set to filter
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.filterAttrs-example">
-   <title>Filtering an attributeset</title>
-<programlisting><![CDATA[
-filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; }
-=> { foo = 1; }
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.filterAttrsRecursive">
-  <title><function>lib.attrsets.filterAttrsRecursive</function></title>
-
-  <subtitle><literal>filterAttrsRecursive :: (String -> Any -> Bool) -> AttrSet -> AttrSet</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrsRecursive" />
-
-  <para>
-   Filter an attribute set recursively by removing all attributes for which the
-   given predicate return false.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>pred</varname>
-    </term>
-    <listitem>
-     <para>
-      <literal>String -> Any -> Bool</literal>
-     </para>
-     <para>
-      Predicate which returns true to include an attribute, or returns false to
-      exclude it.
-     </para>
-     <variablelist>
-      <varlistentry>
-       <term>
-        <varname>name</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute's name
-        </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term>
-        <varname>value</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute's value
-        </para>
-       </listitem>
-      </varlistentry>
-     </variablelist>
-     <para>
-      Returns <literal>true</literal> to include the attribute,
-      <literal>false</literal> to exclude the attribute.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute set to filter
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.filterAttrsRecursive-example">
-   <title>Recursively filtering an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.filterAttrsRecursive
-  (n: v: v != null)
-  {
-    levelA = {
-      example = "hi";
-      levelB = {
-        hello = "there";
-        this-one-is-present = {
-          this-is-excluded = null;
-        };
-      };
-      this-one-is-also-excluded = null;
-    };
-    also-excluded = null;
-  }
-=> {
-     levelA = {
-       example = "hi";
-       levelB = {
-         hello = "there";
-         this-one-is-present = { };
-       };
-     };
-   }
-     ]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.foldAttrs">
-  <title><function>lib.attrsets.foldAttrs</function></title>
-
-  <subtitle><literal>foldAttrs :: (Any -> Any -> Any) -> Any -> [AttrSets] -> Any</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.foldAttrs" />
-
-  <para>
-   Apply fold function to values grouped by key.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>op</varname>
-    </term>
-    <listitem>
-     <para>
-      <literal>Any -> Any -> Any</literal>
-     </para>
-     <para>
-      Given a value <varname>val</varname> and a collector
-      <varname>col</varname>, combine the two.
-     </para>
-     <variablelist>
-      <varlistentry>
-       <term>
-        <varname>val</varname>
-       </term>
-       <listitem>
-        <para>
-         An attribute's value
-        </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term>
-        <varname>col</varname>
-       </term>
-       <listitem>
-<!-- TODO: make this not bad, use more fold-ey terms -->
-        <para>
-         The result of previous <function>op</function> calls with other values
-         and <function>nul</function>.
-        </para>
-       </listitem>
-      </varlistentry>
-     </variablelist>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>nul</varname>
-    </term>
-    <listitem>
-     <para>
-      The null-value, the starting value.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>list_of_attrs</varname>
-    </term>
-    <listitem>
-     <para>
-      A list of attribute sets to fold together by key.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.foldAttrs-example">
-   <title>Combining an attribute of lists in to one attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.foldAttrs
-  (n: a: [n] ++ a) []
-  [
-    { a = 2; b = 7; }
-    { a = 3; }
-    { b = 6; }
-  ]
-=> { a = [ 2 3 ]; b = [ 7 6 ]; }
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.collect">
-  <title><function>lib.attrsets.collect</function></title>
-
-  <subtitle><literal>collect :: (Any -> Bool) -> AttrSet -> [Any]</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.collect" />
-
-  <para>
-   Recursively collect sets that verify a given predicate named
-   <varname>pred</varname> from the set <varname>attrs</varname>. The recursion
-   stops when <varname>pred</varname> returns <literal>true</literal>.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>pred</varname>
-    </term>
-    <listitem>
-     <para>
-      <literal>Any -> Bool</literal>
-     </para>
-     <para>
-      Given an attribute's value, determine if recursion should stop.
-     </para>
-     <variablelist>
-      <varlistentry>
-       <term>
-        <varname>value</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute set value.
-        </para>
-       </listitem>
-      </varlistentry>
-     </variablelist>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>attrs</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute set to recursively collect.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.collect-example-lists">
-   <title>Collecting all lists from an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.collect isList { a = { b = ["b"]; }; c = [1]; }
-=> [["b"] [1]]
-]]></programlisting>
-  </example>
-
-  <example xml:id="function-library-lib.attrsets.collect-example-outpath">
-   <title>Collecting all attribute-sets which contain the <literal>outPath</literal> attribute name.</title>
-<programlisting><![CDATA[
-collect (x: x ? outPath)
-  { a = { outPath = "a/"; }; b = { outPath = "b/"; }; }
-=> [{ outPath = "a/"; } { outPath = "b/"; }]
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.nameValuePair">
-  <title><function>lib.attrsets.nameValuePair</function></title>
-
-  <subtitle><literal>nameValuePair :: String -> Any -> AttrSet</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.nameValuePair" />
-
-  <para>
-   Utility function that creates a <literal>{name, value}</literal> pair as
-   expected by <function>builtins.listToAttrs</function>.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>name</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute name.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>value</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute value.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.nameValuePair-example">
-   <title>Creating a name value pair</title>
-<programlisting><![CDATA[
-nameValuePair "some" 6
-=> { name = "some"; value = 6; }
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.mapAttrs">
-  <title><function>lib.attrsets.mapAttrs</function></title>
-
-  <subtitle><literal></literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs" />
-
-  <para>
-   Apply a function to each element in an attribute set, creating a new
-   attribute set.
-  </para>
-
-  <para>
-   Provides a backwards-compatible interface of
-   <function>builtins.mapAttrs</function> for Nix version older than 2.1.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>fn</varname>
-    </term>
-    <listitem>
-     <para>
-      <literal>String -> Any -> Any</literal>
-     </para>
-     <para>
-      Given an attribute's name and value, return a new value.
-     </para>
-     <variablelist>
-      <varlistentry>
-       <term>
-        <varname>name</varname>
-       </term>
-       <listitem>
-        <para>
-         The name of the attribute.
-        </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term>
-        <varname>value</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute's value.
-        </para>
-       </listitem>
-      </varlistentry>
-     </variablelist>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.mapAttrs-example">
-   <title>Modifying each value of an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.mapAttrs
-  (name: value: name + "-" value)
-  { x = "foo"; y = "bar"; }
-=> { x = "x-foo"; y = "y-bar"; }
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.mapAttrs-prime">
-  <title><function>lib.attrsets.mapAttrs&apos;</function></title>
-
-  <subtitle><literal>mapAttrs' :: (String -> Any -> { name = String; value = Any }) -> AttrSet -> AttrSet</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs-prime" />
-
-  <para>
-   Like <function>mapAttrs</function>, but allows the name of each attribute to
-   be changed in addition to the value. The applied function should return both
-   the new name and value as a <function>nameValuePair</function>.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>fn</varname>
-    </term>
-    <listitem>
-     <para>
-      <literal>String -> Any -> { name = String; value = Any }</literal>
-     </para>
-     <para>
-      Given an attribute's name and value, return a new
-      <link
-       linkend="function-library-lib.attrsets.nameValuePair">name
-      value pair</link>.
-     </para>
-     <variablelist>
-      <varlistentry>
-       <term>
-        <varname>name</varname>
-       </term>
-       <listitem>
-        <para>
-         The name of the attribute.
-        </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term>
-        <varname>value</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute's value.
-        </para>
-       </listitem>
-      </varlistentry>
-     </variablelist>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute set to map over.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.mapAttrs-prime-example">
-   <title>Change the name and value of each attribute of an attribute set</title>
-<programlisting><![CDATA[
-lib.attrsets.mapAttrs' (name: value: lib.attrsets.nameValuePair ("foo_" + name) ("bar-" + value))
-   { x = "a"; y = "b"; }
-=> { foo_x = "bar-a"; foo_y = "bar-b"; }
-
-    ]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.mapAttrsToList">
-  <title><function>lib.attrsets.mapAttrsToList</function></title>
-
-  <subtitle><literal>mapAttrsToList :: (String -> Any -> Any) ->
-   AttrSet -> Any</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsToList" />
-
-  <para>
-   Call <varname>fn</varname> for each attribute in the given
-   <varname>set</varname> and return the result in a list.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>fn</varname>
-    </term>
-    <listitem>
-     <para>
-      <literal>String -> Any -> Any</literal>
-     </para>
-     <para>
-      Given an attribute's name and value, return a new value.
-     </para>
-     <variablelist>
-      <varlistentry>
-       <term>
-        <varname>name</varname>
-       </term>
-       <listitem>
-        <para>
-         The name of the attribute.
-        </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term>
-        <varname>value</varname>
-       </term>
-       <listitem>
-        <para>
-         The attribute's value.
-        </para>
-       </listitem>
-      </varlistentry>
-     </variablelist>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>set</varname>
-    </term>
-    <listitem>
-     <para>
-      The attribute set to map over.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.attrsets.mapAttrsToList-example">
-   <title>Combine attribute values and names in to a list</title>
-<programlisting><![CDATA[
-lib.attrsets.mapAttrsToList (name: value: "${name}=${value}")
-   { x = "a"; y = "b"; }
-=> [ "x=a" "y=b" ]
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.attrsets.mapAttrsRecursive">
-  <title><function>lib.attrsets.mapAttrsRecursive</function></title>
-
-  <subtitle><literal>mapAttrsRecursive :: ([String] > Any -> Any) -> AttrSet -> AttrSet</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursive" />
-
-  <para>
-   Like <function>mapAttrs</function>, except that it recursively applies
-   itself to attribute sets. Also, the first argument of the argument function
-   is a <emphasis>list</emphasis> of the names of the containing attributes.
-  </para>
- </section>
-</section>

doc/functions/overrides.xml

@@ -1,193 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-overrides">
- <title>Overriding</title>
-
- <para>
-  Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g.
-  derivation attributes, the results of derivations or even the whole package
-  set.
- </para>
-
- <section xml:id="sec-pkg-override">
-  <title>&lt;pkg&gt;.override</title>
-
-  <para>
-   The function <varname>override</varname> is usually available for all the
-   derivations in the nixpkgs expression (<varname>pkgs</varname>).
-  </para>
-
-  <para>
-   It is used to override the arguments passed to a function.
-  </para>
-
-  <para>
-   Example usages:
-<programlisting>pkgs.foo.override { arg1 = val1; arg2 = val2; ... }</programlisting>
-<programlisting>import pkgs.path { overlays = [ (self: super: {
-    foo = super.foo.override { barSupport = true ; };
-  })]};</programlisting>
-<programlisting>mypkg = pkgs.callPackage ./mypkg.nix {
-    mydep = pkgs.mydep.override { ... };
-  }</programlisting>
-  </para>
-
-  <para>
-   In the first example, <varname>pkgs.foo</varname> is the result of a
-   function call with some default arguments, usually a derivation. Using
-   <varname>pkgs.foo.override</varname> will call the same function with the
-   given new arguments.
-  </para>
- </section>
-
- <section xml:id="sec-pkg-overrideAttrs">
-  <title>&lt;pkg&gt;.overrideAttrs</title>
-
-  <para>
-   The function <varname>overrideAttrs</varname> allows overriding the
-   attribute set passed to a <varname>stdenv.mkDerivation</varname> call,
-   producing a new derivation based on the original one. This function is
-   available on all derivations produced by the
-   <varname>stdenv.mkDerivation</varname> function, which is most packages in
-   the nixpkgs expression <varname>pkgs</varname>.
-  </para>
-
-  <para>
-   Example usage:
-<programlisting>helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
-    separateDebugInfo = true;
-  });</programlisting>
-  </para>
-
-  <para>
-   In the above example, the <varname>separateDebugInfo</varname> attribute is
-   overridden to be true, thus building debug info for
-   <varname>helloWithDebug</varname>, while all other attributes will be
-   retained from the original <varname>hello</varname> package.
-  </para>
-
-  <para>
-   The argument <varname>oldAttrs</varname> is conventionally used to refer to
-   the attr set originally passed to <varname>stdenv.mkDerivation</varname>.
-  </para>
-
-  <note>
-   <para>
-    Note that <varname>separateDebugInfo</varname> is processed only by the
-    <varname>stdenv.mkDerivation</varname> function, not the generated, raw Nix
-    derivation. Thus, using <varname>overrideDerivation</varname> will not work
-    in this case, as it overrides only the attributes of the final derivation.
-    It is for this reason that <varname>overrideAttrs</varname> should be
-    preferred in (almost) all cases to <varname>overrideDerivation</varname>,
-    i.e. to allow using <varname>sdenv.mkDerivation</varname> to process input
-    arguments, as well as the fact that it is easier to use (you can use the
-    same attribute names you see in your Nix code, instead of the ones
-    generated (e.g. <varname>buildInputs</varname> vs
-    <varname>nativeBuildInputs</varname>, and involves less typing.
-   </para>
-  </note>
- </section>
-
- <section xml:id="sec-pkg-overrideDerivation">
-  <title>&lt;pkg&gt;.overrideDerivation</title>
-
-  <warning>
-   <para>
-    You should prefer <varname>overrideAttrs</varname> in almost all cases, see
-    its documentation for the reasons why.
-    <varname>overrideDerivation</varname> is not deprecated and will continue
-    to work, but is less nice to use and does not have as many abilities as
-    <varname>overrideAttrs</varname>.
-   </para>
-  </warning>
-
-  <warning>
-   <para>
-    Do not use this function in Nixpkgs as it evaluates a Derivation before
-    modifying it, which breaks package abstraction and removes error-checking
-    of function arguments. In addition, this evaluation-per-function
-    application incurs a performance penalty, which can become a problem if
-    many overrides are used. It is only intended for ad-hoc customisation, such
-    as in <filename>~/.config/nixpkgs/config.nix</filename>.
-   </para>
-  </warning>
-
-  <para>
-   The function <varname>overrideDerivation</varname> creates a new derivation
-   based on an existing one by overriding the original's attributes with the
-   attribute set produced by the specified function. This function is available
-   on all derivations defined using the <varname>makeOverridable</varname>
-   function. Most standard derivation-producing functions, such as
-   <varname>stdenv.mkDerivation</varname>, are defined using this function,
-   which means most packages in the nixpkgs expression,
-   <varname>pkgs</varname>, have this function.
-  </para>
-
-  <para>
-   Example usage:
-<programlisting>mySed = pkgs.gnused.overrideDerivation (oldAttrs: {
-    name = "sed-4.2.2-pre";
-    src = fetchurl {
-      url = ftp://alpha.gnu.org/gnu/sed/sed-4.2.2-pre.tar.bz2;
-      sha256 = "11nq06d131y4wmf3drm0yk502d2xc6n5qy82cg88rb9nqd2lj41k";
-    };
-    patches = [];
-  });</programlisting>
-  </para>
-
-  <para>
-   In the above example, the <varname>name</varname>, <varname>src</varname>,
-   and <varname>patches</varname> of the derivation will be overridden, while
-   all other attributes will be retained from the original derivation.
-  </para>
-
-  <para>
-   The argument <varname>oldAttrs</varname> is used to refer to the attribute
-   set of the original derivation.
-  </para>
-
-  <note>
-   <para>
-    A package's attributes are evaluated *before* being modified by the
-    <varname>overrideDerivation</varname> function. For example, the
-    <varname>name</varname> attribute reference in <varname>url =
-    "mirror://gnu/hello/${name}.tar.gz";</varname> is filled-in *before* the
-    <varname>overrideDerivation</varname> function modifies the attribute set.
-    This means that overriding the <varname>name</varname> attribute, in this
-    example, *will not* change the value of the <varname>url</varname>
-    attribute. Instead, we need to override both the <varname>name</varname>
-    *and* <varname>url</varname> attributes.
-   </para>
-  </note>
- </section>
-
- <section xml:id="sec-lib-makeOverridable">
-  <title>lib.makeOverridable</title>
-
-  <para>
-   The function <varname>lib.makeOverridable</varname> is used to make the
-   result of a function easily customizable. This utility only makes sense for
-   functions that accept an argument set and return an attribute set.
-  </para>
-
-  <para>
-   Example usage:
-<programlisting>f = { a, b }: { result = a+b; }
-  c = lib.makeOverridable f { a = 1; b = 2; }</programlisting>
-  </para>
-
-  <para>
-   The variable <varname>c</varname> is the value of the <varname>f</varname>
-   function applied with some default arguments. Hence the value of
-   <varname>c.result</varname> is <literal>3</literal>, in this example.
-  </para>
-
-  <para>
-   The variable <varname>c</varname> however also has some additional
-   functions, like <link linkend="sec-pkg-override">c.override</link> which can
-   be used to override the default arguments. In this example the value of
-   <varname>(c.override { a = 4; }).result</varname> is 6.
-  </para>
- </section>
-</section>

doc/functions/shell.xml

@@ -1,26 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         xml:id="sec-pkgs-mkShell">
- <title>pkgs.mkShell</title>
-
- <para>
-  <function>pkgs.mkShell</function> is a special kind of derivation that is
-  only useful when using it combined with <command>nix-shell</command>. It will
-  in fact fail to instantiate when invoked with <command>nix-build</command>.
- </para>
-
- <section xml:id="sec-pkgs-mkShell-usage">
-  <title>Usage</title>
-
-<programlisting><![CDATA[
-{ pkgs ? import <nixpkgs> {} }:
-pkgs.mkShell {
-  # this will make all the build inputs from hello and gnutar
-  # available to the shell environment
-  inputsFrom = with pkgs; [ hello gnutar ];
-  buildInputs = [ pkgs.gnumake ];
-}
-]]></programlisting>
- </section>
-</section>

doc/introduction.chapter.md

@@ -30,7 +30,7 @@ Packages, including the Nix packages collection, are distributed through
 distributed for users of Nix on non-NixOS distributions through the channel
 `nixpkgs`. Users of NixOS generally use one of the `nixos-*` channels, e.g.
 `nixos-16.03`, which includes all packages and modules for the stable NixOS
-16.03. Stable NixOS releases are generally only given
+16.03. The purpose of stable NixOS releases are generally only given
 security updates. More up to date packages and modules are available via the
 `nixos-unstable` channel.
 

doc/languages-frameworks/beam.xml

@@ -1,137 +1,124 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-beam">
- <title>BEAM Languages (Erlang, Elixir &amp; LFE)</title>
 
- <section xml:id="beam-introduction">
-  <title>Introduction</title>
-
-  <para>
-   In this document and related Nix expressions, we use the term,
-   <emphasis>BEAM</emphasis>, to describe the environment. BEAM is the name of
-   the Erlang Virtual Machine and, as far as we're concerned, from a packaging
-   perspective, all languages that run on the BEAM are interchangeable. That
-   which varies, like the build system, is transparent to users of any given
-   BEAM package, so we make no distinction.
-  </para>
- </section>
-
- <section xml:id="beam-structure">
-  <title>Structure</title>
-
-  <para>
-   All BEAM-related expressions are available via the top-level
-   <literal>beam</literal> attribute, which includes:
-  </para>
-
-  <itemizedlist>
-   <listitem>
+  <title>BEAM Languages (Erlang, Elixir &amp; LFE)</title>
+  <section xml:id="beam-introduction">
+    <title>Introduction</title>
     <para>
-     <literal>interpreters</literal>: a set of compilers running on the BEAM,
-     including multiple Erlang/OTP versions
-     (<literal>beam.interpreters.erlangR19</literal>, etc), Elixir
-     (<literal>beam.interpreters.elixir</literal>) and LFE
-     (<literal>beam.interpreters.lfe</literal>).
+      In this document and related Nix expressions, we use the term,
+      <emphasis>BEAM</emphasis>, to describe the environment. BEAM is the name
+      of the Erlang Virtual Machine and, as far as we're concerned, from a
+      packaging perspective, all languages that run on the BEAM are
+      interchangeable. That which varies, like the build system, is transparent
+      to users of any given BEAM package, so we make no distinction.
     </para>
-   </listitem>
-   <listitem>
+  </section>
+  <section xml:id="beam-structure">
+    <title>Structure</title>
     <para>
-     <literal>packages</literal>: a set of package sets, each compiled with a
-     specific Erlang/OTP version, e.g.
-     <literal>beam.packages.erlangR19</literal>.
+      All BEAM-related expressions are available via the top-level
+      <literal>beam</literal> attribute, which includes:
     </para>
-   </listitem>
-  </itemizedlist>
-
-  <para>
-   The default Erlang compiler, defined by
-   <literal>beam.interpreters.erlang</literal>, is aliased as
-   <literal>erlang</literal>. The default BEAM package set is defined by
-   <literal>beam.packages.erlang</literal> and aliased at the top level as
-   <literal>beamPackages</literal>.
-  </para>
-
-  <para>
-   To create a package set built with a custom Erlang version, use the lambda,
-   <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP derivation
-   and produces a package set similar to
-   <literal>beam.packages.erlang</literal>.
-  </para>
-
-  <para>
-   Many Erlang/OTP distributions available in
-   <literal>beam.interpreters</literal> have versions with ODBC and/or Java
-   enabled. For example, there's
-   <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which corresponds
-   to <literal>beam.interpreters.erlangR19</literal>.
-  </para>
-
-  <para xml:id="erlang-call-package">
-   We also provide the lambda,
-   <literal>beam.packages.erlang.callPackage</literal>, which simplifies
-   writing BEAM package definitions by injecting all packages from
-   <literal>beam.packages.erlang</literal> into the top-level context.
-  </para>
- </section>
-
- <section xml:id="build-tools">
-  <title>Build Tools</title>
-
-  <section xml:id="build-tools-rebar3">
-   <title>Rebar3</title>
-
-   <para>
-    By default, Rebar3 wants to manage its own dependencies. This is perfectly
-    acceptable in the normal, non-Nix setup, but in the Nix world, it is not.
-    To rectify this, we provide two versions of Rebar3:
     <itemizedlist>
-     <listitem>
-      <para>
-       <literal>rebar3</literal>: patched to remove the ability to download
-       anything. When not running it via <literal>nix-shell</literal> or
-       <literal>nix-build</literal>, it's probably not going to work as
-       desired.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal>rebar3-open</literal>: the normal, unmodified Rebar3. It should
-       work exactly as would any other version of Rebar3. Any Erlang package
-       should rely on <literal>rebar3</literal> instead. See
-       <xref
-            linkend="rebar3-packages"/>.
-      </para>
-     </listitem>
+      <listitem>
+        <para>
+          <literal>interpreters</literal>: a set of compilers running on the
+          BEAM, including multiple Erlang/OTP versions
+          (<literal>beam.interpreters.erlangR19</literal>, etc), Elixir
+          (<literal>beam.interpreters.elixir</literal>) and LFE
+          (<literal>beam.interpreters.lfe</literal>).
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <literal>packages</literal>: a set of package sets, each compiled with
+          a specific Erlang/OTP version, e.g.
+          <literal>beam.packages.erlangR19</literal>.
+        </para>
+      </listitem>
     </itemizedlist>
-   </para>
+    <para>
+      The default Erlang compiler, defined by
+      <literal>beam.interpreters.erlang</literal>, is aliased as
+      <literal>erlang</literal>. The default BEAM package set is defined by
+      <literal>beam.packages.erlang</literal> and aliased at the top level as
+      <literal>beamPackages</literal>.
+    </para>
+    <para>
+      To create a package set built with a custom Erlang version, use the
+      lambda, <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP
+      derivation and produces a package set similar to
+      <literal>beam.packages.erlang</literal>.
+    </para>
+    <para>
+      Many Erlang/OTP distributions available in
+      <literal>beam.interpreters</literal> have versions with ODBC and/or Java
+      enabled. For example, there's
+      <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which
+      corresponds to <literal>beam.interpreters.erlangR19</literal>.
+    </para>
+    <para xml:id="erlang-call-package">
+      We also provide the lambda,
+      <literal>beam.packages.erlang.callPackage</literal>, which simplifies
+      writing BEAM package definitions by injecting all packages from
+      <literal>beam.packages.erlang</literal> into the top-level context.
+    </para>
+  </section>
+  <section xml:id="build-tools">
+  <title>Build Tools</title>
+  <section xml:id="build-tools-rebar3">
+    <title>Rebar3</title>
+    <para>
+      By default, Rebar3 wants to manage its own dependencies. This is perfectly
+      acceptable in the normal, non-Nix setup, but in the Nix world, it is not.
+      To rectify this, we provide two versions of Rebar3:
+      <itemizedlist>
+        <listitem>
+          <para>
+            <literal>rebar3</literal>: patched to remove the ability to download
+            anything. When not running it via <literal>nix-shell</literal> or
+            <literal>nix-build</literal>, it's probably not going to work as
+            desired.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <literal>rebar3-open</literal>: the normal, unmodified Rebar3. It
+            should work exactly as would any other version of Rebar3. Any Erlang
+            package should rely on <literal>rebar3</literal> instead. See <xref
+            linkend="rebar3-packages"/>.
+          </para>
+        </listitem>
+      </itemizedlist>
+    </para>
   </section>
-
   <section xml:id="build-tools-other">
-   <title>Mix &amp; Erlang.mk</title>
-
-   <para>
-    Both Mix and Erlang.mk work exactly as expected. There is a bootstrap
-    process that needs to be run for both, however, which is supported by the
-    <literal>buildMix</literal> and <literal>buildErlangMk</literal>
-    derivations, respectively.
-   </para>
+    <title>Mix &amp; Erlang.mk</title>
+    <para>
+      Both Mix and Erlang.mk work exactly as expected. There is a bootstrap
+      process that needs to be run for both, however, which is supported by the
+      <literal>buildMix</literal> and <literal>buildErlangMk</literal>
+      derivations, respectively.
+    </para>
   </section>
- </section>
+</section>
 
- <section xml:id="how-to-install-beam-packages">
+<section xml:id="how-to-install-beam-packages">
   <title>How to Install BEAM Packages</title>
-
   <para>
-   BEAM packages are not registered at the top level, simply because they are
-   not relevant to the vast majority of Nix users. They are installable using
-   the <literal>beam.packages.erlang</literal> attribute set (aliased as
-   <literal>beamPackages</literal>), which points to packages built by the
-   default Erlang/OTP version in Nixpkgs, as defined by
-   <literal>beam.interpreters.erlang</literal>. To list the available packages
-   in <literal>beamPackages</literal>, use the following command:
+    BEAM packages are not registered at the top level, simply because they are
+    not relevant to the vast majority of Nix users. They are installable using
+    the <literal>beam.packages.erlang</literal> attribute set (aliased as
+    <literal>beamPackages</literal>), which points to packages built by the
+    default Erlang/OTP version in Nixpkgs, as defined by
+    <literal>beam.interpreters.erlang</literal>.
+
+    To list the available packages in
+    <literal>beamPackages</literal>, use the following command:
   </para>
 
-<programlisting>
+  <programlisting>
 $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -qaP -A beamPackages
 beamPackages.esqlite    esqlite-0.2.1
 beamPackages.goldrush   goldrush-0.1.7
@@ -141,43 +128,34 @@ beamPackages.lager      lager-3.0.2
 beamPackages.meck       meck-0.8.3
 beamPackages.rebar3-pc  pc-1.1.0
   </programlisting>
-
   <para>
-   To install any of those packages into your profile, refer to them by their
-   attribute path (first column):
+    To install any of those packages into your profile, refer to them by their
+    attribute path (first column):
   </para>
-
-<programlisting>
+  <programlisting>
 $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
   </programlisting>
-
   <para>
-   The attribute path of any BEAM package corresponds to the name of that
-   particular package in <link xlink:href="https://hex.pm">Hex</link> or its
-   OTP Application/Release name.
+    The attribute path of any BEAM package corresponds to the name of that
+    particular package in <link xlink:href="https://hex.pm">Hex</link> or its
+    OTP Application/Release name.
   </para>
- </section>
-
- <section xml:id="packaging-beam-applications">
+</section>
+<section xml:id="packaging-beam-applications">
   <title>Packaging BEAM Applications</title>
-
   <section  xml:id="packaging-erlang-applications">
-   <title>Erlang Applications</title>
-
-   <section xml:id="rebar3-packages">
-    <title>Rebar3 Packages</title>
-
-    <para>
-     The Nix function, <literal>buildRebar3</literal>, defined in
-     <literal>beam.packages.erlang.buildRebar3</literal> and aliased at the top
-     level, can be used to build a derivation that understands how to build a
-     Rebar3 project. For example, we can build
-     <link
-        xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>
-     as follows:
-    </para>
-
-<programlisting>
+    <title>Erlang Applications</title>
+    <section xml:id="rebar3-packages">
+      <title>Rebar3 Packages</title>
+      <para>
+        The Nix function, <literal>buildRebar3</literal>, defined in
+        <literal>beam.packages.erlang.buildRebar3</literal> and aliased at the
+        top level, can be used to build a derivation that understands how to
+        build a Rebar3 project. For example, we can build <link
+        xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> as
+        follows:
+      </para>
+      <programlisting>
         { stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }:
 
         buildRebar3 rec {
@@ -194,40 +172,33 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
           beamDeps = [ ibrowse jsx erlware_commons ];
         }
       </programlisting>
-
-    <para>
-     Such derivations are callable with
-     <literal>beam.packages.erlang.callPackage</literal> (see
-     <xref
-        linkend="erlang-call-package"/>). To call this package using
-     the normal <literal>callPackage</literal>, refer to dependency packages
-     via <literal>beamPackages</literal>, e.g.
-     <literal>beamPackages.ibrowse</literal>.
-    </para>
-
-    <para>
-     Notably, <literal>buildRebar3</literal> includes
-     <literal>beamDeps</literal>, while <literal>stdenv.mkDerivation</literal>
-     does not. BEAM dependencies added there will be correctly handled by the
-     system.
-    </para>
-
-    <para>
-     If a package needs to compile native code via Rebar3's port compilation
-     mechanism, add <literal>compilePort = true;</literal> to the derivation.
-    </para>
-   </section>
-
-   <section xml:id="erlang-mk-packages">
-    <title>Erlang.mk Packages</title>
-
-    <para>
-     Erlang.mk functions similarly to Rebar3, except we use
-     <literal>buildErlangMk</literal> instead of
-     <literal>buildRebar3</literal>.
-    </para>
-
-<programlisting>
+      <para>
+        Such derivations are callable with
+        <literal>beam.packages.erlang.callPackage</literal> (see <xref
+        linkend="erlang-call-package"/>). To call this package using the normal
+        <literal>callPackage</literal>, refer to dependency packages via
+        <literal>beamPackages</literal>, e.g.
+        <literal>beamPackages.ibrowse</literal>.
+      </para>
+      <para>
+        Notably, <literal>buildRebar3</literal> includes
+        <literal>beamDeps</literal>, while
+        <literal>stdenv.mkDerivation</literal> does not. BEAM dependencies added
+        there will be correctly handled by the system.
+      </para>
+      <para>
+        If a package needs to compile native code via Rebar3's port compilation
+        mechanism, add <literal>compilePort = true;</literal> to the derivation.
+      </para>
+    </section>
+    <section xml:id="erlang-mk-packages">
+      <title>Erlang.mk Packages</title>
+      <para>
+        Erlang.mk functions similarly to Rebar3, except we use
+        <literal>buildErlangMk</literal> instead of
+        <literal>buildRebar3</literal>.
+      </para>
+      <programlisting>
         { buildErlangMk, fetchHex, cowlib, ranch }:
 
         buildErlangMk {
@@ -251,17 +222,14 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
           };
         }
       </programlisting>
-   </section>
-
-   <section xml:id="mix-packages">
-    <title>Mix Packages</title>
-
-    <para>
-     Mix functions similarly to Rebar3, except we use
-     <literal>buildMix</literal> instead of <literal>buildRebar3</literal>.
-    </para>
-
-<programlisting>
+    </section>
+    <section xml:id="mix-packages">
+      <title>Mix Packages</title>
+      <para>
+        Mix functions similarly to Rebar3, except we use
+        <literal>buildMix</literal> instead of <literal>buildRebar3</literal>.
+      </para>
+      <programlisting>
         { buildMix, fetchHex, plug, absinthe }:
 
         buildMix {
@@ -285,12 +253,10 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
           };
         }
       </programlisting>
-
-    <para>
-     Alternatively, we can use <literal>buildHex</literal> as a shortcut:
-    </para>
-
-<programlisting>
+      <para>
+        Alternatively, we can use <literal>buildHex</literal> as a shortcut:
+      </para>
+      <programlisting>
         { buildHex, buildMix, plug, absinthe }:
 
         buildHex {
@@ -312,25 +278,21 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
          };
        }
       </programlisting>
-   </section>
+    </section>
   </section>
- </section>
-
- <section xml:id="how-to-develop">
+</section>
+<section xml:id="how-to-develop">
   <title>How to Develop</title>
-
   <section xml:id="accessing-an-environment">
-   <title>Accessing an Environment</title>
-
-   <para>
-    Often, we simply want to access a valid environment that contains a
-    specific package and its dependencies. We can accomplish that with the
-    <literal>env</literal> attribute of a derivation. For example, let's say we
-    want to access an Erlang REPL with <literal>ibrowse</literal> loaded up. We
-    could do the following:
-   </para>
-
-<programlisting>
+    <title>Accessing an Environment</title>
+    <para>
+      Often, we simply want to access a valid environment that contains a
+      specific package and its dependencies. We can accomplish that with the
+      <literal>env</literal> attribute of a derivation. For example, let's say
+      we want to access an Erlang REPL with <literal>ibrowse</literal> loaded
+      up. We could do the following:
+    </para>
+    <programlisting>
       $ nix-shell -A beamPackages.ibrowse.env --run "erl"
       Erlang/OTP 18 [erts-7.0] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false]
 
@@ -371,25 +333,22 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
       ok
       2>
     </programlisting>
-
-   <para>
-    Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key
-    to this functionality.
-   </para>
+    <para>
+      Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key
+      to this functionality.
+    </para>
   </section>
-
   <section xml:id="creating-a-shell">
-   <title>Creating a Shell</title>
-
-   <para>
-    Getting access to an environment often isn't enough to do real development.
-    Usually, we need to create a <literal>shell.nix</literal> file and do our
-    development inside of the environment specified therein. This file looks a
-    lot like the packaging described above, except that <literal>src</literal>
-    points to the project root and we call the package directly.
-   </para>
-
-<programlisting>
+    <title>Creating a Shell</title>
+    <para>
+      Getting access to an environment often isn't enough to do real
+      development. Usually, we need to create a <literal>shell.nix</literal>
+      file and do our development inside of the environment specified therein.
+      This file looks a lot like the packaging described above, except that
+      <literal>src</literal> points to the project root and we call the package
+      directly.
+    </para>
+    <programlisting>
 { pkgs ? import &quot;&lt;nixpkgs&quot;&gt; {} }:
 
 with pkgs;
@@ -409,16 +368,13 @@ in
 
   drv
     </programlisting>
-
-   <section xml:id="building-in-a-shell">
+    <section xml:id="building-in-a-shell">
     <title>Building in a Shell (for Mix Projects)</title>
-
     <para>
-     We can leverage the support of the derivation, irrespective of the build
-     derivation, by calling the commands themselves.
+      We can leverage the support of the derivation, irrespective of the build
+      derivation, by calling the commands themselves.
     </para>
-
-<programlisting>
+    <programlisting>
 # =============================================================================
 # Variables
 # =============================================================================
@@ -475,54 +431,44 @@ analyze: build plt
         $(NIX_SHELL) --run "mix dialyzer --no-compile"
 
     </programlisting>
-
     <para>
-     Using a <literal>shell.nix</literal> as described (see
-     <xref
+      Using a <literal>shell.nix</literal> as described (see <xref
       linkend="creating-a-shell"/>) should just work. Aside from
-     <literal>test</literal>, <literal>plt</literal>, and
-     <literal>analyze</literal>, the Make targets work just fine for all of the
-     build derivations.
+      <literal>test</literal>, <literal>plt</literal>, and
+      <literal>analyze</literal>, the Make targets work just fine for all of the
+      build derivations.
     </para>
-   </section>
   </section>
- </section>
-
- <section xml:id="generating-packages-from-hex-with-hex2nix">
+</section>
+</section>
+<section xml:id="generating-packages-from-hex-with-hex2nix">
   <title>Generating Packages from Hex with <literal>hex2nix</literal></title>
-
   <para>
-   Updating the <link xlink:href="https://hex.pm">Hex</link> package set
-   requires
-   <link
-    xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>.
-   Given the path to the Erlang modules (usually
-   <literal>pkgs/development/erlang-modules</literal>), it will dump a file
-   called <literal>hex-packages.nix</literal>, containing all the packages that
-   use a recognized build system in
-   <link
-    xlink:href="https://hex.pm">Hex</link>. It can't be determined,
-   however, whether every package is buildable.
-  </para>
-
-  <para>
-   To make life easier for our users, try to build every
-   <link
-      xlink:href="https://hex.pm">Hex</link> package and remove those
-   that fail. To do that, simply run the following command in the root of your
-   <literal>nixpkgs</literal> repository:
-  </para>
-
-<programlisting>
+    Updating the <link xlink:href="https://hex.pm">Hex</link> package set
+    requires <link
+    xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>. Given the
+    path to the Erlang modules (usually
+    <literal>pkgs/development/erlang-modules</literal>), it will dump a file
+    called <literal>hex-packages.nix</literal>, containing all the packages that
+    use a recognized build system in <link
+    xlink:href="https://hex.pm">Hex</link>. It can't be determined, however,
+    whether every package is buildable.
+    </para>
+    <para>
+      To make life easier for our users, try to build every <link
+      xlink:href="https://hex.pm">Hex</link> package and remove those that fail.
+      To do that, simply run the following command in the root of your
+      <literal>nixpkgs</literal> repository:
+    </para>
+    <programlisting>
 $ nix-build -A beamPackages
     </programlisting>
-
-  <para>
-   That will attempt to build every package in <literal>beamPackages</literal>.
-   Then manually remove those that fail. Hopefully, someone will improve
-   <link
-      xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>
-   in the future to automate the process.
-  </para>
- </section>
+    <para>
+      That will attempt to build every package in
+      <literal>beamPackages</literal>. Then manually remove those that fail.
+      Hopefully, someone will improve <link
+      xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> in the
+      future to automate the process.
+    </para>
+</section>
 </section>

doc/languages-frameworks/bower.xml

@@ -1,37 +1,40 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-bower">
- <title>Bower</title>
 
- <para>
-  <link xlink:href="http://bower.io">Bower</link> is a package manager for web
-  site front-end components. Bower packages (comprising of build artefacts and
-  sometimes sources) are stored in <command>git</command> repositories,
-  typically on Github. The package registry is run by the Bower team with
-  package metadata coming from the <filename>bower.json</filename> file within
-  each package.
- </para>
+<title>Bower</title>
 
- <para>
-  The end result of running Bower is a <filename>bower_components</filename>
-  directory which can be included in the web app's build process.
- </para>
+<para>
+  <link xlink:href="http://bower.io">Bower</link> is a package manager
+  for web site front-end components. Bower packages (comprising of
+  build artefacts and sometimes sources) are stored in
+  <command>git</command> repositories, typically on Github. The
+  package registry is run by the Bower team with package metadata
+  coming from the <filename>bower.json</filename> file within each
+  package.
+</para>
 
- <para>
+<para>
+  The end result of running Bower is a
+  <filename>bower_components</filename> directory which can be included
+  in the web app's build process.
+</para>
+
+<para>
   Bower can be run interactively, by installing
   <varname>nodePackages.bower</varname>. More interestingly, the Bower
   components can be declared in a Nix derivation, with the help of
   <varname>nodePackages.bower2nix</varname>.
- </para>
+</para>
 
- <section xml:id="ssec-bower2nix-usage">
+<section xml:id="ssec-bower2nix-usage">
   <title><command>bower2nix</command> usage</title>
 
-  <para>
-   Suppose you have a <filename>bower.json</filename> with the following
-   contents:
-   <example xml:id="ex-bowerJson">
-    <title><filename>bower.json</filename></title>
+<para>
+  Suppose you have a <filename>bower.json</filename> with the following contents:
+
+
+<example xml:id="ex-bowerJson"><title><filename>bower.json</filename></title>
 <programlisting language="json">
 <![CDATA[{
   "name": "my-web-app",
@@ -41,12 +44,14 @@
   }
 }]]>
 </programlisting>
-   </example>
-  </para>
+</example>
+</para>
+
+
+<para>
+  Running <command>bower2nix</command> will produce something like the
+  following output:
 
-  <para>
-   Running <command>bower2nix</command> will produce something like the
-   following output:
 <programlisting language="nix">
 <![CDATA[{ fetchbower, buildEnv }:
 buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [
@@ -55,31 +60,31 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [
   (fetchbower "jquery" "2.2.2" "1.9.1 - 2" "10sp5h98sqwk90y4k6hbdviwqzvzwqf47r3r51pakch5ii2y7js1")
 ]; }]]>
 </programlisting>
-  </para>
+</para>
+
+
+<para>
+  Using the <command>bower2nix</command> command line arguments, the
+  output can be redirected to a file. A name like
+  <filename>bower-packages.nix</filename> would be fine.
+</para>
+
+<para>
+  The resulting derivation is a union of all the downloaded Bower
+  packages (and their dependencies). To use it, they still need to be
+  linked together by Bower, which is where
+  <varname>buildBowerComponents</varname> is useful.
+</para>
+</section>
+
+<section xml:id="ssec-build-bower-components"><title><varname>buildBowerComponents</varname> function</title>
 
   <para>
-   Using the <command>bower2nix</command> command line arguments, the output
-   can be redirected to a file. A name like
-   <filename>bower-packages.nix</filename> would be fine.
-  </para>
+  The function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix">
+  <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>.
+  Example usage:
 
-  <para>
-   The resulting derivation is a union of all the downloaded Bower packages
-   (and their dependencies). To use it, they still need to be linked together
-   by Bower, which is where <varname>buildBowerComponents</varname> is useful.
-  </para>
- </section>
-
- <section xml:id="ssec-build-bower-components">
-  <title><varname>buildBowerComponents</varname> function</title>
-
-  <para>
-   The function is implemented in
-   <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix">
-   <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>.
-   Example usage:
-   <example xml:id="ex-buildBowerComponents">
-    <title>buildBowerComponents</title>
+<example xml:id="ex-buildBowerComponents"><title>buildBowerComponents</title>
 <programlisting language="nix">
 bowerComponents = buildBowerComponents {
   name = "my-web-app";
@@ -87,42 +92,42 @@ bowerComponents = buildBowerComponents {
   src = myWebApp; <co xml:id="ex-buildBowerComponents-2" />
 };
 </programlisting>
-   </example>
+</example>
   </para>
 
-  <para>
-   In <xref linkend="ex-buildBowerComponents" />, the following arguments are
-   of special significance to the function:
-   <calloutlist>
-    <callout arearefs="ex-buildBowerComponents-1">
-     <para>
-      <varname>generated</varname> specifies the file which was created by
-      <command>bower2nix</command>.
-     </para>
-    </callout>
-    <callout arearefs="ex-buildBowerComponents-2">
-     <para>
-      <varname>src</varname> is your project's sources. It needs to contain a
-      <filename>bower.json</filename> file.
-     </para>
-    </callout>
-   </calloutlist>
-  </para>
+<para>
+In <xref linkend="ex-buildBowerComponents" />, the following arguments
+are of special significance to the function:
 
-  <para>
-   <varname>buildBowerComponents</varname> will run Bower to link together the
-   output of <command>bower2nix</command>, resulting in a
-   <filename>bower_components</filename> directory which can be used.
-  </para>
+<calloutlist>
+  <callout arearefs="ex-buildBowerComponents-1">
+    <para>
+      <varname>generated</varname> specifies the file which was created by <command>bower2nix</command>.
+    </para>
+  </callout>
 
-  <para>
-   Here is an example of a web frontend build process using
-   <command>gulp</command>. You might use <command>grunt</command>, or anything
-   else.
-  </para>
+  <callout arearefs="ex-buildBowerComponents-2">
+    <para>
+      <varname>src</varname> is your project's sources. It needs to
+      contain a <filename>bower.json</filename> file.
+    </para>
+  </callout>
+</calloutlist>
+</para>
 
-  <example xml:id="ex-bowerGulpFile">
-   <title>Example build script (<filename>gulpfile.js</filename>)</title>
+<para>
+  <varname>buildBowerComponents</varname> will run Bower to link
+  together the output of <command>bower2nix</command>, resulting in a
+  <filename>bower_components</filename> directory which can be used.
+</para>
+
+<para>
+  Here is an example of a web frontend build process using
+  <command>gulp</command>. You might use <command>grunt</command>, or
+  anything else.
+</para>
+
+<example xml:id="ex-bowerGulpFile"><title>Example build script (<filename>gulpfile.js</filename>)</title>
 <programlisting language="javascript">
 <![CDATA[var gulp = require('gulp');
 
@@ -137,10 +142,10 @@ gulp.task('build', [], function () {
     .pipe(gulp.dest("./gulpdist/"));
 });]]>
 </programlisting>
-  </example>
+</example>
 
-  <example xml:id="ex-buildBowerComponentsDefaultNix">
-   <title>Full example — <filename>default.nix</filename></title>
+<example xml:id="ex-buildBowerComponentsDefaultNix">
+  <title>Full example — <filename>default.nix</filename></title>
 <programlisting language="nix">
 { myWebApp ? { outPath = ./.; name = "myWebApp"; }
 , pkgs ? import &lt;nixpkgs&gt; {}
@@ -167,63 +172,73 @@ pkgs.stdenv.mkDerivation {
   installPhase = "mv gulpdist $out";
 }
 </programlisting>
-  </example>
+</example>
 
-  <para>
-   A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />:
-   <calloutlist>
-    <callout arearefs="ex-buildBowerComponentsDefault-1">
-     <para>
-      The result of <varname>buildBowerComponents</varname> is an input to the
-      frontend build.
-     </para>
-    </callout>
-    <callout arearefs="ex-buildBowerComponentsDefault-2">
-     <para>
-      Whether to symlink or copy the <filename>bower_components</filename>
-      directory depends on the build tool in use. In this case a copy is used
-      to avoid <command>gulp</command> silliness with permissions.
-     </para>
-    </callout>
-    <callout arearefs="ex-buildBowerComponentsDefault-3">
-     <para>
-      <command>gulp</command> requires <varname>HOME</varname> to refer to a
-      writeable directory.
-     </para>
-    </callout>
-    <callout arearefs="ex-buildBowerComponentsDefault-4">
-     <para>
+<para>
+A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />:
+
+<calloutlist>
+  <callout arearefs="ex-buildBowerComponentsDefault-1">
+    <para>
+      The result of <varname>buildBowerComponents</varname> is an
+      input to the frontend build.
+    </para>
+  </callout>
+
+  <callout arearefs="ex-buildBowerComponentsDefault-2">
+    <para>
+      Whether to symlink or copy the
+      <filename>bower_components</filename> directory depends on the
+      build tool in use. In this case a copy is used to avoid
+      <command>gulp</command> silliness with permissions.
+    </para>
+  </callout>
+
+  <callout arearefs="ex-buildBowerComponentsDefault-3">
+    <para>
+      <command>gulp</command> requires <varname>HOME</varname> to
+      refer to a writeable directory.
+    </para>
+  </callout>
+
+  <callout arearefs="ex-buildBowerComponentsDefault-4">
+    <para>
       The actual build command. Other tools could be used.
-     </para>
-    </callout>
-   </calloutlist>
-  </para>
- </section>
+    </para>
+  </callout>
+</calloutlist>
+</para>
+</section>
 
- <section xml:id="ssec-bower2nix-troubleshooting">
+<section xml:id="ssec-bower2nix-troubleshooting">
   <title>Troubleshooting</title>
 
-  <variablelist>
-   <varlistentry>
+<variablelist>
+
+  <varlistentry>
     <term>
-     <literal>ENOCACHE</literal> errors from <varname>buildBowerComponents</varname>
+    <literal>ENOCACHE</literal> errors from
+    <varname>buildBowerComponents</varname>
     </term>
     <listitem>
-     <para>
-      This means that Bower was looking for a package version which doesn't
-      exist in the generated <filename>bower-packages.nix</filename>.
-     </para>
-     <para>
-      If <filename>bower.json</filename> has been updated, then run
-      <command>bower2nix</command> again.
-     </para>
-     <para>
-      It could also be a bug in <command>bower2nix</command> or
-      <command>fetchbower</command>. If possible, try reformulating the version
-      specification in <filename>bower.json</filename>.
-     </para>
+      <para>
+        This means that Bower was looking for a package version which
+        doesn't exist in the generated
+        <filename>bower-packages.nix</filename>.
+      </para>
+      <para>
+        If <filename>bower.json</filename> has been updated, then run
+        <command>bower2nix</command> again.
+      </para>
+      <para>
+        It could also be a bug in <command>bower2nix</command> or
+        <command>fetchbower</command>. If possible, try reformulating
+        the version specification in <filename>bower.json</filename>.
+      </para>
     </listitem>
-   </varlistentry>
-  </variablelist>
- </section>
+  </varlistentry>
+</variablelist>
+
+</section>
+
 </section>

doc/languages-frameworks/coq.xml

@@ -1,38 +1,36 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-coq">
- <title>Coq</title>
 
- <para>
-  Coq libraries should be installed in
-  <literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>. Such
-  directories are automatically added to the <literal>$COQPATH</literal>
-  environment variable by the hook defined in the Coq derivation.
- </para>
-
- <para>
-  Some libraries require OCaml and sometimes also Camlp5 or findlib. The exact
-  versions that were used to build Coq are saved in the
-  <literal>coq.ocaml</literal> and <literal>coq.camlp5</literal> and
-  <literal>coq.findlib</literal> attributes.
- </para>
-
- <para>
-  Coq libraries may be compatible with some specific versions of Coq only. The
-  <literal>compatibleCoqVersions</literal> attribute is used to precisely
-  select those versions of Coq that are compatible with this derivation.
- </para>
-
- <para>
-  Here is a simple package example. It is a pure Coq library, thus it depends
-  on Coq. It builds on the Mathematical Components library, thus it also takes
-  <literal>mathcomp</literal> as <literal>buildInputs</literal>. Its
-  <literal>Makefile</literal> has been generated using
-  <literal>coq_makefile</literal> so we only have to set the
-  <literal>$COQLIB</literal> variable at install time.
- </para>
-
-<programlisting>
+<title>Coq</title>
+  <para>
+    Coq libraries should be installed in
+    <literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>.
+    Such directories are automatically added to the
+    <literal>$COQPATH</literal> environment variable by the hook defined
+    in the Coq derivation.
+  </para>
+  <para>
+    Some libraries require OCaml and sometimes also Camlp5 or findlib.
+    The exact versions that were used to build Coq are saved in the
+    <literal>coq.ocaml</literal> and <literal>coq.camlp5</literal>
+    and <literal>coq.findlib</literal> attributes.
+  </para>
+  <para>
+    Coq libraries may be compatible with some specific versions of Coq only.
+    The <literal>compatibleCoqVersions</literal> attribute is used to
+    precisely select those versions of Coq that are compatible with this
+    derivation.
+  </para>
+  <para>
+    Here is a simple package example. It is a pure Coq library, thus it
+    depends on Coq. It builds on the Mathematical Components library, thus it
+    also takes <literal>mathcomp</literal> as <literal>buildInputs</literal>.
+    Its <literal>Makefile</literal> has been generated using
+    <literal>coq_makefile</literal> so we only have to
+    set the <literal>$COQLIB</literal> variable at install time.
+  </para>
+  <programlisting>
 { stdenv, fetchFromGitHub, coq, mathcomp }:
 
 stdenv.mkDerivation rec {

doc/languages-frameworks/emscripten.section.md

@@ -1,185 +0,0 @@
-# User's Guide to Emscripten in Nixpkgs
-
-[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler
-
-This section of the manual covers how to use `emscripten` in nixpkgs.
-
-Minimal requirements:
-
-* nix
-* nixpkgs
-
-Modes of use of `emscripten`:
-
-* **Imperative usage** (on the command line):
-
-   If you want to work with `emcc`, `emconfigure` and `emmake` as you are used to from Ubuntu and similar distributions you can use these commands:
-
-    * `nix-env -i emscripten`
-    * `nix-shell -p emscripten`
-
-* **Declarative usage**:
-
-    This mode is far more power full since this makes use of `nix` for dependency management of emscripten libraries and targets by using the `mkDerivation` which is implemented by `pkgs.emscriptenStdenv` and `pkgs.buildEmscriptenPackage`. The source for the packages is in `pkgs/top-level/emscripten-packages.nix` and the abstraction behind it in `pkgs/development/em-modules/generic/default.nix`.
-    * build and install all packages: 
-        * `nix-env -iA emscriptenPackages` 
-          
-    * dev-shell for zlib implementation hacking: 
-        * `nix-shell -A emscriptenPackages.zlib` 
-
-
-## Imperative usage
-
-A few things to note:
-
-* `export EMCC_DEBUG=2` is nice for debugging
-* `~/.emscripten`, the build artifact cache sometimes creates issues and needs to be removed from time to time
-
-
-## Declarative usage
-
-Let's see two different examples from `pkgs/top-level/emscripten-packages.nix`:
-
-* `pkgs.zlib.override`
-* `pkgs.buildEmscriptenPackage`
-
-Both are interesting concepts.
-
-A special requirement of the `pkgs.buildEmscriptenPackage` is the `doCheck = true` is a default meaning that each emscriptenPackage requires a `checkPhase` implemented.
-
-* Use `export EMCC_DEBUG=2` from within a emscriptenPackage's `phase` to get more detailed debug output what is going wrong.
-* ~/.emscripten cache is requiring us to set `HOME=$TMPDIR` in individual phases. This makes compilation slower but also makes it more deterministic.
-
-### Usage 1: pkgs.zlib.override
-
-This example uses `zlib` from nixpkgs but instead of compiling **C** to **ELF** it compiles **C** to **JS** since we were using `pkgs.zlib.override` and changed stdenv to `pkgs.emscriptenStdenv`. A few adaptions and hacks were set in place to make it working. One advantage is that when `pkgs.zlib` is updated, it will automatically update this package as well. However, this can also be the downside...
-
-See the `zlib` example:
-
-    zlib = (pkgs.zlib.override {
-      stdenv = pkgs.emscriptenStdenv;
-    }).overrideDerivation
-    (old: rec {
-      buildInputs = old.buildInputs ++ [ pkgconfig ];
-      # we need to reset this setting!
-      NIX_CFLAGS_COMPILE="";
-      configurePhase = ''
-        # FIXME: Some tests require writing at $HOME
-        HOME=$TMPDIR
-        runHook preConfigure
-
-        #export EMCC_DEBUG=2
-        emconfigure ./configure --prefix=$out --shared
-
-        runHook postConfigure
-      '';
-      dontStrip = true;
-      outputs = [ "out" ];
-      buildPhase = ''
-        emmake make
-      '';
-      installPhase = ''
-        emmake make install
-      '';
-      checkPhase = ''
-        echo "================= testing zlib using node ================="
-
-        echo "Compiling a custom test"
-        set -x
-        emcc -O2 -s EMULATE_FUNCTION_POINTER_CASTS=1 test/example.c -DZ_SOLO \
-        libz.so.${old.version} -I . -o example.js
-
-        echo "Using node to execute the test"
-        ${pkgs.nodejs}/bin/node ./example.js 
-
-        set +x
-        if [ $? -ne 0 ]; then
-          echo "test failed for some reason"
-          exit 1;
-        else
-          echo "it seems to work! very good."
-        fi
-        echo "================= /testing zlib using node ================="
-      '';
-
-      postPatch = pkgs.stdenv.lib.optionalString pkgs.stdenv.isDarwin ''
-        substituteInPlace configure \
-          --replace '/usr/bin/libtool' 'ar' \
-          --replace 'AR="libtool"' 'AR="ar"' \
-          --replace 'ARFLAGS="-o"' 'ARFLAGS="-r"'
-      '';
-    });
-
-### Usage 2: pkgs.buildEmscriptenPackage
-
-This `xmlmirror` example features a emscriptenPackage which is defined completely from this context and no `pkgs.zlib.override` is used. 
-
-    xmlmirror = pkgs.buildEmscriptenPackage rec {
-      name = "xmlmirror";
-
-      buildInputs = [ pkgconfig autoconf automake libtool gnumake libxml2 nodejs openjdk json_c ];
-      nativeBuildInputs = [ pkgconfig zlib ];
-
-      src = pkgs.fetchgit {
-        url = "https://gitlab.com/odfplugfest/xmlmirror.git";
-        rev = "4fd7e86f7c9526b8f4c1733e5c8b45175860a8fd";
-        sha256 = "1jasdqnbdnb83wbcnyrp32f36w3xwhwp0wq8lwwmhqagxrij1r4b";
-      };
-
-      configurePhase = ''
-        rm -f fastXmlLint.js*
-        # a fix for ERROR:root:For asm.js, TOTAL_MEMORY must be a multiple of 16MB, was 234217728
-        # https://gitlab.com/odfplugfest/xmlmirror/issues/8
-        sed -e "s/TOTAL_MEMORY=234217728/TOTAL_MEMORY=268435456/g" -i Makefile.emEnv
-        # https://github.com/kripken/emscripten/issues/6344
-        # https://gitlab.com/odfplugfest/xmlmirror/issues/9
-        sed -e "s/\$(JSONC_LDFLAGS) \$(ZLIB_LDFLAGS) \$(LIBXML20_LDFLAGS)/\$(JSONC_LDFLAGS) \$(LIBXML20_LDFLAGS) \$(ZLIB_LDFLAGS) /g" -i Makefile.emEnv
-        # https://gitlab.com/odfplugfest/xmlmirror/issues/11
-        sed -e "s/-o fastXmlLint.js/-s EXTRA_EXPORTED_RUNTIME_METHODS='[\"ccall\", \"cwrap\"]' -o fastXmlLint.js/g" -i Makefile.emEnv
-      '';
-
-      buildPhase = ''
-        HOME=$TMPDIR
-        make -f Makefile.emEnv
-      '';
-
-      outputs = [ "out" "doc" ];
-
-      installPhase = ''
-        mkdir -p $out/share
-        mkdir -p $doc/share/${name}
-
-        cp Demo* $out/share
-        cp -R codemirror-5.12 $out/share
-        cp fastXmlLint.js* $out/share
-        cp *.xsd $out/share
-        cp *.js $out/share
-        cp *.xhtml $out/share
-        cp *.html $out/share
-        cp *.json $out/share
-        cp *.rng $out/share
-        cp README.md $doc/share/${name}
-      '';
-      checkPhase = ''
-
-      '';
-    }; 
-
-### Declarative debugging
-
-Use `nix-shell -I nixpkgs=/some/dir/nixpkgs -A emscriptenPackages.libz` and from there you can go trough the individual steps. This makes it easy to build a good `unit test` or list the files of the project.
-
-1. `nix-shell -I nixpkgs=/some/dir/nixpkgs -A emscriptenPackages.libz`
-2. `cd /tmp/`
-3. `unpackPhase`
-4. cd libz-1.2.3
-5. `configurePhase`
-6. `buildPhase`
-7. ... happy hacking...
-
-## Summary
-
-Using this toolchain makes it easy to leverage `nix` from NixOS, MacOSX or even Windows (WSL+ubuntu+nix). This toolchain is reproducible, behaves like the rest of the packages from nixpkgs and contains a set of well working examples to learn and adapt from.
-
-If in trouble, ask the maintainers.
-

doc/languages-frameworks/go.xml

@@ -1,14 +1,14 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-go">
- <title>Go</title>
 
- <para>
-  The function <varname>buildGoPackage</varname> builds standard Go programs.
- </para>
+<title>Go</title>
 
- <example xml:id='ex-buildGoPackage'>
-  <title>buildGoPackage</title>
+<para>The function <varname>buildGoPackage</varname> builds
+standard Go programs.
+</para>
+
+<example xml:id='ex-buildGoPackage'><title>buildGoPackage</title>
 <programlisting>
 deis = buildGoPackage rec {
   name = "deis-${version}";
@@ -29,56 +29,55 @@ deis = buildGoPackage rec {
   buildFlags = "--tags release"; <co xml:id='ex-buildGoPackage-4' />
 }
 </programlisting>
- </example>
+</example>
 
- <para>
-  <xref linkend='ex-buildGoPackage'/> is an example expression using
-  buildGoPackage, the following arguments are of special significance to the
-  function:
-  <calloutlist>
-   <callout arearefs='ex-buildGoPackage-1'>
-    <para>
-     <varname>goPackagePath</varname> specifies the package's canonical Go
-     import path.
-    </para>
-   </callout>
-   <callout arearefs='ex-buildGoPackage-2'>
-    <para>
-     <varname>subPackages</varname> limits the builder from building child
-     packages that have not been listed. If <varname>subPackages</varname> is
-     not specified, all child packages will be built.
-    </para>
-    <para>
-     In this example only <literal>github.com/deis/deis/client</literal> will
-     be built.
-    </para>
-   </callout>
-   <callout arearefs='ex-buildGoPackage-3'>
-    <para>
-     <varname>goDeps</varname> is where the Go dependencies of a Go program are
-     listed as a list of package source identified by Go import path. It could
-     be imported as a separate <varname>deps.nix</varname> file for
-     readability. The dependency data structure is described below.
-    </para>
-   </callout>
-   <callout arearefs='ex-buildGoPackage-4'>
-    <para>
-     <varname>buildFlags</varname> is a list of flags passed to the go build
-     command.
-    </para>
-   </callout>
-  </calloutlist>
- </para>
+<para><xref linkend='ex-buildGoPackage'/> is an example expression using buildGoPackage,
+the following arguments are of special significance to the function:
 
- <para>
-  The <varname>goDeps</varname> attribute can be imported from a separate
-  <varname>nix</varname> file that defines which Go libraries are needed and
-  should be included in <varname>GOPATH</varname> for
-  <varname>buildPhase</varname>.
- </para>
+<calloutlist>
 
- <example xml:id='ex-goDeps'>
-  <title>deps.nix</title>
+  <callout arearefs='ex-buildGoPackage-1'>
+    <para>
+      <varname>goPackagePath</varname> specifies the package's canonical Go import path.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-buildGoPackage-2'>
+    <para>
+      <varname>subPackages</varname> limits the builder from building child packages that
+      have not been listed. If <varname>subPackages</varname> is not specified, all child
+      packages will be built.
+    </para>
+    <para>
+      In this example only <literal>github.com/deis/deis/client</literal> will be built.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-buildGoPackage-3'>
+    <para>
+      <varname>goDeps</varname> is where the Go dependencies of a Go program are listed
+      as a list of package source identified by Go import path.
+      It could be imported as a separate <varname>deps.nix</varname> file for
+      readability. The dependency data structure is described below.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-buildGoPackage-4'>
+    <para>
+      <varname>buildFlags</varname> is a list of flags passed to the go build command.
+    </para>
+  </callout>
+
+</calloutlist>
+
+</para>
+
+<para>The <varname>goDeps</varname> attribute can be imported from a separate
+  <varname>nix</varname> file that defines which Go libraries are needed and should
+  be included in <varname>GOPATH</varname> for <varname>buildPhase</varname>.
+</para>
+
+<example xml:id='ex-goDeps'><title>deps.nix</title>
 <programlisting>
 [ <co xml:id='ex-goDeps-1' />
   {
@@ -101,60 +100,67 @@ deis = buildGoPackage rec {
   }
 ]
 </programlisting>
- </example>
+</example>
 
- <para>
-  <calloutlist>
-   <callout arearefs='ex-goDeps-1'>
-    <para>
-     <varname>goDeps</varname> is a list of Go dependencies.
-    </para>
-   </callout>
-   <callout arearefs='ex-goDeps-2'>
-    <para>
-     <varname>goPackagePath</varname> specifies Go package import path.
-    </para>
-   </callout>
-   <callout arearefs='ex-goDeps-3'>
-    <para>
-     <varname>fetch type</varname> that needs to be used to get package source.
-     If <varname>git</varname> is used there should be <varname>url</varname>,
-     <varname>rev</varname> and <varname>sha256</varname> defined next to it.
-    </para>
-   </callout>
-  </calloutlist>
- </para>
+<para>
 
- <para>
-  To extract dependency information from a Go package in automated way use
-  <link xlink:href="https://github.com/kamilchm/go2nix">go2nix</link>. It can
-  produce complete derivation and <varname>goDeps</varname> file for Go
-  programs.
- </para>
+<calloutlist>
 
- <para>
-  <varname>buildGoPackage</varname> produces
-  <xref linkend='chap-multiple-output' xrefstyle="select: title" /> where
-  <varname>bin</varname> includes program binaries. You can test build a Go
-  binary as follows:
-<screen>
+  <callout arearefs='ex-goDeps-1'>
+    <para>
+      <varname>goDeps</varname> is a list of Go dependencies.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-goDeps-2'>
+    <para>
+      <varname>goPackagePath</varname> specifies Go package import path.
+    </para>
+  </callout>
+
+  <callout arearefs='ex-goDeps-3'>
+    <para>
+      <varname>fetch type</varname> that needs to be used to get package source. If <varname>git</varname>
+      is used there should be <varname>url</varname>, <varname>rev</varname> and <varname>sha256</varname>
+      defined next to it.
+    </para>
+  </callout>
+
+</calloutlist>
+
+</para>
+
+<para>To extract dependency information from a Go package in automated way use <link xlink:href="https://github.com/kamilchm/go2nix">go2nix</link>.
+  It can produce complete derivation and <varname>goDeps</varname> file for Go programs.</para>
+
+<para>
+  <varname>buildGoPackage</varname> produces <xref linkend='chap-multiple-output' xrefstyle="select: title" />
+  where <varname>bin</varname> includes program binaries. You can test build a Go binary as follows:
+
+  <screen>
     $ nix-build -A deis.bin
   </screen>
+
   or build all outputs with:
-<screen>
+
+  <screen>
     $ nix-build -A deis.all
   </screen>
-  <varname>bin</varname> output will be installed by default with
-  <varname>nix-env -i</varname> or <varname>systemPackages</varname>.
- </para>
 
- <para>
-  You may use Go packages installed into the active Nix profiles by adding the
-  following to your ~/.bashrc:
+  <varname>bin</varname> output will be installed by default with <varname>nix-env -i</varname>
+  or <varname>systemPackages</varname>.
+
+</para>
+
+<para>
+You may use Go packages installed into the active Nix profiles by adding
+the following to your ~/.bashrc:
+
 <screen>
 for p in $NIX_PROFILES; do
     GOPATH="$p/share/go:$GOPATH"
 done
 </screen>
- </para>
+</para>
+
 </section>

doc/languages-frameworks/haskell.section.md

@@ -312,7 +312,7 @@ For example, installing the following environment
 allows one to browse module documentation index [not too dissimilar to
 this](https://downloads.haskell.org/~ghc/latest/docs/html/libraries/index.html)
 for all the specified packages and their dependencies by directing a browser of
-choice to `~/.nix-profile/share/doc/hoogle/index.html` (or
+choice to `~/.nix-profiles/share/doc/hoogle/index.html` (or
 `/run/current-system/sw/share/doc/hoogle/index.html` in case you put it in
 `environment.systemPackages` in NixOS).
 
@@ -334,29 +334,10 @@ navigate there.
 
 Finally, you can run
 ```shell
-hoogle server --local -p 8080
+hoogle server -p 8080 --local
 ```
 and navigate to http://localhost:8080/ for your own local
-[Hoogle](https://www.haskell.org/hoogle/). The `--local` flag makes the hoogle
-server serve files from your nix store over http, without the flag it will use
-`file://` URIs. Note, however, that Firefox and possibly other browsers
-disallow navigation from `http://` to `file://` URIs for security reasons,
-which might be quite an inconvenience. Versions before v5 did not have this
-flag. See
-[this page](http://kb.mozillazine.org/Links_to_local_pages_do_not_work) for
-workarounds.
-
-For NixOS users there's a service which runs this exact command for you.
-Specify the `packages` you want documentation for and the `haskellPackages` set
-you want them to come from. Add the following to `configuration.nix`.
-
-```nix
-services.hoogle = {
-enable = true;
-packages = (hpkgs: with hpkgs; [text cryptonite]);
-haskellPackages = pkgs.haskellPackages;
-};
-```
+[Hoogle](https://www.haskell.org/hoogle/).
 
 ### How to build a Haskell project using Stack
 
@@ -685,112 +666,6 @@ prefer one built with GHC 7.8.x in the first place. However, for users who
 cannot use GHC 7.10.x at all for some reason, the approach of downgrading to an
 older version might be useful.
 
-### How to override packages in all compiler-specific package sets
-
-In the previous section we learned how to override a package in a single
-compiler-specific package set. You may have some overrides defined that you want
-to use across multiple package sets. To accomplish this you could use the
-technique that we learned in the previous section by repeating the overrides for
-all the compiler-specific package sets. For example:
-
-```nix
-{
-  packageOverrides = super: let self = super.pkgs; in
-  {
-    haskell = super.haskell // {
-      packages = super.haskell.packages // {
-        ghc784 = super.haskell.packages.ghc784.override {
-          overrides = self: super: {
-            my-package = ...;
-            my-other-package = ...;
-          };
-        };
-        ghc822 = super.haskell.packages.ghc784.override {
-          overrides = self: super: {
-            my-package = ...;
-            my-other-package = ...;
-          };
-        };
-        ...
-      };
-    };
-  };
-}
-```
-
-However there's a more convenient way to override all compiler-specific package
-sets at once:
-
-```nix
-{
-  packageOverrides = super: let self = super.pkgs; in
-  {
-    haskell = super.haskell // {
-      packageOverrides = self: super: {
-        my-package = ...;
-        my-other-package = ...;
-      };
-    };
-  };
-}
-```
-
-### How to specify source overrides for your Haskell package
-
-When starting a Haskell project you can use `developPackage`
-to define a derivation for your package at the `root` path
-as well as source override versions for Hackage packages, like so:
-
-```nix
-# default.nix
-{ compilerVersion ? "ghc842" }:
-let
-  # pinning nixpkgs using new Nix 2.0 builtin `fetchGit`
-  pkgs = import (fetchGit (import ./version.nix)) { };
-  compiler = pkgs.haskell.packages."${compilerVersion}";
-  pkg = compiler.developPackage {
-    root = ./.;
-    source-overrides = {
-      # Let's say the GHC 8.4.2 haskellPackages uses 1.6.0.0 and your test suite is incompatible with >= 1.6.0.0
-      HUnit = "1.5.0.0";
-    };
-  };
-in pkg
-```
-
-This could be used in place of a simplified `stack.yaml` defining a Nix
-derivation for your Haskell package.
-
-As you can see this allows you to specify only the source version found on
-Hackage and nixpkgs will take care of the rest.
-
-You can also specify `buildInputs` for your Haskell derivation for packages
-that directly depend on external libraries like so:
-
-```nix
-# default.nix
-{ compilerVersion ? "ghc842" }:
-let
-  # pinning nixpkgs using new Nix 2.0 builtin `fetchGit`
-  pkgs = import (fetchGit (import ./version.nix)) { };
-  compiler = pkgs.haskell.packages."${compilerVersion}";
-  pkg = compiler.developPackage {
-    root = ./.;
-    source-overrides = {
-      HUnit = "1.5.0.0"; # Let's say the GHC 8.4.2 haskellPackages uses 1.6.0.0 and your test suite is incompatible with >= 1.6.0.0
-    };
-  };
-  # in case your package source depends on any libraries directly, not just transitively.
-  buildInputs = [ zlib ];
-in pkg.overrideAttrs(attrs: {
-  buildInputs = attrs.buildInputs ++ buildInputs;
-})
-```
-
-Notice that you will need to override (via `overrideAttrs` or similar) the
-derivation returned by the `developPackage` Nix lambda as there is no `buildInputs`
-named argument you can pass directly into the `developPackage` lambda.
-
 ### How to recover from GHC's infamous non-deterministic library ID bug
 
 GHC and distributed build farms don't get along well:
@@ -814,7 +689,9 @@ might be necessary to purge the local caches that store data from those
 machines to disable these binary channels for the duration of the previous
 command, i.e. by running:
 ```shell
-rm ~/.cache/nix/binary-cache*.sqlite
+rm /nix/var/nix/binary-cache-v3.sqlite
+rm /nix/var/nix/manifests/*
+rm /nix/var/nix/channel-cache/*
 ```
 
 ### Builds on Darwin fail with `math.h` not found
@@ -1047,19 +924,6 @@ As you can see, `packunused` finds out that although the testsuite component has
 no redundant dependencies the library component of `scientific-0.3.5.1` depends
 on `ghc-prim` which is unused in the library.
 
-### Using hackage2nix with nixpkgs
-
-Hackage package derivations are found in the
-[`hackage-packages.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/haskell-modules/hackage-packages.nix)
-file within `nixpkgs` and are used as the initial package set for
-`haskellPackages`. The `hackage-packages.nix` file is not meant to be edited
-by hand, but rather autogenerated by [`hackage2nix`](https://github.com/NixOS/cabal2nix/tree/master/hackage2nix),
-which by default uses the [`configuration-hackage2nix.yaml`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/haskell-modules/configuration-hackage2nix.yaml)
-file to generate all the derivations.
-
-To modify the contents `configuration-hackage2nix.yaml`, follow the
-instructions on [`hackage2nix`](https://github.com/NixOS/cabal2nix/tree/master/hackage2nix).
-
 ## Other resources
 
   - The Youtube video [Nix Loves Haskell](https://www.youtube.com/watch?v=BsBhi_r-OeE)

doc/languages-frameworks/index.xml

@@ -1,31 +1,34 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xml:id="chap-language-support">
- <title>Support for specific programming languages and frameworks</title>
- <para>
-  The <link linkend="chap-stdenv">standard build environment</link> makes it
-  easy to build typical Autotools-based packages with very little code. Any
-  other kind of package can be accomodated by overriding the appropriate phases
-  of <literal>stdenv</literal>. However, there are specialised functions in
-  Nixpkgs to easily build packages for other programming languages, such as
-  Perl or Haskell. These are described in this chapter.
- </para>
- <xi:include href="beam.xml" />
- <xi:include href="bower.xml" />
- <xi:include href="coq.xml" />
- <xi:include href="go.xml" />
- <xi:include href="haskell.section.xml" />
- <xi:include href="idris.section.xml" />
- <xi:include href="java.xml" />
- <xi:include href="lua.xml" />
- <xi:include href="node.section.xml" />
- <xi:include href="perl.xml" />
- <xi:include href="python.section.xml" />
- <xi:include href="qt.xml" />
- <xi:include href="r.section.xml" />
- <xi:include href="ruby.xml" />
- <xi:include href="rust.section.xml" />
- <xi:include href="texlive.xml" />
- <xi:include href="vim.section.xml" />
- <xi:include href="emscripten.section.xml" />
+
+<title>Support for specific programming languages and frameworks</title>
+
+<para>The <link linkend="chap-stdenv">standard build
+environment</link> makes it easy to build typical Autotools-based
+packages with very little code.  Any other kind of package can be
+accomodated by overriding the appropriate phases of
+<literal>stdenv</literal>.  However, there are specialised functions
+in Nixpkgs to easily build packages for other programming languages,
+such as Perl or Haskell.  These are described in this chapter.</para>
+
+
+<xi:include href="beam.xml" />
+<xi:include href="bower.xml" />
+<xi:include href="coq.xml" />
+<xi:include href="go.xml" />
+<xi:include href="haskell.section.xml" />
+<xi:include href="idris.section.xml" />
+<xi:include href="java.xml" />
+<xi:include href="lua.xml" />
+<xi:include href="node.section.xml" />
+<xi:include href="perl.xml" />
+<xi:include href="python.section.xml" />
+<xi:include href="qt.xml" />
+<xi:include href="r.section.xml" />
+<xi:include href="ruby.xml" />
+<xi:include href="rust.section.xml" />
+<xi:include href="texlive.xml" />
+<xi:include href="vim.section.xml" />
+
 </chapter>

doc/languages-frameworks/java.xml

@@ -1,10 +1,11 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-java">
- <title>Java</title>
 
- <para>
-  Ant-based Java packages are typically built from source as follows:
+<title>Java</title>
+
+<para>Ant-based Java packages are typically built from source as follows:
+
 <programlisting>
 stdenv.mkDerivation {
   name = "...";
@@ -15,36 +16,33 @@ stdenv.mkDerivation {
   buildPhase = "ant";
 }
 </programlisting>
-  Note that <varname>jdk</varname> is an alias for the OpenJDK (self-built
-  where available, or pre-built via Zulu). Platforms with OpenJDK not (yet) in
-  Nixpkgs (<literal>Aarch32</literal>, <literal>Aarch64</literal>) point to the
-  (unfree) <literal>oraclejdk</literal>.
- </para>
 
- <para>
-  JAR files that are intended to be used by other packages should be installed
-  in <filename>$out/share/java</filename>. JDKs have a stdenv setup hook that
-  add any JARs in the <filename>share/java</filename> directories of the build
-  inputs to the <envar>CLASSPATH</envar> environment variable. For instance, if
-  the package <literal>libfoo</literal> installs a JAR named
-  <filename>foo.jar</filename> in its <filename>share/java</filename>
-  directory, and another package declares the attribute
+Note that <varname>jdk</varname> is an alias for the OpenJDK.</para>
+
+<para>JAR files that are intended to be used by other packages should
+be installed in <filename>$out/share/java</filename>.  The OpenJDK has
+a stdenv setup hook that adds any JARs in the
+<filename>share/java</filename> directories of the build inputs to the
+<envar>CLASSPATH</envar> environment variable.  For instance, if the
+package <literal>libfoo</literal> installs a JAR named
+<filename>foo.jar</filename> in its <filename>share/java</filename>
+directory, and another package declares the attribute
+
 <programlisting>
 buildInputs = [ jdk libfoo ];
 </programlisting>
-  then <envar>CLASSPATH</envar> will be set to
-  <filename>/nix/store/...-libfoo/share/java/foo.jar</filename>.
- </para>
 
- <para>
-  Private JARs should be installed in a location like
-  <filename>$out/share/<replaceable>package-name</replaceable></filename>.
- </para>
+then <envar>CLASSPATH</envar> will be set to
+<filename>/nix/store/...-libfoo/share/java/foo.jar</filename>.</para>
+
+<para>Private JARs
+should be installed in a location like
+<filename>$out/share/<replaceable>package-name</replaceable></filename>.</para>
+
+<para>If your Java package provides a program, you need to generate a
+wrapper script to run it using the OpenJRE.  You can use
+<literal>makeWrapper</literal> for this:
 
- <para>
-  If your Java package provides a program, you need to generate a wrapper
-  script to run it using the OpenJRE. You can use
-  <literal>makeWrapper</literal> for this:
 <programlisting>
 buildInputs = [ makeWrapper ];
 
@@ -55,30 +53,32 @@ installPhase =
       --add-flags "-cp $out/share/java/foo.jar org.foo.Main"
   '';
 </programlisting>
-  Note the use of <literal>jre</literal>, which is the part of the OpenJDK
-  package that contains the Java Runtime Environment. By using
-  <literal>${jre}/bin/java</literal> instead of
-  <literal>${jdk}/bin/java</literal>, you prevent your package from depending
-  on the JDK at runtime.
- </para>
 
- <para>
-  Note all JDKs passthru <literal>home</literal>, so if your application
-  requires environment variables like <envar>JAVA_HOME</envar> being set, that
-  can be done in a generic fashion with the <literal>--set</literal> argument
-  of <literal>makeWrapper</literal>:
+Note the use of <literal>jre</literal>, which is the part of the
+OpenJDK package that contains the Java Runtime Environment.  By using
+<literal>${jre}/bin/java</literal> instead of
+<literal>${jdk}/bin/java</literal>, you prevent your package from
+depending on the JDK at runtime.</para>
+
+<para>It is possible to use a different Java compiler than
+<command>javac</command> from the OpenJDK.  For instance, to use the
+Eclipse Java Compiler:
+
 <programlisting>
-  --set JAVA_HOME ${jdk.home}
+buildInputs = [ jre ant ecj ];
 </programlisting>
- </para>
 
- <para>
-  It is possible to use a different Java compiler than <command>javac</command>
-  from the OpenJDK. For instance, to use the GNU Java Compiler:
+(Note that here you don’t need the full JDK as an input, but just the
+JRE.)  The ECJ has a stdenv setup hook that sets some environment
+variables to cause Ant to use ECJ, but this doesn’t work with all Ant
+files.  Similarly, you can use the GNU Java Compiler:
+
 <programlisting>
 buildInputs = [ gcj ant ];
 </programlisting>
-  Here, Ant will automatically use <command>gij</command> (the GNU Java
-  Runtime) instead of the OpenJRE.
- </para>
+
+Here, Ant will automatically use <command>gij</command> (the GNU Java
+Runtime) instead of the OpenJRE.</para>
+
 </section>
+

doc/languages-frameworks/lua.xml

@@ -1,22 +1,24 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-lua">
- <title>Lua</title>
 
- <para>
-  Lua packages are built by the <varname>buildLuaPackage</varname> function.
-  This function is implemented in
-  <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules/generic/default.nix">
+<title>Lua</title>
+
+<para>
+  Lua packages are built by the <varname>buildLuaPackage</varname> function.  This function is
+  implemented
+  in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules/generic/default.nix">
   <filename>pkgs/development/lua-modules/generic/default.nix</filename></link>
   and works similarly to <varname>buildPerlPackage</varname>. (See
   <xref linkend="sec-language-perl"/> for details.)
- </para>
+</para>
 
- <para>
-  Lua packages are defined in
-  <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/lua-packages.nix"><filename>pkgs/top-level/lua-packages.nix</filename></link>.
+<para>
+  Lua packages are defined
+  in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/lua-packages.nix"><filename>pkgs/top-level/lua-packages.nix</filename></link>.
   Most of them are simple. For example:
-<programlisting>
+
+  <programlisting>
 fileSystem = buildLuaPackage {
   name = "filesystem-1.6.2";
   src = fetchurl {
@@ -30,19 +32,20 @@ fileSystem = buildLuaPackage {
   };
 };
   </programlisting>
- </para>
+</para>
 
- <para>
+<para>
   Though, more complicated package should be placed in a seperate file in
   <link
   xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules"><filename>pkgs/development/lua-modules</filename></link>.
- </para>
+</para>
+<para>
+  Lua packages accept additional parameter <varname>disabled</varname>, which defines
+  the condition of disabling package from luaPackages. For example, if package has
+  <varname>disabled</varname> assigned to <literal>lua.luaversion != "5.1"</literal>,
+  it will not be included in any luaPackages except lua51Packages, making it
+  only be built for lua 5.1.
+</para>
 
- <para>
-  Lua packages accept additional parameter <varname>disabled</varname>, which
-  defines the condition of disabling package from luaPackages. For example, if
-  package has <varname>disabled</varname> assigned to <literal>lua.luaversion
-  != "5.1"</literal>, it will not be included in any luaPackages except
-  lua51Packages, making it only be built for lua 5.1.
- </para>
 </section>
+

doc/languages-frameworks/node.section.md

@@ -14,7 +14,7 @@ project.
 
 The package set also provides support for multiple Node.js versions. The policy
 is that a new package should be added to the collection for the latest stable LTS
-release (which is currently 8.x), unless there is an explicit reason to support
+release (which is currently 6.x), unless there is an explicit reason to support
 a different release.
 
 If your package uses native addons, you need to examine what kind of native
@@ -26,7 +26,7 @@ build system it uses. Here are some examples:
 
 After you have identified the correct system, you need to override your package
 expression while adding in build system as a build input. For example, `dat`
-requires `node-gyp-build`, so we override its expression in `default-v8.nix`:
+requires `node-gyp-build`, so we override its expression in `default-v6.nix`:
 
 ```nix
 dat = nodePackages.dat.override (oldAttrs: {
@@ -36,14 +36,14 @@ dat = nodePackages.dat.override (oldAttrs: {
 
 To add a package from NPM to nixpkgs:
 
- 1. Modify `pkgs/development/node-packages/node-packages-v8.json` to add, update
-    or remove package entries. (Or `pkgs/development/node-packages/node-packages-v10.json`
-    for packages depending on Node.js 10.x)
+ 1. Modify `pkgs/development/node-packages/node-packages-v6.json` to add, update
+    or remove package entries. (Or `pkgs/development/node-packages/node-packages-v4.json`
+    for packages depending on Node.js 4.x)
  2. Run the script: `(cd pkgs/development/node-packages && ./generate.sh)`.
  3. Build your new package to test your changes:
     `cd /path/to/nixpkgs && nix-build -A nodePackages.<new-or-updated-package>`.
-    To build against a specific Node.js version (e.g. 10.x):
-    `nix-build -A nodePackages_10_x.<new-or-updated-package>`
+    To build against a specific Node.js version (e.g. 4.x):
+    `nix-build -A nodePackages_4_x.<new-or-updated-package>`
  4. Add and commit all modified and generated files.
 
 For more information about the generation process, consult the

doc/languages-frameworks/perl.xml

@@ -1,27 +1,24 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-perl">
- <title>Perl</title>
 
- <para>
-  Nixpkgs provides a function <varname>buildPerlPackage</varname>, a generic
-  package builder function for any Perl package that has a standard
-  <varname>Makefile.PL</varname>. It’s implemented in
-  <link
-xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/perl-modules/generic"><filename>pkgs/development/perl-modules/generic</filename></link>.
- </para>
+<title>Perl</title>
 
- <para>
-  Perl packages from CPAN are defined in
-  <link
+<para>Nixpkgs provides a function <varname>buildPerlPackage</varname>,
+a generic package builder function for any Perl package that has a
+standard <varname>Makefile.PL</varname>.  It’s implemented in <link
+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/perl-modules/generic"><filename>pkgs/development/perl-modules/generic</filename></link>.</para>
+
+<para>Perl packages from CPAN are defined in <link
 xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix"><filename>pkgs/top-level/perl-packages.nix</filename></link>,
-  rather than <filename>pkgs/all-packages.nix</filename>. Most Perl packages
-  are so straight-forward to build that they are defined here directly, rather
-  than having a separate function for each package called from
-  <filename>perl-packages.nix</filename>. However, more complicated packages
-  should be put in a separate file, typically in
-  <filename>pkgs/development/perl-modules</filename>. Here is an example of the
-  former:
+rather than <filename>pkgs/all-packages.nix</filename>.  Most Perl
+packages are so straight-forward to build that they are defined here
+directly, rather than having a separate function for each package
+called from <filename>perl-packages.nix</filename>.  However, more
+complicated packages should be put in a separate file, typically in
+<filename>pkgs/development/perl-modules</filename>.  Here is an
+example of the former:
+
 <programlisting>
 ClassC3 = buildPerlPackage rec {
   name = "Class-C3-0.21";
@@ -31,72 +28,74 @@ ClassC3 = buildPerlPackage rec {
   };
 };
 </programlisting>
-  Note the use of <literal>mirror://cpan/</literal>, and the
-  <literal>${name}</literal> in the URL definition to ensure that the name
-  attribute is consistent with the source that we’re actually downloading.
-  Perl packages are made available in <filename>all-packages.nix</filename>
-  through the variable <varname>perlPackages</varname>. For instance, if you
-  have a package that needs <varname>ClassC3</varname>, you would typically
-  write
+
+Note the use of <literal>mirror://cpan/</literal>, and the
+<literal>${name}</literal> in the URL definition to ensure that the
+name attribute is consistent with the source that we’re actually
+downloading.  Perl packages are made available in
+<filename>all-packages.nix</filename> through the variable
+<varname>perlPackages</varname>.  For instance, if you have a package
+that needs <varname>ClassC3</varname>, you would typically write
+
 <programlisting>
 foo = import ../path/to/foo.nix {
   inherit stdenv fetchurl ...;
   inherit (perlPackages) ClassC3;
 };
 </programlisting>
-  in <filename>all-packages.nix</filename>. You can test building a Perl
-  package as follows:
+
+in <filename>all-packages.nix</filename>.  You can test building a
+Perl package as follows:
+
 <screen>
 $ nix-build -A perlPackages.ClassC3
 </screen>
-  <varname>buildPerlPackage</varname> adds <literal>perl-</literal> to the
-  start of the name attribute, so the package above is actually called
-  <literal>perl-Class-C3-0.21</literal>. So to install it, you can say:
+
+<varname>buildPerlPackage</varname> adds <literal>perl-</literal> to
+the start of the name attribute, so the package above is actually
+called <literal>perl-Class-C3-0.21</literal>.  So to install it, you
+can say:
+
 <screen>
 $ nix-env -i perl-Class-C3
 </screen>
-  (Of course you can also install using the attribute name: <literal>nix-env -i
-  -A perlPackages.ClassC3</literal>.)
- </para>
 
- <para>
-  So what does <varname>buildPerlPackage</varname> do? It does the following:
-  <orderedlist>
-   <listitem>
-    <para>
-     In the configure phase, it calls <literal>perl Makefile.PL</literal> to
-     generate a Makefile. You can set the variable
-     <varname>makeMakerFlags</varname> to pass flags to
-     <filename>Makefile.PL</filename>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     It adds the contents of the <envar>PERL5LIB</envar> environment variable
-     to <literal>#! .../bin/perl</literal> line of Perl scripts as
-     <literal>-I<replaceable>dir</replaceable></literal> flags. This ensures
-     that a script can find its dependencies.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     In the fixup phase, it writes the propagated build inputs
-     (<varname>propagatedBuildInputs</varname>) to the file
-     <filename>$out/nix-support/propagated-user-env-packages</filename>.
-     <command>nix-env</command> recursively installs all packages listed in
-     this file when you install a package that has it. This ensures that a Perl
-     package can find its dependencies.
-    </para>
-   </listitem>
-  </orderedlist>
- </para>
+(Of course you can also install using the attribute name:
+<literal>nix-env -i -A perlPackages.ClassC3</literal>.)</para>
+
+<para>So what does <varname>buildPerlPackage</varname> do?  It does
+the following:
+
+<orderedlist>
+
+  <listitem><para>In the configure phase, it calls <literal>perl
+  Makefile.PL</literal> to generate a Makefile.  You can set the
+  variable <varname>makeMakerFlags</varname> to pass flags to
+  <filename>Makefile.PL</filename></para></listitem>
+
+  <listitem><para>It adds the contents of the <envar>PERL5LIB</envar>
+  environment variable to <literal>#! .../bin/perl</literal> line of
+  Perl scripts as <literal>-I<replaceable>dir</replaceable></literal>
+  flags.  This ensures that a script can find its
+  dependencies.</para></listitem>
+
+  <listitem><para>In the fixup phase, it writes the propagated build
+  inputs (<varname>propagatedBuildInputs</varname>) to the file
+  <filename>$out/nix-support/propagated-user-env-packages</filename>.
+  <command>nix-env</command> recursively installs all packages listed
+  in this file when you install a package that has it.  This ensures
+  that a Perl package can find its dependencies.</para></listitem>
+
+</orderedlist>
+
+</para>
+
+<para><varname>buildPerlPackage</varname> is built on top of
+<varname>stdenv</varname>, so everything can be customised in the
+usual way.  For instance, the <literal>BerkeleyDB</literal> module has
+a <varname>preConfigure</varname> hook to generate a configuration
+file used by <filename>Makefile.PL</filename>:
 
- <para>
-  <varname>buildPerlPackage</varname> is built on top of
-  <varname>stdenv</varname>, so everything can be customised in the usual way.
-  For instance, the <literal>BerkeleyDB</literal> module has a
-  <varname>preConfigure</varname> hook to generate a configuration file used by
-  <filename>Makefile.PL</filename>:
 <programlisting>
 { buildPerlPackage, fetchurl, db }:
 
@@ -109,20 +108,23 @@ buildPerlPackage rec {
   };
 
   preConfigure = ''
-    echo "LIB = ${db.out}/lib" > config.in
-    echo "INCLUDE = ${db.dev}/include" >> config.in
+    echo "LIB = ${db}/lib" > config.in
+    echo "INCLUDE = ${db}/include" >> config.in
   '';
 }
 </programlisting>
- </para>
 
- <para>
-  Dependencies on other Perl packages can be specified in the
-  <varname>buildInputs</varname> and <varname>propagatedBuildInputs</varname>
-  attributes. If something is exclusively a build-time dependency, use
-  <varname>buildInputs</varname>; if it’s (also) a runtime dependency, use
-  <varname>propagatedBuildInputs</varname>. For instance, this builds a Perl
-  module that has runtime dependencies on a bunch of other modules:
+</para>
+
+<para>Dependencies on other Perl packages can be specified in the
+<varname>buildInputs</varname> and
+<varname>propagatedBuildInputs</varname> attributes.  If something is
+exclusively a build-time dependency, use
+<varname>buildInputs</varname>; if it’s (also) a runtime dependency,
+use <varname>propagatedBuildInputs</varname>.  For instance, this
+builds a Perl module that has runtime dependencies on a bunch of other
+modules:
+
 <programlisting>
 ClassC3Componentised = buildPerlPackage rec {
   name = "Class-C3-Componentised-1.0004";
@@ -135,26 +137,24 @@ ClassC3Componentised = buildPerlPackage rec {
   ];
 };
 </programlisting>
- </para>
 
- <section xml:id="ssec-generation-from-CPAN">
-  <title>Generation from CPAN</title>
+</para>
 
-  <para>
-   Nix expressions for Perl packages can be generated (almost) automatically
-   from CPAN. This is done by the program
-   <command>nix-generate-from-cpan</command>, which can be installed as
-   follows:
-  </para>
+<section xml:id="ssec-generation-from-CPAN"><title>Generation from CPAN</title>
+
+<para>Nix expressions for Perl packages can be generated (almost)
+automatically from CPAN.  This is done by the program
+<command>nix-generate-from-cpan</command>, which can be installed
+as follows:</para>
 
 <screen>
 $ nix-env -i nix-generate-from-cpan
 </screen>
 
-  <para>
-   This program takes a Perl module name, looks it up on CPAN, fetches and
-   unpacks the corresponding package, and prints a Nix expression on standard
-   output. For example:
+<para>This program takes a Perl module name, looks it up on CPAN,
+fetches and unpacks the corresponding package, and prints a Nix
+expression on standard output.  For example:
+
 <screen>
 $ nix-generate-from-cpan XML::Simple
   XMLSimple = buildPerlPackage rec {
@@ -170,23 +170,12 @@ $ nix-generate-from-cpan XML::Simple
     };
   };
 </screen>
-   The output can be pasted into
-   <filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you
-   need it.
-  </para>
- </section>
 
- <section xml:id="ssec-perl-cross-compilation">
-  <title>Cross-compiling modules</title>
+The output can be pasted into
+<filename>pkgs/top-level/perl-packages.nix</filename> or wherever else
+you need it.</para>
 
-  <para>
-   Nixpkgs has experimental support for cross-compiling Perl modules. In many
-   cases, it will just work out of the box, even for modules with native
-   extensions. Sometimes, however, the Makefile.PL for a module may
-   (indirectly) import a native module. In that case, you will need to make a
-   stub for that module that will satisfy the Makefile.PL and install it into
-   <filename>lib/perl5/site_perl/cross_perl/${perl.version}</filename>. See the
-   <varname>postInstall</varname> for <varname>DBI</varname> for an example.
-  </para>
- </section>
 </section>
+
+</section>
+

doc/languages-frameworks/python.section.md

@@ -200,7 +200,7 @@ building Python libraries is `buildPythonPackage`. Let's see how we can build th
     doCheck = false;
 
     meta = {
-      homepage = "https://github.com/pytoolz/toolz/";
+      homepage = "http://github.com/pytoolz/toolz/";
       description = "List processing tools and functional utilities";
       license = licenses.bsd3;
       maintainers = with maintainers; [ fridh ];
@@ -245,7 +245,7 @@ with import <nixpkgs> {};
       doCheck = false;
 
       meta = {
-        homepage = "https://github.com/pytoolz/toolz/";
+        homepage = "http://github.com/pytoolz/toolz/";
         description = "List processing tools and functional utilities";
       };
     };
@@ -328,7 +328,7 @@ when building the bindings and are therefore added as `buildInputs`.
 
     meta = {
       description = "Pythonic binding for the libxml2 and libxslt libraries";
-      homepage = https://lxml.de;
+      homepage = http://lxml.de;
       license = licenses.bsd3;
       maintainers = with maintainers; [ sjourdois ];
     };
@@ -374,7 +374,7 @@ and `CFLAGS`.
       description = "A pythonic wrapper around FFTW, the FFT library, presenting a unified interface for all the supported transforms";
       homepage = http://hgomersall.github.com/pyFFTW/;
       license = with licenses; [ bsd2 bsd3 ];
-      maintainers = with maintainers; [ fridh ];
+      maintainer = with maintainers; [ fridh ];
     };
   };
 }
@@ -424,7 +424,7 @@ available.
 
 At some point you'll likely have multiple packages which you would
 like to be able to use in different projects. In order to minimise unnecessary
-duplication we now look at how you can maintain a repository with your
+duplication we now look at how you can maintain yourself a repository with your
 own packages. The important functions here are `import` and `callPackage`.
 
 ### Including a derivation using `callPackage`
@@ -436,7 +436,7 @@ Let's split the package definition from the environment definition.
 We first create a function that builds `toolz` in `~/path/to/toolz/release.nix`
 
 ```nix
-{ lib, pkgs, buildPythonPackage }:
+{ pkgs, buildPythonPackage }:
 
 buildPythonPackage rec {
   pname = "toolz";
@@ -447,7 +447,7 @@ buildPythonPackage rec {
     sha256 = "43c2c9e5e7a16b6c88ba3088a9bfc82f7db8e13378be7c78d6c14a5f8ed05afd";
   };
 
-  meta = with lib; {
+  meta = {
     homepage = "http://github.com/pytoolz/toolz/";
     description = "List processing tools and functional utilities";
     license = licenses.bsd3;
@@ -484,7 +484,7 @@ and in this case the `python35` interpreter is automatically used.
 
 ### Interpreters
 
-Versions 2.7, 3.4, 3.5, 3.6 and 3.7 of the CPython interpreter are available as
+Versions 2.7, 3.3, 3.4, 3.5 and 3.6 of the CPython interpreter are available as
 respectively `python27`, `python34`, `python35` and `python36`. The PyPy interpreter
 is available as `pypy`. The aliases `python2` and `python3` correspond to respectively `python27` and
 `python35`. The default interpreter, `python`, maps to `python2`.
@@ -533,7 +533,6 @@ sets are
 * `pkgs.python34Packages`
 * `pkgs.python35Packages`
 * `pkgs.python36Packages`
-* `pkgs.python37Packages`
 * `pkgs.pypyPackages`
 
 and the aliases
@@ -588,32 +587,30 @@ The `buildPythonPackage` mainly does four things:
 
 As in Perl, dependencies on other Python packages can be specified in the
 `buildInputs` and `propagatedBuildInputs` attributes.  If something is
-exclusively a build-time dependency, use `buildInputs`; if it is (also) a runtime
+exclusively a build-time dependency, use `buildInputs`; if it’s (also) a runtime
 dependency, use `propagatedBuildInputs`.
 
 By default tests are run because `doCheck = true`. Test dependencies, like
-e.g. the test runner, should be added to `checkInputs`.
+e.g. the test runner, should be added to `buildInputs`.
 
 By default `meta.platforms` is set to the same value
 as the interpreter unless overridden otherwise.
 
 ##### `buildPythonPackage` parameters
 
-All parameters from `stdenv.mkDerivation` function are still supported. The following are specific to `buildPythonPackage`:
+All parameters from `mkDerivation` function are still supported.
 
-* `catchConflicts ? true`: If `true`, abort package build if a package name appears more than once in dependency tree. Default is `true`.
-* `checkInputs ? []`: Dependencies needed for running the `checkPhase`. These are added to `buildInputs` when `doCheck = true`.
-* `disabled` ? false: If `true`, package is not build for the particular Python interpreter version.
-* `dontWrapPythonPrograms ? false`: Skip wrapping of python programs.
-* `installFlags ? []`: A list of strings. Arguments to be passed to `pip install`. To pass options to `python setup.py install`, use `--install-option`. E.g., `installFlags=["--install-option='--cpp_implementation'"].
-* `format ? "setuptools"`: Format of the source. Valid options are `"setuptools"`, `"flit"`, `"wheel"`, and `"other"`. `"setuptools"` is for when the source has a `setup.py` and `setuptools` is used to build a wheel, `flit`, in case `flit` should be used to build a wheel, and `wheel` in case a wheel is provided. Use `other` when a custom `buildPhase` and/or `installPhase` is needed.
-* `makeWrapperArgs ? []`: A list of strings. Arguments to be passed to `makeWrapper`, which wraps generated binaries. By default, the arguments to `makeWrapper` set `PATH` and `PYTHONPATH` environment variables before calling the binary. Additional arguments here can allow a developer to set environment variables which will be available when the binary is run. For example, `makeWrapperArgs = ["--set FOO BAR" "--set BAZ QUX"]`.
-* `namePrefix`: Prepends text to `${name}` parameter. In case of libraries, this defaults to `"python3.5-"` for Python 3.5, etc., and in case of applications to `""`.
-* `pythonPath ? []`: List of packages to be added into `$PYTHONPATH`. Packages in `pythonPath` are not propagated (contrary to `propagatedBuildInputs`).
+* `namePrefix`: Prepended text to `${name}` parameter. Defaults to `"python3.3-"` for Python 3.3, etc. Set it to `""` if you're packaging an application or a command line tool.
+* `disabled`: If `true`, package is not build for particular python interpreter version. Grep around `pkgs/top-level/python-packages.nix` for examples.
+* `setupPyBuildFlags`: List of flags passed to `setup.py build_ext` command.
+* `pythonPath`: List of packages to be added into `$PYTHONPATH`. Packages in `pythonPath` are not propagated (contrary to `propagatedBuildInputs`).
 * `preShellHook`: Hook to execute commands before `shellHook`.
 * `postShellHook`: Hook to execute commands after `shellHook`.
-* `removeBinByteCode ? true`: Remove bytecode from `/bin`. Bytecode is only created when the filenames end with `.py`.
-* `setupPyBuildFlags ? []`: List of flags passed to `setup.py build_ext` command.
+* `makeWrapperArgs`: A list of strings. Arguments to be passed to `makeWrapper`, which wraps generated binaries. By default, the arguments to `makeWrapper` set `PATH` and `PYTHONPATH` environment variables before calling the binary. Additional arguments here can allow a developer to set environment variables which will be available when the binary is run. For example, `makeWrapperArgs = ["--set FOO BAR" "--set BAZ QUX"]`.
+* `installFlags`: A list of strings. Arguments to be passed to `pip install`. To pass options to `python setup.py install`, use `--install-option`. E.g., `installFlags=["--install-option='--cpp_implementation'"].
+* `format`: Format of the source. Valid options are `setuptools` (default), `flit`, `wheel`, and `other`. `setuptools` is for when the source has a `setup.py` and `setuptools` is used to build a wheel, `flit`, in case `flit` should be used to build a wheel, and `wheel` in case a wheel is provided. In case you need to provide your own `buildPhase` and `installPhase` you can use `other`.
+* `catchConflicts` If `true`, abort package build if a package name appears more than once in dependency tree. Default is `true`.
+* `checkInputs` Dependencies needed for running the `checkPhase`. These are added to `buildInputs` when `doCheck = true`.
 
 ##### Overriding Python packages
 
@@ -645,47 +642,11 @@ in python.withPackages(ps: [ps.blaze])).env
 
 #### `buildPythonApplication` function
 
-The `buildPythonApplication` function is practically the same as
-`buildPythonPackage`. The main purpose of this function is to build a Python
-package where one is interested only in the executables, and not importable
-modules. For that reason, when adding this package to a `python.buildEnv`, the
-modules won't be made available.
+The `buildPythonApplication` function is practically the same as `buildPythonPackage`.
+The difference is that `buildPythonPackage` by default prefixes the names of the packages with the version of the interpreter.
+Because with an application we're not interested in multiple version the prefix is dropped.
 
-Another difference is that `buildPythonPackage` by default prefixes the names of
-the packages with the version of the interpreter. Because this is irrelevant for
-applications, the prefix is omitted.
-
-#### `toPythonApplication` function
-
-A distinction is made between applications and libraries, however, sometimes a
-package is used as both. In this case the package is added as a library to
-`python-packages.nix` and as an application to `all-packages.nix`. To reduce
-duplication the `toPythonApplication` can be used to convert a library to an
-application.
-
-The Nix expression shall use `buildPythonPackage` and be called from
-`python-packages.nix`. A reference shall be created from `all-packages.nix` to
-the attribute in `python-packages.nix`, and the `toPythonApplication` shall be
-applied to the reference:
-```nix
-youtube-dl = with pythonPackages; toPythonApplication youtube-dl;
-```
-
-#### `toPythonModule` function
-
-In some cases, such as bindings, a package is created using
-`stdenv.mkDerivation` and added as attribute in `all-packages.nix`.
-The Python bindings should be made available from `python-packages.nix`.
-The `toPythonModule` function takes a derivation and makes certain Python-specific modifications.
-```nix
-opencv = toPythonModule (pkgs.opencv.override {
-  enablePython = true;
-  pythonPackages = self;
-});
-```
-Do pay attention to passing in the right Python version!
-
-#### `python.buildEnv` function
+#### python.buildEnv function
 
 Python environments can be created using the low-level `pkgs.buildEnv` function.
 This example shows how to create an environment that has the Pyramid Web Framework.
@@ -727,7 +688,7 @@ specified packages in its path.
 * `postBuild`: Shell command executed after the build of environment.
 * `ignoreCollisions`: Ignore file collisions inside the environment (default is `false`).
 
-#### `python.withPackages` function
+#### python.withPackages function
 
 The `python.withPackages` function provides a simpler interface to the `python.buildEnv` functionality.
 It takes a function as an argument that is passed the set of python packages and returns the list
@@ -761,7 +722,7 @@ with import <nixpkgs> {};
 In contrast to `python.buildEnv`, `python.withPackages` does not support the more advanced options
 such as `ignoreCollisions = true` or `postBuild`. If you need them, you have to use `python.buildEnv`.
 
-Python 2 namespace packages may provide `__init__.py` that collide. In that case `python.buildEnv`
+Python 2 namespace packages may provide `__init__.py` that collide. In that case `python.buildEnv` 
 should be used with `ignoreCollisions = true`.
 
 ### Development mode
@@ -829,8 +790,8 @@ example of such a situation is when `py.test` is used.
 
 - Non-working tests can often be deselected. By default `buildPythonPackage` runs `python setup.py test`.
   Most python modules follows the standard test protocol where the pytest runner can be used instead.
-  `py.test` supports a `-k` parameter to ignore test methods or classes:
-
+  `py.test` supports a `-k` parameter to ignore test methods or classes: 
+  
   ```nix
   buildPythonPackage {
     # ...
@@ -980,7 +941,7 @@ stdenv.mkDerivation {
     # the following packages are related to the dependencies of your python
     # project.
     # In this particular example the python modules listed in the
-    # requirements.txt require the following packages to be installed locally
+    # requirements.tx require the following packages to be installed locally
     # in order to compile any binary extensions they may require.
     #
     taglib
@@ -1012,14 +973,14 @@ folder and not downloaded again.
 If you need to change a package's attribute(s) from `configuration.nix` you could do:
 
 ```nix
-  nixpkgs.config.packageOverrides = super: {
-    python = super.python.override {
-      packageOverrides = python-self: python-super: {
-        zerobin = python-super.zerobin.overrideAttrs (oldAttrs: {
-          src = super.fetchgit {
-            url = "https://github.com/sametmax/0bin";
-            rev = "a344dbb18fe7a855d0742b9a1cede7ce423b34ec";
-            sha256 = "16d769kmnrpbdr0ph0whyf4yff5df6zi4kmwx7sz1d3r6c8p6xji";
+  nixpkgs.config.packageOverrides = superP: {
+    pythonPackages = superP.pythonPackages.override {
+      overrides = self: super: {
+        bepasty-server = super.bepasty-server.overrideAttrs ( oldAttrs: {
+          src = pkgs.fetchgit {
+            url = "https://github.com/bepasty/bepasty-server";
+            sha256 = "9ziqshmsf0rjvdhhca55sm0x8jz76fsf2q4rwh4m6lpcf8wr0nps";
+            rev = "e2516e8cf4f2afb5185337073607eb9e84a61d2d";
           };
         });
       };
@@ -1027,39 +988,27 @@ If you need to change a package's attribute(s) from `configuration.nix` you coul
   };
 ```
 
-`pythonPackages.zerobin` is now globally overridden. All packages and also the
-`zerobin` NixOS service use the new definition.
-Note that `python-super` refers to the old package set and `python-self`
-to the new, overridden version.
-
-To modify only a Python package set instead of a whole Python derivation, use this snippet:
-
-```nix
-  myPythonPackages = pythonPackages.override {
-    overrides = self: super: {
-      zerobin = ...;
-    };
-  }
-```
+If you are using the `bepasty-server` package somewhere, for example in `systemPackages` or indirectly from `services.bepasty`, then a `nixos-rebuild switch` will rebuild the system but with the `bepasty-server` package using a different `src` attribute. This way one can modify `python` based software/libraries easily. Using `self` and `super` one can also alter dependencies (`buildInputs`) between the old state (`self`) and new state (`super`). 
 
 ### How to override a Python package using overlays?
 
-Use the following overlay template:
+To alter a python package using overlays, you would use the following approach:
 
 ```nix
 self: super:
-{
+rec {
   python = super.python.override {
     packageOverrides = python-self: python-super: {
-      zerobin = python-super.zerobin.overrideAttrs (oldAttrs: {
-        src = super.fetchgit {
-          url = "https://github.com/sametmax/0bin";
-          rev = "a344dbb18fe7a855d0742b9a1cede7ce423b34ec";
-          sha256 = "16d769kmnrpbdr0ph0whyf4yff5df6zi4kmwx7sz1d3r6c8p6xji";
+      bepasty-server = python-super.bepasty-server.overrideAttrs ( oldAttrs: {
+        src = self.pkgs.fetchgit {
+          url = "https://github.com/bepasty/bepasty-server";
+          sha256 = "9ziqshmsf0rjvdhhca55sm0x8jz76fsf2q4rwh4m6lpcf8wr0nps";
+          rev = "e2516e8cf4f2afb5185337073607eb9e84a61d2d";
         };
       });
     };
   };
+  pythonPackages = python.pkgs;
 }
 ```
 
@@ -1074,5 +1023,4 @@ Following rules are desired to be respected:
 * Make sure libraries build for all Python interpreters.
 * By default we enable tests. Make sure the tests are found and, in the case of libraries, are passing for all interpreters. If certain tests fail they can be disabled individually. Try to avoid disabling the tests altogether. In any case, when you disable tests, leave a comment explaining why.
 * Commit names of Python libraries should reflect that they are Python libraries, so write for example `pythonPackages.numpy: 1.11 -> 1.12`.
-* Attribute names in `python-packages.nix` should be normalized according to [PEP 0503](https://www.python.org/dev/peps/pep-0503/#normalized-names).
-  This means that characters should be converted to lowercase and `.` and `_` should be replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz )
+

doc/languages-frameworks/qt.xml

@@ -1,74 +1,58 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-qt">
- <title>Qt</title>
 
- <para>
-  Qt is a comprehensive desktop and mobile application development toolkit for
-  C++. Legacy support is available for Qt 3 and Qt 4, but all current
-  development uses Qt 5. The Qt 5 packages in Nixpkgs are updated frequently to
-  take advantage of new features, but older versions are typically retained
-  until their support window ends. The most important consideration in
-  packaging Qt-based software is ensuring that each package and all its
-  dependencies use the same version of Qt 5; this consideration motivates most
-  of the tools described below.
- </para>
+<title>Qt</title>
 
- <section xml:id="ssec-qt-libraries">
-  <title>Packaging Libraries for Nixpkgs</title>
+<para>
+Qt is a comprehensive desktop and mobile application development toolkit for C++.
+Legacy support is available for Qt 3 and Qt 4, but all current development uses Qt 5.
+The Qt 5 packages in Nixpkgs are updated frequently to take advantage of new features,
+but older versions are typically retained until their support window ends.
+The most important consideration in packaging Qt-based software is ensuring that each package and all its dependencies use the same version of Qt 5;
+this consideration motivates most of the tools described below.
+</para>
 
-  <para>
-   Whenever possible, libraries that use Qt 5 should be built with each
-   available version. Packages providing libraries should be added to the
-   top-level function <varname>mkLibsForQt5</varname>, which is used to build a
-   set of libraries for every Qt 5 version. A special
-   <varname>callPackage</varname> function is used in this scope to ensure that
-   the entire dependency tree uses the same Qt 5 version. Import dependencies
-   unqualified, i.e., <literal>qtbase</literal> not
-   <literal>qt5.qtbase</literal>. <emphasis>Do not</emphasis> import a package
-   set such as <literal>qt5</literal> or <literal>libsForQt5</literal>.
-  </para>
+<section xml:id="ssec-qt-libraries"><title>Packaging Libraries for Nixpkgs</title>
 
-  <para>
-   If a library does not support a particular version of Qt 5, it is best to
-   mark it as broken by setting its <literal>meta.broken</literal> attribute. A
-   package may be marked broken for certain versions by testing the
-   <literal>qtbase.version</literal> attribute, which will always give the
-   current Qt 5 version.
-  </para>
- </section>
+<para>
+Whenever possible, libraries that use Qt 5 should be built with each available version.
+Packages providing libraries should be added to the top-level function <varname>mkLibsForQt5</varname>,
+which is used to build a set of libraries for every Qt 5 version.
+A special <varname>callPackage</varname> function is used in this scope to ensure that the entire dependency tree uses the same Qt 5 version.
+Import dependencies unqualified, i.e., <literal>qtbase</literal> not <literal>qt5.qtbase</literal>.
+<emphasis>Do not</emphasis> import a package set such as <literal>qt5</literal> or <literal>libsForQt5</literal>.
+</para>
 
- <section xml:id="ssec-qt-applications">
-  <title>Packaging Applications for Nixpkgs</title>
+<para>
+If a library does not support a particular version of Qt 5, it is best to mark it as broken by setting its <literal>meta.broken</literal> attribute.
+A package may be marked broken for certain versions by testing the <literal>qtbase.version</literal> attribute, which will always give the current Qt 5 version.
+</para>
 
-  <para>
-   Call your application expression using
-   <literal>libsForQt5.callPackage</literal> instead of
-   <literal>callPackage</literal>. Import dependencies unqualified, i.e.,
-   <literal>qtbase</literal> not <literal>qt5.qtbase</literal>. <emphasis>Do
-   not</emphasis> import a package set such as <literal>qt5</literal> or
-   <literal>libsForQt5</literal>.
-  </para>
-
-  <para>
-   Qt 5 maintains strict backward compatibility, so it is generally best to
-   build an application package against the latest version using the
-   <varname>libsForQt5</varname> library set. In case a package does not build
-   with the latest Qt version, it is possible to pick a set pinned to a
-   particular version, e.g. <varname>libsForQt55</varname> for Qt 5.5, if that
-   is the latest version the package supports. If a package must be pinned to
-   an older Qt version, be sure to file a bug upstream; because Qt is strictly
-   backwards-compatible, any incompatibility is by definition a bug in the
-   application.
-  </para>
-
-  <para>
-   When testing applications in Nixpkgs, it is a common practice to build the
-   package with <literal>nix-build</literal> and run it using the created
-   symbolic link. This will not work with Qt applications, however, because
-   they have many hard runtime requirements that can only be guaranteed if the
-   package is actually installed. To test a Qt application, install it with
-   <literal>nix-env</literal> or run it inside <literal>nix-shell</literal>.
-  </para>
- </section>
 </section>
+
+<section xml:id="ssec-qt-applications"><title>Packaging Applications for Nixpkgs</title>
+
+<para>
+Call your application expression using <literal>libsForQt5.callPackage</literal> instead of <literal>callPackage</literal>.
+Import dependencies unqualified, i.e., <literal>qtbase</literal> not <literal>qt5.qtbase</literal>.
+<emphasis>Do not</emphasis> import a package set such as <literal>qt5</literal> or <literal>libsForQt5</literal>.
+</para>
+
+<para>
+Qt 5 maintains strict backward compatibility, so it is generally best to build an application package against the latest version using the <varname>libsForQt5</varname> library set.
+In case a package does not build with the latest Qt version, it is possible to pick a set pinned to a particular version, e.g. <varname>libsForQt55</varname> for Qt 5.5, if that is the latest version the package supports.
+If a package must be pinned to an older Qt version, be sure to file a bug upstream;
+because Qt is strictly backwards-compatible, any incompatibility is by definition a bug in the application.
+</para>
+
+<para>
+When testing applications in Nixpkgs, it is a common practice to build the package with <literal>nix-build</literal> and run it using the created symbolic link.
+This will not work with Qt applications, however, because they have many hard runtime requirements that can only be guaranteed if the package is actually installed.
+To test a Qt application, install it with <literal>nix-env</literal> or run it inside <literal>nix-shell</literal>.
+</para>
+
+</section>
+
+</section>
+

doc/languages-frameworks/ruby.xml

@@ -1,19 +1,17 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-ruby">
- <title>Ruby</title>
 
- <para>
-  There currently is support to bundle applications that are packaged as Ruby
-  gems. The utility "bundix" allows you to write a
-  <filename>Gemfile</filename>, let bundler create a
-  <filename>Gemfile.lock</filename>, and then convert this into a nix
-  expression that contains all Gem dependencies automatically.
- </para>
+<title>Ruby</title>
 
- <para>
-  For example, to package sensu, we did:
- </para>
+<para>There currently is support to bundle applications that are packaged as
+Ruby gems. The utility "bundix" allows you to write a
+<filename>Gemfile</filename>, let bundler create a
+<filename>Gemfile.lock</filename>, and then convert this into a nix
+expression that contains all Gem dependencies automatically.
+</para>
+
+<para>For example, to package sensu, we did:</para>
 
 <screen>
 <![CDATA[$ cd pkgs/servers/monitoring
@@ -44,18 +42,17 @@ bundlerEnv rec {
 }]]>
 </screen>
 
- <para>
-  Please check in the <filename>Gemfile</filename>,
-  <filename>Gemfile.lock</filename> and the <filename>gemset.nix</filename> so
-  future updates can be run easily.
- </para>
+<para>Please check in the <filename>Gemfile</filename>,
+<filename>Gemfile.lock</filename> and the
+<filename>gemset.nix</filename> so future updates can be run easily.
+</para>
 
- <para>
-  For tools written in Ruby - i.e. where the desire is to install a package and
-  then execute e.g. <command>rake</command> at the command line, there is an
-  alternative builder called <literal>bundlerApp</literal>. Set up the
-  <filename>gemset.nix</filename> the same way, and then, for example:
- </para>
+<para>For tools written in Ruby - i.e. where the desire is to install
+a package and then execute e.g. <command>rake</command> at the command
+line, there is an alternative builder called <literal>bundlerApp</literal>.
+Set up the <filename>gemset.nix</filename> the same way, and then, for
+example:
+</para>
 
 <screen>
 <![CDATA[{ lib, bundlerApp }:
@@ -75,31 +72,31 @@ bundlerApp {
 }]]>
 </screen>
 
- <para>
-  The chief advantage of <literal>bundlerApp</literal> over
-  <literal>bundlerEnv</literal> is the executables introduced in the
-  environment are precisely those selected in the <literal>exes</literal> list,
-  as opposed to <literal>bundlerEnv</literal> which adds all the executables
-  made available by gems in the gemset, which can mean e.g.
-  <command>rspec</command> or <command>rake</command> in unpredictable versions
-  available from various packages.
- </para>
+<para>The chief advantage of <literal>bundlerApp</literal> over
+<literal>bundlerEnv</literal> is the executables introduced in the
+environment are precisely those selected in the <literal>exes</literal>
+list, as opposed to <literal>bundlerEnv</literal> which adds all the
+executables made available by gems in the gemset, which can mean e.g.
+<command>rspec</command> or <command>rake</command> in unpredictable
+versions available from various packages.
+</para>
 
- <para>
-  Resulting derivations for both builders also have two helpful attributes,
-  <literal>env</literal> and <literal>wrappedRuby</literal>. The first one
-  allows one to quickly drop into <command>nix-shell</command> with the
-  specified environment present. E.g. <command>nix-shell -A sensu.env</command>
-  would give you an environment with Ruby preset so it has all the libraries
-  necessary for <literal>sensu</literal> in its paths. The second one can be
-  used to make derivations from custom Ruby scripts which have
-  <filename>Gemfile</filename>s with their dependencies specified. It is a
-  derivation with <command>ruby</command> wrapped so it can find all the needed
-  dependencies. For example, to make a derivation <literal>my-script</literal>
-  for a <filename>my-script.rb</filename> (which should be placed in
-  <filename>bin</filename>) you should run <command>bundix</command> as
-  specified above and then use <literal>bundlerEnv</literal> like this:
- </para>
+<para>Resulting derivations for both builders also have two helpful
+attributes, <literal>env</literal> and <literal>wrappedRuby</literal>.
+The first one allows one to quickly drop into
+<command>nix-shell</command> with the specified environment present.
+E.g. <command>nix-shell -A sensu.env</command> would give you an
+environment with Ruby preset so it has all the libraries necessary
+for <literal>sensu</literal> in its paths. The second one can be
+used to make derivations from custom Ruby scripts which have
+<filename>Gemfile</filename>s with their dependencies specified. It is
+a derivation with <command>ruby</command> wrapped so it can find all
+the needed dependencies. For example, to make a derivation
+<literal>my-script</literal> for a <filename>my-script.rb</filename>
+(which should be placed in <filename>bin</filename>) you should run
+<command>bundix</command> as specified above and then use
+<literal>bundlerEnv</literal> like this:
+</para>
 
 <programlisting>
 <![CDATA[let env = bundlerEnv {
@@ -121,4 +118,5 @@ in stdenv.mkDerivation {
   '';
 }]]>
 </programlisting>
+
 </section>

doc/languages-frameworks/rust.section.md

@@ -59,10 +59,8 @@ all crate sources of this package. Currently it is obtained by inserting a
 fake checksum into the expression and building the package once. The correct
 checksum can be then take from the failed build.
 
-When the `Cargo.lock`, provided by upstream, is not in sync with the
-`Cargo.toml`, it is possible to use `cargoPatches` to update it. All patches
-added in `cargoPatches` will also be prepended to the patches in `patches` at
-build-time.
+To install crates with nix there is also an experimental project called
+[nixcrates](https://github.com/fractalide/nixcrates).
 
 ## Compiling Rust crates using Nix instead of Cargo
 
@@ -90,8 +88,8 @@ Now, the file produced by the call to `carnix`, called `hello.nix`, looks like:
 
 ```
 # Generated by carnix 0.6.5: carnix -o hello.nix --src ./. Cargo.lock --standalone
-{ lib, stdenv, buildRustCrate, fetchgit }:
-let kernel = stdenv.buildPlatform.parsed.kernel.name;
+{ lib, buildPlatform, buildRustCrate, fetchgit }:
+let kernel = buildPlatform.parsed.kernel.name;
     # ... (content skipped)
 in
 rec {
@@ -119,8 +117,8 @@ following nix file:
 
 ```
 # Generated by carnix 0.6.5: carnix -o hello.nix --src ./. Cargo.lock --standalone
-{ lib, stdenv, buildRustCrate, fetchgit }:
-let kernel = stdenv.buildPlatform.parsed.kernel.name;
+{ lib, buildPlatform, buildRustCrate, fetchgit }:
+let kernel = buildPlatform.parsed.kernel.name;
     # ... (content skipped)
 in
 rec {

doc/languages-frameworks/texlive.xml

@@ -1,42 +1,27 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-texlive">
- <title>TeX Live</title>
 
- <para>
-  Since release 15.09 there is a new TeX Live packaging that lives entirely
-  under attribute <varname>texlive</varname>.
- </para>
-
- <section xml:id="sec-language-texlive-users-guide">
-  <title>User's guide</title>
+<title>TeX Live</title>
 
+<para>Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute <varname>texlive</varname>.</para>
+<section><title>User's guide</title>
   <itemizedlist>
-   <listitem>
-    <para>
-     For basic usage just pull <varname>texlive.combined.scheme-basic</varname>
-     for an environment with basic LaTeX support.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     It typically won't work to use separately installed packages together.
-     Instead, you can build a custom set of packages like this:
-<programlisting>
+    <listitem><para>
+      For basic usage just pull <varname>texlive.combined.scheme-basic</varname> for an environment with basic LaTeX support.</para></listitem>
+    <listitem><para>
+      It typically won't work to use separately installed packages together.
+      Instead, you can build a custom set of packages like this:
+      <programlisting>
 texlive.combine {
   inherit (texlive) scheme-small collection-langkorean algorithms cm-super;
 }
       </programlisting>
-     There are all the schemes, collections and a few thousand packages, as
-     defined upstream (perhaps with tiny differences).
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     By default you only get executables and files needed during runtime, and a
-     little documentation for the core packages. To change that, you need to
-     add <varname>pkgFilter</varname> function to <varname>combine</varname>.
-<programlisting>
+      There are all the schemes, collections and a few thousand packages, as defined upstream (perhaps with tiny differences).
+    </para></listitem>
+    <listitem><para>
+      By default you only get executables and files needed during runtime, and a little documentation for the core packages.  To change that, you need to add <varname>pkgFilter</varname> function to <varname>combine</varname>.
+      <programlisting>
 texlive.combine {
   # inherit (texlive) whatever-you-want;
   pkgFilter = pkg:
@@ -45,55 +30,31 @@ texlive.combine {
   # there are also other attributes: version, name
 }
       </programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     You can list packages e.g. by <command>nix-repl</command>.
-<programlisting>
+    </para></listitem>
+    <listitem><para>
+      You can list packages e.g. by <command>nix-repl</command>.
+      <programlisting>
 $ nix-repl
 nix-repl> :l &lt;nixpkgs>
 nix-repl> texlive.collection-&lt;TAB>
       </programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Note that the wrapper assumes that the result has a chance to be useful.
-     For example, the core executables should be present, as well as some core
-     data files. The supported way of ensuring this is by including some
-     scheme, for example <varname>scheme-basic</varname>, into the combination.
-    </para>
-   </listitem>
+    </para></listitem>
   </itemizedlist>
- </section>
-
- <section xml:id="sec-language-texlive-known-problems">
-  <title>Known problems</title>
-
-  <itemizedlist>
-   <listitem>
-    <para>
-     Some tools are still missing, e.g. luajittex;
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     some apps aren't packaged/tested yet (asymptote, biber, etc.);
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     feature/bug: when a package is rejected by <varname>pkgFilter</varname>,
-     its dependencies are still propagated;
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     in case of any bugs or feature requests, file a github issue or better a
-     pull request and /cc @vcunat.
-    </para>
-   </listitem>
-  </itemizedlist>
- </section>
 </section>
+
+<section><title>Known problems</title>
+  <itemizedlist>
+    <listitem><para>
+      Some tools are still missing, e.g. luajittex;</para></listitem>
+    <listitem><para>
+      some apps aren't packaged/tested yet (asymptote, biber, etc.);</para></listitem>
+    <listitem><para>
+      feature/bug: when a package is rejected by <varname>pkgFilter</varname>, its dependencies are still propagated;</para></listitem>
+    <listitem><para>
+      in case of any bugs or feature requests, file a github issue or better a pull request and /cc @vcunat.</para></listitem>
+  </itemizedlist>
+</section>
+
+
+</section>
+

doc/languages-frameworks/vim.section.md

@@ -5,16 +5,11 @@ date: 2016-06-25
 ---
 # User's Guide to Vim Plugins/Addons/Bundles/Scripts in Nixpkgs
 
-Both Neovim and Vim can be configured to include your favorite plugins
-and additional libraries.
-
+You'll get a vim(-your-suffix) in PATH also loading the plugins you want.
 Loading can be deferred; see examples.
 
-At the moment we support three different methods for managing plugins:
-
-- Vim packages (*recommend*)
-- VAM (=vim-addon-manager)
-- Pathogen
+Vim packages, VAM (=vim-addon-manager) and Pathogen are supported to load
+packages.
 
 ## Custom configuration
 
@@ -30,19 +25,7 @@ vim_configurable.customize {
 }
 ```
 
-For Neovim the `configure` argument can be overridden to achieve the same:
-
-```
-neovim.override {
-  configure = {
-    customRC = ''
-      # here your custom configuration goes!
-    '';
-  };
-}
-```
-
-## Managing plugins with Vim packages
+## Vim packages
 
 To store you plugins in Vim packages the following example can be used:
 
@@ -55,50 +38,13 @@ vim_configurable.customize {
     opt = [ phpCompletion elm-vim ];
     # To automatically load a plugin when opening a filetype, add vimrc lines like:
     # autocmd FileType php :packadd phpCompletion
-  };
-}
+  }
+};
 ```
 
-For Neovim the syntax is
+## VAM
 
-```
-neovim.override {
-  configure = {
-    customRC = ''
-      # here your custom configuration goes!
-    '';
-    packages.myVimPackage = with pkgs.vimPlugins; {
-      # see examples below how to use custom packages
-      start = [ ];
-      opt = [ ];
-    };
-  };
-}
-```
-
-The resulting package can be added to `packageOverrides` in `~/.nixpkgs/config.nix` to make it installable:
-
-```
-{
-  packageOverrides = pkgs: with pkgs; {
-    myVim = vim_configurable.customize {
-      name = "vim-with-plugins";
-      # add here code from the example section
-    };
-    myNeovim = neovim.override {
-      configure = {
-      # add here code from the example section
-      };
-    };
-  };
-}
-```
-
-After that you can install your special grafted `myVim` or `myNeovim` packages.
-
-## Managing plugins with VAM
-
-### Handling dependencies of Vim plugins
+### dependencies by Vim plugins
 
 VAM introduced .json files supporting dependencies without versioning
 assuming that "using latest version" is ok most of the time.

doc/lib-function-locations.nix

@@ -1,85 +0,0 @@
-{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
-let
-  revision = pkgs.lib.trivial.revisionWithDefault (nixpkgs.revision or "master");
-
-  libDefPos = set:
-    builtins.map
-      (name: {
-        name = name;
-        location = builtins.unsafeGetAttrPos name set;
-      })
-      (builtins.attrNames set);
-
-  libset = toplib:
-    builtins.map
-      (subsetname: {
-        subsetname = subsetname;
-        functions = libDefPos toplib."${subsetname}";
-      })
-      (builtins.filter
-        (name: builtins.isAttrs toplib."${name}")
-        (builtins.attrNames toplib));
-
-  nixpkgsLib = pkgs.lib;
-
-  flattenedLibSubset = { subsetname, functions }:
-  builtins.map
-    (fn: {
-      name = "lib.${subsetname}.${fn.name}";
-      value = fn.location;
-    })
-    functions;
-
-  locatedlibsets = libs: builtins.map flattenedLibSubset (libset libs);
-  removeFilenamePrefix = prefix: filename:
-    let
-    prefixLen = (builtins.stringLength prefix) + 1; # +1 to remove the leading /
-      filenameLen = builtins.stringLength filename;
-      substr = builtins.substring prefixLen filenameLen filename;
-      in substr;
-
-  removeNixpkgs = removeFilenamePrefix (builtins.toString pkgs.path);
-
-  liblocations =
-    builtins.filter
-      (elem: elem.value != null)
-      (nixpkgsLib.lists.flatten
-        (locatedlibsets nixpkgsLib));
-
-  fnLocationRelative = { name, value }:
-    {
-      inherit name;
-      value = value // { file = removeNixpkgs value.file; };
-    };
-
-  relativeLocs = (builtins.map fnLocationRelative liblocations);
-  sanitizeId = builtins.replaceStrings
-    [ "'"      ]
-    [ "-prime" ];
-
-  urlPrefix = "https://github.com/NixOS/nixpkgs/blob/${revision}";
-  xmlstrings = (nixpkgsLib.strings.concatMapStrings
-      ({ name, value }:
-      ''
-      <section><title>${name}</title>
-        <para xml:id="${sanitizeId name}">
-        Located at
-        <link
-          xlink:href="${urlPrefix}/${value.file}#L${builtins.toString value.line}">${value.file}:${builtins.toString value.line}</link>
-        in  <literal>&lt;nixpkgs&gt;</literal>.
-        </para>
-        </section>
-      '')
-      relativeLocs);
-
-in pkgs.writeText
-    "locations.xml"
-    ''
-    <section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         version="5">
-         <title>All the locations for every lib function</title>
-         <para>This file is only for inclusion by other files.</para>
-         ${xmlstrings}
-    </section>
-    ''

doc/manual.xml

@@ -1,24 +1,29 @@
 <book xmlns="http://docbook.org/ns/docbook"
       xmlns:xi="http://www.w3.org/2001/XInclude">
- <info>
-  <title>Nixpkgs Contributors Guide</title>
-  <subtitle>Version <xi:include href=".version" parse="text" />
-  </subtitle>
- </info>
- <xi:include href="introduction.chapter.xml" />
- <xi:include href="quick-start.xml" />
- <xi:include href="stdenv.xml" />
- <xi:include href="multiple-output.xml" />
- <xi:include href="cross-compilation.xml" />
- <xi:include href="configuration.xml" />
- <xi:include href="functions.xml" />
- <xi:include href="meta.xml" />
- <xi:include href="languages-frameworks/index.xml" />
- <xi:include href="platform-notes.xml" />
- <xi:include href="package-notes.xml" />
- <xi:include href="overlays.xml" />
- <xi:include href="coding-conventions.xml" />
- <xi:include href="submitting-changes.xml" />
- <xi:include href="reviewing-contributions.xml" />
- <xi:include href="contributing.xml" />
+
+  <info>
+
+    <title>Nixpkgs Contributors Guide</title>
+
+    <subtitle>Version <xi:include href=".version" parse="text" /></subtitle>
+
+  </info>
+
+  <xi:include href="introduction.chapter.xml" />
+  <xi:include href="quick-start.xml" />
+  <xi:include href="stdenv.xml" />
+  <xi:include href="multiple-output.xml" />
+  <xi:include href="cross-compilation.xml" />
+  <xi:include href="configuration.xml" />
+  <xi:include href="functions.xml" />
+  <xi:include href="meta.xml" />
+  <xi:include href="languages-frameworks/index.xml" />
+  <xi:include href="platform-notes.xml" />
+  <xi:include href="package-notes.xml" />
+  <xi:include href="overlays.xml" />
+  <xi:include href="coding-conventions.xml" />
+  <xi:include href="submitting-changes.xml" />
+  <xi:include href="reviewing-contributions.xml" />
+  <xi:include href="contributing.xml" />
+
 </book>

doc/meta.xml

@@ -1,34 +1,37 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-meta">
- <title>Meta-attributes</title>
- <para>
-  Nix packages can declare <emphasis>meta-attributes</emphasis> that contain
-  information about a package such as a description, its homepage, its license,
-  and so on. For instance, the GNU Hello package has a <varname>meta</varname>
-  declaration like this:
+
+<title>Meta-attributes</title>
+
+<para>Nix packages can declare <emphasis>meta-attributes</emphasis>
+that contain information about a package such as a description, its
+homepage, its license, and so on.  For instance, the GNU Hello package
+has a <varname>meta</varname> declaration like this:
+
 <programlisting>
-meta = with stdenv.lib; {
+meta = {
   description = "A program that produces a familiar, friendly greeting";
   longDescription = ''
     GNU Hello is a program that prints "Hello, world!" when you run it.
     It is fully customizable.
   '';
   homepage = http://www.gnu.org/software/hello/manual/;
-  license = licenses.gpl3Plus;
-  maintainers = [ maintainers.eelco ];
-  platforms = platforms.all;
+  license = stdenv.lib.licenses.gpl3Plus;
+  maintainers = [ stdenv.lib.maintainers.eelco ];
+  platforms = stdenv.lib.platforms.all;
 };
 </programlisting>
- </para>
- <para>
-  Meta-attributes are not passed to the builder of the package. Thus, a change
-  to a meta-attribute doesn’t trigger a recompilation of the package. The
-  value of a meta-attribute must be a string.
- </para>
- <para>
-  The meta-attributes of a package can be queried from the command-line using
-  <command>nix-env</command>:
+
+</para>
+
+<para>Meta-attributes are not passed to the builder of the package.
+Thus, a change to a meta-attribute doesn’t trigger a recompilation of
+the package.  The value of a meta-attribute must be a string.</para>
+
+<para>The meta-attributes of a package can be queried from the
+command-line using <command>nix-env</command>:
+
 <screen>
 $ nix-env -qa hello --json
 {
@@ -67,311 +70,252 @@ $ nix-env -qa hello --json
 
 
 </screen>
-  <command>nix-env</command> knows about the <varname>description</varname>
-  field specifically:
+
+<command>nix-env</command> knows about the
+<varname>description</varname> field specifically:
+
 <screen>
 $ nix-env -qa hello --description
 hello-2.3  A program that produces a familiar, friendly greeting
 </screen>
- </para>
- <section xml:id="sec-standard-meta-attributes">
-  <title>Standard meta-attributes</title>
 
-  <para>
-   It is expected that each meta-attribute is one of the following:
-  </para>
+</para>
+
+
+<section xml:id="sec-standard-meta-attributes"><title>Standard
+meta-attributes</title>
+
+<para>It is expected that each meta-attribute is one of the following:</para>
+
+<variablelist>
+
+  <varlistentry>
+    <term><varname>description</varname></term>
+    <listitem><para>A short (one-line) description of the package.
+    This is shown by <command>nix-env -q --description</command> and
+    also on the Nixpkgs release pages.</para>
+
+    <para>Don’t include a period at the end.  Don’t include newline
+    characters.  Capitalise the first character.  For brevity, don’t
+    repeat the name of package — just describe what it does.</para>
+
+    <para>Wrong: <literal>"libpng is a library that allows you to decode PNG images."</literal></para>
+
+    <para>Right: <literal>"A library for decoding PNG images"</literal></para>
 
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>description</varname>
-    </term>
-    <listitem>
-     <para>
-      A short (one-line) description of the package. This is shown by
-      <command>nix-env -q --description</command> and also on the Nixpkgs
-      release pages.
-     </para>
-     <para>
-      Don’t include a period at the end. Don’t include newline characters.
-      Capitalise the first character. For brevity, don’t repeat the name of
-      package — just describe what it does.
-     </para>
-     <para>
-      Wrong: <literal>"libpng is a library that allows you to decode PNG
-      images."</literal>
-     </para>
-     <para>
-      Right: <literal>"A library for decoding PNG images"</literal>
-     </para>
     </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>longDescription</varname>
-    </term>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>longDescription</varname></term>
+    <listitem><para>An arbitrarily long description of the
+    package.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>branch</varname></term>
+    <listitem><para>Release branch. Used to specify that a package is not
+    going to receive updates that are not in this branch; for example, Linux
+    kernel 3.0 is supposed to be updated to 3.0.X, not 3.1.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>homepage</varname></term>
+    <listitem><para>The package’s homepage.  Example:
+    <literal>http://www.gnu.org/software/hello/manual/</literal></para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>downloadPage</varname></term>
+    <listitem><para>The page where a link to the current version can be found.  Example:
+    <literal>http://ftp.gnu.org/gnu/hello/</literal></para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>license</varname></term>
     <listitem>
-     <para>
-      An arbitrarily long description of the package.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>branch</varname>
-    </term>
-    <listitem>
-     <para>
-      Release branch. Used to specify that a package is not going to receive
-      updates that are not in this branch; for example, Linux kernel 3.0 is
-      supposed to be updated to 3.0.X, not 3.1.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>homepage</varname>
-    </term>
-    <listitem>
-     <para>
-      The package’s homepage. Example:
-      <literal>http://www.gnu.org/software/hello/manual/</literal>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>downloadPage</varname>
-    </term>
-    <listitem>
-     <para>
-      The page where a link to the current version can be found. Example:
-      <literal>http://ftp.gnu.org/gnu/hello/</literal>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>license</varname>
-    </term>
-    <listitem>
-     <para>
-      The license, or licenses, for the package. One from the attribute set
-      defined in
-      <link
+      <para>
+        The license, or licenses, for the package. One from the attribute set
+        defined in <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix">
-      <filename>nixpkgs/lib/licenses.nix</filename></link>. At this moment
-      using both a list of licenses and a single license is valid. If the
-      license field is in the form of a list representation, then it means that
-      parts of the package are licensed differently. Each license should
-      preferably be referenced by their attribute. The non-list attribute value
-      can also be a space delimited string representation of the contained
-      attribute shortNames or spdxIds. The following are all valid examples:
-      <itemizedlist>
-       <listitem>
-        <para>
-         Single license referenced by attribute (preferred)
-         <literal>stdenv.lib.licenses.gpl3</literal>.
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Single license referenced by its attribute shortName (frowned upon)
-         <literal>"gpl3"</literal>.
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Single license referenced by its attribute spdxId (frowned upon)
-         <literal>"GPL-3.0"</literal>.
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Multiple licenses referenced by attribute (preferred) <literal>with
-         stdenv.lib.licenses; [ asl20 free ofl ]</literal>.
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Multiple licenses referenced as a space delimited string of attribute
-         shortNames (frowned upon) <literal>"asl20 free ofl"</literal>.
-        </para>
-       </listitem>
-      </itemizedlist>
-      For details, see <xref linkend='sec-meta-license'/>.
-     </para>
+          <filename>nixpkgs/lib/licenses.nix</filename></link>. At this moment
+        using both a list of licenses and a single license is valid. If the
+        license field is in the form of a list representation, then it means
+        that parts of the package are licensed differently.  Each license
+        should preferably be referenced by their attribute. The non-list
+        attribute value can also be a space delimited string representation of
+        the contained attribute shortNames or spdxIds. The following are all valid
+        examples:
+        <itemizedlist>
+          <listitem><para>Single license referenced by attribute (preferred)
+              <literal>stdenv.lib.licenses.gpl3</literal>.
+          </para></listitem>
+          <listitem><para>Single license referenced by its attribute shortName (frowned upon)
+              <literal>"gpl3"</literal>.
+          </para></listitem>
+          <listitem><para>Single license referenced by its attribute spdxId (frowned upon)
+              <literal>"GPL-3.0"</literal>.
+          </para></listitem>
+          <listitem><para>Multiple licenses referenced by attribute (preferred)
+              <literal>with stdenv.lib.licenses; [ asl20 free ofl ]</literal>.
+          </para></listitem>
+          <listitem><para>Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon)
+              <literal>"asl20 free ofl"</literal>.
+          </para></listitem>
+        </itemizedlist>
+        For details, see <xref linkend='sec-meta-license'/>.
+      </para>
     </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>maintainers</varname>
-    </term>
-    <listitem>
-     <para>
-      A list of names and e-mail addresses of the maintainers of this Nix
-      expression. If you would like to be a maintainer of a package, you may
-      want to add yourself to
-      <link
-    xlink:href="https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix"><filename>nixpkgs/maintainers/maintainer-list.nix</filename></link>
-      and write something like <literal>[ stdenv.lib.maintainers.alice
-      stdenv.lib.maintainers.bob ]</literal>.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>priority</varname>
-    </term>
-    <listitem>
-     <para>
-      The <emphasis>priority</emphasis> of the package, used by
-      <command>nix-env</command> to resolve file name conflicts between
-      packages. See the Nix manual page for <command>nix-env</command> for
-      details. Example: <literal>"10"</literal> (a low-priority package).
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>platforms</varname>
-    </term>
-    <listitem>
-     <para>
-      The list of Nix platform types on which the package is supported. Hydra
-      builds packages according to the platform specified. If no platform is
-      specified, the package does not have prebuilt binaries. An example is:
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>maintainers</varname></term>
+    <listitem><para>A list of names and e-mail addresses of the
+    maintainers of this Nix expression. If
+    you would like to be a maintainer of a package, you may want to add
+    yourself to <link
+    xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/maintainers.nix"><filename>nixpkgs/lib/maintainers.nix</filename></link>
+    and write something like <literal>[ stdenv.lib.maintainers.alice
+    stdenv.lib.maintainers.bob ]</literal>.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>priority</varname></term>
+    <listitem><para>The <emphasis>priority</emphasis> of the package,
+    used by <command>nix-env</command> to resolve file name conflicts
+    between packages.  See the Nix manual page for
+    <command>nix-env</command> for details.  Example:
+    <literal>"10"</literal> (a low-priority
+    package).</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>platforms</varname></term>
+    <listitem><para>The list of Nix platform types on which the
+    package is supported. Hydra builds packages according to the
+    platform specified. If no platform is specified, the package does
+    not have prebuilt binaries. An example is:
+
 <programlisting>
 meta.platforms = stdenv.lib.platforms.linux;
 </programlisting>
-      Attribute Set <varname>stdenv.lib.platforms</varname> defines
-      <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix">
-      various common lists</link> of platforms types.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>hydraPlatforms</varname>
-    </term>
-    <listitem>
-     <para>
-      The list of Nix platform types for which the Hydra instance at
-      <literal>hydra.nixos.org</literal> will build the package. (Hydra is the
-      Nix-based continuous build system.) It defaults to the value of
-      <varname>meta.platforms</varname>. Thus, the only reason to set
-      <varname>meta.hydraPlatforms</varname> is if you want
-      <literal>hydra.nixos.org</literal> to build the package on a subset of
-      <varname>meta.platforms</varname>, or not at all, e.g.
+
+    Attribute Set <varname>stdenv.lib.platforms</varname> defines
+    <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix">
+    various common lists</link> of platforms types.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>hydraPlatforms</varname></term>
+    <listitem><para>The list of Nix platform types for which the Hydra
+    instance at <literal>hydra.nixos.org</literal> will build the
+    package.  (Hydra is the Nix-based continuous build system.)  It
+    defaults to the value of <varname>meta.platforms</varname>.  Thus,
+    the only reason to set <varname>meta.hydraPlatforms</varname> is
+    if you want <literal>hydra.nixos.org</literal> to build the
+    package on a subset of <varname>meta.platforms</varname>, or not
+    at all, e.g.
+
 <programlisting>
 meta.platforms = stdenv.lib.platforms.linux;
 meta.hydraPlatforms = [];
 </programlisting>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>broken</varname>
-    </term>
-    <listitem>
-     <para>
-      If set to <literal>true</literal>, the package is marked as “broken”,
-      meaning that it won’t show up in <literal>nix-env -qa</literal>, and
-      cannot be built or installed. Such packages should be removed from
-      Nixpkgs eventually unless they are fixed.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>updateWalker</varname>
-    </term>
-    <listitem>
-     <para>
-      If set to <literal>true</literal>, the package is tested to be updated
-      correctly by the <literal>update-walker.sh</literal> script without
-      additional settings. Such packages have <varname>meta.version</varname>
-      set and their homepage (or the page specified by
-      <varname>meta.downloadPage</varname>) contains a direct link to the
-      package tarball.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
- </section>
- <section xml:id="sec-meta-license">
-  <title>Licenses</title>
 
-  <para>
-   The <varname>meta.license</varname> attribute should preferrably contain a
-   value from <varname>stdenv.lib.licenses</varname> defined in
-   <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix">
-   <filename>nixpkgs/lib/licenses.nix</filename></link>, or in-place license
-   description of the same format if the license is unlikely to be useful in
-   another expression.
-  </para>
+    </para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>broken</varname></term>
+    <listitem><para>If set to <literal>true</literal>, the package is
+    marked as “broken”, meaning that it won’t show up in
+    <literal>nix-env -qa</literal>, and cannot be built or installed.
+    Such packages should be removed from Nixpkgs eventually unless
+    they are fixed.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>updateWalker</varname></term>
+    <listitem><para>If set to <literal>true</literal>, the package is
+    tested to be updated correctly by the <literal>update-walker.sh</literal>
+    script without additional settings. Such packages have
+    <varname>meta.version</varname> set and their homepage (or
+    the page specified by <varname>meta.downloadPage</varname>) contains
+    a direct link to the package tarball.</para></listitem>
+  </varlistentry>
+
+</variablelist>
+
+
+</section>
+
+
+<section xml:id="sec-meta-license"><title>Licenses</title>
+
+<para>The <varname>meta.license</varname> attribute should preferrably contain
+a value from <varname>stdenv.lib.licenses</varname> defined in
+<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix">
+<filename>nixpkgs/lib/licenses.nix</filename></link>,
+or in-place license description of the same format if the license is
+unlikely to be useful in another expression.</para>
+
+<para>Although it's typically better to indicate the specific license,
+a few generic options are available:
+
+<variablelist>
+
+  <varlistentry>
+    <term><varname>stdenv.lib.licenses.free</varname>,
+    <varname>"free"</varname></term>
+
+    <listitem><para>Catch-all for free software licenses not listed
+    above.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>stdenv.lib.licenses.unfreeRedistributable</varname>,
+    <varname>"unfree-redistributable"</varname></term>
+
+    <listitem><para>Unfree package that can be redistributed in binary
+    form. That is, it’s legal to redistribute the
+    <emphasis>output</emphasis> of the derivation.  This means that
+    the package can be included in the Nixpkgs
+    channel.</para>
+
+    <para>Sometimes proprietary software can only be redistributed
+    unmodified. Make sure the builder doesn’t actually modify the
+    original binaries; otherwise we’re breaking the license.  For
+    instance, the NVIDIA X11 drivers can be redistributed unmodified,
+    but our builder applies <command>patchelf</command> to make them
+    work. Thus, its license is <varname>"unfree"</varname> and it
+    cannot be included in the Nixpkgs channel.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>stdenv.lib.licenses.unfree</varname>,
+    <varname>"unfree"</varname></term>
+
+    <listitem><para>Unfree package that cannot be redistributed. You
+    can build it yourself, but you cannot redistribute the output of
+    the derivation. Thus it cannot be included in the Nixpkgs
+    channel.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>,
+    <varname>"unfree-redistributable-firmware"</varname></term>
+
+    <listitem><para>This package supplies unfree, redistributable
+    firmware.  This is a separate value from
+    <varname>unfree-redistributable</varname> because not everybody
+    cares whether firmware is free.</para></listitem>
+  </varlistentry>
+
+</variablelist>
+
+</para>
+
+
+</section>
+
 
-  <para>
-   Although it's typically better to indicate the specific license, a few
-   generic options are available:
-   <variablelist>
-    <varlistentry>
-     <term>
-      <varname>stdenv.lib.licenses.free</varname>, <varname>"free"</varname>
-     </term>
-     <listitem>
-      <para>
-       Catch-all for free software licenses not listed above.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>stdenv.lib.licenses.unfreeRedistributable</varname>, <varname>"unfree-redistributable"</varname>
-     </term>
-     <listitem>
-      <para>
-       Unfree package that can be redistributed in binary form. That is, it’s
-       legal to redistribute the <emphasis>output</emphasis> of the derivation.
-       This means that the package can be included in the Nixpkgs channel.
-      </para>
-      <para>
-       Sometimes proprietary software can only be redistributed unmodified.
-       Make sure the builder doesn’t actually modify the original binaries;
-       otherwise we’re breaking the license. For instance, the NVIDIA X11
-       drivers can be redistributed unmodified, but our builder applies
-       <command>patchelf</command> to make them work. Thus, its license is
-       <varname>"unfree"</varname> and it cannot be included in the Nixpkgs
-       channel.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>stdenv.lib.licenses.unfree</varname>, <varname>"unfree"</varname>
-     </term>
-     <listitem>
-      <para>
-       Unfree package that cannot be redistributed. You can build it yourself,
-       but you cannot redistribute the output of the derivation. Thus it cannot
-       be included in the Nixpkgs channel.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>, <varname>"unfree-redistributable-firmware"</varname>
-     </term>
-     <listitem>
-      <para>
-       This package supplies unfree, redistributable firmware. This is a
-       separate value from <varname>unfree-redistributable</varname> because
-       not everybody cares whether firmware is free.
-      </para>
-     </listitem>
-    </varlistentry>
-   </variablelist>
-  </para>
- </section>
 </chapter>

doc/multiple-output.xml

@@ -5,319 +5,99 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-multiple-output">
- <title>Multiple-output packages</title>
- <section xml:id="sec-multiple-outputs-introduction">
-  <title>Introduction</title>
 
-  <para>
-   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
-   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.
-  </para>
+<title>Multiple-output packages</title>
 
-  <para>
-   The main motivation is to save disk space by reducing runtime closure sizes;
-   consequently also sizes of substituted binaries get reduced. Splitting can
-   be used to have more granular runtime dependencies, for example the typical
-   reduction is to split away development-only files, as those are typically
-   not needed during runtime. As a result, closure sizes of many packages can
-   get reduced to a half or even much less.
-  </para>
-
-  <note>
-   <para>
-    The reduction effects could be instead achieved by building the parts in
-    completely separate derivations. That would often additionally reduce
-    build-time closures, but it tends to be much harder to write such
-    derivations, as build systems typically assume all parts are being built at
-    once. This compromise approach of single source package producing multiple
-    binary packages is also utilized often by rpm and deb.
-   </para>
-  </note>
- </section>
- <section xml:id="sec-multiple-outputs-installing">
-  <title>Installing a split package</title>
-
-  <para>
-   When installing a package via <varname>systemPackages</varname> or
-   <command>nix-env</command> you have several options:
-  </para>
+<section><title>Introduction</title>
+  <para>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 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.</para>
+  <para>The main motivation is to save disk space by reducing runtime closure sizes; consequently also sizes of substituted binaries get reduced.  Splitting can be used to have more granular runtime dependencies, for example the typical reduction is to split away development-only files, as those are typically not needed during runtime.  As a result, closure sizes of many packages can get reduced to a half or even much less.</para>
+  <note><para>The reduction effects could be instead achieved by building the parts in completely separate derivations.  That would often additionally reduce build-time closures, but it tends to be much harder to write such derivations, as build systems typically assume all parts are being built at once.  This compromise approach of single source package producing multiple binary packages is also utilized often by rpm and deb.</para></note>
+</section>
 
+<section><title>Installing a split package</title>
+  <para>When installing a package via <varname>systemPackages</varname> or <command>nix-env</command> you have several options:</para>
   <itemizedlist>
-   <listitem>
-    <para>
-     You can install particular outputs explicitly, as each is available in the
-     Nix language as an attribute of the package. The
-     <varname>outputs</varname> attribute contains a list of output names.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     You can let it use the default outputs. These are handled by
-     <varname>meta.outputsToInstall</varname> attribute that contains a list of
-     output names.
-    </para>
-    <para>
-     TODO: more about tweaking the attribute, etc.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     NixOS provides configuration option
-     <varname>environment.extraOutputsToInstall</varname> that allows adding
-     extra outputs of <varname>environment.systemPackages</varname> atop the
-     default ones. It's mainly meant for documentation and debug symbols, and
-     it's also modified by specific options.
-    </para>
-    <note>
-     <para>
-      At this moment there is no similar configurability for packages installed
-      by <command>nix-env</command>. You can still use approach from
-      <xref linkend="sec-modify-via-packageOverrides" /> to override
-      <varname>meta.outputsToInstall</varname> attributes, but that's a rather
-      inconvenient way.
-     </para>
-    </note>
-   </listitem>
+    <listitem><para>You can install particular outputs explicitly, as each is available in the Nix language as an attribute of the package.  The <varname>outputs</varname> attribute contains a list of output names.</para></listitem>
+    <listitem><para>You can let it use the default outputs.  These are handled by <varname>meta.outputsToInstall</varname> attribute that contains a list of output names.</para>
+      <para>TODO: more about tweaking the attribute, etc.</para></listitem>
+    <listitem><para>NixOS provides configuration option <varname>environment.extraOutputsToInstall</varname> that allows adding extra outputs of <varname>environment.systemPackages</varname> atop the default ones.  It's mainly meant for documentation and debug symbols, and it's also modified by specific options.</para>
+      <note><para>At this moment there is no similar configurability for packages installed by <command>nix-env</command>.  You can still use approach from <xref linkend="sec-modify-via-packageOverrides" /> to override <varname>meta.outputsToInstall</varname> attributes, but that's a rather inconvenient way.</para></note>
+    </listitem>
   </itemizedlist>
- </section>
- <section xml:id="sec-multiple-outputs-using-split-packages">
-  <title>Using a split package</title>
+</section>
 
-  <para>
-   In the Nix language the individual outputs can be reached explicitly as
-   attributes, e.g. <varname>coreutils.info</varname>, but the typical case is
-   just using packages as build inputs.
-  </para>
+<section><title>Using a split package</title>
+  <para>In the Nix language the individual outputs can be reached explicitly as attributes, e.g. <varname>coreutils.info</varname>, but the typical case is just using packages as build inputs.</para>
+  <para>When a multiple-output derivation gets into a build input of another derivation, the <varname>dev</varname> output is added if it exists, otherwise the first output is added. In addition to that, <varname>propagatedBuildOutputs</varname> of that package which by default contain <varname>$outputBin</varname> and <varname>$outputLib</varname> are also added. (See <xref linkend="multiple-output-file-type-groups" />.)</para>
+</section>
 
-  <para>
-   When a multiple-output derivation gets into a build input of another
-   derivation, the <varname>dev</varname> output is added if it exists,
-   otherwise the first output is added. In addition to that,
-   <varname>propagatedBuildOutputs</varname> of that package which by default
-   contain <varname>$outputBin</varname> and <varname>$outputLib</varname> are
-   also added. (See <xref linkend="multiple-output-file-type-groups" />.)
-  </para>
- </section>
- <section xml:id="sec-multiple-outputs-">
-  <title>Writing a split derivation</title>
 
-  <para>
-   Here you find how to write a derivation that produces multiple outputs.
-  </para>
+<section><title>Writing a split derivation</title>
+  <para>Here you find how to write a derivation that produces multiple outputs.</para>
+  <para>In nixpkgs there is a framework supporting multiple-output derivations. It tries to cover most cases by default behavior.  You can find the source separated in &lt;<filename>nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh</filename>&gt;; it's relatively well-readable.  The whole machinery is triggered by defining the <varname>outputs</varname> attribute to contain the list of desired output names (strings).</para>
+  <programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting>
+  <para>Often such a single line is enough.  For each output an equally named environment variable is passed to the builder and contains the path in nix store for that output.  By convention, the first output should contain the executable programs provided by the package as that output is used by Nix in string conversions, allowing references to binaries like <literal>${pkgs.perl}/bin/perl</literal> to always work. Typically you also want to have the main <varname>out</varname> output, as it catches any files that didn't get elsewhere.</para>
 
-  <para>
-   In nixpkgs there is a framework supporting multiple-output derivations. It
-   tries to cover most cases by default behavior. You can find the source
-   separated in
-   &lt;<filename>nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh</filename>&gt;;
-   it's relatively well-readable. The whole machinery is triggered by defining
-   the <varname>outputs</varname> attribute to contain the list of desired
-   output names (strings).
-  </para>
-
-<programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting>
-
-  <para>
-   Often such a single line is enough. For each output an equally named
-   environment variable is passed to the builder and contains the path in nix
-   store for that output. Typically you also want to have the main
-   <varname>out</varname> output, as it catches any files that didn't get
-   elsewhere.
-  </para>
-
-  <note>
-   <para>
-    There is a special handling of the <varname>debug</varname> output,
-    described at <xref linkend="stdenv-separateDebugInfo" />.
-   </para>
-  </note>
-
-  <section xml:id="multiple-output-file-binaries-first-convention">
-   <title><quote>Binaries first</quote></title>
-
-   <para>
-    A commonly adopted convention in <literal>nixpkgs</literal> is that
-    executables provided by the package are contained within its first output.
-    This convention allows the dependent packages to reference the executables
-    provided by packages in a uniform manner. For instance, provided with the
-    knowledge that the <literal>perl</literal> package contains a
-    <literal>perl</literal> executable it can be referenced as
-    <literal>${pkgs.perl}/bin/perl</literal> within a Nix derivation that needs
-    to execute a Perl script.
-   </para>
-
-   <para>
-    The <literal>glibc</literal> package is a deliberate single exception to
-    the <quote>binaries first</quote> convention. The <literal>glibc</literal>
-    has <literal>libs</literal> as its first output allowing the libraries
-    provided by <literal>glibc</literal> to be referenced directly (e.g.
-    <literal>${stdenv.glibc}/lib/ld-linux-x86-64.so.2</literal>). The
-    executables provided by <literal>glibc</literal> can be accessed via its
-    <literal>bin</literal> attribute (e.g.
-    <literal>${stdenv.glibc.bin}/bin/ldd</literal>).
-   </para>
-
-   <para>
-    The reason for why <literal>glibc</literal> deviates from the convention is
-    because referencing a library provided by <literal>glibc</literal> is a
-    very common operation among Nix packages. For instance, third-party
-    executables packaged by Nix are typically patched and relinked with the
-    relevant version of <literal>glibc</literal> libraries from Nix packages
-    (please see the documentation on
-    <link xlink:href="https://nixos.org/patchelf.html">patchelf</link> for more
-    details).
-   </para>
-  </section>
+  <note><para>There is a special handling of the <varname>debug</varname> output, described at <xref linkend="stdenv-separateDebugInfo" />.</para></note>
 
   <section xml:id="multiple-output-file-type-groups">
-   <title>File type groups</title>
+    <title>File type groups</title>
+    <para>The support code currently recognizes some particular kinds of outputs and either instructs the build system of the package to put files into their desired outputs or it moves the files during the fixup phase.  Each group of file types has an <varname>outputFoo</varname> variable specifying the output name where they should go.  If that variable isn't defined by the derivation writer, it is guessed &ndash; a default output name is defined, falling back to other possibilities if the output isn't defined.</para>
+    <variablelist>
 
-   <para>
-    The support code currently recognizes some particular kinds of outputs and
-    either instructs the build system of the package to put files into their
-    desired outputs or it moves the files during the fixup phase. Each group of
-    file types has an <varname>outputFoo</varname> variable specifying the
-    output name where they should go. If that variable isn't defined by the
-    derivation writer, it is guessed &ndash; a default output name is defined,
-    falling back to other possibilities if the output isn't defined.
-   </para>
+      <varlistentry><term><varname>
+         $outputDev</varname></term><listitem><para>
+         is for development-only files. These include C(++) headers, pkg-config, cmake and aclocal files.  They go to <varname>dev</varname> or <varname>out</varname> by default.
+       </para></listitem>
+      </varlistentry>
 
-   <variablelist>
-    <varlistentry>
-     <term>
-      <varname> $outputDev</varname>
-     </term>
-     <listitem>
-      <para>
-       is for development-only files. These include C(++) headers, pkg-config,
-       cmake and aclocal files. They go to <varname>dev</varname> or
-       <varname>out</varname> by default.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname> $outputBin</varname>
-     </term>
-     <listitem>
-      <para>
-       is meant for user-facing binaries, typically residing in bin/. They go
-       to <varname>bin</varname> or <varname>out</varname> by default.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname> $outputLib</varname>
-     </term>
-     <listitem>
-      <para>
-       is meant for libraries, typically residing in <filename>lib/</filename>
-       and <filename>libexec/</filename>. They go to <varname>lib</varname> or
-       <varname>out</varname> by default.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname> $outputDoc</varname>
-     </term>
-     <listitem>
-      <para>
-       is for user documentation, typically residing in
-       <filename>share/doc/</filename>. It goes to <varname>doc</varname> or
-       <varname>out</varname> by default.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname> $outputDevdoc</varname>
-     </term>
-     <listitem>
-      <para>
-       is for <emphasis>developer</emphasis> documentation. Currently we count
-       gtk-doc and devhelp books in there. It goes to <varname>devdoc</varname>
-       or is removed (!) by default. This is because e.g. gtk-doc tends to be
-       rather large and completely unused by nixpkgs users.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname> $outputMan</varname>
-     </term>
-     <listitem>
-      <para>
-       is for man pages (except for section 3). They go to
-       <varname>man</varname> or <varname>$outputBin</varname> by default.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname> $outputDevman</varname>
-     </term>
-     <listitem>
-      <para>
-       is for section 3 man pages. They go to <varname>devman</varname> or
-       <varname>$outputMan</varname> by default.
-      </para>
-     </listitem>
-    </varlistentry>
-    <varlistentry>
-     <term>
-      <varname> $outputInfo</varname>
-     </term>
-     <listitem>
-      <para>
-       is for info pages. They go to <varname>info</varname> or
-       <varname>$outputBin</varname> by default.
-      </para>
-     </listitem>
-    </varlistentry>
-   </variablelist>
+      <varlistentry><term><varname>
+        $outputBin</varname></term><listitem><para>
+        is meant for user-facing binaries, typically residing in bin/.  They go to <varname>bin</varname> or <varname>out</varname> by default.
+      </para></listitem></varlistentry>
+
+      <varlistentry><term><varname>
+        $outputLib</varname></term><listitem><para>
+        is meant for libraries, typically residing in <filename>lib/</filename> and <filename>libexec/</filename>.  They go to <varname>lib</varname> or <varname>out</varname> by default.
+      </para></listitem></varlistentry>
+
+      <varlistentry><term><varname>
+        $outputDoc</varname></term><listitem><para>
+        is for user documentation, typically residing in <filename>share/doc/</filename>.  It goes to <varname>doc</varname> or <varname>out</varname> by default.
+      </para></listitem></varlistentry>
+
+      <varlistentry><term><varname>
+        $outputDevdoc</varname></term><listitem><para>
+        is for <emphasis>developer</emphasis> documentation.  Currently we count gtk-doc and devhelp books in there.  It goes to <varname>devdoc</varname> or is removed (!) by default.  This is because e.g. gtk-doc tends to be rather large and completely unused by nixpkgs users.
+      </para></listitem></varlistentry>
+
+      <varlistentry><term><varname>
+        $outputMan</varname></term><listitem><para>
+        is for man pages (except for section 3). They go to <varname>man</varname> or <varname>$outputBin</varname> by default.
+      </para></listitem></varlistentry>
+
+      <varlistentry><term><varname>
+        $outputDevman</varname></term><listitem><para>
+        is for section 3 man pages. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default.
+      </para></listitem></varlistentry>
+
+      <varlistentry><term><varname>
+        $outputInfo</varname></term><listitem><para>
+        is for info pages. They go to <varname>info</varname> or <varname>$outputBin</varname> by default.
+      </para></listitem></varlistentry>
+
+    </variablelist>
   </section>
 
-  <section xml:id="sec-multiple-outputs-caveats">
-   <title>Common caveats</title>
-
-   <itemizedlist>
-    <listitem>
-     <para>
-      Some configure scripts don't like some of the parameters passed by
-      default by the framework, e.g. <literal>--docdir=/foo/bar</literal>. You
-      can disable this by setting <literal>setOutputFlags = false;</literal>.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      The outputs of a single derivation can retain references to each other,
-      but note that circular references are not allowed. (And each
-      strongly-connected component would act as a single output anyway.)
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Most of split packages contain their core functionality in libraries.
-      These libraries tend to refer to various kind of data that typically gets
-      into <varname>out</varname>, e.g. locale strings, so there is often no
-      advantage in separating the libraries into <varname>lib</varname>, as
-      keeping them in <varname>out</varname> is easier.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Some packages have hidden assumptions on install paths, which complicates
-      splitting.
-     </para>
-    </listitem>
-   </itemizedlist>
+  <section><title>Common caveats</title>
+    <itemizedlist>
+      <listitem><para>Some configure scripts don't like some of the parameters passed by default by the framework, e.g. <literal>--docdir=/foo/bar</literal>.  You can disable this by setting <literal>setOutputFlags = false;</literal>.</para></listitem>
+      <listitem><para>The outputs of a single derivation can retain references to each other, but note that circular references are not allowed.  (And each strongly-connected component would act as a single output anyway.)</para></listitem>
+      <listitem><para>Most of split packages contain their core functionality in libraries.  These libraries tend to refer to various kind of data that typically gets into <varname>out</varname>, e.g. locale strings, so there is often no advantage in separating the libraries into <varname>lib</varname>, as keeping them in <varname>out</varname> is easier.</para></listitem>
+      <listitem><para>Some packages have hidden assumptions on install paths, which complicates splitting.</para></listitem>
+    </itemizedlist>
   </section>
- </section>
-<!--Writing a split derivation-->
+
+</section><!--Writing a split derivation-->
+
 </chapter>

doc/old/cross.txt

@@ -64,7 +64,7 @@ stdenv.mkDerivation {
     sha256 = "1ian3kwh2vg6hr3ymrv48s04gijs539vzrq62xr76bxbhbwnz2np";
   };
   inherit noSysDirs;
-  configureFlags = [ "--target=arm-linux" ];
+  configureFlags = "--target=arm-linux";
 }
 ---
 
@@ -78,7 +78,7 @@ Step 2: build kernel headers for the target architecture
 ---
 {stdenv, fetchurl}:
 
-assert stdenv.buildPlatform.system == "i686-linux";
+assert stdenv.system == "i686-linux";
 
 stdenv.mkDerivation {
   name = "linux-headers-2.6.13.1-arm";

doc/overlays.xml

@@ -1,117 +1,95 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-overlays">
- <title>Overlays</title>
- <para>
-  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.
- </para>
- <para>
-  Nixpkgs can be configured with a list of overlays, which are applied in
-  order. This means that the order of the overlays can be significant if
-  multiple layers override the same package.
- </para>
+
+<title>Overlays</title>
+
+<para>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.</para>
+
+<para>Nixpkgs can be configured with a list of overlays, which are
+applied in order. This means that the order of the overlays can be significant
+if multiple layers override the same package.</para>
+
 <!--============================================================-->
- <section xml:id="sec-overlays-install">
-  <title>Installing overlays</title>
 
-  <para>
-   The list of overlays is determined as follows.
-  </para>
+<section xml:id="sec-overlays-install">
+<title>Installing overlays</title>
 
-  <para>
-   If the <varname>overlays</varname> argument is not provided explicitly, we
-   look for overlays in a path. The path is determined as follows:
-   <orderedlist>
-    <listitem>
-     <para>
-      First, if an <varname>overlays</varname> argument to the nixpkgs function
-      itself is given, then that is used.
-     </para>
-     <para>
-      This can be passed explicitly when importing nipxkgs, for example
-      <literal>import &lt;nixpkgs> { overlays = [ overlay1 overlay2 ];
-      }</literal>.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Otherwise, if the Nix path entry <literal>&lt;nixpkgs-overlays></literal>
-      exists, we look for overlays at that path, as described below.
-     </para>
-     <para>
-      See the section on <literal>NIX_PATH</literal> in the Nix manual for more
-      details on how to set a value for
-      <literal>&lt;nixpkgs-overlays>.</literal>
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and
-      <filename>~/.config/nixpkgs/overlays/</filename> exists, then we look for
-      overlays at that path, as described below. It is an error if both exist.
-     </para>
-    </listitem>
-   </orderedlist>
-  </para>
+<para>The list of overlays is determined as follows.</para>
 
-  <para>
-   If we are looking for overlays at a path, then there are two cases:
-   <itemizedlist>
-    <listitem>
-     <para>
-      If the path is a file, then the file is imported as a Nix expression and
-      used as the list of overlays.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      If the path is a directory, then we take the content of the directory,
-      order it lexicographically, and attempt to interpret each as an overlay
-      by:
-      <itemizedlist>
-       <listitem>
-        <para>
-         Importing the file, if it is a <literal>.nix</literal> file.
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Importing a top-level <filename>default.nix</filename> file, if it is
-         a directory.
-        </para>
-       </listitem>
-      </itemizedlist>
-     </para>
-    </listitem>
-   </itemizedlist>
-  </para>
+<para>If the <varname>overlays</varname> argument is not provided explicitly, we look for overlays in a path. The path
+is determined as follows:
 
-  <para>
-   On a NixOS system the value of the <literal>nixpkgs.overlays</literal>
-   option, if present, is passed to the system Nixpkgs directly as an argument.
-   Note that this does not affect the overlays for non-NixOS operations (e.g.
-   <literal>nix-env</literal>), which are looked up independently.
-  </para>
+<orderedlist>
+
+  <listitem>
+    <para>First, if an <varname>overlays</varname> argument to the nixpkgs function itself is given,
+    then that is used.</para>
+
+    <para>This can be passed explicitly when importing nipxkgs, for example 
+    <literal>import &lt;nixpkgs> { overlays = [ overlay1 overlay2 ]; }</literal>.</para>
+  </listitem>
+
+  <listitem>
+    <para>Otherwise, if the Nix path entry <literal>&lt;nixpkgs-overlays></literal> exists, we look for overlays
+    at that path, as described below.</para>
+
+    <para>See the section on <literal>NIX_PATH</literal> in the Nix manual for more details on how to 
+    set a value for <literal>&lt;nixpkgs-overlays>.</literal></para>
+  </listitem>
+
+  <listitem>
+    <para>If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and
+    <filename>~/.config/nixpkgs/overlays/</filename> exists, then we look for overlays at that path, as
+    described below. It is an error if both exist.</para>
+  </listitem>
+
+</orderedlist>
+</para>
+
+<para>If we are looking for overlays at a path, then there are two cases:
+<itemizedlist>
+  <listitem>
+    <para>If the path is a file, then the file is imported as a Nix expression and used as the list of
+    overlays.</para>
+  </listitem>
+
+  <listitem>
+    <para>If the path is a directory, then we take the content of the directory, order it
+    lexicographically, and attempt to interpret each as an overlay by:
+    <itemizedlist>
+      <listitem>
+        <para>Importing the file, if it is a <literal>.nix</literal> file.</para>
+      </listitem>
+      <listitem>
+        <para>Importing a top-level <filename>default.nix</filename> file, if it is a directory.</para>
+      </listitem>
+    </itemizedlist>
+    </para>
+  </listitem>
+</itemizedlist>
+</para>
+
+<para>On a NixOS system the value of the <literal>nixpkgs.overlays</literal> option, if present, 
+is passed to the system Nixpkgs directly as an argument. Note that this does not affect the overlays for
+non-NixOS operations (e.g. <literal>nix-env</literal>), which are looked up independently.</para>
+
+<para>The <filename>overlays.nix</filename> option therefore provides a convenient way to use the same
+overlays for a NixOS system configuration and user configuration: the same file can be used
+as <filename>overlays.nix</filename> and imported as the value of <literal>nixpkgs.overlays</literal>.</para>
+
+</section>
 
-  <para>
-   The <filename>overlays.nix</filename> option therefore provides a convenient
-   way to use the same overlays for a NixOS system configuration and user
-   configuration: the same file can be used as
-   <filename>overlays.nix</filename> and imported as the value of
-   <literal>nixpkgs.overlays</literal>.
-  </para>
- </section>
 <!--============================================================-->
- <section xml:id="sec-overlays-definition">
-  <title>Defining overlays</title>
 
-  <para>
-   Overlays are Nix functions which accept two arguments, conventionally called
-   <varname>self</varname> and <varname>super</varname>, and return a set of
-   packages. For example, the following is a valid overlay.
-  </para>
+<section xml:id="sec-overlays-definition">
+<title>Defining overlays</title>
+
+<para>Overlays are Nix functions which accept two arguments, 
+conventionally called <varname>self</varname> and <varname>super</varname>, 
+and return a set of packages. For example, the following is a valid overlay.</para>
 
 <programlisting>
 self: super:
@@ -126,39 +104,31 @@ self: super:
 }
 </programlisting>
 
-  <para>
-   The first argument (<varname>self</varname>) corresponds to the final
-   package set. You should use this set for the dependencies of all packages
-   specified in your overlay. For example, all the dependencies of
-   <varname>rr</varname> in the example above come from
-   <varname>self</varname>, as well as the overridden dependencies used in the
-   <varname>boost</varname> override.
-  </para>
+<para>The first argument (<varname>self</varname>) corresponds to the final package
+set. You should use this set for the dependencies of all packages specified in your
+overlay. For example, all the dependencies of <varname>rr</varname> in the example above come
+from <varname>self</varname>, as well as the overridden dependencies used in the
+<varname>boost</varname> override.</para>
 
-  <para>
-   The second argument (<varname>super</varname>) corresponds to the result of
-   the evaluation of the previous stages of Nixpkgs. It does not contain any of
-   the packages added by the current overlay, nor any of the following
-   overlays. This set should be used either to refer to packages you wish to
-   override, or to access functions defined in Nixpkgs. For example, the
-   original recipe of <varname>boost</varname> in the above example, comes from
-   <varname>super</varname>, as well as the <varname>callPackage</varname>
-   function.
-  </para>
+<para>The second argument (<varname>super</varname>)
+corresponds to the result of the evaluation of the previous stages of
+Nixpkgs. It does not contain any of the packages added by the current
+overlay, nor any of the following overlays. This set should be used either
+to refer to packages you wish to override, or to access functions defined
+in Nixpkgs. For example, the original recipe of <varname>boost</varname>
+in the above example, comes from <varname>super</varname>, as well as the
+<varname>callPackage</varname> function.</para>
 
-  <para>
-   The value returned by this function should be a set similar to
-   <filename>pkgs/top-level/all-packages.nix</filename>, containing overridden
-   and/or new packages.
-  </para>
+<para>The value returned by this function should be a set similar to
+<filename>pkgs/top-level/all-packages.nix</filename>, containing
+overridden and/or new packages.</para>
+
+<para>Overlays are similar to other methods for customizing Nixpkgs, in particular
+the <literal>packageOverrides</literal> attribute described in <xref linkend="sec-modify-via-packageOverrides"/>.
+Indeed, <literal>packageOverrides</literal> acts as an overlay with only the 
+<varname>super</varname> argument. It is therefore appropriate for basic use, 
+but overlays are more powerful and easier to distribute.</para>
+
+</section>
 
-  <para>
-   Overlays are similar to other methods for customizing Nixpkgs, in particular
-   the <literal>packageOverrides</literal> attribute described in
-   <xref linkend="sec-modify-via-packageOverrides"/>. Indeed,
-   <literal>packageOverrides</literal> acts as an overlay with only the
-   <varname>super</varname> argument. It is therefore appropriate for basic
-   use, but overlays are more powerful and easier to distribute.
-  </para>
- </section>
 </chapter>

doc/overrides.css

@@ -1,5 +1,4 @@
-.docbook .xref img[src^=images\/callouts\/],
-.screen img,
+
 .programlisting img {
     width: 1em;
 }

doc/platform-notes.xml

@@ -1,25 +1,27 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-platform-nodes">
- <title>Platform Notes</title>
- <section xml:id="sec-darwin">
-  <title>Darwin (macOS)</title>
 
-  <para>
-   Some common issues when packaging software for darwin:
-  </para>
+<title>Platform Notes</title>
 
-  <itemizedlist>
-   <listitem>
+<section xml:id="sec-darwin">
+
+<title>Darwin (macOS)</title>
+<para>Some common issues when packaging software for darwin:</para>
+
+<itemizedlist>
+
+  <listitem>
     <para>
-     The darwin <literal>stdenv</literal> uses clang instead of gcc. When
-     referring to the compiler <varname>$CC</varname> or <command>cc</command>
-     will work in both cases. Some builds hardcode gcc/g++ in their build
-     scripts, that can usually be fixed with using something like
-     <literal>makeFlags = [ "CC=cc" ];</literal> or by patching the build
-     scripts.
+      The darwin <literal>stdenv</literal> uses clang instead of gcc.
+      When referring to the compiler <varname>$CC</varname> or <command>cc</command>
+      will work in both cases.  Some builds hardcode gcc/g++ in their
+      build scripts, that can usually be fixed with using something
+      like <literal>makeFlags = [ "CC=cc" ];</literal> or by patching
+      the build scripts.
     </para>
-<programlisting>
+
+    <programlisting>
       stdenv.mkDerivation {
         name = "libfoo-1.2.3";
         # ...
@@ -28,63 +30,36 @@
         '';
       }
     </programlisting>
-   </listitem>
-   <listitem>
+  </listitem>
+
+  <listitem>
     <para>
-     On darwin libraries are linked using absolute paths, libraries are
-     resolved by their <literal>install_name</literal> 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
-     <command>install_name_tool -id</command> during the
-     <function>fixupPhase</function>.
+      On darwin libraries are linked using absolute paths, libraries
+      are resolved by their <literal>install_name</literal> 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 <command>install_name_tool -id</command>
+      during the <function>fixupPhase</function>.
     </para>
-<programlisting>
+
+    <programlisting>
       stdenv.mkDerivation {
         name = "libfoo-1.2.3";
         # ...
         makeFlags = stdenv.lib.optional stdenv.isDarwin "LDFLAGS=-Wl,-install_name,$(out)/lib/libfoo.dylib";
       }
     </programlisting>
-   </listitem>
-   <listitem>
+  </listitem>
+
+  <listitem>
     <para>
-     Even if the libraries are linked using absolute paths and resolved via
-     their <literal>install_name</literal> correctly, tests can sometimes fail
-     to run binaries. This happens because the <varname>checkPhase</varname>
-     runs before the libraries are installed.
+      Some packages assume xcode is available and use <command>xcrun</command>
+      to resolve build tools like <command>clang</command>, etc.
+      This causes errors like <code>xcode-select: error: no developer tools were found at '/Applications/Xcode.app'</code>
+      while the build doesn't actually depend on xcode.
     </para>
-    <para>
-     This can usually be solved by running the tests after the
-     <varname>installPhase</varname> or alternatively by using
-     <varname>DYLD_LIBRARY_PATH</varname>. More information about this variable
-     can be found in the <citerefentry>
-     <refentrytitle>dyld</refentrytitle>
-     <manvolnum>1</manvolnum></citerefentry> manpage.
-    </para>
-<programlisting>
-      dyld: Library not loaded: /nix/store/7hnmbscpayxzxrixrgxvvlifzlxdsdir-jq-1.5-lib/lib/libjq.1.dylib
-      Referenced from: /private/tmp/nix-build-jq-1.5.drv-0/jq-1.5/tests/../jq
-      Reason: image not found
-      ./tests/jqtest: line 5: 75779 Abort trap: 6
-    </programlisting>
-<programlisting>
-      stdenv.mkDerivation {
-        name = "libfoo-1.2.3";
-        # ...
-        doInstallCheck = true;
-        installCheckTarget = "check";
-      }
-    </programlisting>
-   </listitem>
-   <listitem>
-    <para>
-     Some packages assume xcode is available and use <command>xcrun</command>
-     to resolve build tools like <command>clang</command>, etc. This causes
-     errors like <code>xcode-select: error: no developer tools were found at
-     '/Applications/Xcode.app'</code> while the build doesn't actually depend
-     on xcode.
-    </para>
-<programlisting>
+
+    <programlisting>
       stdenv.mkDerivation {
         name = "libfoo-1.2.3";
         # ...
@@ -94,12 +69,15 @@
         '';
       }
     </programlisting>
+
     <para>
-     The package <literal>xcbuild</literal> 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.
+      The package <literal>xcbuild</literal> 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.
     </para>
-   </listitem>
-  </itemizedlist>
- </section>
+  </listitem>
+
+</itemizedlist>
+</section>
+
 </chapter>

doc/quick-start.xml

@@ -1,219 +1,223 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-quick-start">
- <title>Quick Start to Adding a Package</title>
- <para>
-  To add a package to Nixpkgs:
-  <orderedlist>
-   <listitem>
-    <para>
-     Checkout the Nixpkgs source tree:
+
+<title>Quick Start to Adding a Package</title>
+
+<para>To add a package to Nixpkgs:
+
+<orderedlist>
+
+  <listitem>
+    <para>Checkout the Nixpkgs source tree:
+
 <screen>
-$ git clone https://github.com/NixOS/nixpkgs
+$ git clone git://github.com/NixOS/nixpkgs.git 
 $ cd nixpkgs</screen>
+
     </para>
-   </listitem>
-   <listitem>
-    <para>
-     Find a good place in the Nixpkgs tree to add the Nix expression for your
-     package. For instance, a library package typically goes into
-     <filename>pkgs/development/libraries/<replaceable>pkgname</replaceable></filename>,
-     while a web browser goes into
-     <filename>pkgs/applications/networking/browsers/<replaceable>pkgname</replaceable></filename>.
-     See <xref linkend="sec-organisation" /> for some hints on the tree
-     organisation. Create a directory for your package, e.g.
+  </listitem>
+
+  <listitem>
+    <para>Find a good place in the Nixpkgs tree to add the Nix
+    expression for your package.  For instance, a library package
+    typically goes into
+    <filename>pkgs/development/libraries/<replaceable>pkgname</replaceable></filename>,
+    while a web browser goes into
+    <filename>pkgs/applications/networking/browsers/<replaceable>pkgname</replaceable></filename>.
+    See <xref linkend="sec-organisation" /> for some hints on the tree
+    organisation.  Create a directory for your package, e.g.
+
 <screen>
 $ mkdir pkgs/development/libraries/libfoo</screen>
+  
     </para>
-   </listitem>
-   <listitem>
-    <para>
-     In the package directory, create a Nix expression — a piece of code that
-     describes how to build the package. In this case, it should be a
-     <emphasis>function</emphasis> that is called with the package dependencies
-     as arguments, and returns a build of the package in the Nix store. The
-     expression should usually be called <filename>default.nix</filename>.
+  </listitem>
+
+  <listitem>
+    <para>In the package directory, create a Nix expression — a piece
+    of code that describes how to build the package.  In this case, it
+    should be a <emphasis>function</emphasis> that is called with the
+    package dependencies as arguments, and returns a build of the
+    package in the Nix store.  The expression should usually be called
+    <filename>default.nix</filename>.
+
 <screen>
 $ emacs pkgs/development/libraries/libfoo/default.nix
 $ git add pkgs/development/libraries/libfoo/default.nix</screen>
+
     </para>
-    <para>
-     You can have a look at the existing Nix expressions under
-     <filename>pkgs/</filename> to see how it’s done. Here are some good
-     ones:
-     <itemizedlist>
-      <listitem>
-       <para>
-        GNU Hello:
-        <link
+
+    <para>You can have a look at the existing Nix expressions under
+    <filename>pkgs/</filename> to see how it’s done.  Here are some
+    good ones:
+
+      <itemizedlist>
+
+        <listitem>
+          <para>GNU Hello: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/hello/default.nix"><filename>pkgs/applications/misc/hello/default.nix</filename></link>.
-        Trivial package, which specifies some <varname>meta</varname>
-        attributes which is good practice.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        GNU cpio:
-        <link
+          Trivial package, which specifies some <varname>meta</varname>
+          attributes which is good practice.</para>
+        </listitem>
+
+        <listitem>
+          <para>GNU cpio: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/archivers/cpio/default.nix"><filename>pkgs/tools/archivers/cpio/default.nix</filename></link>.
-        Also a simple package. The generic builder in <varname>stdenv</varname>
-        does everything for you. It has no dependencies beyond
-        <varname>stdenv</varname>.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        GNU Multiple Precision arithmetic library (GMP):
-        <link
+          Also a simple package. The generic builder in
+          <varname>stdenv</varname> does everything for you. It has
+          no dependencies beyond <varname>stdenv</varname>.</para>
+        </listitem>
+
+        <listitem>
+          <para>GNU Multiple Precision arithmetic library (GMP): <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/gmp/5.1.x.nix"><filename>pkgs/development/libraries/gmp/5.1.x.nix</filename></link>.
-        Also done by the generic builder, but has a dependency on
-        <varname>m4</varname>.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Pan, a GTK-based newsreader:
-        <link
+          Also done by the generic builder, but has a dependency on
+          <varname>m4</varname>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Pan, a GTK-based newsreader: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/newsreaders/pan/default.nix"><filename>pkgs/applications/networking/newsreaders/pan/default.nix</filename></link>.
-        Has an optional dependency on <varname>gtkspell</varname>, which is
-        only built if <varname>spellCheck</varname> is <literal>true</literal>.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Apache HTTPD:
-        <link
+          Has an optional dependency on <varname>gtkspell</varname>,
+          which is only built if <varname>spellCheck</varname> is
+          <literal>true</literal>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Apache HTTPD: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/http/apache-httpd/2.4.nix"><filename>pkgs/servers/http/apache-httpd/2.4.nix</filename></link>.
-        A bunch of optional features, variable substitutions in the configure
-        flags, a post-install hook, and miscellaneous hackery.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Thunderbird:
-        <link
+          A bunch of optional features, variable substitutions in the
+          configure flags, a post-install hook, and miscellaneous
+          hackery.</para>
+        </listitem>
+
+        <listitem>
+          <para>Thunderbird: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/mailreaders/thunderbird/default.nix"><filename>pkgs/applications/networking/mailreaders/thunderbird/default.nix</filename></link>.
-        Lots of dependencies.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        JDiskReport, a Java utility:
-        <link
+          Lots of dependencies.</para>
+        </listitem>
+
+        <listitem>
+          <para>JDiskReport, a Java utility: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/default.nix"><filename>pkgs/tools/misc/jdiskreport/default.nix</filename></link>
-        (and the
-        <link
+          (and the <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/builder.sh">builder</link>).
-        Nixpkgs doesn’t have a decent <varname>stdenv</varname> for Java yet
-        so this is pretty ad-hoc.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        XML::Simple, a Perl module:
-        <link
+          Nixpkgs doesn’t have a decent <varname>stdenv</varname> for
+          Java yet so this is pretty ad-hoc.</para>
+        </listitem>
+
+        <listitem>
+          <para>XML::Simple, a Perl module: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix"><filename>pkgs/top-level/perl-packages.nix</filename></link>
-        (search for the <varname>XMLSimple</varname> attribute). Most Perl
-        modules are so simple to build that they are defined directly in
-        <filename>perl-packages.nix</filename>; no need to make a separate file
-        for them.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Adobe Reader:
-        <link
+          (search for the <varname>XMLSimple</varname> attribute).
+          Most Perl modules are so simple to build that they are
+          defined directly in <filename>perl-packages.nix</filename>;
+          no need to make a separate file for them.</para>
+        </listitem>
+
+        <listitem>
+          <para>Adobe Reader: <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/default.nix"><filename>pkgs/applications/misc/adobe-reader/default.nix</filename></link>.
-        Shows how binary-only packages can be supported. In particular the
-        <link
+          Shows how binary-only packages can be supported.  In
+          particular the <link
           xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/builder.sh">builder</link>
-        uses <command>patchelf</command> to set the RUNPATH and ELF interpreter
-        of the executables so that the right libraries are found at runtime.
-       </para>
-      </listitem>
-     </itemizedlist>
+          uses <command>patchelf</command> to set the RUNPATH and ELF
+          interpreter of the executables so that the right libraries
+          are found at runtime.</para>
+        </listitem>
+
+      </itemizedlist>
+
     </para>
-    <para>
-     Some notes:
-     <itemizedlist>
-      <listitem>
-       <para>
-        All <varname linkend="chap-meta">meta</varname> attributes are
-        optional, but it’s still a good idea to provide at least the
-        <varname>description</varname>, <varname>homepage</varname> and
-        <varname
-          linkend="sec-meta-license">license</varname>.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        You can use <command>nix-prefetch-url</command> (or similar
-        nix-prefetch-git, etc) <replaceable>url</replaceable> to get the
-        SHA-256 hash of source distributions. There are similar commands as
-        <command>nix-prefetch-git</command> and
-        <command>nix-prefetch-hg</command> available in
-        <literal>nix-prefetch-scripts</literal> package.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        A list of schemes for <literal>mirror://</literal> URLs can be found in
-        <link
-          xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix"><filename>pkgs/build-support/fetchurl/mirrors.nix</filename></link>.
-       </para>
-      </listitem>
-     </itemizedlist>
+
+    <para>Some notes:
+
+      <itemizedlist>
+
+        <listitem>
+          <para>All <varname linkend="chap-meta">meta</varname>
+          attributes are optional, but it’s still a good idea to
+          provide at least the <varname>description</varname>,
+          <varname>homepage</varname> and <varname
+          linkend="sec-meta-license">license</varname>.</para>
+        </listitem>
+
+        <listitem>
+          <para>You can use <command>nix-prefetch-url</command> (or similar nix-prefetch-git, etc)
+          <replaceable>url</replaceable> to get the SHA-256 hash of
+          source distributions. There are similar commands as <command>nix-prefetch-git</command> and
+          <command>nix-prefetch-hg</command> available in <literal>nix-prefetch-scripts</literal> package.</para>
+        </listitem>
+
+        <listitem>
+          <para>A list of schemes for <literal>mirror://</literal>
+          URLs can be found in <link
+          xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix"><filename>pkgs/build-support/fetchurl/mirrors.nix</filename></link>.</para>
+        </listitem>
+
+      </itemizedlist>
+
     </para>
-    <para>
-     The exact syntax and semantics of the Nix expression language, including
-     the built-in function, are described in the Nix manual in the
-     <link
+
+    <para>The exact syntax and semantics of the Nix expression
+    language, including the built-in function, are described in the
+    Nix manual in the <link
     xlink:href="http://hydra.nixos.org/job/nix/trunk/tarball/latest/download-by-type/doc/manual/#chap-writing-nix-expressions">chapter
-     on writing Nix expressions</link>.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Add a call to the function defined in the previous step to
-     <link
+    on writing Nix expressions</link>.</para>
+    
+  </listitem>
+
+  <listitem>
+    <para>Add a call to the function defined in the previous step to
+    <link
     xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/all-packages.nix"><filename>pkgs/top-level/all-packages.nix</filename></link>
-     with some descriptive name for the variable, e.g.
-     <varname>libfoo</varname>.
-<screen>
+    with some descriptive name for the variable,
+    e.g. <varname>libfoo</varname>.
+
+    <screen>
 $ emacs pkgs/top-level/all-packages.nix</screen>
+      
     </para>
-    <para>
-     The attributes in that file are sorted by category (like “Development /
-     Libraries”) that more-or-less correspond to the directory structure of
-     Nixpkgs, and then by attribute name.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     To test whether the package builds, run the following command from the
-     root of the nixpkgs source tree:
-<screen>
+
+    <para>The attributes in that file are sorted by category (like
+    “Development / Libraries”) that more-or-less correspond to the
+    directory structure of Nixpkgs, and then by attribute name.</para>
+  </listitem>
+
+  <listitem>
+    <para>To test whether the package builds, run the following command
+    from the root of the nixpkgs source tree:
+
+    <screen>
 $ nix-build -A libfoo</screen>
-     where <varname>libfoo</varname> should be the variable name defined in the
-     previous step. You may want to add the flag <option>-K</option> to keep
-     the temporary build directory in case something fails. If the build
-     succeeds, a symlink <filename>./result</filename> to the package in the
-     Nix store is created.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     If you want to install the package into your profile (optional), do
-<screen>
+
+    where <varname>libfoo</varname> should be the variable name
+    defined in the previous step.  You may want to add the flag
+    <option>-K</option> to keep the temporary build directory in case
+    something fails.  If the build succeeds, a symlink
+    <filename>./result</filename> to the package in the Nix store is
+    created.</para>
+  </listitem>
+
+  <listitem>
+    <para>If you want to install the package into your profile
+    (optional), do
+
+    <screen>
 $ nix-env -f . -iA libfoo</screen>
+
     </para>
-   </listitem>
-   <listitem>
-    <para>
-     Optionally commit the new package and open a pull request, or send a patch
-     to <literal>https://groups.google.com/forum/#!forum/nix-devel</literal>.
-    </para>
-   </listitem>
-  </orderedlist>
- </para>
+  </listitem>
+
+  <listitem>
+    <para>Optionally commit the new package and open a pull request, or send a patch to
+    <literal>https://groups.google.com/forum/#!forum/nix-devel</literal>.</para>
+  </listitem>
+
+
+</orderedlist>
+
+</para>
+
 </chapter>

doc/reviewing-contributions.xml

@@ -3,155 +3,93 @@
         xmlns:xi="http://www.w3.org/2001/XInclude"
         version="5.0"
         xml:id="sec-reviewing-contributions">
- <title>Reviewing contributions</title>
- <warning>
-  <para>
-   The following section is a draft, and the policy for reviewing is still
-   being discussed in issues such as
-   <link
-	   xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166
-   </link> and
-   <link
-	   xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836
-   </link>.
-  </para>
- </warning>
- <para>
-  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.
- </para>
- <para>
-  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
+
+<title>Reviewing contributions</title>
+
+<warning>
+  <para>The following section is a draft and reviewing policy is still being
+    discussed.</para>
+</warning>
+
+<para>The nixpkgs projects 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.</para>
+
+<para>The high change rate of nixpkgs make any pull request that is open for
+  long enough 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
-  <link
+  filters that can be used to see the <link
     xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
-  recently</link> and the
-  <link
+    recently</link> and the <link
     xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least
-  recently</link> updated pull-requests. We highly encourage looking at
-  <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone">
-  this list of ready to merge, unreviewed pull requests</link>.
- </para>
- <para>
-  When reviewing a pull request, please always be nice and polite.
+    recently</link> updated pull-requests.</para>
+
+<para>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.
- </para>
- <para>
-  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
-  care and if possible accompanied with some explanation so the submitter has
-  directions to improve their contribution.
- </para>
- <para>
-  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.
- </para>
- <para>
-  All the review template samples provided in this section are generic and
+  to respect every community members and their work.</para>
+
+<para>GitHub provides reactions, they are a simple and quick way to provide
+  feedback to pull-requests or any comments. The thumb-down reaction should be
+  used with care and if possible accompanied with some explanations so the
+  submitter has directions to improve his contribution.</para>
+
+<para>Pull-requests 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.</para>
+
+<para>All the review template samples provided in this section are generic and
   meant as examples. Their usage is optional and the reviewer is free to adapt
-  them to their liking.
- </para>
- <section xml:id="reviewing-contributions-package-updates">
-  <title>Package updates</title>
+  them to his liking.</para>
 
-  <para>
-   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.
-  </para>
+<section><title>Package updates</title>
 
-  <para>
-   It can happen that non-trivial updates include patches or more complex
-   changes.
-  </para>
+<para>A package update is the most trivial and common type of pull-request.
+  These pull-requests mainly consist in updating the version part of the package
+  name and the source hash.</para>
+<para>It can happen that non trivial updates include patches or more complex
+  changes.</para>
 
-  <para>
-   Reviewing process:
-  </para>
+<para>Reviewing process:</para>
 
-  <itemizedlist>
-   <listitem>
-    <para>
-     Add labels to the pull-request. (Requires commit rights)
-    </para>
+<itemizedlist>
+  <listitem><para>Add labels to the pull-request. (Requires commit
+      rights)</para>
     <itemizedlist>
-     <listitem>
-      <para>
-       <literal>8.has: package (update)</literal> and any topic label that fit
-       the updated package.
-      </para>
-     </listitem>
+      <listitem><para><literal>8.has: package (update)</literal> and any topic
+          label that fit the updated package.</para></listitem>
     </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the package versioning fits the guidelines.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the commit text fits the guidelines.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the package maintainers are notified.
-    </para>
+  </listitem>
+  <listitem><para>Ensure that the package versioning is fitting the
+      guidelines.</para></listitem>
+  <listitem><para>Ensure that the commit text is fitting the
+      guidelines.</para></listitem>
+  <listitem><para>Ensure that the package maintainers are notified.</para>
     <itemizedlist>
-     <listitem>
-      <para>
-       <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link>
-       will make GitHub notify users based on the submitted changes, but it can
-       happen that it misses some of the package maintainers.
-      </para>
-     </listitem>
+      <listitem><para>mention-bot usually notify GitHub users based on the
+          submitted changes, but it can happen that it misses some of the
+          package maintainers.</para></listitem>
     </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the meta field information is correct.
-    </para>
+  </listitem>
+  <listitem><para>Ensure that the meta field contains correct
+      information.</para>
     <itemizedlist>
-     <listitem>
-      <para>
-       License can change with version updates, so it should be checked to
-       match the upstream license.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       If the package has no maintainer, a maintainer must be set. This can be
-       the update submitter or a community member that accepts to take
-       maintainership of the package.
-      </para>
-     </listitem>
+      <listitem><para>License can change with version updates, so it should be
+          checked to be fitting upstream license.</para></listitem>
+      <listitem><para>If the package has no maintainer, a maintainer must be
+          set. This can be the update submitter or a community member that
+          accepts to take maintainership of the package.</para></listitem>
     </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the code contains no typos.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Building the package locally.
-    </para>
+  </listitem>
+  <listitem><para>Ensure that the code contains no typos.</para></listitem>
+  <listitem><para>Building the package locally.</para>
     <itemizedlist>
-     <listitem>
-      <para>
-       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.
-      </para>
-      <para>
-       It is possible to rebase the changes on nixos-unstable or
-       nixpkgs-unstable for easier review by running the following commands
-       from a nixpkgs clone.
+      <listitem><para>Pull-requests are often targeted to the master or staging
+          branch so building the pull-request locally as it is submitted can
+          trigger a large amount of source builds.</para>
+        <para>It is possible to rebase the changes on nixos-unstable or
+          nixpkgs-unstable for easier review by running the following commands
+          from a nixpkgs clone.
 <screen>
 $ git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co
   xml:id='reviewing-rebase-1' />
@@ -160,56 +98,43 @@ $ git fetch origin pull/PRNUMBER/head <co xml:id='reviewing-rebase-3' />
 $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co
   xml:id='reviewing-rebase-4' />
 </screen>
-       <calloutlist>
-        <callout arearefs='reviewing-rebase-1'>
-         <para>
-          This should be done only once to be able to fetch channel branches
-          from the nixpkgs-channels repository.
-         </para>
-        </callout>
-        <callout arearefs='reviewing-rebase-2'>
-         <para>
-          Fetching the nixos-unstable branch.
-         </para>
-        </callout>
-        <callout arearefs='reviewing-rebase-3'>
-         <para>
-          Fetching the pull-request changes, <varname>PRNUMBER</varname> is the
-          number at the end of the pull-request title and
-          <varname>BASEBRANCH</varname> the base branch of the pull-request.
-         </para>
-        </callout>
-        <callout arearefs='reviewing-rebase-4'>
-         <para>
-          Rebasing the pull-request changes to the nixos-unstable branch.
-         </para>
-        </callout>
-       </calloutlist>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       The <link xlink:href="https://github.com/madjar/nox">nox</link> tool can
-       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.
-       <varname>PRNUMBER</varname> should be replaced by the number at the end
-       of the pull-request title.
-      </para>
+        <calloutlist>
+          <callout arearefs='reviewing-rebase-1'>
+            <para>This should be done only once to be able to fetch channel
+              branches from the nixpkgs-channels repository.</para>
+          </callout>
+          <callout arearefs='reviewing-rebase-2'>
+            <para>Fetching the nixos-unstable branch.</para>
+          </callout>
+          <callout arearefs='reviewing-rebase-3'>
+            <para>Fetching the pull-request changes, <varname>PRNUMBER</varname>
+              is the number at the end of the pull-request title and
+              <varname>BASEBRANCH</varname> the base branch of the
+              pull-request.</para>
+          </callout>
+          <callout arearefs='reviewing-rebase-3'>
+            <para>Rebasing the pull-request changes to the nixos-unstable
+              branch.</para>
+          </callout>
+        </calloutlist>
+        </para>
+      </listitem>
+      <listitem>
+        <para>The <link xlink:href="https://github.com/madjar/nox">nox</link>
+          tool can 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. <varname>PRNUMBER</varname> should be replaced by the
+          number at the end of the pull-request title.</para>
 <screen>
 $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 </screen>
-     </listitem>
+      </listitem>
     </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Running every binary.
-    </para>
-   </listitem>
-  </itemizedlist>
+  </listitem>
+  <listitem><para>Running every binary.</para></listitem>
+</itemizedlist>
 
-  <example xml:id="reviewing-contributions-sample-package-update">
-   <title>Sample template for a package update review</title>
+<example><title>Sample template for a package update review</title>
 <screen>
 ##### Reviewed points
 
@@ -223,105 +148,55 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 
 ##### Comments
 
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-new-packages">
-  <title>New packages</title>
+</screen></example>
+</section>
 
-  <para>
-   New packages are a common type of pull-requests. These pull requests
-   consists in adding a new nix-expression for a package.
-  </para>
+<section><title>New packages</title>
 
-  <para>
-   Reviewing process:
-  </para>
+<para>New packages are a common type of pull-requests. These pull requests
+  consists in adding a new nix-expression for a package.</para>
 
-  <itemizedlist>
-   <listitem>
-    <para>
-     Add labels to the pull-request. (Requires commit rights)
-    </para>
+<para>Reviewing process:</para>
+
+<itemizedlist>
+  <listitem><para>Add labels to the pull-request. (Requires commit
+      rights)</para>
     <itemizedlist>
-     <listitem>
-      <para>
-       <literal>8.has: package (new)</literal> and any topic label that fit the
-       new package.
-      </para>
-     </listitem>
+      <listitem><para><literal>8.has: package (new)</literal> and any topic
+          label that fit the new package.</para></listitem>
     </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the package versioning is fitting the guidelines.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the commit name is fitting the guidelines.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the meta field contains correct information.
-    </para>
+  </listitem>
+  <listitem><para>Ensure that the package versioning is fitting the
+      guidelines.</para></listitem>
+  <listitem><para>Ensure that the commit name is fitting the
+      guidelines.</para></listitem>
+  <listitem><para>Ensure that the meta field contains correct
+      information.</para>
     <itemizedlist>
-     <listitem>
-      <para>
-       License must be checked to be fitting upstream license.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       Platforms should be set or the package will not get binary substitutes.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       A maintainer must be set, this can be the package submitter or a
-       community member that accepts to take maintainership of the package.
-      </para>
-     </listitem>
+      <listitem><para>License must be checked to be fitting upstream
+          license.</para></listitem>
+      <listitem><para>Platforms should be set or the package will not get binary
+          substitutes.</para></listitem>
+      <listitem><para>A maintainer must be set, this can be the package
+          submitter or a community member that accepts to take maintainership of
+          the package.</para></listitem>
     </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the code contains no typos.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure the package source.
-    </para>
+  </listitem>
+  <listitem><para>Ensure that the code contains no typos.</para></listitem>
+  <listitem><para>Ensure the package source.</para>
     <itemizedlist>
-     <listitem>
-      <para>
-       Mirrors urls should be used when available.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       The most appropriate function should be used (e.g. packages from GitHub
-       should use <literal>fetchFromGitHub</literal>).
-      </para>
-     </listitem>
+      <listitem><para>Mirrors urls should be used when
+          available.</para></listitem>
+      <listitem><para>The most appropriate function should be used (e.g.
+          packages from GitHub should use
+          <literal>fetchFromGitHub</literal>).</para></listitem>
     </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Building the package locally.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Running every binary.
-    </para>
-   </listitem>
-  </itemizedlist>
+  </listitem>
+  <listitem><para>Building the package locally.</para></listitem>
+  <listitem><para>Running every binary.</para></listitem>
+</itemizedlist>
 
-  <example xml:id="reviewing-contributions-sample-new-package">
-   <title>Sample template for a new package review</title>
+<example><title>Sample template for a new package review</title>
 <screen>
 ##### Reviewed points
 
@@ -343,108 +218,58 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 
 ##### Comments
 
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-module-updates">
-  <title>Module updates</title>
+</screen></example>
+</section>
 
-  <para>
-   Module updates are submissions changing modules in some ways. These often
-   contains changes to the options or introduce new options.
-  </para>
+<section><title>Module updates</title>
 
-  <para>
-   Reviewing process
-  </para>
+<para>Module updates are submissions changing modules in some ways. These often
+  contains changes to the options or introduce new options.</para>
 
-  <itemizedlist>
-   <listitem>
-    <para>
-     Add labels to the pull-request. (Requires commit rights)
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <literal>8.has: module (update)</literal> and any topic label that fit
-       the module.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the module maintainers are notified.
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link>
-       will make GitHub notify users based on the submitted changes, but it can
-       happen that it misses some of the package maintainers.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the module tests, if any, are succeeding.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the introduced options are correct.
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Type should be appropriate (string related types differs in their
-       merging capabilities, <literal>optionSet</literal> and
-       <literal>string</literal> types are deprecated).
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       Description, default and example should be provided.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that option changes are backward compatible.
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <literal>mkRenamedOptionModule</literal> and
-       <literal>mkAliasOptionModule</literal> functions provide way to make
-       option changes backward compatible.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that removed options are declared with
-     <literal>mkRemovedOptionModule</literal>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that changes that are not backward compatible are mentioned in
-     release notes.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that documentations affected by the change is updated.
-    </para>
-   </listitem>
-  </itemizedlist>
+<para>Reviewing process</para>
 
-  <example xml:id="reviewing-contributions-sample-module-update">
-   <title>Sample template for a module update review</title>
+<itemizedlist>
+  <listitem><para>Add labels to the pull-request. (Requires commit
+      rights)</para>
+    <itemizedlist>
+      <listitem><para><literal>8.has: module (update)</literal> and any topic
+          label that fit the module.</para></listitem>
+    </itemizedlist>
+  </listitem>
+  <listitem><para>Ensure that the module maintainers are notified.</para>
+    <itemizedlist>
+      <listitem><para>Mention-bot notify GitHub users based on the submitted
+          changes, but it can happen that it miss some of the package
+          maintainers.</para></listitem>
+    </itemizedlist>
+  </listitem>
+  <listitem><para>Ensure that the module tests, if any, are
+      succeeding.</para></listitem>
+  <listitem><para>Ensure that the introduced options are correct.</para>
+    <itemizedlist>
+      <listitem><para>Type should be appropriate (string related types differs
+          in their merging capabilities, <literal>optionSet</literal> and
+          <literal>string</literal> types are deprecated).</para></listitem>
+      <listitem><para>Description, default and example should be
+          provided.</para></listitem>
+    </itemizedlist>
+  </listitem>
+  <listitem><para>Ensure that option changes are backward compatible.</para>
+    <itemizedlist>
+      <listitem><para><literal>mkRenamedOptionModule</literal> and
+          <literal>mkAliasOptionModule</literal> functions provide way to make
+          option changes backward compatible.</para></listitem>
+    </itemizedlist>
+  </listitem>
+  <listitem><para>Ensure that removed options are declared with
+      <literal>mkRemovedOptionModule</literal></para></listitem>
+  <listitem><para>Ensure that changes that are not backward compatible are
+      mentioned in release notes.</para></listitem>
+  <listitem><para>Ensure that documentations affected by the change is
+      updated.</para></listitem>
+</itemizedlist>
+
+<example><title>Sample template for a module update review</title>
 <screen>
 ##### Reviewed points
 
@@ -461,89 +286,51 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 
 ##### Comments
 
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-new-modules">
-  <title>New modules</title>
+</screen></example>
+</section>
 
-  <para>
-   New modules submissions introduce a new module to NixOS.
-  </para>
+<section><title>New modules</title>
 
-  <itemizedlist>
-   <listitem>
-    <para>
-     Add labels to the pull-request. (Requires commit rights)
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       <literal>8.has: module (new)</literal> and any topic label that fit the
-       module.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the module tests, if any, are succeeding.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the introduced options are correct.
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Type should be appropriate (string related types differs in their
-       merging capabilities, <literal>optionSet</literal> and
-       <literal>string</literal> types are deprecated).
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       Description, default and example should be provided.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that module <literal>meta</literal> field is present
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Maintainers should be declared in <literal>meta.maintainers</literal>.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       Module documentation should be declared with
-       <literal>meta.doc</literal>.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Ensure that the module respect other modules functionality.
-    </para>
-    <itemizedlist>
-     <listitem>
-      <para>
-       For example, enabling a module should not open firewall ports by
-       default.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-  </itemizedlist>
+<para>New modules submissions introduce a new module to NixOS.</para>
 
-  <example xml:id="reviewing-contributions-sample-new-module">
-   <title>Sample template for a new module review</title>
+<itemizedlist>
+  <listitem><para>Add labels to the pull-request. (Requires commit
+      rights)</para>
+    <itemizedlist>
+      <listitem><para><literal>8.has: module (new)</literal> and any topic label
+          that fit the module.</para></listitem>
+    </itemizedlist>
+  </listitem>
+  <listitem><para>Ensure that the module tests, if any, are
+      succeeding.</para></listitem>
+  <listitem><para>Ensure that the introduced options are correct.</para>
+    <itemizedlist>
+      <listitem><para>Type should be appropriate (string related types differs
+          in their merging capabilities, <literal>optionSet</literal> and
+          <literal>string</literal> types are deprecated).</para></listitem>
+      <listitem><para>Description, default and example should be
+          provided.</para></listitem>
+    </itemizedlist>
+  </listitem>
+  <listitem><para>Ensure that module <literal>meta</literal> field is
+      present</para>
+    <itemizedlist>
+      <listitem><para>Maintainers should be declared in
+          <literal>meta.maintainers</literal>.</para></listitem>
+      <listitem><para>Module documentation should be declared with
+          <literal>meta.doc</literal>.</para></listitem>
+    </itemizedlist>
+  </listitem>
+  <listitem><para>Ensure that the module respect other modules
+      functionality.</para>
+    <itemizedlist>
+      <listitem><para>For example, enabling a module should not open firewall
+          ports by default.</para></listitem>
+    </itemizedlist>
+  </listitem>
+</itemizedlist>
+
+<example><title>Sample template for a new module review</title>
 <screen>
 ##### Reviewed points
 
@@ -561,41 +348,32 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 
 ##### Comments
 
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-other-submissions">
-  <title>Other submissions</title>
+</screen></example>
+</section>
 
-  <para>
-   Other type of submissions requires different reviewing steps.
-  </para>
+<section><title>Other submissions</title>
 
-  <para>
-   If you consider having enough knowledge and experience in a topic and would
-   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
-   git-blaming the code to see who committed to that topic can give some hints.
-  </para>
+<para>Other type of submissions requires different reviewing steps.</para>
 
-  <para>
-   Container system, boot system and library changes are some examples of the
-   pull requests fitting this category.
-  </para>
- </section>
- <section xml:id="reviewing-contributions--merging-pull-requests">
-  <title>Merging pull-requests</title>
+<para>If you consider having enough knowledge and experience in a topic and
+  would 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 git-blaming the code to see
+who committed to that topic can give some hints.</para>
 
-  <para>
-   It is possible for community members that have enough knowledge and
-   experience on a special topic to contribute by merging pull requests.
-  </para>
+<para>Container system, boot system and library changes are some examples of the
+  pull requests fitting this category.</para>
 
-  <para>
-   TODO: add the procedure to request merging rights.
-  </para>
+</section>
+
+<section><title>Merging pull-requests</title>
+
+<para>It is possible for community members that have enough knowledge and
+  experience on a special topic to contribute by merging pull requests.</para>
+
+<para>TODO: add the procedure to request merging rights.</para>
 
 <!--
 The following paragraph about how to deal with unactive contributors is just a
@@ -606,13 +384,10 @@ policy.
   three months will have their commit rights revoked.</para>
 -->
 
-  <para>
-   In a case a contributor leaves definitively the Nix community, he should
-   create an issue or post on
-   <link
-   xlink:href="https://discourse.nixos.org">Discourse</link> with
-   references of packages and modules he maintains so the maintainership can be
-   taken over by other contributors.
-  </para>
- </section>
+<para>In a case a contributor leaves definitively the Nix community, he should
+  create an issue or notify the mailing list with references of packages and
+  modules he maintains so the maintainership can be taken over by other
+  contributors.</para>
+
+</section>
 </chapter>

doc/shell.nix

@@ -1,5 +1,4 @@
 { pkgs ? import ../. {} }:
-(import ./default.nix {}).overrideAttrs (x: {
-  buildInputs = x.buildInputs ++ [ pkgs.xmloscopy pkgs.ruby ];
-
+(import ./default.nix).overrideAttrs (x: {
+  buildInputs = x.buildInputs ++ [ pkgs.xmloscopy ];
 })

doc/shell.section.md

@@ -0,0 +1,22 @@
+---
+title: pkgs.mkShell
+author: zimbatm
+date: 2017-10-30
+---
+
+# mkShell
+
+pkgs.mkShell is a special kind of derivation that is only useful when using
+it combined with nix-shell. It will in fact fail to instantiate when invoked
+with nix-build.
+
+## Usage
+
+```nix
+{ pkgs ? import <nixpkgs> {} }:
+pkgs.mkShell {
+  # this will make all the build inputs from hello and gnutar available to the shell environment
+  inputsFrom = with pkgs; [ hello gnutar ];
+  buildInputs = [ pkgs.gnumake ];
+}
+```

doc/style.css

@@ -248,23 +248,6 @@ table
     box-shadow: 0.4em 0.4em 0.5em #e0e0e0;
 }
 
-table.simplelist
-{
-    text-align: left;
-    color: #005aa0;
-    border: 0;
-    padding: 5px;
-    background: #fffff5;
-    font-weight: normal;
-    font-style: italic;
-    box-shadow: none;
-    margin-bottom: 1em;
-}
-
-div.navheader table, div.navfooter table {
-    box-shadow: none;
-}
-
 div.affiliation
 {
     font-style: italic;

doc/submitting-changes.xml

@@ -1,513 +1,447 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-submitting-changes">
- <title>Submitting changes</title>
- <section xml:id="submitting-changes-making-patches">
-  <title>Making patches</title>
 
-  <itemizedlist>
-   <listitem>
-    <para>
-     Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to
-     write packages for Nix)</link>.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Fork the repository on GitHub.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Create a branch for your future fix.
-     <itemizedlist>
-      <listitem>
-       <para>
-        You can make branch from a commit of your local
-        <command>nixos-version</command>. That will help you to avoid
-        additional local compilations. Because you will receive packages from
-        binary cache.
-        <itemizedlist>
-         <listitem>
-          <para>
-           For example: <command>nixos-version</command> returns
-           <command>15.05.git.0998212 (Dingo)</command>. So you can do:
-          </para>
-         </listitem>
-        </itemizedlist>
+<title>Submitting changes</title>
+
+<section>
+<title>Making patches</title>
+
+<itemizedlist>
+<listitem>
+<para>Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to write packages for Nix)</link>.</para>
+</listitem>
+
+<listitem>
+<para>Fork the repository on GitHub.</para>
+</listitem>
+
+<listitem>
+<para>Create a branch for your future fix.
+
+<itemizedlist>
+<listitem>
+<para>You can make branch from a commit of your local <command>nixos-version</command>. That will help you to avoid additional local compilations. Because you will receive packages from binary cache.
+
+<itemizedlist>
+<listitem>
+<para>For example: <command>nixos-version</command> returns <command>15.05.git.0998212 (Dingo)</command>. So you can do:</para>
+</listitem>
+</itemizedlist>
+
 <screen>
 $ git checkout 0998212
 $ git checkout -b 'fix/pkg-name-update'
 </screen>
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Please avoid working directly on the <command>master</command> branch.
-       </para>
-      </listitem>
-     </itemizedlist>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Make commits of logical units.
-     <itemizedlist>
-      <listitem>
-       <para>
-        If you removed pkgs, made some major NixOS changes etc., write about
-        them in
-        <command>nixos/doc/manual/release-notes/rl-unstable.xml</command>.
-       </para>
-      </listitem>
-     </itemizedlist>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Check for unnecessary whitespace with <command>git diff --check</command>
-     before committing.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Format the commit in a following way:
-    </para>
+</para>
+</listitem>
+
+<listitem>
+<para>Please avoid working directly on the <command>master</command> branch.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>Make commits of logical units.
+
+<itemizedlist>
+<listitem>
+<para>If you removed pkgs, made some major NixOS changes etc., write about them in <command>nixos/doc/manual/release-notes/rl-unstable.xml</command>.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>Check for unnecessary whitespace with <command>git diff --check</command> before committing.</para>
+</listitem>
+
+<listitem>
+<para>Format the commit in a following way:</para>
 <programlisting>
 (pkg-name | nixos/&lt;module>): (from -> to | init at version | refactor | etc)
 Additional information.
 </programlisting>
-    <itemizedlist>
-     <listitem>
-      <para>
-       Examples:
-       <itemizedlist>
-        <listitem>
-         <para>
-          <command>nginx: init at 2.0.1</command>
-         </para>
-        </listitem>
-        <listitem>
-         <para>
-          <command>firefox: 54.0.1 -> 55.0</command>
-         </para>
-        </listitem>
-        <listitem>
-         <para>
-          <command>nixos/hydra: add bazBaz option</command>
-         </para>
-        </listitem>
-        <listitem>
-         <para>
-          <command>nixos/nginx: refactor config generation</command>
-         </para>
-        </listitem>
-       </itemizedlist>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </listitem>
-   <listitem>
-    <para>
-     Test your changes. If you work with
-     <itemizedlist>
-      <listitem>
-       <para>
-        nixpkgs:
-        <itemizedlist>
-         <listitem>
-          <para>
-           update pkg ->
-           <itemizedlist>
-            <listitem>
-             <para>
-              <command>nix-env -i pkg-name -f &lt;path to your local nixpkgs
-              folder&gt;</command>
-             </para>
-            </listitem>
-           </itemizedlist>
-          </para>
-         </listitem>
-         <listitem>
-          <para>
-           add pkg ->
-           <itemizedlist>
-            <listitem>
-             <para>
-              Make sure it's in
-              <command>pkgs/top-level/all-packages.nix</command>
-             </para>
-            </listitem>
-            <listitem>
-             <para>
-              <command>nix-env -i pkg-name -f &lt;path to your local nixpkgs
-              folder&gt;</command>
-             </para>
-            </listitem>
-           </itemizedlist>
-          </para>
-         </listitem>
-         <listitem>
-          <para>
-           <emphasis>If you don't want to install pkg in you
-           profile</emphasis>.
-           <itemizedlist>
-            <listitem>
-             <para>
-              <command>nix-build -A pkg-attribute-name &lt;path to your local
-              nixpkgs folder&gt;/default.nix</command> and check results in the
-              folder <command>result</command>. It will appear in the same
-              directory where you did <command>nix-build</command>.
-             </para>
-            </listitem>
-           </itemizedlist>
-          </para>
-         </listitem>
-         <listitem>
-          <para>
-           If you did <command>nix-env -i pkg-name</command> you can do
-           <command>nix-env -e pkg-name</command> to uninstall it from your
-           system.
-          </para>
-         </listitem>
-        </itemizedlist>
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        NixOS and its modules:
-        <itemizedlist>
-         <listitem>
-          <para>
-           You can add new module to your NixOS configuration file (usually
-           it's <command>/etc/nixos/configuration.nix</command>). And do
-           <command>sudo nixos-rebuild test -I nixpkgs=&lt;path to your local
-           nixpkgs folder&gt; --fast</command>.
-          </para>
-         </listitem>
-        </itemizedlist>
-       </para>
-      </listitem>
-     </itemizedlist>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     If you have commits <command>pkg-name: oh, forgot to insert
-     whitespace</command>: squash commits in this case. Use <command>git rebase
-     -i</command>.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Rebase you branch against current <command>master</command>.
-    </para>
-   </listitem>
-  </itemizedlist>
- </section>
- <section xml:id="submitting-changes-submitting-changes">
-  <title>Submitting changes</title>
 
-  <itemizedlist>
-   <listitem>
-    <para>
-     Push your changes to your fork of nixpkgs.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Create pull request:
-     <itemizedlist>
-      <listitem>
-       <para>
-        Write the title in format <command>(pkg-name | nixos/&lt;module>):
-        improvement</command>.
-        <itemizedlist>
-         <listitem>
-          <para>
-           If you update the pkg, write versions <command>from -> to</command>.
-          </para>
-         </listitem>
-        </itemizedlist>
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Write in comment if you have tested your patch. Do not rely much on
-        <command>TravisCI</command>.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        If you make an improvement, write about your motivation.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Notify maintainers of the package. For example add to the message:
-        <command>cc @jagajaga @domenkozar</command>.
-       </para>
-      </listitem>
-     </itemizedlist>
-    </para>
-   </listitem>
-  </itemizedlist>
- </section>
- <section xml:id="submitting-changes-pull-request-template">
+<itemizedlist>
+<listitem>
+<para>Examples:
+
+<itemizedlist>
+<listitem>
+<para>
+<command>nginx: init at 2.0.1</command>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<command>firefox: 54.0.1 -> 55.0</command>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<command>nixos/hydra: add bazBaz option</command>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<command>nixos/nginx: refactor config generation</command>
+</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+</itemizedlist>
+</listitem>
+
+<listitem>
+<para>Test your changes. If you work with
+
+<itemizedlist>
+<listitem>
+<para>nixpkgs:
+
+<itemizedlist>
+<listitem>
+<para>update pkg ->
+
+<itemizedlist>
+<listitem>
+<para>
+<command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command>
+</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>add pkg ->
+
+<itemizedlist>
+<listitem>
+<para>Make sure it's in <command>pkgs/top-level/all-packages.nix</command>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command>
+</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<emphasis>If you don't want to install pkg in you profile</emphasis>.
+
+<itemizedlist>
+<listitem>
+<para>
+<command>nix-build -A pkg-attribute-name &lt;path to your local nixpkgs folder&gt;/default.nix</command> and check results in the folder <command>result</command>. It will appear in the same directory where you did <command>nix-build</command>.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>If you did <command>nix-env -i pkg-name</command> you can do <command>nix-env -e pkg-name</command> to uninstall it from your system.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>NixOS and its modules:
+
+<itemizedlist>
+<listitem>
+<para>You can add new module to your NixOS configuration file (usually it's <command>/etc/nixos/configuration.nix</command>).
+            And do <command>sudo nixos-rebuild test -I nixpkgs=&lt;path to your local nixpkgs folder&gt; --fast</command>.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>If you have commits <command>pkg-name: oh, forgot to insert whitespace</command>: squash commits in this case. Use <command>git rebase -i</command>.</para>
+</listitem>
+
+<listitem>
+<para>Rebase you branch against current <command>master</command>.</para>
+</listitem>
+</itemizedlist>
+</section>
+
+<section>
+<title>Submitting changes</title>
+
+<itemizedlist>
+<listitem>
+<para>Push your changes to your fork of nixpkgs.</para>
+</listitem>
+
+<listitem>
+<para>Create pull request:
+
+<itemizedlist>
+<listitem>
+<para>Write the title in format <command>(pkg-name | nixos/&lt;module>): improvement</command>.
+
+<itemizedlist>
+<listitem>
+<para>If you update the pkg, write versions <command>from -> to</command>.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+<listitem>
+<para>Write in comment if you have tested your patch. Do not rely much on <command>TravisCI</command>.</para>
+</listitem>
+
+<listitem>
+<para>If you make an improvement, write about your motivation.</para>
+</listitem>
+
+<listitem>
+<para>Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+</itemizedlist>
+</section>
+
+<section>
   <title>Pull Request Template</title>
-
   <para>
-   The pull request template helps determine what steps have been made for a
-   contribution so far, and will help guide maintainers on the status of a
-   change. The motivation section of the PR should include any extra details
-   the title does not address and link any existing issues related to the pull
-   request.
-  </para>
-
-  <para>
-   When a PR is created, it will be pre-populated with some checkboxes detailed
-   below:
-  </para>
-
-  <section xml:id="submitting-changes-tested-with-sandbox">
-   <title>Tested using sandboxing</title>
-
-   <para>
-    When sandbox builds are enabled, Nix will setup an isolated environment for
-    each build process. It is used to remove further hidden dependencies set by
-    the build environment to improve reproducibility. This includes access to
-    the network during the build outside of <function>fetch*</function>
-    functions and files outside the Nix store. Depending on the operating
-    system access to other resources are blocked as well (ex. inter process
-    communication is isolated on Linux); see
-    <link
-      xlink:href="https://nixos.org/nix/manual/#description-45">build-use-sandbox</link>
-    in Nix manual for details.
-   </para>
-
-   <para>
-    Sandboxing is not enabled by default in Nix due to a small performance hit
-    on each build. In pull requests for
-    <link
-        xlink:href="https://github.com/NixOS/nixpkgs/">nixpkgs</link>
-    people are asked to test builds with sandboxing enabled (see
-    <literal>Tested using sandboxing</literal> in the pull request template)
-    because
-    in<link
-        xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link>
-    sandboxing is also used.
-   </para>
-
-   <para>
-    Depending if you use NixOS or other platforms you can use one of the
-    following methods to enable sandboxing
-    <emphasis role="bold">before</emphasis> building the package:
-    <itemizedlist>
-     <listitem>
-      <para>
-       <emphasis role="bold">Globally enable sandboxing on NixOS</emphasis>:
-       add the following to <filename>configuration.nix</filename>
-<screen>nix.useSandbox = true;</screen>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <emphasis role="bold">Globally enable sandboxing on non-NixOS
-       platforms</emphasis>: add the following to:
-       <filename>/etc/nix/nix.conf</filename>
-<screen>build-use-sandbox = true</screen>
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-  </section>
-
-  <section xml:id="submitting-changes-platform-diversity">
-   <title>Built on platform(s)</title>
-
-   <para>
-    Many Nix packages are designed to run on multiple platforms. As such, it's
-    important to let the maintainer know which platforms your changes have been
-    tested on. It's not always practical to test a change on all platforms, and
-    is not required for a pull request to be merged. Only check the systems you
-    tested the build on in this section.
-   </para>
-  </section>
-
-  <section xml:id="submitting-changes-nixos-tests">
-   <title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title>
-
-   <para>
-    Packages with automated tests are much more likely to be merged in a timely
-    fashion because it doesn't require as much manual testing by the maintainer
-    to verify the functionality of the package. If there are existing tests for
-    the package, they should be run to verify your changes do not break the
-    tests. Tests only apply to packages with NixOS modules defined and can only
-    be run on Linux. For more details on writing and running tests, see the
-    <link
-        xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section
-    in the NixOS manual</link>.
-   </para>
-  </section>
-
-  <section xml:id="submitting-changes-tested-compilation">
-   <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title>
-
-   <para>
-    If you are updating a package's version, you can use nox to make sure all
-    packages that depend on the updated package still compile correctly. This
-    can be done using the nox utility. The <command>nox-review</command>
-    utility can look for and build all dependencies either based on uncommited
-    changes with the <literal>wip</literal> option or specifying a github pull
-    request number.
-   </para>
-
-   <para>
-    review uncommitted changes:
-<screen>nix-shell -p nox --run "nox-review wip"</screen>
-   </para>
-
-   <para>
-    review changes from pull request number 12345:
-<screen>nix-shell -p nox --run "nox-review pr 12345"</screen>
-   </para>
-  </section>
-
-  <section xml:id="submitting-changes-tested-execution">
-   <title>Tested execution of all binary files (usually in <filename>./result/bin/</filename>)</title>
-
-   <para>
-    It's important to test any executables generated by a build when you change
-    or create a package in nixpkgs. This can be done by looking in
-    <filename>./result/bin</filename> and running any files in there, or at a
-    minimum, the main executable for the package. For example, if you make a
-    change to <package>texlive</package>, you probably would only check the
-    binaries associated with the change you made rather than testing all of
-    them.
-   </para>
-  </section>
-
-  <section xml:id="submitting-changes-contribution-standards">
-   <title>Meets Nixpkgs contribution standards</title>
-
-   <para>
-    The last checkbox is fits
-    <link
-        xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</link>.
-    The contributing document has detailed information on standards the Nix
-    community has for commit messages, reviews, licensing of contributions you
-    make to the project, etc... Everyone should read and understand the
-    standards the community has for contributing before submitting a pull
+    The pull request template helps determine what steps have been made for a
+    contribution so far, and will help guide maintainers on the status of a
+    change. The motivation section of the PR should include any extra details
+    the title does not address and link any existing issues related to the pull
     request.
-   </para>
+  </para>
+  <para>When a PR is created, it will be pre-populated with some checkboxes detailed below:
+  </para>
+  <section>
+    <title>Tested using sandboxing</title>
+    <para>
+      When sandbox builds are enabled, Nix will setup an isolated environment
+      for each build process. It is used to remove further hidden dependencies
+      set by the build environment to improve reproducibility. This includes
+      access to the network during the build outside of
+      <function>fetch*</function> functions and files outside the Nix store.
+      Depending on the operating system access to other resources are blocked
+      as well (ex. inter process communication is isolated on Linux); see <link
+      xlink:href="https://nixos.org/nix/manual/#description-45">build-use-sandbox</link>
+      in Nix manual for details.
+    </para>
+    <para>
+      Sandboxing is not enabled by default in Nix due to a small performance
+      hit on each build.  In pull requests for <link
+        xlink:href="https://github.com/NixOS/nixpkgs/">nixpkgs</link> people
+      are asked to test builds with sandboxing enabled (see <literal>Tested
+        using sandboxing</literal> in the pull request template) because
+      in<link
+        xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link>
+      sandboxing is also used.
+    </para>
+    <para>
+      Depending if you use NixOS or other platforms you can use one of the
+      following methods to enable sandboxing <emphasis role="bold">before</emphasis> building the package:
+      <itemizedlist>
+        <listitem>
+          <para>
+            <emphasis role="bold">Globally enable sandboxing on NixOS</emphasis>:
+            add the following to 
+            <filename>configuration.nix</filename>
+            <screen>nix.useSandbox = true;</screen>
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <emphasis role="bold">Globally enable sandboxing on non-NixOS platforms</emphasis>:
+            add the following to: <filename>/etc/nix/nix.conf</filename>
+            <screen>build-use-sandbox = true</screen>
+          </para>
+        </listitem>
+      </itemizedlist>
+    </para>
+    
   </section>
- </section>
- <section xml:id="submitting-changes-hotfixing-pull-requests">
-  <title>Hotfixing pull requests</title>
+  <section>
+    <title>Built on platform(s)</title>
+    <para>
+      Many Nix packages are designed to run on multiple
+      platforms. As such, it's important to let the maintainer know which
+      platforms your changes have been tested on. It's not always practical to
+      test a change on all platforms, and is not required for a pull request to
+      be merged. Only check the systems you tested the build on in this
+      section.
+    </para>
+  </section>
+  <section>
+    <title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title>
+    <para>
+      Packages with automated tests are much more likely to be merged in a
+      timely fashion because it doesn't require as much manual testing by the
+      maintainer to verify the functionality of the package. If there are
+      existing tests for the package, they should be run to verify your changes
+      do not break the tests. Tests only apply to packages with NixOS modules
+      defined and can only be run on Linux. For more details on writing and
+      running tests, see the <link
+        xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section
+        in the NixOS manual</link>.
+    </para>
+  </section>
+  <section>
+    <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title>
+    <para>
+      If you are updating a package's version, you can use nox to make sure all
+      packages that depend on the updated package still compile correctly. This
+      can be done using the nox utility. The <command>nox-review</command>
+      utility can look for and build all dependencies either based on
+      uncommited changes with the <literal>wip</literal> option or specifying a
+      github pull request number.
+    </para>
+    <para>
+      review uncommitted changes:
+      <screen>nix-shell -p nox --run nox-review wip</screen>
+    </para>
+    <para>
+      review changes from pull request number 12345:
+      <screen>nix-shell -p nox --run nox-review pr 12345</screen>
+    </para>
+  </section>
+  <section>
+    <title>Tested execution of all binary files (usually in <filename>./result/bin/</filename>)</title>
+    <para>
+      It's important to test any executables generated by a build when you
+      change or create a package in nixpkgs. This can be done by looking in
+      <filename>./result/bin</filename> and running any files in there, or at a
+      minimum, the main executable for the package. For example, if you make a change
+      to <package>texlive</package>, you probably would only check the binaries
+      associated with the change you made rather than testing all of them.
+    </para>
+  </section>
+  <section>
+    <title>Meets nixpkgs contribution standards</title>
+    <para>
+      The last checkbox is fits <link
+        xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</link>.
+      The contributing document has detailed information on standards the Nix
+      community has for commit messages, reviews, licensing of contributions
+      you make to the project, etc... Everyone should read and understand the
+      standards the community has for contributing before submitting a pull
+      request.
+    </para>
+    
+  </section>
+</section>
+
+<section>
+<title>Hotfixing pull requests</title>
+
+<itemizedlist>
+<listitem>
+<para>Make the appropriate changes in you branch.</para>
+</listitem>
+
+<listitem>
+<para>Don't create additional commits, do
+
+<itemizedlist>
+<listitem>
+<para><command>git rebase -i</command></para>
+</listitem>
+<listitem>
+<para>
+<command>git push --force</command> to your branch.</para>
+</listitem>
+</itemizedlist>
+</para>
+</listitem>
+
+</itemizedlist>
+</section>
+
+<section>
+<title>Commit policy</title>
+
+<itemizedlist>
+<listitem>
+<para>Commits must be sufficiently tested before being merged, both for the master and staging branches.</para>
+</listitem>
+
+<listitem>
+<para>Hydra builds for master and staging should not be used as testing platform, it's a build farm for changes that have been already tested.</para>
+</listitem>
+
+<listitem>
+<para>When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people's installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from @edolstra.</para>
+</listitem>
+</itemizedlist>
+
+<section>
+  <title>Master branch</title>
 
   <itemizedlist>
-   <listitem>
-    <para>
-     Make the appropriate changes in you branch.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Don't create additional commits, do
-     <itemizedlist>
-      <listitem>
-       <para>
-        <command>git rebase -i</command>
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        <command>git push --force</command> to your branch.
-       </para>
-      </listitem>
-     </itemizedlist>
-    </para>
-   </listitem>
+    <listitem>
+      <para>
+        It should only see non-breaking commits that do not cause mass rebuilds.
+      </para>
+    </listitem>
   </itemizedlist>
- </section>
- <section xml:id="submitting-changes-commit-policy">
-  <title>Commit policy</title>
+</section>
+
+<section>
+  <title>Staging branch</title>
 
   <itemizedlist>
-   <listitem>
-    <para>
-     Commits must be sufficiently tested before being merged, both for the
-     master and staging branches.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Hydra builds for master and staging should not be used as testing
-     platform, it's a build farm for changes that have been already tested.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     When changing the bootloader installation process, extra care must be
-     taken. Grub installations cannot be rolled back, hence changes may break
-     people's installations forever. For any non-trivial change to the
-     bootloader please file a PR asking for review, especially from @edolstra.
-    </para>
-   </listitem>
+    <listitem>
+      <para>
+        It's only for non-breaking mass-rebuild commits. That means it's not to
+        be used for testing, and changes must have been well tested already.
+        <link xlink:href="http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+        If the branch is already in a broken state, please refrain from adding
+        extra new breakages. Stabilize it for a few days, merge into master,
+        then resume development on staging.
+        <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep an eye on the staging evaluations here</link>.
+        If any fixes for staging happen to be already in master, then master can
+        be merged into staging.
+      </para>
+    </listitem>
   </itemizedlist>
+</section>
 
-  <section xml:id="submitting-changes-master-branch">
-   <title>Master branch</title>
+<section>
+  <title>Stable release branches</title>
 
-   <itemizedlist>
+  <itemizedlist>
     <listitem>
-     <para>
-      It should only see non-breaking commits that do not cause mass rebuilds.
-     </para>
-    </listitem>
-   </itemizedlist>
-  </section>
-
-  <section xml:id="submitting-changes-staging-branch">
-   <title>Staging branch</title>
-
-   <itemizedlist>
-    <listitem>
-     <para>
-      It's only for non-breaking mass-rebuild commits. That means it's not to
-      be used for testing, and changes must have been well tested already.
-      <link xlink:href="https://web.archive.org/web/20160528180406/http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read
-      policy here</link>.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      If the branch is already in a broken state, please refrain from adding
-      extra new breakages. Stabilize it for a few days, merge into master, then
-      resume development on staging.
-      <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep
-      an eye on the staging evaluations here</link>. If any fixes for staging
-      happen to be already in master, then master can be merged into staging.
-     </para>
-    </listitem>
-   </itemizedlist>
-  </section>
-
-  <section xml:id="submitting-changes-stable-release-branches">
-   <title>Stable release branches</title>
-
-   <itemizedlist>
-    <listitem>
-     <para>
-      If you're cherry-picking a commit to a stable release branch, always use
-      <command>git cherry-pick -xe</command> and ensure the message contains a
-      clear description about why this needs to be included in the stable
-      branch.
-     </para>
-     <para>
-      An example of a cherry-picked commit would look like this:
-     </para>
-<screen>
+      <para>
+        If you're cherry-picking a commit to a stable release branch, always use
+        <command>git cherry-pick -xe</command> and ensure the message contains a
+        clear description about why this needs to be included in the stable
+        branch.
+      </para>
+      <para>An example of a cherry-picked commit would look like this:</para>
+      <screen>
 nixos: Refactor the world.
 
 The original commit message describing the reason why the world was torn apart.
@@ -517,7 +451,9 @@ Reason: I just had a gut feeling that this would also be wanted by people from
 the stone age.
       </screen>
     </listitem>
-   </itemizedlist>
-  </section>
- </section>
+  </itemizedlist>
+</section>
+
+</section>
 </chapter>
+

lib/attrsets.nix

@@ -3,9 +3,9 @@
 
 let
   inherit (builtins) head tail length;
-  inherit (lib.trivial) and;
+  inherit (lib.trivial) and or;
   inherit (lib.strings) concatStringsSep;
-  inherit (lib.lists) fold concatMap concatLists;
+  inherit (lib.lists) fold concatMap concatLists all deepSeqList;
 in
 
 rec {
@@ -145,7 +145,7 @@ rec {
   foldAttrs = op: nul: list_of_attrs:
     fold (n: a:
         fold (name: o:
-          o // { ${name} = op n.${name} (a.${name} or nul); }
+          o // (listToAttrs [{inherit name; value = op n.${name} (a.${name} or nul); }])
         ) a (attrNames n)
     ) {} list_of_attrs;
 
@@ -195,9 +195,8 @@ rec {
           { x = "foo"; y = "bar"; }
        => { x = "x-foo"; y = "y-bar"; }
   */
-  mapAttrs = builtins.mapAttrs or
-    (f: set:
-      listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set)));
+  mapAttrs = f: set:
+    listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set));
 
 
   /* Like `mapAttrs', but allows the name of each attribute to be
@@ -384,12 +383,11 @@ rec {
   recursiveUpdateUntil = pred: lhs: rhs:
     let f = attrPath:
       zipAttrsWith (n: values:
-        let here = attrPath ++ [n]; in
         if tail values == []
-        || pred here (head (tail values)) (head values) then
+        || pred attrPath (head (tail values)) (head values) then
           head values
         else
-          f here values
+          f (attrPath ++ [n]) values
       );
     in f [] [rhs lhs];
 

lib/composable-derivation.nix

@@ -1,5 +1,5 @@
 {lib, pkgs}:
-let inherit (lib) nvs; in
+let inherit (lib) nv nvs; in
 {
 
   # composableDerivation basically mixes these features:

lib/customisation.nix

@@ -1,4 +1,9 @@
 { lib }:
+let
+
+  inherit (builtins) attrNames;
+
+in
 
 rec {
 
@@ -185,7 +190,7 @@ rec {
   /* Make a set of packages with a common scope. All packages called
      with the provided `callPackage' will be evaluated with the same
      arguments. Any package in the set may depend on any other. The
-     `overrideScope'` function allows subsequent modification of the package
+     `overrideScope' function allows subsequent modification of the package
      set in a consistent way, i.e. all packages in the set will be
      called with the overridden packages. The package sets may be
      hierarchical: the packages in the set are called with the scope
@@ -195,10 +200,9 @@ rec {
     let self = f self // {
           newScope = scope: newScope (self // scope);
           callPackage = self.newScope {};
-          overrideScope = g: lib.warn
-            "`overrideScope` (from `lib.makeScope`) is deprecated. Do `overrideScope' (self: self: { … })` instead of `overrideScope (super: self: { … })`. All other overrides have the parameters in that order, including other definitions of `overrideScope`. This was the only definition violating the pattern."
-            (makeScope newScope (lib.fixedPoints.extends (lib.flip g) f));
-          overrideScope' = g: makeScope newScope (lib.fixedPoints.extends g f);
+          overrideScope = g:
+            makeScope newScope
+            (self_: let super = f self_; in super // g super self_);
           packages = f;
         };
     in self;

lib/debug.nix

@@ -1,67 +1,34 @@
-/* Collection of functions useful for debugging
-   broken nix expressions.
-
-   * `trace`-like functions take two values, print
-     the first to stderr and return the second.
-   * `traceVal`-like functions take one argument
-     which both printed and returned.
-   * `traceSeq`-like functions fully evaluate their
-     traced value before printing (not just to “weak
-     head normal form” like trace does by default).
-   * Functions that end in `-Fn` take an additional
-     function as their first argument, which is applied
-     to the traced value before it is printed.
-*/
 { lib }:
+
 let
-  inherit (builtins) trace isAttrs isList isInt
-          head substring attrNames;
-  inherit (lib) id elem isFunction;
+
+inherit (builtins) trace attrNamesToStr isAttrs isList isInt
+        isString isBool head substring attrNames;
+
+inherit (lib) all id mapAttrsFlatten elem isFunction;
+
 in
 
 rec {
 
-  # -- TRACING --
+  inherit (builtins) addErrorContext;
 
-  /* Trace msg, but only if pred is true.
+  addErrorContextToAttrs = lib.mapAttrs (a: v: lib.addErrorContext "while evaluating ${a}" v);
 
-     Example:
-       traceIf true "hello" 3
-       trace: hello
-       => 3
-  */
-  traceIf = pred: msg: x: if pred then trace msg x else x;
+  traceIf = p: msg: x: if p then trace msg x else x;
 
-  /* Trace the value and also return it.
+  traceVal = x: trace x x;
+  traceXMLVal = x: trace (builtins.toXML x) x;
+  traceXMLValMarked = str: x: trace (str + builtins.toXML x) x;
 
-     Example:
-       traceValFn (v: "mystring ${v}") "foo"
-       trace: mystring foo
-       => "foo"
-  */
-  traceValFn = f: x: trace (f x) x;
-  traceVal = traceValFn id;
+  # strict trace functions (traced structure is fully evaluated and printed)
 
-  /* `builtins.trace`, but the value is `builtins.deepSeq`ed first.
-
-     Example:
-       trace { a.b.c = 3; } null
-       trace: { a = <CODE>; }
-       => null
-       traceSeq { a.b.c = 3; } null
-       trace: { a = { b = { c = 3; }; }; }
-       => null
-  */
+  /* `builtins.trace`, but the value is `builtins.deepSeq`ed first. */
   traceSeq = x: y: trace (builtins.deepSeq x x) y;
 
-  /* Like `traceSeq`, but only evaluate down to depth n.
-     This is very useful because lots of `traceSeq` usages
-     lead to an infinite recursion.
-
-     Example:
-       traceSeqN 2 { a.b.c = 3; } null
-       trace: { a = { b = {…}; }; }
-       => null
+  /* Like `traceSeq`, but only down to depth n.
+   * This is very useful because lots of `traceSeq` usages
+   * lead to an infinite recursion.
    */
   traceSeqN = depth: x: y: with lib;
     let snip = v: if      isList  v then noQuotes "[…]" v
@@ -76,16 +43,39 @@ rec {
     in trace (generators.toPretty { allowPrettyValues = true; }
                (modify depth snip x)) y;
 
-  /* A combination of `traceVal` and `traceSeq` */
-  traceValSeqFn = f: v: traceValFn f (builtins.deepSeq v v);
-  traceValSeq = traceValSeqFn id;
-
-  /* A combination of `traceVal` and `traceSeqN`. */
-  traceValSeqNFn = f: depth: v: traceSeqN depth (f v) v;
-  traceValSeqN = traceValSeqNFn id;
+  /* `traceSeq`, but the same value is traced and returned */
+  traceValSeq = v: traceVal (builtins.deepSeq v v);
+  /* `traceValSeq` but with fixed depth */
+  traceValSeqN = depth: v: traceSeqN depth v v;
 
 
-  # -- TESTING --
+  # this can help debug your code as well - designed to not produce thousands of lines
+  traceShowVal = x: trace (showVal x) x;
+  traceShowValMarked = str: x: trace (str + showVal x) x;
+  attrNamesToStr = a: lib.concatStringsSep "; " (map (x: "${x}=") (attrNames a));
+  showVal = x:
+      if isAttrs x then
+          if x ? outPath then "x is a derivation, name ${if x ? name then x.name else "<no name>"}, { ${attrNamesToStr x} }"
+          else "x is attr set { ${attrNamesToStr x} }"
+      else if isFunction x then "x is a function"
+      else if x == [] then "x is an empty list"
+      else if isList x then "x is a list, first element is: ${showVal (head x)}"
+      else if x == true then "x is boolean true"
+      else if x == false then "x is boolean false"
+      else if x == null then "x is null"
+      else if isInt x then "x is an integer `${toString x}'"
+      else if isString x then "x is a string `${substring 0 50 x}...'"
+      else "x is probably a path `${substring 0 50 (toString x)}...'";
+
+  # trace the arguments passed to function and its result
+  # maybe rewrite these functions in a traceCallXml like style. Then one function is enough
+  traceCall  = n: f: a: let t = n2: x: traceShowValMarked "${n} ${n2}:" x; in t "result" (f (t "arg 1" a));
+  traceCall2 = n: f: a: b: let t = n2: x: traceShowValMarked "${n} ${n2}:" x; in t "result" (f (t "arg 1" a) (t "arg 2" b));
+  traceCall3 = n: f: a: b: c: let t = n2: x: traceShowValMarked "${n} ${n2}:" x; in t "result" (f (t "arg 1" a) (t "arg 2" b) (t "arg 3" c));
+
+  # FIXME: rename this?
+  traceValIfNot = c: x:
+    if c x then true else trace (showVal x) false;
 
   /* Evaluate a set of tests.  A test is an attribute set {expr,
      expected}, denoting an expression and its expected result.  The
@@ -109,68 +99,9 @@ rec {
   # usage: { testX = allTrue [ true ]; }
   testAllTrue = expr: { inherit expr; expected = map (x: true) expr; };
 
-
-  # -- DEPRECATED --
-
-  traceShowVal = x: trace (showVal x) x;
-  traceShowValMarked = str: x: trace (str + showVal x) x;
-
-  attrNamesToStr = a:
-    trace ( "Warning: `attrNamesToStr` is deprecated "
-          + "and will be removed in the next release. "
-          + "Please use more specific concatenation "
-          + "for your uses (`lib.concat(Map)StringsSep`)." )
-    (lib.concatStringsSep "; " (map (x: "${x}=") (attrNames a)));
-
-  showVal = with lib;
-    trace ( "Warning: `showVal` is deprecated "
-          + "and will be removed in the next release, "
-          + "please use `traceSeqN`" )
-    (let
-      modify = v:
-        let pr = f: { __pretty = f; val = v; };
-        in   if isDerivation v then pr
-          (drv: "<δ:${drv.name}:${concatStringsSep ","
-                                 (attrNames drv)}>")
-        else if [] ==   v then pr (const "[]")
-        else if isList  v then pr (l: "[ ${go (head l)}, … ]")
-        else if isAttrs v then pr
-          (a: "{ ${ concatStringsSep ", " (attrNames a)} }")
-        else v;
-      go = x: generators.toPretty
-        { allowPrettyValues = true; }
-        (modify x);
-    in go);
-
-  traceXMLVal = x:
-    trace ( "Warning: `traceXMLVal` is deprecated "
-          + "and will be removed in the next release. "
-          + "Please use `traceValFn builtins.toXML`." )
-    (trace (builtins.toXML x) x);
-  traceXMLValMarked = str: x:
-    trace ( "Warning: `traceXMLValMarked` is deprecated "
-          + "and will be removed in the next release. "
-          + "Please use `traceValFn (x: str + builtins.toXML x)`." )
-    (trace (str + builtins.toXML x) x);
-
-  # trace the arguments passed to function and its result
-  # maybe rewrite these functions in a traceCallXml like style. Then one function is enough
-  traceCall  = n: f: a: let t = n2: x: traceShowValMarked "${n} ${n2}:" x; in t "result" (f (t "arg 1" a));
-  traceCall2 = n: f: a: b: let t = n2: x: traceShowValMarked "${n} ${n2}:" x; in t "result" (f (t "arg 1" a) (t "arg 2" b));
-  traceCall3 = n: f: a: b: c: let t = n2: x: traceShowValMarked "${n} ${n2}:" x; in t "result" (f (t "arg 1" a) (t "arg 2" b) (t "arg 3" c));
-
-  traceValIfNot = c: x:
-    trace ( "Warning: `traceValIfNot` is deprecated "
-          + "and will be removed in the next release. "
-          + "Please use `if/then/else` and `traceValSeq 1`.")
-    (if c x then true else traceSeq (showVal x) false);
-
-
-  addErrorContextToAttrs = attrs:
-    trace ( "Warning: `addErrorContextToAttrs` is deprecated "
-          + "and will be removed in the next release. "
-          + "Please use `builtins.addErrorContext` directly." )
-    (lib.mapAttrs (a: v: lib.addErrorContext "while evaluating ${a}" v) attrs);
+  strict = v:
+    trace "Warning: strict is deprecated and will be removed in the next release"
+      (builtins.seq v v);
 
   # example: (traceCallXml "myfun" id 3) will output something like
   # calling myfun arg 1: 3 result: 3
@@ -178,20 +109,17 @@ rec {
   # note: if result doesn't evaluate you'll get no trace at all (FIXME)
   #       args should be printed in any case
   traceCallXml = a:
-    trace ( "Warning: `traceCallXml` is deprecated "
-          + "and will be removed in the next release. "
-          + "Please complain if you use the function regularly." )
-    (if !isInt a then
+    if !isInt a then
       traceCallXml 1 "calling ${a}\n"
     else
       let nr = a;
       in (str: expr:
           if isFunction expr then
             (arg:
-              traceCallXml (builtins.add 1 nr) "${str}\n arg ${builtins.toString nr} is \n ${builtins.toXML (builtins.seq arg arg)}" (expr arg)
+              traceCallXml (builtins.add 1 nr) "${str}\n arg ${builtins.toString nr} is \n ${builtins.toXML (strict arg)}" (expr arg)
             )
           else
-            let r = builtins.seq expr expr;
+            let r = strict expr;
             in trace "${str}\n result:\n${builtins.toXML r}" r
-      ));
+      );
 }

lib/default.nix

@@ -5,11 +5,9 @@
  */
 let
 
-  inherit (import ./fixed-points.nix {}) makeExtensible;
+  callLibs = file: import file { inherit lib; };
 
-  lib = makeExtensible (self: let
-    callLibs = file: import file { lib = self; };
-  in with self; {
+  lib = rec {
 
     # often used, or depending on very little
     trivial = callLibs ./trivial.nix;
@@ -49,17 +47,17 @@ let
     filesystem = callLibs ./filesystem.nix;
 
     # back-compat aliases
-    platforms = systems.forMeta;
+    platforms = systems.doubles;
 
-    inherit (builtins) add addErrorContext attrNames concatLists
-      deepSeq elem elemAt filter genericClosure genList getAttr
-      hasAttr head isAttrs isBool isInt isList isString length
-      lessThan listToAttrs pathExists readFile replaceStrings seq
-      stringLength sub substring tail;
-    inherit (trivial) id const concat or and bitAnd bitOr bitXor bitNot
-      boolToString mergeAttrs flip mapNullable inNixShell min max
-      importJSON warn info nixpkgsVersion version mod compare
-      splitByAndCompare functionArgs setFunctionArgs isFunction;
+    inherit (builtins) add addErrorContext attrNames
+      concatLists deepSeq elem elemAt filter genericClosure genList
+      getAttr hasAttr head isAttrs isBool isInt isList
+      isString length lessThan listToAttrs pathExists readFile
+      replaceStrings seq stringLength sub substring tail;
+    inherit (trivial) id const concat or and boolToString mergeAttrs
+      flip mapNullable inNixShell min max importJSON warn info
+      nixpkgsVersion mod compare splitByAndCompare
+      functionArgs setFunctionArgs isFunction;
 
     inherit (fixedPoints) fix fix' extends composeExtensions
       makeExtensible makeExtensibleWithCustomName;
@@ -74,32 +72,30 @@ let
     inherit (lists) singleton foldr fold foldl foldl' imap0 imap1
       concatMap flatten remove findSingle findFirst any all count
       optional optionals toList range partition zipListsWith zipLists
-      reverseList listDfs toposort sort naturalSort compareLists take
-      drop sublist last init crossLists unique intersectLists
-      subtractLists mutuallyExclusive groupBy groupBy';
+      reverseList listDfs toposort sort compareLists take drop sublist
+      last init crossLists unique intersectLists subtractLists
+      mutuallyExclusive;
     inherit (strings) concatStrings concatMapStrings concatImapStrings
       intersperse concatStringsSep concatMapStringsSep
       concatImapStringsSep makeSearchPath makeSearchPathOutput
-      makeLibraryPath makeBinPath makePerlPath makeFullPerlPath optionalString
+      makeLibraryPath makeBinPath makePerlPath optionalString
       hasPrefix hasSuffix stringToCharacters stringAsChars escape
-      escapeShellArg escapeShellArgs replaceChars lowerChars
-      upperChars toLower toUpper addContextFrom splitString
-      removePrefix removeSuffix versionOlder versionAtLeast getVersion
-      nameFromURL enableFeature enableFeatureAs withFeature
-      withFeatureAs fixedWidthString fixedWidthNumber isStorePath
+      escapeShellArg escapeShellArgs replaceChars lowerChars upperChars
+      toLower toUpper addContextFrom splitString removePrefix
+      removeSuffix versionOlder versionAtLeast getVersion nameFromURL
+      enableFeature fixedWidthString fixedWidthNumber isStorePath
       toInt readPathsFromFile fileContents;
     inherit (stringsWithDeps) textClosureList textClosureMap
       noDepEntry fullDepEntry packEntry stringAfter;
     inherit (customisation) overrideDerivation makeOverridable
-      callPackageWith callPackagesWith extendDerivation hydraJob
-      makeScope;
+      callPackageWith callPackagesWith extendDerivation
+      hydraJob makeScope;
     inherit (meta) addMetaAttrs dontDistribute setName updateName
       appendToName mapDerivationAttrset lowPrio lowPrioSet hiPrio
       hiPrioSet;
     inherit (sources) pathType pathIsDirectory cleanSourceFilter
       cleanSource sourceByRegex sourceFilesBySuffices
-      commitIdFromGitRepo cleanSourceWith pathHasContext
-      canCleanSource;
+      commitIdFromGitRepo cleanSourceWith pathHasContext canCleanSource;
     inherit (modules) evalModules closeModules unifyModuleSyntax
       applyIfFunction unpackSubmodule packSubmodule mergeModules
       mergeModules' mergeOptionDecls evalOptionValue mergeDefinitions
@@ -117,11 +113,11 @@ let
       unknownModule mkOption;
     inherit (types) isType setType defaultTypeMerge defaultFunctor
       isOptionType mkOptionType;
-    inherit (debug) addErrorContextToAttrs traceIf traceVal traceValFn
+    inherit (debug) addErrorContextToAttrs traceIf traceVal
       traceXMLVal traceXMLValMarked traceSeq traceSeqN traceValSeq
-      traceValSeqFn traceValSeqN traceValSeqNFn traceShowVal
-      traceShowValMarked showVal traceCall traceCall2 traceCall3
-      traceValIfNot runTests testAllTrue traceCallXml attrNamesToStr;
+      traceValSeqN traceShowVal traceShowValMarked
+      showVal traceCall traceCall2 traceCall3 traceValIfNot runTests
+      testAllTrue strict traceCallXml attrNamesToStr;
     inherit (misc) maybeEnv defaultMergeArg defaultMerge foldArgs
       defaultOverridableDelayableArgs composedArgsAndFun
       maybeAttrNullable maybeAttr ifEnable checkFlag getValue
@@ -130,7 +126,7 @@ let
       closePropagation mapAttrsFlatten nvs setAttr setAttrMerge
       mergeAttrsWithFunc mergeAttrsConcatenateValues
       mergeAttrsNoOverride mergeAttrByFunc mergeAttrsByFuncDefaults
-      mergeAttrsByFuncDefaultsClean mergeAttrBy prepareDerivationArgs
-      nixType imap overridableDelayableArgs;
-  });
+      mergeAttrsByFuncDefaultsClean mergeAttrBy
+      prepareDerivationArgs nixType imap overridableDelayableArgs;
+  };
 in lib

lib/generators.nix

@@ -4,12 +4,6 @@
  * They all follow a similar interface:
  * generator { config-attrs } data
  *
- * `config-attrs` are “holes” in the generators
- * with sensible default implementations that
- * can be overwritten. The default implementations
- * are mostly generators themselves, called with
- * their respective default values; they can be reused.
- *
  * Tests can be found in ./tests.nix
  * Documentation in the manual, #sec-generators
  */
@@ -19,37 +13,13 @@ let
   libStr = lib.strings;
   libAttr = lib.attrsets;
 
+  flipMapAttrs = flip libAttr.mapAttrs;
+
   inherit (lib) isFunction;
 in
 
 rec {
 
-  ## -- HELPER FUNCTIONS & DEFAULTS --
-
-  /* Convert a value to a sensible default string representation.
-   * The builtin `toString` function has some strange defaults,
-   * suitable for bash scripts but not much else.
-   */
-  mkValueStringDefault = {}: v: with builtins;
-    let err = t: v: abort
-          ("generators.mkValueStringDefault: " +
-           "${t} not supported: ${toPretty {} v}");
-    in   if isInt      v then toString v
-    # we default to not quoting strings
-    else if isString   v then v
-    # isString returns "1", which is not a good default
-    else if true  ==   v then "true"
-    # here it returns to "", which is even less of a good default
-    else if false ==   v then "false"
-    else if null  ==   v then "null"
-    # if you have lists you probably want to replace this
-    else if isList     v then err "lists" v
-    # same as for lists, might want to replace
-    else if isAttrs    v then err "attrsets" v
-    else if isFunction v then err "functions" v
-    else err "this value is" (toString v);
-
-
   /* Generate a line of key k and value v, separated by
    * character sep. If sep appears in k, it is escaped.
    * Helper for synaxes with different separators.
@@ -60,14 +30,11 @@ rec {
    * > "f\:oo:bar"
    */
   mkKeyValueDefault = {
-    mkValueString ? mkValueStringDefault {}
+    mkValueString ? toString
   }: sep: k: v:
     "${libStr.escape [sep] k}${sep}${mkValueString v}";
 
 
-  ## -- FILE FORMAT GENERATORS --
-
-
   /* Generate a key-value-style config file from an attrset.
    *
    * mkKeyValue is the same as in toINI.
@@ -131,7 +98,6 @@ rec {
     */
   toYAML = {}@args: toJSON args;
 
-
   /* Pretty print a value, akin to `builtins.trace`.
     * Should probably be a builtin as well.
     */
@@ -141,13 +107,17 @@ rec {
        (This means fn is type Val -> String.) */
     allowPrettyValues ? false
   }@args: v: with builtins;
-    let     isPath   = v: typeOf v == "path";
-    in if   isInt      v then toString v
-    else if isString   v then ''"${libStr.escape [''"''] v}"''
-    else if true  ==   v then "true"
-    else if false ==   v then "false"
-    else if null  ==   v then "null"
-    else if isPath     v then toString v
+    if      isInt      v then toString v
+    else if isBool     v then (if v == true then "true" else "false")
+    else if isString   v then "\"" + v + "\""
+    else if null ==    v then "null"
+    else if isFunction v then
+      let fna = lib.functionArgs v;
+          showFnas = concatStringsSep "," (libAttr.mapAttrsToList
+                       (name: hasDefVal: if hasDefVal then "(${name})" else name)
+                       fna);
+      in if fna == {}    then "<λ>"
+                         else "<λ:{${showFnas}}>"
     else if isList     v then "[ "
         + libStr.concatMapStringsSep " " (toPretty args) v
       + " ]"
@@ -156,71 +126,12 @@ rec {
       if attrNames v == [ "__pretty" "val" ] && allowPrettyValues
          then v.__pretty v.val
       # TODO: there is probably a better representation?
-      else if v ? type && v.type == "derivation" then
-        "<δ:${v.name}>"
-        # "<δ:${concatStringsSep "," (builtins.attrNames v)}>"
+      else if v ? type && v.type == "derivation" then "<δ>"
       else "{ "
           + libStr.concatStringsSep " " (libAttr.mapAttrsToList
               (name: value:
                 "${toPretty args name} = ${toPretty args value};") v)
         + " }"
-    else if isFunction v then
-      let fna = lib.functionArgs v;
-          showFnas = concatStringsSep "," (libAttr.mapAttrsToList
-                       (name: hasDefVal: if hasDefVal then "(${name})" else name)
-                       fna);
-      in if fna == {}    then "<λ>"
-                         else "<λ:{${showFnas}}>"
-    else abort "generators.toPretty: should never happen (v = ${v})";
-
-  # PLIST handling
-  toPlist = {}: v: let
-    isFloat = builtins.isFloat or (x: false);
-    expr = ind: x:  with builtins;
-      if isNull x   then "" else
-      if isBool x   then bool ind x else
-      if isInt x    then int ind x else
-      if isString x then str ind x else
-      if isList x   then list ind x else
-      if isAttrs x  then attrs ind x else
-      if isFloat x  then float ind x else
-      abort "generators.toPlist: should never happen (v = ${v})";
-
-    literal = ind: x: ind + x;
-
-    bool = ind: x: literal ind  (if x then "<true/>" else "<false/>");
-    int = ind: x: literal ind "<integer>${toString x}</integer>";
-    str = ind: x: literal ind "<string>${x}</string>";
-    key = ind: x: literal ind "<key>${x}</key>";
-    float = ind: x: literal ind "<real>${toString x}</real>";
-
-    indent = ind: expr "\t${ind}";
-
-    item = ind: libStr.concatMapStringsSep "\n" (indent ind);
-
-    list = ind: x: libStr.concatStringsSep "\n" [
-      (literal ind "<array>")
-      (item ind x)
-      (literal ind "</array>")
-    ];
-
-    attrs = ind: x: libStr.concatStringsSep "\n" [
-      (literal ind "<dict>")
-      (attr ind x)
-      (literal ind "</dict>")
-    ];
-
-    attr = let attrFilter = name: value: name != "_module" && value != null;
-    in ind: x: libStr.concatStringsSep "\n" (lib.flatten (lib.mapAttrsToList
-      (name: value: lib.optional (attrFilter name value) [
-      (key "\t${ind}" name)
-      (expr "\t${ind}" value)
-    ]) x));
-
-  in ''<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-${expr "" v}
-</plist>'';
+    else abort "toPretty: should never happen (v = ${v})";
 
 }

lib/kernel.nix

@@ -1,57 +0,0 @@
-{ lib
-# we pass the kernel version here to keep a nice syntax `whenOlder "4.13"`
-# kernelVersion, e.g., config.boot.kernelPackages.version
-, version
-, mkValuePreprocess ? null
-}:
-
-with lib;
-rec {
-  # Common patterns
-  when        = cond: opt: if cond then opt else null;
-  whenAtLeast = ver: when (versionAtLeast version ver);
-  whenOlder   = ver: when (versionOlder version ver);
-  whenBetween = verLow: verHigh: when (versionAtLeast version verLow && versionOlder version verHigh);
-
-  # Keeping these around in case we decide to change this horrible implementation :)
-  option = x: if x == null then null else "?${x}";
-  yes    = "y";
-  no     = "n";
-  module = "m";
-
-  mkValue = val:
-  let
-    isNumber = c: elem c ["0" "1" "2" "3" "4" "5" "6" "7" "8" "9"];
-  in
-    if val == "" then "\"\""
-    else if val == yes || val == module || val == no then val
-    else if all isNumber (stringToCharacters val) then val
-    else if substring 0 2 val == "0x" then val
-    else val; # FIXME: fix quoting one day
-
-
-  # generate nix intermediate kernel config file of the form
-  #
-  #       VIRTIO_MMIO m
-  #       VIRTIO_BLK y
-  #       VIRTIO_CONSOLE n
-  #       NET_9P_VIRTIO? y
-  #
-  # Use mkValuePreprocess to preprocess option values, aka mark 'modules' as
-  # 'yes' or vice-versa
-  # Borrowed from copumpkin https://github.com/NixOS/nixpkgs/pull/12158
-  # returns a string, expr should be an attribute set
-  generateNixKConf = exprs: mkValuePreprocess:
-  let
-    mkConfigLine = key: rawval:
-    let
-      val = if builtins.isFunction mkValuePreprocess then mkValuePreprocess rawval else rawval;
-    in
-      if val == null
-        then ""
-        else if hasPrefix "?" val
-          then "${key}? ${mkValue (removePrefix "?" val)}\n"
-          else "${key} ${mkValue val}\n";
-    mkConf = cfg: concatStrings (mapAttrsToList mkConfigLine cfg);
-  in mkConf exprs;
-}

lib/licenses.nix

@@ -99,16 +99,6 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
     fullName = ''BSD 4-clause "Original" or "Old" License'';
   };
 
-  bsl10 = {
-    fullName = "Business Source License 1.0";
-    url = https://mariadb.com/bsl10;
-  };
-
-  bsl11 = {
-    fullName = "Business Source License 1.1";
-    url = https://mariadb.com/bsl11;
-  };
-
   clArtistic = spdx {
     spdxId = "ClArtistic";
     fullName = "Clarified Artistic License";
@@ -122,37 +112,26 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
   cc-by-nc-sa-20 = spdx {
     spdxId = "CC-BY-NC-SA-2.0";
     fullName = "Creative Commons Attribution Non Commercial Share Alike 2.0";
-    free = false;
   };
 
   cc-by-nc-sa-25 = spdx {
     spdxId = "CC-BY-NC-SA-2.5";
     fullName = "Creative Commons Attribution Non Commercial Share Alike 2.5";
-    free = false;
   };
 
   cc-by-nc-sa-30 = spdx {
     spdxId = "CC-BY-NC-SA-3.0";
     fullName = "Creative Commons Attribution Non Commercial Share Alike 3.0";
-    free = false;
   };
 
   cc-by-nc-sa-40 = spdx {
     spdxId = "CC-BY-NC-SA-4.0";
     fullName = "Creative Commons Attribution Non Commercial Share Alike 4.0";
-    free = false;
-  };
-
-  cc-by-nc-40 = spdx {
-    spdxId = "CC-BY-NC-4.0";
-    fullName = "Creative Commons Attribution Non Commercial 4.0 International";
-    free = false;
   };
 
   cc-by-nd-30 = spdx {
     spdxId = "CC-BY-ND-3.0";
     fullName = "Creative Commons Attribution-No Derivative Works v3.00";
-    free = false;
   };
 
   cc-by-sa-25 = spdx {
@@ -200,21 +179,11 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
     fullName  = "CeCILL-C Free Software License Agreement";
   };
 
-  cpal10 = spdx {
-    spdxId = "CPAL-1.0";
-    fullName = "Common Public Attribution License 1.0";
-  };
-
   cpl10 = spdx {
     spdxId = "CPL-1.0";
     fullName = "Common Public License 1.0";
   };
 
-  curl = {
-    fullName = "MIT/X11 derivate";
-    url = "https://curl.haxx.se/docs/copyright.html";
-  };
-
   doc = spdx {
     spdxId = "DOC";
     fullName = "DOC License";
@@ -236,12 +205,6 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
     fullName = "Eiffel Forum License v2.0";
   };
 
-  elastic = {
-    fullName = "ELASTIC LICENSE";
-    url = https://github.com/elastic/elasticsearch/blob/master/licenses/ELASTIC-LICENSE.txt;
-    free = false;
-  };
-
   epl10 = spdx {
     spdxId = "EPL-1.0";
     fullName = "Eclipse Public License 1.0";
@@ -316,7 +279,7 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
 
   gpl2Oss = {
     fullName = "GNU General Public License version 2 only (with OSI approved licenses linking exception)";
-    url = https://www.mysql.com/about/legal/licensing/foss-exception;
+    url = http://www.mysql.com/about/legal/licensing/foss-exception;
   };
 
   gpl2Plus = spdx {
@@ -355,11 +318,6 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
     fullName = "Independent JPEG Group License";
   };
 
-  imagemagick = spdx {
-    fullName = "ImageMagick License";
-    spdxId = "imagemagick";
-  };
-
   inria-compcert = {
     fullName  = "INRIA Non-Commercial License Agreement for the CompCert verified compiler";
     url       = "http://compcert.inria.fr/doc/LICENSE";
@@ -482,7 +440,6 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
   msrla = {
     fullName  = "Microsoft Research License Agreement";
     url       = "http://research.microsoft.com/en-us/projects/pex/msr-la.txt";
-    free = false;
   };
 
   ncsa = spdx {
@@ -623,12 +580,6 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
     fullName = "Vim License";
   };
 
-  virtualbox-puel = {
-    fullName = "Oracle VM VirtualBox Extension Pack Personal Use and Evaluation License (PUEL)";
-    url = "https://www.virtualbox.org/wiki/VirtualBox_PUEL";
-    free = false;
-  };
-
   vsl10 = spdx {
     spdxId = "VSL-1.0";
     fullName = "Vovida Software License v1.0";
@@ -659,11 +610,6 @@ lib.mapAttrs (n: v: v // { shortName = n; }) rec {
     fullName = "wxWindows Library Licence, Version 3.1";
   };
 
-  xfig = {
-    fullName = "xfig";
-    url = "http://mcj.sourceforge.net/authors.html#xfig";
-  };
-
   zlib = spdx {
     spdxId = "Zlib";
     fullName = "zlib License";

lib/lists.nix

@@ -1,9 +1,7 @@
 # General list operations.
 { lib }:
 with lib.trivial;
-let
-  inherit (lib.strings) toInt;
-in
+
 rec {
 
   inherit (builtins) head tail length isList elemAt concatLists filter elem genList;
@@ -64,6 +62,7 @@ rec {
   */
   foldl = op: nul: list:
     let
+      len = length list;
       foldl' = n:
         if n == -1
         then nul
@@ -100,7 +99,7 @@ rec {
        concatMap (x: [x] ++ ["z"]) ["a" "b"]
        => [ "a" "z" "b" "z" ]
   */
-  concatMap = builtins.concatMap or (f: list: concatLists (map f list));
+  concatMap = f: list: concatLists (map f list);
 
   /* Flatten the argument into a single list; that is, nested lists are
      spliced into the top-level lists.
@@ -249,42 +248,6 @@ rec {
       else { right = t.right; wrong = [h] ++ t.wrong; }
     ) { right = []; wrong = []; });
 
-  /* Splits the elements of a list into many lists, using the return value of a predicate.
-     Predicate should return a string which becomes keys of attrset `groupBy' returns.
-
-     `groupBy'' allows to customise the combining function and initial value
-
-     Example:
-       groupBy (x: boolToString (x > 2)) [ 5 1 2 3 4 ]
-       => { true = [ 5 3 4 ]; false = [ 1 2 ]; }
-       groupBy (x: x.name) [ {name = "icewm"; script = "icewm &";}
-                             {name = "xfce";  script = "xfce4-session &";}
-                             {name = "icewm"; script = "icewmbg &";}
-                             {name = "mate";  script = "gnome-session &";}
-                           ]
-       => { icewm = [ { name = "icewm"; script = "icewm &"; }
-                      { name = "icewm"; script = "icewmbg &"; } ];
-            mate  = [ { name = "mate";  script = "gnome-session &"; } ];
-            xfce  = [ { name = "xfce";  script = "xfce4-session &"; } ];
-          }
-
-
-     groupBy' allows to customise the combining function and initial value
-
-     Example:
-       groupBy' builtins.add 0 (x: boolToString (x > 2)) [ 5 1 2 3 4 ]
-       => { true = 12; false = 3; }
-  */
-  groupBy' = op: nul: pred: lst:
-    foldl' (r: e:
-              let
-                key = pred e;
-              in
-                r // { ${key} = op (r.${key} or nul) e; }
-           ) {} lst;
-
-  groupBy = groupBy' (sum: e: sum ++ [e]) [];
-
   /* Merges two lists of the same size together. If the sizes aren't the same
      the merging stops at the shortest. How both lists are merged is defined
      by the first argument.
@@ -446,25 +409,6 @@ rec {
               then compareLists cmp (tail a) (tail b)
               else rel;
 
-  /* Sort list using "Natural sorting".
-     Numeric portions of strings are sorted in numeric order.
-
-     Example:
-       naturalSort ["disk11" "disk8" "disk100" "disk9"]
-       => ["disk8" "disk9" "disk11" "disk100"]
-       naturalSort ["10.46.133.149" "10.5.16.62" "10.54.16.25"]
-       => ["10.5.16.62" "10.46.133.149" "10.54.16.25"]
-       naturalSort ["v0.2" "v0.15" "v0.0.9"]
-       => [ "v0.0.9" "v0.2" "v0.15" ]
-  */
-  naturalSort = lst:
-    let
-      vectorise = s: map (x: if isList x then toInt (head x) else x) (builtins.split "(0|[1-9][0-9]*)" s);
-      prepared = map (x: [ (vectorise x) x ]) lst; # remember vectorised version for O(n) regex splits
-      less = a: b: (compareLists compare (head a) (head b)) < 0;
-    in
-      map (x: elemAt x 1) (sort less prepared);
-
   /* Return the first (at most) N elements of a list.
 
      Example:

lib/meta.nix

@@ -67,23 +67,4 @@ rec {
   */
   hiPrioSet = set: mapDerivationAttrset hiPrio set;
 
-
-  /* Check to see if a platform is matched by the given `meta.platforms`
-     element.
-
-     A `meta.platform` pattern is either
-
-       1. (legacy) a system string.
-
-       2. (modern) a pattern for the platform `parsed` field.
-
-     We can inject these into a patten for the whole of a structured platform,
-     and then match that.
-  */
-  platformMatch = platform: elem: let
-      pattern =
-        if builtins.isString elem
-        then { system = elem; }
-        else { parsed = elem; };
-    in lib.matchAttrs pattern platform;
 }

lib/modules.nix

@@ -59,7 +59,7 @@ rec {
         };
       };
 
-      closed = closeModules (modules ++ [ internalModule ]) ({ inherit config options lib; } // specialArgs);
+      closed = closeModules (modules ++ [ internalModule ]) ({ inherit config options; lib = import ./.; } // specialArgs);
 
       options = mergeModules prefix (reverseList (filterModules (specialArgs.modulesPath or "") closed));
 
@@ -159,7 +159,7 @@ rec {
       context = name: ''while evaluating the module argument `${name}' in "${key}":'';
       extraArgs = builtins.listToAttrs (map (name: {
         inherit name;
-        value = builtins.addErrorContext (context name)
+        value = addErrorContext (context name)
           (args.${name} or config._module.args.${name});
       }) requiredArgs);
 
@@ -192,53 +192,29 @@ rec {
       (concatMap (m: map (config: { inherit (m) file; inherit config; }) (pushDownProperties m.config)) modules);
 
   mergeModules' = prefix: options: configs:
-    let
-     /* byName is like foldAttrs, but will look for attributes to merge in the
-        specified attribute name.
-
-        byName "foo" (module: value: ["module.hidden=${module.hidden},value=${value}"])
-        [
-          {
-            hidden="baz";
-            foo={qux="bar"; gla="flop";};
-          }
-          {
-            hidden="fli";
-            foo={qux="gne"; gli="flip";};
-          }
-        ]
-        ===>
-        {
-          gla = [ "module.hidden=baz,value=flop" ];
-          gli = [ "module.hidden=fli,value=flip" ];
-          qux = [ "module.hidden=baz,value=bar" "module.hidden=fli,value=gne" ];
-        }
-      */
-      byName = attr: f: modules: foldl' (acc: module:
-        foldl' (inner: name:
-          inner // { ${name} = (acc.${name} or []) ++ (f module module.${attr}.${name}); }
-          ) acc (attrNames module.${attr})
-        ) {} modules;
-      # an attrset 'name' => list of submodules that declare ‘name’.
-      declsByName = byName "options"
-        (module: option: [{ inherit (module) file; options = option; }])
-        options;
-      # an attrset 'name' => list of submodules that define ‘name’.
-      defnsByName = byName "config" (module: value:
-        map (config: { inherit (module) file; inherit config; }) (pushDownProperties value)
-        ) configs;
-      # extract the definitions for each loc
-      defnsByName' = byName "config"
-        (module: value: [{ inherit (module) file; inherit value; }])
-        configs;
-    in
-    (flip mapAttrs declsByName (name: decls:
+    listToAttrs (map (name: {
       # We're descending into attribute ‘name’.
+      inherit name;
+      value =
         let
           loc = prefix ++ [name];
-          defns = defnsByName.${name} or [];
-          defns' = defnsByName'.${name} or [];
+          # Get all submodules that declare ‘name’.
+          decls = concatMap (m:
+            if m.options ? ${name}
+              then [ { inherit (m) file; options = m.options.${name}; } ]
+              else []
+            ) options;
+          # Get all submodules that define ‘name’.
+          defns = concatMap (m:
+            if m.config ? ${name}
+              then map (config: { inherit (m) file; inherit config; })
+                (pushDownProperties m.config.${name})
+              else []
+            ) configs;
           nrOptions = count (m: isOption m.options) decls;
+          # Extract the definitions for this loc
+          defns' = map (m: { inherit (m) file; value = m.config.${name}; })
+            (filter (m: m.config ? ${name}) configs);
         in
           if nrOptions == length decls then
             let opt = fixupOptionType loc (mergeOptionDecls loc decls);
@@ -250,8 +226,8 @@ rec {
             in
               throw "The option `${showOption loc}' in `${firstOption.file}' is a prefix of options in `${firstNonOption.file}'."
           else
-            mergeModules' loc decls defns
-      ))
+            mergeModules' loc decls defns;
+    }) (concatMap (m: attrNames m.options) options))
     // { _definedNames = map (m: { inherit (m) file; names = attrNames m.config; }) configs; };
 
   /* Merge multiple option declarations into a single declaration.  In
@@ -333,8 +309,7 @@ rec {
           res.mergedValue;
 
     in opt //
-      { value = builtins.addErrorContext "while evaluating the option `${showOption loc}':" value;
-        inherit (res.defsFinal') highestPrio;
+      { value = addErrorContext "while evaluating the option `${showOption loc}':" value;
         definitions = map (def: def.value) res.defsFinal;
         files = map (def: def.file) res.defsFinal;
         inherit (res) isDefined;
@@ -342,7 +317,7 @@ rec {
 
   # Merge definitions of a value of a given type.
   mergeDefinitions = loc: type: defs: rec {
-    defsFinal' =
+    defsFinal =
       let
         # Process mkMerge and mkIf properties.
         defs' = concatMap (m:
@@ -350,20 +325,15 @@ rec {
         ) defs;
 
         # Process mkOverride properties.
-        defs'' = filterOverrides' defs';
+        defs'' = filterOverrides defs';
 
         # Sort mkOrder properties.
         defs''' =
           # Avoid sorting if we don't have to.
-          if any (def: def.value._type or "" == "order") defs''.values
-          then sortProperties defs''.values
-          else defs''.values;
-      in {
-        values = defs''';
-        inherit (defs'') highestPrio;
-      };
-
-    defsFinal = defsFinal'.values;
+          if any (def: def.value._type or "" == "order") defs''
+          then sortProperties defs''
+          else defs'';
+      in defs''';
 
     # Type-check the remaining definitions, and merge them.
     mergedValue = foldl' (res: def:
@@ -446,18 +416,13 @@ rec {
 
      Note that "z" has the default priority 100.
   */
-  filterOverrides = defs: (filterOverrides' defs).values;
-
-  filterOverrides' = defs:
+  filterOverrides = defs:
     let
       defaultPrio = 100;
       getPrio = def: if def.value._type or "" == "override" then def.value.priority else defaultPrio;
       highestPrio = foldl' (prio: def: min (getPrio def) prio) 9999 defs;
       strip = def: if def.value._type or "" == "override" then def // { value = def.value.content; } else def;
-    in {
-      values = concatMap (def: if getPrio def == highestPrio then [(strip def)] else []) defs;
-      inherit highestPrio;
-    };
+    in concatMap (def: if getPrio def == highestPrio then [(strip def)] else []) defs;
 
   /* Sort a list of properties.  The sort priority of a property is
      1000 by default, but can be overridden by wrapping the property
@@ -517,7 +482,7 @@ rec {
       inherit priority content;
     };
 
-  mkOptionDefault = mkOverride 1500; # priority of option defaults
+  mkOptionDefault = mkOverride 1001; # priority of option defaults
   mkDefault = mkOverride 1000; # used in config sections of non-user modules to set a default
   mkForce = mkOverride 50;
   mkVMOverride = mkOverride 10; # used by ‘nixos-rebuild build-vm’
@@ -556,7 +521,9 @@ rec {
   #
   mkAliasDefinitions = mkAliasAndWrapDefinitions id;
   mkAliasAndWrapDefinitions = wrap: option:
-    mkIf (isOption option && option.isDefined) (wrap (mkMerge option.definitions));
+    mkMerge
+      (optional (isOption option && option.isDefined)
+        (wrap (mkMerge option.definitions)));
 
 
   /* Compatibility. */
@@ -691,25 +658,21 @@ rec {
   };
 
   doRename = { from, to, visible, warn, use }:
-    { config, options, ... }:
     let
-      fromOpt = getAttrFromPath from options;
       toOf = attrByPath to
         (abort "Renaming error: option `${showOption to}' does not exist.");
     in
-    {
-      options = setAttrByPath from (mkOption {
-        inherit visible;
-        description = "Alias of <option>${showOption to}</option>.";
-        apply = x: use (toOf config);
-      });
-      config = mkMerge [
-        {
-          warnings = optional (warn && fromOpt.isDefined)
-            "The option `${showOption from}' defined in ${showFiles fromOpt.files} has been renamed to `${showOption to}'.";
-        }
-        (mkAliasAndWrapDefinitions (setAttrByPath to) fromOpt)
-      ];
-    };
+      { config, options, ... }:
+      { options = setAttrByPath from (mkOption {
+          description = "Alias of <option>${showOption to}</option>.";
+          apply = x: use (toOf config);
+        });
+        config = {
+          warnings =
+            let opt = getAttrFromPath from options; in
+            optional (warn && opt.isDefined)
+              "The option `${showOption from}' defined in ${showFiles opt.files} has been renamed to `${showOption to}'.";
+        } // setAttrByPath to (mkAliasDefinitions (getAttrFromPath from options));
+      };
 
 }

lib/options.nix

@@ -127,20 +127,7 @@ rec {
 
 
   /* Helper functions. */
-
-  # Convert an option, described as a list of the option parts in to a
-  # safe, human readable version. ie:
-  #
-  # (showOption ["foo" "bar" "baz"]) == "foo.bar.baz"
-  # (showOption ["foo" "bar.baz" "tux"]) == "foo.\"bar.baz\".tux"
-  showOption = parts: let
-    escapeOptionPart = part:
-      let
-        escaped = lib.strings.escapeNixString part;
-      in if escaped == "\"${part}\""
-         then part
-         else escaped;
-    in (concatStringsSep ".") (map escapeOptionPart parts);
+  showOption = concatStringsSep ".";
   showFiles = files: concatStringsSep " and " (map (f: "`${f}'") files);
   unknownModule = "<unknown-file>";
 

lib/strings.nix

@@ -82,7 +82,7 @@ rec {
        => "//bin"
   */
   makeSearchPath = subDir: packages:
-    concatStringsSep ":" (map (path: path + "/" + subDir) (builtins.filter (x: x != null) packages));
+    concatStringsSep ":" (map (path: path + "/" + subDir) packages);
 
   /* Construct a Unix-style search path, using given package output.
      If no output is found, fallback to `.out` and then to the default.
@@ -121,20 +121,11 @@ rec {
 
      Example:
        pkgs = import <nixpkgs> { }
-       makePerlPath [ pkgs.perlPackages.libnet ]
+       makePerlPath [ pkgs.perlPackages.NetSMTP ]
        => "/nix/store/n0m1fk9c960d8wlrs62sncnadygqqc6y-perl-Net-SMTP-1.25/lib/perl5/site_perl"
   */
   makePerlPath = makeSearchPathOutput "lib" "lib/perl5/site_perl";
 
-  /* Construct a perl search path recursively including all dependencies (such as $PERL5LIB)
-
-     Example:
-       pkgs = import <nixpkgs> { }
-       makeFullPerlPath [ pkgs.perlPackages.CGI ]
-       => "/nix/store/fddivfrdc1xql02h9q500fpnqy12c74n-perl-CGI-4.38/lib/perl5/site_perl:/nix/store/8hsvdalmsxqkjg0c5ifigpf31vc4vsy2-perl-HTML-Parser-3.72/lib/perl5/site_perl:/nix/store/zhc7wh0xl8hz3y3f71nhlw1559iyvzld-perl-HTML-Tagset-3.20/lib/perl5/site_perl"
-  */
-  makeFullPerlPath = deps: makePerlPath (lib.misc.closePropagation deps);
-
   /* Depending on the boolean `cond', return either the given string
      or the empty string. Useful to concatenate against a bigger string.
 
@@ -423,39 +414,6 @@ rec {
   */
   enableFeature = enable: feat: "--${if enable then "enable" else "disable"}-${feat}";
 
-  /* Create an --{enable-<feat>=<value>,disable-<feat>} string that can be passed to
-     standard GNU Autoconf scripts.
-
-     Example:
-       enableFeature true "shared" "foo"
-       => "--enable-shared=foo"
-       enableFeature false "shared" (throw "ignored")
-       => "--disable-shared"
-  */
-  enableFeatureAs = enable: feat: value: enableFeature enable feat + optionalString enable "=${value}";
-
-  /* Create an --{with,without}-<feat> string that can be passed to
-     standard GNU Autoconf scripts.
-
-     Example:
-       withFeature true "shared"
-       => "--with-shared"
-       withFeature false "shared"
-       => "--without-shared"
-  */
-  withFeature = with_: feat: "--${if with_ then "with" else "without"}-${feat}";
-
-  /* Create an --{with-<feat>=<value>,without-<feat>} string that can be passed to
-     standard GNU Autoconf scripts.
-
-     Example:
-       with_Feature true "shared" "foo"
-       => "--with-shared=foo"
-       with_Feature false "shared" (throw "ignored")
-       => "--without-shared"
-  */
-  withFeatureAs = with_: feat: value: withFeature with_ feat + optionalString with_ "=${value}";
-
   /* Create a fixed width string with additional prefix to match
      required width.
 
@@ -479,13 +437,6 @@ rec {
   */
   fixedWidthNumber = width: n: fixedWidthString width "0" (toString n);
 
-  /* Check whether a value can be coerced to a string */
-  isCoercibleToString = x:
-    builtins.elem (builtins.typeOf x) [ "path" "string" "null" "int" "float" "bool" ] ||
-    (builtins.isList x && lib.all isCoercibleToString x) ||
-    x ? outPath ||
-    x ? __toString;
-
   /* Check whether a value is a store path.
 
      Example:
@@ -499,7 +450,7 @@ rec {
        => false
   */
   isStorePath = x:
-       isCoercibleToString x
+       builtins.isString x
     && builtins.substring 0 1 (toString x) == "/"
     && dirOf (builtins.toPath x) == builtins.storeDir;
 

lib/systems/default.nix

@@ -3,7 +3,6 @@
 
 rec {
   doubles = import ./doubles.nix { inherit lib; };
-  forMeta = import ./for-meta.nix { inherit lib; };
   parse = import ./parse.nix { inherit lib; };
   inspect = import ./inspect.nix { inherit lib; };
   platforms = import ./platforms.nix { inherit lib; };
@@ -29,7 +28,6 @@ rec {
         /**/ if final.isDarwin              then "libSystem"
         else if final.isMinGW               then "msvcrt"
         else if final.isMusl                then "musl"
-        else if final.isUClibc              then "uclibc"
         else if final.isAndroid             then "bionic"
         else if final.isLinux /* default */ then "glibc"
         # TODO(@Ericson2314) think more about other operating systems
@@ -45,16 +43,8 @@ rec {
       };
       # Misc boolean options
       useAndroidPrebuilt = false;
-      useiOSPrebuilt = false;
     } // mapAttrs (n: v: v final.parsed) inspect.predicates
       // args;
   in assert final.useAndroidPrebuilt -> final.isAndroid;
-     assert lib.foldl
-       (pass: { assertion, message }:
-         if assertion final
-         then pass
-         else throw message)
-       true
-       (final.parsed.abi.assertions or []);
     final;
 }

lib/systems/doubles.nix

@@ -24,25 +24,24 @@ let
 in rec {
   inherit all;
 
+  allBut = platforms: lists.filter (x: !(builtins.elem x platforms)) all;
   none = [];
 
-  arm     = filterDoubles predicates.isAarch32;
-  aarch64 = filterDoubles predicates.isAarch64;
-  x86     = filterDoubles predicates.isx86;
+  arm     = filterDoubles predicates.isArm;
   i686    = filterDoubles predicates.isi686;
-  x86_64  = filterDoubles predicates.isx86_64;
   mips    = filterDoubles predicates.isMips;
+  x86_64  = filterDoubles predicates.isx86_64;
 
   cygwin  = filterDoubles predicates.isCygwin;
   darwin  = filterDoubles predicates.isDarwin;
   freebsd = filterDoubles predicates.isFreeBSD;
-  # Should be better, but MinGW is unclear.
-  gnu     = filterDoubles (matchAttrs { kernel = parse.kernels.linux; abi = parse.abis.gnu; });
+  # Should be better, but MinGW is unclear, and HURD is bit-rotted.
+  gnu     = filterDoubles (matchAttrs { kernel = parse.kernels.linux;  abi = parse.abis.gnu; });
   illumos = filterDoubles predicates.isSunOS;
   linux   = filterDoubles predicates.isLinux;
   netbsd  = filterDoubles predicates.isNetBSD;
   openbsd = filterDoubles predicates.isOpenBSD;
   unix    = filterDoubles predicates.isUnix;
 
-  mesaPlatforms = ["i686-linux" "x86_64-linux" "x86_64-darwin" "armv5tel-linux" "armv6l-linux" "armv7l-linux" "aarch64-linux" "powerpc64le-linux"];
+  mesaPlatforms = ["i686-linux" "x86_64-linux" "x86_64-darwin" "armv5tel-linux" "armv6l-linux" "armv7l-linux" "aarch64-linux"];
 }

lib/systems/examples.nix

@@ -8,55 +8,39 @@ rec {
   #
   # Linux
   #
-  powernv = {
-    config = "powerpc64le-unknown-linux-gnu";
-    platform = platforms.powernv;
-  };
-  musl-power = {
-    config = "powerpc64le-unknown-linux-musl";
-    platform = platforms.powernv;
-  };
 
   sheevaplug = rec {
     config = "armv5tel-unknown-linux-gnueabi";
+    arch = "armv5tel";
+    float = "soft";
     platform = platforms.sheevaplug;
   };
 
   raspberryPi = rec {
     config = "armv6l-unknown-linux-gnueabihf";
+    arch = "armv6l";
+    float = "hard";
+    fpu = "vfp";
     platform = platforms.raspberrypi;
   };
 
   armv7l-hf-multiplatform = rec {
-    config = "armv7a-unknown-linux-gnueabihf";
+    config = "arm-unknown-linux-gnueabihf";
+    arch = "armv7-a";
+    float = "hard";
+    fpu = "vfpv3-d16";
     platform = platforms.armv7l-hf-multiplatform;
   };
 
   aarch64-multiplatform = rec {
     config = "aarch64-unknown-linux-gnu";
+    arch = "aarch64";
     platform = platforms.aarch64-multiplatform;
   };
 
-  armv5te-android-prebuilt = rec {
-    config = "armv5tel-unknown-linux-androideabi";
-    sdkVer = "21";
-    ndkVer = "10e";
-    platform = platforms.armv5te-android;
-    useAndroidPrebuilt = true;
-  };
-
-  armv7a-android-prebuilt = rec {
-    config = "armv7a-unknown-linux-androideabi";
-    sdkVer = "24";
-    ndkVer = "17c";
-    platform = platforms.armv7a-android;
-    useAndroidPrebuilt = true;
-  };
-
   aarch64-android-prebuilt = rec {
     config = "aarch64-unknown-linux-android";
-    sdkVer = "24";
-    ndkVer = "17c";
+    arch = "aarch64";
     platform = platforms.aarch64-multiplatform;
     useAndroidPrebuilt = true;
   };
@@ -67,17 +51,16 @@ rec {
   };
 
   pogoplug4 = rec {
+    arch = "armv5tel";
     config = "armv5tel-unknown-linux-gnueabi";
+    float = "soft";
     platform = platforms.pogoplug4;
   };
 
-  ben-nanonote = rec {
-    config = "mipsel-unknown-linux-uclibc";
-    platform = platforms.ben_nanonote;
-  };
-
   fuloongminipc = rec {
     config = "mipsel-unknown-linux-gnu";
+    arch = "mips";
+    float = "hard";
     platform = platforms.fuloong2f_n32;
   };
 
@@ -105,42 +88,16 @@ rec {
   #
 
   iphone64 = {
-    config = "aarch64-apple-ios";
-    # config = "aarch64-apple-darwin14";
-    sdkVer = "10.2";
-    xcodeVer = "8.2";
-    xcodePlatform = "iPhoneOS";
-    useiOSPrebuilt = true;
+    config = "aarch64-apple-darwin14";
+    arch = "arm64";
+    libc = "libSystem";
     platform = {};
   };
 
   iphone32 = {
-    config = "armv7a-apple-ios";
-    # config = "arm-apple-darwin10";
-    sdkVer = "10.2";
-    xcodeVer = "8.2";
-    xcodePlatform = "iPhoneOS";
-    useiOSPrebuilt = true;
-    platform = {};
-  };
-
-  iphone64-simulator = {
-    config = "x86_64-apple-ios";
-    # config = "x86_64-apple-darwin14";
-    sdkVer = "10.2";
-    xcodeVer = "8.2";
-    xcodePlatform = "iPhoneSimulator";
-    useiOSPrebuilt = true;
-    platform = {};
-  };
-
-  iphone32-simulator = {
-    config = "i686-apple-ios";
-    # config = "i386-apple-darwin11";
-    sdkVer = "10.2";
-    xcodeVer = "8.2";
-    xcodePlatform = "iPhoneSimulator";
-    useiOSPrebuilt = true;
+    config = "arm-apple-darwin10";
+    arch = "armv7-a";
+    libc = "libSystem";
     platform = {};
   };
 
@@ -151,6 +108,7 @@ rec {
   # 32 bit mingw-w64
   mingw32 = {
     config = "i686-pc-mingw32";
+    arch = "x86"; # Irrelevant
     libc = "msvcrt"; # This distinguishes the mingw (non posix) toolchain
     platform = {};
   };
@@ -159,6 +117,7 @@ rec {
   mingwW64 = {
     # That's the triplet they use in the mingw-w64 docs.
     config = "x86_64-pc-mingw32";
+    arch = "x86_64"; # Irrelevant
     libc = "msvcrt"; # This distinguishes the mingw (non posix) toolchain
     platform = {};
   };

lib/systems/for-meta.nix

@@ -1,37 +0,0 @@
-{ lib }:
-let
-  inherit (lib.systems) parse;
-  inherit (lib.systems.inspect) patterns;
-
-  abis = lib.mapAttrs (_: abi: builtins.removeAttrs abi [ "assertions" ]) parse.abis;
-
-in rec {
-  all     = [ {} ]; # `{}` matches anything
-  none    = [];
-
-  arm     = [ patterns.isAarch32 ];
-  aarch64 = [ patterns.isAarch64 ];
-  x86     = [ patterns.isx86 ];
-  i686    = [ patterns.isi686 ];
-  x86_64  = [ patterns.isx86_64 ];
-  mips    = [ patterns.isMips ];
-  riscv   = [ patterns.isRiscV ];
-
-  cygwin  = [ patterns.isCygwin ];
-  darwin  = [ patterns.isDarwin ];
-  freebsd = [ patterns.isFreeBSD ];
-  # Should be better, but MinGW is unclear.
-  gnu     = [
-    { kernel = parse.kernels.linux; abi = abis.gnu; }
-    { kernel = parse.kernels.linux; abi = abis.gnueabi; }
-    { kernel = parse.kernels.linux; abi = abis.gnueabihf; }
-  ];
-  illumos = [ patterns.isSunOS ];
-  linux   = [ patterns.isLinux ];
-  netbsd  = [ patterns.isNetBSD ];
-  openbsd = [ patterns.isOpenBSD ];
-  unix    = patterns.isUnix; # Actually a list
-  windows = [ patterns.isWindows ];
-
-  inherit (lib.systems.doubles) mesaPlatforms;
-}

lib/systems/inspect.nix

@@ -3,57 +3,53 @@ with import ./parse.nix { inherit lib; };
 with lib.attrsets;
 with lib.lists;
 
-let abis_ = abis; in
-let abis = lib.mapAttrs (_: abi: builtins.removeAttrs abi [ "assertions" ]) abis_; in
-
 rec {
   patterns = rec {
-    isi686         = { cpu = cpuTypes.i686; };
-    isx86_64       = { cpu = cpuTypes.x86_64; };
-    isPowerPC      = { cpu = cpuTypes.powerpc; };
-    isPower = { cpu = { family = "power"; }; };
-    isx86          = { cpu = { family = "x86"; }; };
-    isAarch32      = { cpu = { family = "arm"; bits = 32; }; };
-    isAarch64      = { cpu = { family = "arm"; bits = 64; }; };
-    isMips         = { cpu = { family = "mips"; }; };
-    isRiscV        = { cpu = { family = "riscv"; }; };
-    isSparc        = { cpu = { family = "sparc"; }; };
-    isWasm         = { cpu = { family = "wasm"; }; };
+    i686         = { cpu = cpuTypes.i686; };
+    x86_64       = { cpu = cpuTypes.x86_64; };
+    PowerPC      = { cpu = cpuTypes.powerpc; };
+    x86          = { cpu = { family = "x86"; }; };
+    Arm          = { cpu = { family = "arm"; }; };
+    Aarch64      = { cpu = { family = "aarch64"; }; };
+    Mips         = { cpu = { family = "mips"; }; };
+    RiscV        = { cpu = { family = "riscv"; }; };
+    Wasm         = { cpu = { family = "wasm"; }; };
 
-    is32bit        = { cpu = { bits = 32; }; };
-    is64bit        = { cpu = { bits = 64; }; };
-    isBigEndian    = { cpu = { significantByte = significantBytes.bigEndian; }; };
-    isLittleEndian = { cpu = { significantByte = significantBytes.littleEndian; }; };
+    "32bit"      = { cpu = { bits = 32; }; };
+    "64bit"      = { cpu = { bits = 64; }; };
+    BigEndian    = { cpu = { significantByte = significantBytes.bigEndian; }; };
+    LittleEndian = { cpu = { significantByte = significantBytes.littleEndian; }; };
 
-    isBSD          = { kernel = { families = { inherit (kernelFamilies) bsd; }; }; };
-    isDarwin       = { kernel = { families = { inherit (kernelFamilies) darwin; }; }; };
-    isUnix         = [ isBSD isDarwin isLinux isSunOS isCygwin ];
+    BSD          = { kernel = { families = { inherit (kernelFamilies) bsd; }; }; };
+    Unix         = [ BSD Darwin Linux SunOS Hurd Cygwin ];
 
-    isMacOS        = { kernel = kernels.macos; };
-    isiOS          = { kernel = kernels.ios; };
-    isLinux        = { kernel = kernels.linux; };
-    isSunOS        = { kernel = kernels.solaris; };
-    isFreeBSD      = { kernel = kernels.freebsd; };
-    isNetBSD       = { kernel = kernels.netbsd; };
-    isOpenBSD      = { kernel = kernels.openbsd; };
-    isWindows      = { kernel = kernels.windows; };
-    isCygwin       = { kernel = kernels.windows; abi = abis.cygnus; };
-    isMinGW        = { kernel = kernels.windows; abi = abis.gnu; };
+    Darwin       = { kernel = kernels.darwin; };
+    Linux        = { kernel = kernels.linux; };
+    SunOS        = { kernel = kernels.solaris; };
+    FreeBSD      = { kernel = kernels.freebsd; };
+    Hurd         = { kernel = kernels.hurd; };
+    NetBSD       = { kernel = kernels.netbsd; };
+    OpenBSD      = { kernel = kernels.openbsd; };
+    Windows      = { kernel = kernels.windows; };
+    Cygwin       = { kernel = kernels.windows; abi = abis.cygnus; };
+    MinGW        = { kernel = kernels.windows; abi = abis.gnu; };
 
-    isAndroid      = [ { abi = abis.android; } { abi = abis.androideabi; } ];
-    isMusl         = with abis; map (a: { abi = a; }) [ musl musleabi musleabihf ];
-    isUClibc       = with abis; map (a: { abi = a; }) [ uclibc uclibceabi uclibceabihf ];
+    Android      = [ { abi = abis.android; } { abi = abis.androideabi; } ];
+    Musl         = with abis; map (a: { abi = a; }) [ musl musleabi musleabihf ];
 
-    isEfi          = map (family: { cpu.family = family; })
-                       [ "x86" "arm" "aarch64" ];
-
-    # Deprecated after 18.03
-    isArm = isAarch32;
+    Kexecable    = map (family: { kernel = kernels.linux; cpu.family = family; })
+                     [ "x86" "arm" "aarch64" "mips" ];
+    Efi          = map (family: { cpu.family = family; })
+                     [ "x86" "arm" "aarch64" ];
+    Seccomputable = map (family: { kernel = kernels.linux; cpu.family = family; })
+                      [ "x86" "arm" "aarch64" "mips" ];
   };
 
   matchAnyAttrs = patterns:
     if builtins.isList patterns then attrs: any (pattern: matchAttrs pattern attrs) patterns
     else matchAttrs patterns;
 
-  predicates = mapAttrs (_: matchAnyAttrs) patterns;
+  predicates = mapAttrs'
+    (name: value: nameValuePair ("is" + name) (matchAnyAttrs value))
+    patterns;
 }

lib/systems/parse.nix

@@ -18,7 +18,6 @@
 with lib.lists;
 with lib.types;
 with lib.attrsets;
-with lib.strings;
 with (import ./inspect.nix { inherit lib; }).predicates;
 
 let
@@ -35,7 +34,7 @@ rec {
 
   ################################################################################
 
-  types.openSignificantByte = mkOptionType {
+  types.openSignifiantByte = mkOptionType {
     name = "significant-byte";
     description = "Endianness";
     merge = mergeOneOption;
@@ -43,7 +42,7 @@ rec {
 
   types.significantByte = enum (attrValues significantBytes);
 
-  significantBytes = setTypes types.openSignificantByte {
+  significantBytes = setTypes types.openSignifiantByte {
     bigEndian = {};
     littleEndian = {};
   };
@@ -69,36 +68,20 @@ rec {
 
   cpuTypes = with significantBytes; setTypes types.openCpuType {
     arm      = { bits = 32; significantByte = littleEndian; family = "arm"; };
-    armv5tel = { bits = 32; significantByte = littleEndian; family = "arm"; version = "5"; };
-    armv6m   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "6"; };
-    armv6l   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "6"; };
-    armv7a   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "7"; };
-    armv7r   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "7"; };
-    armv7m   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "7"; };
-    armv7l   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "7"; };
-    armv8a   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "8"; };
-    armv8r   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "8"; };
-    armv8m   = { bits = 32; significantByte = littleEndian; family = "arm"; version = "8"; };
-    aarch64  = { bits = 64; significantByte = littleEndian; family = "arm"; version = "8"; };
-
+    armv5tel = { bits = 32; significantByte = littleEndian; family = "arm"; };
+    armv6l   = { bits = 32; significantByte = littleEndian; family = "arm"; };
+    armv7a   = { bits = 32; significantByte = littleEndian; family = "arm"; };
+    armv7l   = { bits = 32; significantByte = littleEndian; family = "arm"; };
+    aarch64  = { bits = 64; significantByte = littleEndian; family = "aarch64"; };
     i686     = { bits = 32; significantByte = littleEndian; family = "x86"; };
     x86_64   = { bits = 64; significantByte = littleEndian; family = "x86"; };
-
     mips     = { bits = 32; significantByte = bigEndian;    family = "mips"; };
     mipsel   = { bits = 32; significantByte = littleEndian; family = "mips"; };
     mips64   = { bits = 64; significantByte = bigEndian;    family = "mips"; };
     mips64el = { bits = 64; significantByte = littleEndian; family = "mips"; };
-
     powerpc  = { bits = 32; significantByte = bigEndian;    family = "power"; };
-    powerpc64 = { bits = 64; significantByte = bigEndian; family = "power"; };
-    powerpc64le = { bits = 64; significantByte = littleEndian; family = "power"; };
-
     riscv32  = { bits = 32; significantByte = littleEndian; family = "riscv"; };
     riscv64  = { bits = 64; significantByte = littleEndian; family = "riscv"; };
-
-    sparc    = { bits = 32; significantByte = bigEndian;    family = "sparc"; };
-    sparc64  = { bits = 64; significantByte = bigEndian;    family = "sparc"; };
-
     wasm32   = { bits = 32; significantByte = littleEndian; family = "wasm"; };
     wasm64   = { bits = 64; significantByte = littleEndian; family = "wasm"; };
   };
@@ -151,7 +134,6 @@ rec {
 
   kernelFamilies = setTypes types.openKernelFamily {
     bsd = {};
-    darwin = {};
   };
 
   ################################################################################
@@ -167,11 +149,9 @@ rec {
   types.kernel = enum (attrValues kernels);
 
   kernels = with execFormats; with kernelFamilies; setTypes types.openKernel {
-    # TODO(@Ericson2314): Don't want to mass-rebuild yet to keeping 'darwin' as
-    # the nnormalized name for macOS.
-    macos   = { execFormat = macho;   families = { inherit darwin; }; name = "darwin"; };
-    ios     = { execFormat = macho;   families = { inherit darwin; }; };
+    darwin  = { execFormat = macho;   families = { }; };
     freebsd = { execFormat = elf;     families = { inherit bsd; }; };
+    hurd    = { execFormat = elf;     families = { }; };
     linux   = { execFormat = elf;     families = { }; };
     netbsd  = { execFormat = elf;     families = { inherit bsd; }; };
     none    = { execFormat = unknown; families = { }; };
@@ -179,10 +159,9 @@ rec {
     solaris = { execFormat = elf;     families = { }; };
     windows = { execFormat = pe;      families = { }; };
   } // { # aliases
-    # 'darwin' is the kernel for all of them. We choose macOS by default.
-    darwin = kernels.macos;
-    watchos = kernels.ios;
-    tvos = kernels.ios;
+    # TODO(@Ericson2314): Handle these Darwin version suffixes more generally.
+    darwin10 = kernels.darwin;
+    darwin14 = kernels.darwin;
     win32 = kernels.windows;
   };
 
@@ -197,47 +176,24 @@ rec {
   types.abi = enum (attrValues abis);
 
   abis = setTypes types.openAbi {
-    cygnus       = {};
-    msvc         = {};
-    eabi         = {};
-
-    androideabi  = {};
-    android      = {
-      assertions = [
-        { assertion = platform: !platform.isAarch32;
-          message = ''
-            The "android" ABI is not for 32-bit ARM. Use "androideabi" instead.
-          '';
-        }
-      ];
-    };
-
-    gnueabi      = { float = "soft"; };
-    gnueabihf    = { float = "hard"; };
-    gnu          = {
-      assertions = [
-        { assertion = platform: !platform.isAarch32;
-          message = ''
-            The "gnu" ABI is ambiguous on 32-bit ARM. Use "gnueabi" or "gnueabihf" instead.
-          '';
-        }
-      ];
-    };
-
-    musleabi     = { float = "soft"; };
-    musleabihf   = { float = "hard"; };
-    musl         = {};
-
-    uclibceabihf = { float = "soft"; };
-    uclibceabi   = { float = "hard"; };
-    uclibc       = {};
+    android = {};
+    cygnus = {};
+    gnu = {};
+    msvc = {};
+    eabi = {};
+    androideabi = {};
+    gnueabi = {};
+    gnueabihf = {};
+    musleabi = {};
+    musleabihf = {};
+    musl = {};
 
     unknown = {};
   };
 
   ################################################################################
 
-  types.parsedPlatform = mkOptionType {
+  types.system = mkOptionType {
     name = "system";
     description = "fully parsed representation of llvm- or nix-style platform tuple";
     merge = mergeOneOption;
@@ -251,13 +207,15 @@ rec {
   isSystem = isType "system";
 
   mkSystem = components:
-    assert types.parsedPlatform.check components;
+    assert types.system.check components;
     setType "system" components;
 
   mkSkeletonFromList = l: {
     "2" = # We only do 2-part hacks for things Nix already supports
       if elemAt l 1 == "cygwin"
         then { cpu = elemAt l 0;                      kernel = "windows";  abi = "cygnus";   }
+      else if elemAt l 1 == "gnu"
+        then { cpu = elemAt l 0;                      kernel = "hurd";     abi = "gnu";      }
       else   { cpu = elemAt l 0;                      kernel = elemAt l 1;                   };
     "3" = # Awkwards hacks, beware!
       if elemAt l 1 == "apple"
@@ -266,8 +224,6 @@ rec {
         then { cpu = elemAt l 0;                      kernel = elemAt l 1; abi = elemAt l 2; }
       else if (elemAt l 2 == "mingw32") # autotools breaks on -gnu for window
         then { cpu = elemAt l 0; vendor = elemAt l 1; kernel = "windows";  abi = "gnu"; }
-      else if hasPrefix "netbsd" (elemAt l 2)
-        then { cpu = elemAt l 0; vendor = elemAt l 1;    kernel = elemAt l 2;                }
       else throw "Target specification with 3 components is ambiguous";
     "4" =    { cpu = elemAt l 0; vendor = elemAt l 1; kernel = elemAt l 2; abi = elemAt l 3; };
   }.${toString (length l)}
@@ -294,17 +250,10 @@ rec {
         else if isDarwin  parsed then vendors.apple
         else if isWindows parsed then vendors.pc
         else                     vendors.unknown;
-      kernel = if hasPrefix "darwin" args.kernel      then getKernel "darwin"
-               else if hasPrefix "netbsd" args.kernel then getKernel "netbsd"
-               else                                   getKernel args.kernel;
+      kernel = getKernel args.kernel;
       abi =
         /**/ if args ? abi       then getAbi args.abi
-        else if isLinux   parsed then
-          if isAarch32 parsed then
-            if lib.versionAtLeast (parsed.cpu.version or "0") "6"
-            then abis.gnueabihf
-            else abis.gnueabi
-          else abis.gnu
+        else if isLinux   parsed then abis.gnu
         else if isWindows parsed then abis.gnu
         else                     abis.unknown;
     };
@@ -314,8 +263,8 @@ rec {
   mkSystemFromString = s: mkSystemFromSkeleton (mkSkeletonFromList (lib.splitString "-" s));
 
   doubleFromSystem = { cpu, vendor, kernel, abi, ... }:
-    /**/ if abi == abis.cygnus       then "${cpu.name}-cygwin"
-    else if kernel.families ? darwin then "${cpu.name}-darwin"
+    if abi == abis.cygnus
+    then "${cpu.name}-cygwin"
     else "${cpu.name}-${kernel.name}";
 
   tripleFromSystem = { cpu, vendor, kernel, abi, ... } @ sys: assert isSystem sys; let

lib/systems/platforms.nix

@@ -20,31 +20,12 @@ rec {
     kernelAutoModules = false;
   };
 
-  powernv = {
-    name = "PowerNV";
-    kernelArch = "powerpc";
-    kernelBaseConfig = "powernv_defconfig";
-    kernelTarget = "zImage";
-    kernelInstallTarget = "install";
-    kernelFile = "vmlinux";
-    kernelAutoModules = true;
-    # avoid driver/FS trouble arising from unusual page size
-    kernelExtraConfig = ''
-      PPC_64K_PAGES n
-      PPC_4K_PAGES y
-      IPV6 y
-    '';
-  };
-
-  ##
-  ## ARM
-  ##
-
   pogoplug4 = {
     name = "pogoplug4";
 
     gcc = {
       arch = "armv5te";
+      float = "soft";
     };
 
     kernelMajor = "2.6";
@@ -177,36 +158,185 @@ rec {
     kernelDTB = true; # Beyond 3.10
     gcc = {
       arch = "armv5te";
+      float = "soft";
     };
   };
 
   raspberrypi = {
     name = "raspberrypi";
     kernelMajor = "2.6";
-    kernelBaseConfig = "bcm2835_defconfig";
+    kernelBaseConfig = "bcmrpi_defconfig";
     kernelDTB = true;
     kernelArch = "arm";
-    kernelAutoModules = true;
-    kernelPreferBuiltin = true;
+    kernelAutoModules = false;
     kernelExtraConfig = ''
+      BLK_DEV_RAM y
+      BLK_DEV_INITRD y
+      BLK_DEV_CRYPTOLOOP m
+      BLK_DEV_DM m
+      DM_CRYPT m
+      MD y
+      REISERFS_FS m
+      BTRFS_FS y
+      XFS_FS m
+      JFS_FS y
+      EXT4_FS y
+
+      IP_PNP y
+      IP_PNP_DHCP y
+      NFS_FS y
+      ROOT_NFS y
+      TUN m
+      NFS_V4 y
+      NFS_V4_1 y
+      NFS_FSCACHE y
+      NFSD m
+      NFSD_V2_ACL y
+      NFSD_V3 y
+      NFSD_V3_ACL y
+      NFSD_V4 y
+      NETFILTER y
+      IP_NF_IPTABLES y
+      IP_NF_FILTER y
+      IP_NF_MATCH_ADDRTYPE y
+      IP_NF_TARGET_LOG y
+      IP_NF_MANGLE y
+      IPV6 m
+      VLAN_8021Q m
+
+      CIFS y
+      CIFS_XATTR y
+      CIFS_POSIX y
+      CIFS_FSCACHE y
+      CIFS_ACL y
+
+      ZRAM m
+
       # Disable OABI to have seccomp_filter (required for systemd)
       # https://github.com/raspberrypi/firmware/issues/651
       OABI_COMPAT n
+
+      # Fail to build
+      DRM n
+      SCSI_ADVANSYS n
+      USB_ISP1362_HCD n
+      SND_SOC n
+      SND_ALI5451 n
+      FB_SAVAGE n
+      SCSI_NSP32 n
+      ATA_SFF n
+      SUNGEM n
+      IRDA n
+      ATM_HE n
+      SCSI_ACARD n
+      BLK_DEV_CMD640_ENHANCED n
+
+      FUSE_FS m
+
+      # nixos mounts some cgroup
+      CGROUPS y
+
+      # Latencytop
+      LATENCYTOP y
     '';
     kernelTarget = "zImage";
     gcc = {
       arch = "armv6";
       fpu = "vfp";
+      float = "hard";
+      # TODO(@Ericson2314) what is this and is it a good idea? It was
+      # used in some cross compilation examples but not others.
+      #
+      # abi = "aapcs-linux";
     };
   };
 
-  # Legacy attribute, for compatibility with existing configs only.
-  raspberrypi2 = armv7l-hf-multiplatform;
+  raspberrypi2 = armv7l-hf-multiplatform // {
+    name = "raspberrypi2";
+    kernelBaseConfig = "bcm2709_defconfig";
+    kernelDTB = true;
+    kernelAutoModules = false;
+    kernelExtraConfig = ''
+      BLK_DEV_RAM y
+      BLK_DEV_INITRD y
+      BLK_DEV_CRYPTOLOOP m
+      BLK_DEV_DM m
+      DM_CRYPT m
+      MD y
+      REISERFS_FS m
+      BTRFS_FS y
+      XFS_FS m
+      JFS_FS y
+      EXT4_FS y
+
+      IP_PNP y
+      IP_PNP_DHCP y
+      NFS_FS y
+      ROOT_NFS y
+      TUN m
+      NFS_V4 y
+      NFS_V4_1 y
+      NFS_FSCACHE y
+      NFSD m
+      NFSD_V2_ACL y
+      NFSD_V3 y
+      NFSD_V3_ACL y
+      NFSD_V4 y
+      NETFILTER y
+      IP_NF_IPTABLES y
+      IP_NF_FILTER y
+      IP_NF_MATCH_ADDRTYPE y
+      IP_NF_TARGET_LOG y
+      IP_NF_MANGLE y
+      IPV6 m
+      VLAN_8021Q m
+
+      CIFS y
+      CIFS_XATTR y
+      CIFS_POSIX y
+      CIFS_FSCACHE y
+      CIFS_ACL y
+
+      ZRAM m
+
+      # Disable OABI to have seccomp_filter (required for systemd)
+      # https://github.com/raspberrypi/firmware/issues/651
+      OABI_COMPAT n
+
+      # Fail to build
+      DRM n
+      SCSI_ADVANSYS n
+      USB_ISP1362_HCD n
+      SND_SOC n
+      SND_ALI5451 n
+      FB_SAVAGE n
+      SCSI_NSP32 n
+      ATA_SFF n
+      SUNGEM n
+      IRDA n
+      ATM_HE n
+      SCSI_ACARD n
+      BLK_DEV_CMD640_ENHANCED n
+
+      FUSE_FS m
+
+      # nixos mounts some cgroup
+      CGROUPS y
+
+      # Latencytop
+      LATENCYTOP y
+
+      # Disable the common config Xen, it doesn't build on ARM
+      XEN? n
+    '';
+    kernelTarget = "zImage";
+  };
 
   scaleway-c1 = armv7l-hf-multiplatform // {
     gcc = {
       cpu = "cortex-a9";
       fpu = "vfpv3";
+      float = "hard";
     };
   };
 
@@ -233,6 +363,7 @@ rec {
     gcc = {
       cpu = "cortex-a9";
       fpu = "neon";
+      float = "hard";
     };
   };
 
@@ -245,132 +376,6 @@ rec {
     kernelBaseConfig = "guruplug_defconfig";
   };
 
-  beaglebone = armv7l-hf-multiplatform // {
-    name = "beaglebone";
-    kernelBaseConfig = "bb.org_defconfig";
-    kernelAutoModules = false;
-    kernelExtraConfig = ""; # TBD kernel config
-    kernelTarget = "zImage";
-  };
-
-  # https://developer.android.com/ndk/guides/abis#armeabi
-  armv5te-android = {
-    name = "armeabi";
-    gcc = {
-      arch = "armv5te";
-      float = "soft";
-      float-abi = "soft";
-    };
-  };
-
-  # https://developer.android.com/ndk/guides/abis#v7a
-  armv7a-android =  {
-    name = "armeabi-v7a";
-    gcc = {
-      arch = "armv7-a";
-      float = "hard";
-      float-abi = "softfp";
-      fpu = "vfpv3-d16";
-    };
-  };
-
-  armv7l-hf-multiplatform = {
-    name = "armv7l-hf-multiplatform";
-    kernelMajor = "2.6"; # Using "2.6" enables 2.6 kernel syscalls in glibc.
-    kernelBaseConfig = "multi_v7_defconfig";
-    kernelArch = "arm";
-    kernelDTB = true;
-    kernelAutoModules = true;
-    kernelPreferBuiltin = true;
-    kernelTarget = "zImage";
-    kernelExtraConfig = ''
-      # Serial port for Raspberry Pi 3. Upstream forgot to add it to the ARMv7 defconfig.
-      SERIAL_8250_BCM2835AUX y
-      SERIAL_8250_EXTENDED y
-      SERIAL_8250_SHARE_IRQ y
-
-      # Fix broken sunxi-sid nvmem driver.
-      TI_CPTS y
-
-      # Hangs ODROID-XU4
-      ARM_BIG_LITTLE_CPUIDLE n
-
-      # Disable OABI to have seccomp_filter (required for systemd)
-      # https://github.com/raspberrypi/firmware/issues/651
-      OABI_COMPAT n
-    '';
-    gcc = {
-      # Some table about fpu flags:
-      # http://community.arm.com/servlet/JiveServlet/showImage/38-1981-3827/blogentry-103749-004812900+1365712953_thumb.png
-      # Cortex-A5: -mfpu=neon-fp16
-      # Cortex-A7 (rpi2): -mfpu=neon-vfpv4
-      # Cortex-A8 (beaglebone): -mfpu=neon
-      # Cortex-A9: -mfpu=neon-fp16
-      # Cortex-A15: -mfpu=neon-vfpv4
-
-      # More about FPU:
-      # https://wiki.debian.org/ArmHardFloatPort/VfpComparison
-
-      # vfpv3-d16 is what Debian uses and seems to be the best compromise: NEON is not supported in e.g. Scaleway or Tegra 2,
-      # and the above page suggests NEON is only an improvement with hand-written assembly.
-      arch = "armv7-a";
-      fpu = "vfpv3-d16";
-
-      # For Raspberry Pi the 2 the best would be:
-      #   cpu = "cortex-a7";
-      #   fpu = "neon-vfpv4";
-    };
-  };
-
-  aarch64-multiplatform = {
-    name = "aarch64-multiplatform";
-    kernelMajor = "2.6"; # Using "2.6" enables 2.6 kernel syscalls in glibc.
-    kernelBaseConfig = "defconfig";
-    kernelArch = "arm64";
-    kernelDTB = true;
-    kernelAutoModules = true;
-    kernelPreferBuiltin = true;
-    kernelExtraConfig = ''
-      # Raspberry Pi 3 stuff. Not needed for kernels >= 4.10.
-      ARCH_BCM2835 y
-      BCM2835_MBOX y
-      BCM2835_WDT y
-      RASPBERRYPI_FIRMWARE y
-      RASPBERRYPI_POWER y
-      SERIAL_8250_BCM2835AUX y
-      SERIAL_8250_EXTENDED y
-      SERIAL_8250_SHARE_IRQ y
-
-      # Cavium ThunderX stuff.
-      PCI_HOST_THUNDER_ECAM y
-
-      # Nvidia Tegra stuff.
-      PCI_TEGRA y
-
-      # The default (=y) forces us to have the XHCI firmware available in initrd,
-      # which our initrd builder can't currently do easily.
-      USB_XHCI_TEGRA m
-    '';
-    kernelTarget = "Image";
-    gcc = {
-      arch = "armv8-a";
-    };
-  };
-
-  ##
-  ## MIPS
-  ##
-
-  ben_nanonote = {
-    name = "ben_nanonote";
-    kernelMajor = "2.6";
-    kernelArch = "mips";
-    gcc = {
-      arch = "mips32";
-      float = "soft";
-    };
-  };
-
   fuloong2f_n32 = {
     name = "fuloong2f_n32";
     kernelMajor = "2.6";
@@ -444,14 +449,97 @@ rec {
     kernelTarget = "vmlinux";
     gcc = {
       arch = "loongson2f";
-      float = "hard";
       abi = "n32";
     };
   };
 
-  ##
-  ## Other
-  ##
+  beaglebone = armv7l-hf-multiplatform // {
+    name = "beaglebone";
+    kernelBaseConfig = "bb.org_defconfig";
+    kernelAutoModules = false;
+    kernelExtraConfig = ""; # TBD kernel config
+    kernelTarget = "zImage";
+  };
+
+  armv7l-hf-multiplatform = {
+    name = "armv7l-hf-multiplatform";
+    kernelMajor = "2.6"; # Using "2.6" enables 2.6 kernel syscalls in glibc.
+    kernelBaseConfig = "multi_v7_defconfig";
+    kernelArch = "arm";
+    kernelDTB = true;
+    kernelAutoModules = true;
+    kernelPreferBuiltin = true;
+    kernelTarget = "zImage";
+    kernelExtraConfig = ''
+      # Serial port for Raspberry Pi 3. Upstream forgot to add it to the ARMv7 defconfig.
+      SERIAL_8250_BCM2835AUX y
+      SERIAL_8250_EXTENDED y
+      SERIAL_8250_SHARE_IRQ y
+
+      # Fix broken sunxi-sid nvmem driver.
+      TI_CPTS y
+
+      # Hangs ODROID-XU4
+      ARM_BIG_LITTLE_CPUIDLE n
+    '';
+    gcc = {
+      # Some table about fpu flags:
+      # http://community.arm.com/servlet/JiveServlet/showImage/38-1981-3827/blogentry-103749-004812900+1365712953_thumb.png
+      # Cortex-A5: -mfpu=neon-fp16
+      # Cortex-A7 (rpi2): -mfpu=neon-vfpv4
+      # Cortex-A8 (beaglebone): -mfpu=neon
+      # Cortex-A9: -mfpu=neon-fp16
+      # Cortex-A15: -mfpu=neon-vfpv4
+
+      # More about FPU:
+      # https://wiki.debian.org/ArmHardFloatPort/VfpComparison
+
+      # vfpv3-d16 is what Debian uses and seems to be the best compromise: NEON is not supported in e.g. Scaleway or Tegra 2,
+      # and the above page suggests NEON is only an improvement with hand-written assembly.
+      arch = "armv7-a";
+      fpu = "vfpv3-d16";
+      float = "hard";
+
+      # For Raspberry Pi the 2 the best would be:
+      #   cpu = "cortex-a7";
+      #   fpu = "neon-vfpv4";
+    };
+  };
+
+  aarch64-multiplatform = {
+    name = "aarch64-multiplatform";
+    kernelMajor = "2.6"; # Using "2.6" enables 2.6 kernel syscalls in glibc.
+    kernelBaseConfig = "defconfig";
+    kernelArch = "arm64";
+    kernelDTB = true;
+    kernelAutoModules = true;
+    kernelPreferBuiltin = true;
+    kernelExtraConfig = ''
+      # Raspberry Pi 3 stuff. Not needed for kernels >= 4.10.
+      ARCH_BCM2835 y
+      BCM2835_MBOX y
+      BCM2835_WDT y
+      RASPBERRYPI_FIRMWARE y
+      RASPBERRYPI_POWER y
+      SERIAL_8250_BCM2835AUX y
+      SERIAL_8250_EXTENDED y
+      SERIAL_8250_SHARE_IRQ y
+
+      # Cavium ThunderX stuff.
+      PCI_HOST_THUNDER_ECAM y
+
+      # Nvidia Tegra stuff.
+      PCI_TEGRA y
+
+      # The default (=y) forces us to have the XHCI firmware available in initrd,
+      # which our initrd builder can't currently do easily.
+      USB_XHCI_TEGRA m
+    '';
+    kernelTarget = "Image";
+    gcc = {
+      arch = "armv8-a";
+    };
+  };
 
   riscv-multiplatform = bits: {
     name = "riscv-multiplatform";
@@ -474,6 +562,5 @@ rec {
       "armv7l-linux" = armv7l-hf-multiplatform;
       "aarch64-linux" = aarch64-multiplatform;
       "mipsel-linux" = fuloong2f_n32;
-      "powerpc64le-linux" = powernv;
     }.${system} or pcBase;
 }

lib/tests/misc.nix

@@ -45,21 +45,6 @@ runTests {
     expected = true;
   };
 
-  testBitAnd = {
-    expr = (bitAnd 3 10);
-    expected = 2;
-  };
-
-  testBitOr = {
-    expr = (bitOr 3 10);
-    expected = 11;
-  };
-
-  testBitXor = {
-    expr = (bitXor 3 10);
-    expected = 9;
-  };
-
 # STRINGS
 
   testConcatMapStrings = {
@@ -108,7 +93,6 @@ runTests {
             "${builtins.storeDir}/d945ibfx9x185xf04b890y4f9g3cbb63-python-2.7.11";
       in {
         storePath = isStorePath goodPath;
-        storePathDerivation = isStorePath (import ../.. {}).hello;
         storePathAppendix = isStorePath
           "${goodPath}/bin/python";
         nonAbsolute = isStorePath (concatStrings (tail (stringToCharacters goodPath)));
@@ -122,7 +106,6 @@ runTests {
       };
     expected = {
       storePath = true;
-      storePathDerivation = true;
       storePathAppendix = false;
       nonAbsolute = false;
       asPath = true;
@@ -213,30 +196,6 @@ runTests {
   };
 
 
-# ATTRSETS
-
-  # code from the example
-  testRecursiveUpdateUntil = {
-    expr = recursiveUpdateUntil (path: l: r: path == ["foo"]) {
-      # first attribute set
-      foo.bar = 1;
-      foo.baz = 2;
-      bar = 3;
-    } {
-      #second attribute set
-      foo.bar = 1;
-      foo.quz = 2;
-      baz = 4;
-    };
-    expected = {
-      foo.bar = 1; # 'foo.*' from the second set
-      foo.quz = 2; #
-      bar = 3;     # 'bar' from the first set
-      baz = 4;     # 'baz' from the second set
-    };
-  };
-
-
 # GENERATORS
 # these tests assume attributes are converted to lists
 # in alphabetical order
@@ -246,29 +205,6 @@ runTests {
     expected = ''f\:oo:bar'';
   };
 
-  testMkValueString = {
-    expr = let
-      vals = {
-        int = 42;
-        string = ''fo"o'';
-        bool = true;
-        bool2 = false;
-        null = null;
-        # float = 42.23; # floats are strange
-      };
-      in mapAttrs
-        (const (generators.mkValueStringDefault {}))
-        vals;
-    expected = {
-      int = "42";
-      string = ''fo"o'';
-      bool = "true";
-      bool2 = "false";
-      null = "null";
-      # float = "42.23" true false [ "bar" ] ]'';
-    };
-  };
-
   testToKeyValue = {
     expr = generators.toKeyValue {} {
       key = "value";
@@ -311,8 +247,6 @@ runTests {
       "section 1" = {
         attribute1 = 5;
         x = "Me-se JarJar Binx";
-        # booleans are converted verbatim by default
-        boolean = false;
       };
       "foo[]" = {
         "he\\h=he" = "this is okay";
@@ -324,7 +258,6 @@ runTests {
 
       [section 1]
       attribute1=5
-      boolean=false
       x=Me-se JarJar Binx
     '';
   };
@@ -356,8 +289,7 @@ runTests {
     expr = mapAttrs (const (generators.toPretty {})) rec {
       int = 42;
       bool = true;
-      string = ''fno"rd'';
-      path = /. + "/foo"; # toPath returns a string
+      string = "fnord";
       null_ = null;
       function = x: x;
       functionArgs = { arg ? 4, foo }: arg;
@@ -368,14 +300,13 @@ runTests {
     expected = rec {
       int = "42";
       bool = "true";
-      string = ''"fno\"rd"'';
-      path = "/foo";
+      string = "\"fnord\"";
       null_ = "null";
       function = "<λ>";
       functionArgs = "<λ:{(arg),foo}>";
       list = "[ 3 4 ${function} [ false ] ]";
       attrs = "{ \"foo\" = null; \"foo bar\" = \"baz\"; }";
-      drv = "<δ:test>";
+      drv = "<δ>";
     };
   };
 
@@ -404,6 +335,10 @@ runTests {
 
           resRem7 = res6.replace (a: removeAttrs a ["a"]);
 
+          resReplace6 = let x = defaultOverridableDelayableArgs id { a = 7; mergeAttrBy = { a = builtins.add; }; };
+                            x2 = x.merge { a = 20; }; # now we have 27
+                        in (x2.replace) { a = 10; }; # and override the value by 10
+
           # fixed tests (delayed args): (when using them add some comments, please)
           resFixed1 =
                 let x = defaultOverridableDelayableArgs id ( x: { a = 7; c = x.fixed.b; });

lib/tests/modules.sh

@@ -136,18 +136,7 @@ checkConfigOutput "true" "$@" ./define-module-check.nix
 # Check coerced value.
 checkConfigOutput "\"42\"" config.value ./declare-coerced-value.nix
 checkConfigOutput "\"24\"" config.value ./declare-coerced-value.nix ./define-value-string.nix
-checkConfigError 'The option value .* in .* is not.*string or signed integer convertible to it' config.value ./declare-coerced-value.nix ./define-value-list.nix
-
-# Check coerced value with unsound coercion
-checkConfigOutput "12" config.value ./declare-coerced-value-unsound.nix
-checkConfigError 'The option value .* in .* is not.*8 bit signed integer.* or string convertible to it' config.value ./declare-coerced-value-unsound.nix ./define-value-string-bigint.nix
-checkConfigError 'unrecognised JSON value' config.value ./declare-coerced-value-unsound.nix ./define-value-string-arbitrary.nix
-
-# Check loaOf with long list.
-checkConfigOutput "1 2 3 4 5 6 7 8 9 10" config.result ./loaOf-with-long-list.nix
-
-# Check loaOf with many merges of lists.
-checkConfigOutput "1 2 3 4 5 6 7 8 9 10" config.result ./loaOf-with-many-list-merges.nix
+checkConfigError 'The option value .* in .* is not.*string or signed integer.*' config.value ./declare-coerced-value.nix ./define-value-list.nix
 
 cat <<EOF
 ====== module tests ======

lib/tests/modules/declare-coerced-value-unsound.nix

@@ -1,10 +0,0 @@
-{ lib, ... }:
-
-{
-  options = {
-    value = lib.mkOption {
-      default = "12";
-      type = lib.types.coercedTo lib.types.str lib.toInt lib.types.ints.s8;
-    };
-  };
-}

lib/tests/modules/define-value-string-arbitrary.nix

@@ -1,3 +0,0 @@
-{
-  value = "foobar";
-}

lib/tests/modules/define-value-string-bigint.nix

@@ -1,3 +0,0 @@
-{
-  value = "1000";
-}

lib/tests/modules/loaOf-with-long-list.nix

@@ -1,19 +0,0 @@
-{ config, lib, ... }:
-
-{
-  options = {
-    loaOfInt = lib.mkOption {
-      type = lib.types.loaOf lib.types.int;
-    };
-
-    result = lib.mkOption {
-      type = lib.types.str;
-    };
-  };
-
-  config = {
-    loaOfInt = [ 1 2 3 4 5 6 7 8 9 10 ];
-
-    result = toString (lib.attrValues config.loaOfInt);
-  };
-}

lib/tests/modules/loaOf-with-many-list-merges.nix

@@ -1,19 +0,0 @@
-{ config, lib, ... }:
-
-{
-  options = {
-    loaOfInt = lib.mkOption {
-      type = lib.types.loaOf lib.types.int;
-    };
-
-    result = lib.mkOption {
-      type = lib.types.str;
-    };
-  };
-
-  config = {
-    loaOfInt = lib.mkMerge (map lib.singleton [ 1 2 3 4 5 6 7 8 9 10 ]);
-
-    result = toString (lib.attrValues config.loaOfInt);
-  };
-}

lib/tests/release.nix

@@ -13,6 +13,7 @@ pkgs.stdenv.mkDerivation {
     export NIX_DB_DIR=$TEST_ROOT/db
     export NIX_LOCALSTATE_DIR=$TEST_ROOT/var
     export NIX_LOG_DIR=$TEST_ROOT/var/log/nix
+    export NIX_MANIFESTS_DIR=$TEST_ROOT/var/nix/manifests
     export NIX_STATE_DIR=$TEST_ROOT/var/nix
     export NIX_STORE_DIR=$TEST_ROOT/store
     export PAGER=cat
@@ -20,7 +21,7 @@ pkgs.stdenv.mkDerivation {
     nix-store --init
 
     cd ${pkgs.path}/lib/tests
-    bash ./modules.sh
+    ./modules.sh
 
     [[ "$(nix-instantiate --eval --strict misc.nix)" == "[ ]" ]]
 

lib/tests/systems.nix

@@ -22,7 +22,7 @@ in with lib.systems.doubles; lib.runTests {
   cygwin = assertTrue (mseteq cygwin [ "i686-cygwin" "x86_64-cygwin" ]);
   darwin = assertTrue (mseteq darwin [ "x86_64-darwin" ]);
   freebsd = assertTrue (mseteq freebsd [ "i686-freebsd" "x86_64-freebsd" ]);
-  gnu = assertTrue (mseteq gnu (linux /* ++ kfreebsd ++ ... */));
+  gnu = assertTrue (mseteq gnu (linux /* ++ hurd ++ kfreebsd ++ ... */));
   illumos = assertTrue (mseteq illumos [ "x86_64-solaris" ]);
   linux = assertTrue (mseteq linux [ "i686-linux" "x86_64-linux" "armv5tel-linux" "armv6l-linux" "armv7l-linux" "aarch64-linux" "mipsel-linux" ]);
   netbsd = assertTrue (mseteq netbsd [ "i686-netbsd" "x86_64-netbsd" ]);

lib/trivial.nix

@@ -1,9 +1,6 @@
 { lib }:
-
 rec {
 
-  ## Simple (higher order) functions
-
   /* The identity function
      For when you need a function that does “nothing”.
 
@@ -25,7 +22,7 @@ rec {
 
   ## Named versions corresponding to some builtin operators.
 
-  /* Concatenate two lists */
+  /* Concat two strings */
   concat = x: y: x ++ y;
 
   /* boolean “or” */
@@ -34,24 +31,6 @@ rec {
   /* boolean “and” */
   and = x: y: x && y;
 
-  /* bitwise “and” */
-  bitAnd = builtins.bitAnd
-    or (import ./zip-int-bits.nix
-        (a: b: if a==1 && b==1 then 1 else 0));
-
-  /* bitwise “or” */
-  bitOr = builtins.bitOr
-    or (import ./zip-int-bits.nix
-        (a: b: if a==1 || b==1 then 1 else 0));
-
-  /* bitwise “xor” */
-  bitXor = builtins.bitXor
-    or (import ./zip-int-bits.nix
-        (a: b: if a!=b then 1 else 0));
-
-  /* bitwise “not” */
-  bitNot = builtins.sub (-1);
-
   /* Convert a boolean to a string.
      Note that toString on a bool returns "1" and "".
   */
@@ -65,64 +44,29 @@ rec {
   */
   mergeAttrs = x: y: x // y;
 
-  /* Flip the order of the arguments of a binary function.
-
-     Example:
-       flip concat [1] [2]
-       => [ 2 1 ]
-  */
+  # Flip the order of the arguments of a binary function.
   flip = f: a: b: f b a;
 
-  /* Apply function if argument is non-null.
-
-     Example:
-       mapNullable (x: x+1) null
-       => null
-       mapNullable (x: x+1) 22
-       => 23
-  */
+  # Apply function if argument is non-null
   mapNullable = f: a: if isNull a then a else f a;
 
   # Pull in some builtins not included elsewhere.
   inherit (builtins)
     pathExists readFile isBool
-    isInt isFloat add sub lessThan
+    isInt add sub lessThan
     seq deepSeq genericClosure;
 
+  inherit (lib.strings) fileContents;
 
-  ## nixpks version strings
-
-  # The current full nixpkgs version number.
-  version = release + versionSuffix;
-
-  # The current nixpkgs version number as string.
-  release = lib.strings.fileContents ../.version;
-
-  # The current nixpkgs version suffix as string.
-  versionSuffix =
-    let suffixFile = ../.version-suffix;
-    in if pathExists suffixFile
-    then lib.strings.fileContents suffixFile
-    else "pre-git";
-
-  # Attempt to get the revision nixpkgs is from
-  revisionWithDefault = default:
-    let
-      revisionFile = "${toString ./..}/.git-revision";
-      gitRepo      = "${toString ./..}/.git";
-    in if lib.pathIsDirectory gitRepo
-       then lib.commitIdFromGitRepo gitRepo
-       else if lib.pathExists revisionFile then lib.fileContents revisionFile
-       else default;
-
-  nixpkgsVersion = builtins.trace "`lib.nixpkgsVersion` is deprecated, use `lib.version` instead!" version;
+  # Return the Nixpkgs version number.
+  nixpkgsVersion =
+    let suffixFile = ../.version-suffix; in
+    fileContents ../.version
+    + (if pathExists suffixFile then fileContents suffixFile else "pre-git");
 
   # Whether we're being called by nix-shell.
   inNixShell = builtins.getEnv "IN_NIX_SHELL" != "";
 
-
-  ## Integer operations
-
   # Return minimum/maximum of two numbers.
   min = x: y: if x < y then x else y;
   max = x: y: if x > y then x else y;
@@ -137,9 +81,6 @@ rec {
   */
   mod = base: int: base - (int * (builtins.div base int));
 
-
-  ## Comparisons
-
   /* C-style comparisons
 
      a < b,  compare a b => -1
@@ -169,20 +110,17 @@ rec {
        cmp "fooa" "a" => -1
        # while
        compare "fooa" "a" => 1
+
   */
   splitByAndCompare = p: yes: no: a: b:
     if p a
     then if p b then yes a b else -1
     else if p b then 1 else no a b;
 
-
   /* Reads a JSON file. */
   importJSON = path:
     builtins.fromJSON (builtins.readFile path);
 
-
-  ## Warnings and asserts
-
   /* See https://github.com/NixOS/nix/issues/749. Eventually we'd like these
      to expand to Nix builtins that carry metadata so that Nix can filter out
      the INFO messages without parsing the message string.
@@ -198,36 +136,28 @@ rec {
   warn = msg: builtins.trace "WARNING: ${msg}";
   info = msg: builtins.trace "INFO: ${msg}";
 
-
-  ## Function annotations
-
-  /* Add metadata about expected function arguments to a function.
-     The metadata should match the format given by
-     builtins.functionArgs, i.e. a set from expected argument to a bool
-     representing whether that argument has a default or not.
-     setFunctionArgs : (a → b) → Map String Bool → (a → b)
-
-     This function is necessary because you can't dynamically create a
-     function of the { a, b ? foo, ... }: format, but some facilities
-     like callPackage expect to be able to query expected arguments.
-  */
+  # | Add metadata about expected function arguments to a function.
+  # The metadata should match the format given by
+  # builtins.functionArgs, i.e. a set from expected argument to a bool
+  # representing whether that argument has a default or not.
+  # setFunctionArgs : (a → b) → Map String Bool → (a → b)
+  #
+  # This function is necessary because you can't dynamically create a
+  # function of the { a, b ? foo, ... }: format, but some facilities
+  # like callPackage expect to be able to query expected arguments.
   setFunctionArgs = f: args:
     { # TODO: Should we add call-time "type" checking like built in?
       __functor = self: f;
       __functionArgs = args;
     };
 
-  /* Extract the expected function arguments from a function.
-     This works both with nix-native { a, b ? foo, ... }: style
-     functions and functions with args set with 'setFunctionArgs'. It
-     has the same return type and semantics as builtins.functionArgs.
-     setFunctionArgs : (a → b) → Map String Bool.
-  */
+  # | Extract the expected function arguments from a function.
+  # This works both with nix-native { a, b ? foo, ... }: style
+  # functions and functions with args set with 'setFunctionArgs'. It
+  # has the same return type and semantics as builtins.functionArgs.
+  # setFunctionArgs : (a → b) → Map String Bool.
   functionArgs = f: f.__functionArgs or (builtins.functionArgs f);
 
-  /* Check whether something is a function or something
-     annotated with function args.
-  */
   isFunction = f: builtins.isFunction f ||
     (f ? __functor && isFunction (f.__functor f));
 }

lib/types.nix

@@ -8,7 +8,7 @@ with lib.trivial;
 with lib.strings;
 let
 
-  inherit (lib.modules) mergeDefinitions;
+  inherit (lib.modules) mergeDefinitions filterOverrides;
   outer_types =
 rec {
   isType = type: x: (x._type or "") == type;
@@ -167,13 +167,6 @@ rec {
         # s32 = sign 32 4294967296;
       };
 
-    float = mkOptionType rec {
-        name = "float";
-        description = "floating point number";
-        check = isFloat;
-        merge = mergeOneOption;
-    };
-
     str = mkOptionType {
       name = "str";
       description = "string";
@@ -263,7 +256,7 @@ rec {
       functor = (defaultFunctor name) // { wrapped = elemType; };
     };
 
-    nonEmptyListOf = elemType:
+    nonEmptyListOf = elemType: 
       let list = addCheck (types.listOf elemType) (l: l != []);
       in list // { description = "non-empty " + list.description; };
 
@@ -287,34 +280,24 @@ rec {
     # List or attribute set of ...
     loaOf = elemType:
       let
-        convertAllLists = defs:
-          let
-            padWidth = stringLength (toString (length defs));
-            unnamedPrefix = i: "unnamed-" + fixedWidthNumber padWidth i + ".";
-          in
-            imap1 (i: convertIfList (unnamedPrefix i)) defs;
-
-        convertIfList = unnamedPrefix: def:
+        convertIfList = defIdx: def:
           if isList def.value then
-            let
-              padWidth = stringLength (toString (length def.value));
-              unnamed = i: unnamedPrefix + fixedWidthNumber padWidth i;
-            in
-              { inherit (def) file;
-                value = listToAttrs (
-                  imap1 (elemIdx: elem:
-                    { name = elem.name or (unnamed elemIdx);
-                      value = elem;
-                    }) def.value);
-              }
+            { inherit (def) file;
+              value = listToAttrs (
+                imap1 (elemIdx: elem:
+                  { name = elem.name or "unnamed-${toString defIdx}.${toString elemIdx}";
+                    value = elem;
+                  }) def.value);
+            }
           else
             def;
+        listOnly = listOf elemType;
         attrOnly = attrsOf elemType;
       in mkOptionType rec {
         name = "loaOf";
         description = "list or attribute set of ${elemType.description}s";
         check = x: isList x || isAttrs x;
-        merge = loc: defs: attrOnly.merge loc (convertAllLists defs);
+        merge = loc: defs: attrOnly.merge loc (imap1 convertIfList defs);
         getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["<name?>"]);
         getSubModules = elemType.getSubModules;
         substSubModules = m: loaOf (elemType.substSubModules m);
@@ -378,13 +361,7 @@ rec {
             # This is mandatory as some option declaration might use the
             # "name" attribute given as argument of the submodule and use it
             # as the default of option declarations.
-            #
-            # Using lookalike unicode single angle quotation marks because
-            # of the docbook transformation the options receive. In all uses
-            # &gt; and &lt; wouldn't be encoded correctly so the encoded values
-            # would be used, and use of `<` and `>` would break the XML document.
-            # It shouldn't cause an issue since this is cosmetic for the manual.
-            args.name = "‹name›";
+            args.name = "&lt;name&gt;";
           }).options;
         getSubModules = opts';
         substSubModules = m: submodule m;
@@ -442,13 +419,16 @@ rec {
       assert coercedType.getSubModules == null;
       mkOptionType rec {
         name = "coercedTo";
-        description = "${finalType.description} or ${coercedType.description} convertible to it";
-        check = x: finalType.check x || (coercedType.check x && finalType.check (coerceFunc x));
+        description = "${finalType.description} or ${coercedType.description}";
+        check = x: finalType.check x || coercedType.check x;
         merge = loc: defs:
           let
             coerceVal = val:
               if finalType.check val then val
-              else coerceFunc val;
+              else let
+                coerced = coerceFunc val;
+              in assert finalType.check coerced; coerced;
+
           in finalType.merge loc (map (def: def // { value = coerceVal def.value; }) defs);
         getSubOptions = finalType.getSubOptions;
         getSubModules = finalType.getSubModules;

lib/zip-int-bits.nix

@@ -1,39 +0,0 @@
-/* Helper function to implement a fallback for the bit operators
-   `bitAnd`, `bitOr` and `bitXOr` on older nix version.
-   See ./trivial.nix
-*/
-f: x: y:
-  let
-    # (intToBits 6) -> [ 0 1 1 ]
-    intToBits = x:
-      if x == 0 || x == -1 then
-        []
-      else
-        let
-          headbit  = if (x / 2) * 2 != x then 1 else 0;          # x & 1
-          tailbits = if x < 0 then ((x + 1) / 2) - 1 else x / 2; # x >> 1
-        in
-          [headbit] ++ (intToBits tailbits);
-
-    # (bitsToInt [ 0 1 1 ] 0) -> 6
-    # (bitsToInt [ 0 1 0 ] 1) -> -6
-    bitsToInt = l: signum:
-      if l == [] then
-        (if signum == 0 then 0 else -1)
-      else
-        (builtins.head l) + (2 * (bitsToInt (builtins.tail l) signum));
-
-    xsignum = if x < 0 then 1 else 0;
-    ysignum = if y < 0 then 1 else 0;
-    zipListsWith' = fst: snd:
-      if fst==[] && snd==[] then
-        []
-      else if fst==[] then
-        [(f xsignum             (builtins.head snd))] ++ (zipListsWith' []                  (builtins.tail snd))
-      else if snd==[] then
-        [(f (builtins.head fst) ysignum            )] ++ (zipListsWith' (builtins.tail fst) []                 )
-      else
-        [(f (builtins.head fst) (builtins.head snd))] ++ (zipListsWith' (builtins.tail fst) (builtins.tail snd));
-  in
-    assert (builtins.isInt x) && (builtins.isInt y);
-    bitsToInt (zipListsWith' (intToBits x) (intToBits y)) (f xsignum ysignum)

maintainers/scripts/all-tarballs.nix

@@ -6,11 +6,13 @@
    $ copy-tarballs.pl --expr 'import <nixpkgs/maintainers/scripts/all-tarballs.nix>'
 */
 
-import ../../pkgs/top-level/release.nix
+removeAttrs (import ../../pkgs/top-level/release.nix
   { # Don't apply ‘hydraJob’ to jobs, because then we can't get to the
     # dependency graph.
     scrubJobs = false;
     # No need to evaluate on i686.
     supportedSystems = [ "x86_64-linux" ];
-    limitedSupportedSystems = [];
-  }
+  })
+  [ # Remove jobs whose evaluation depends on a writable Nix store.
+    "tarball" "unstable" "darwin-tested"
+  ]

maintainers/scripts/copy-tarballs.pl

@@ -100,10 +100,7 @@ sub uploadFile {
     sub redirect {
         my ($name, $dest) = @_;
         #print STDERR "linking $name to $dest...\n";
-        $bucket->add_key($name, "", {
-	    'x-amz-website-redirect-location' => "/" . $dest,
-	    'x-amz-acl' => "public-read"
-        })
+        $bucket->add_key($name, "", { 'x-amz-website-redirect-location' => "/" . $dest })
             or die "failed to create redirect from $name to $dest\n";
         $cache{$name} = 1;
     }
@@ -115,10 +112,7 @@ sub uploadFile {
 
     # Upload the file as sha512/<hash-in-base-16>.
     print STDERR "uploading $fn to $mainKey...\n";
-    $bucket->add_key_filename($mainKey, $fn, {
-	'x-amz-meta-original-name' => $name,
-	'x-amz-acl' => "public-read"
-    })
+    $bucket->add_key_filename($mainKey, $fn, { 'x-amz-meta-original-name' => $name })
         or die "failed to upload $fn to $mainKey\n";
     $cache{$mainKey} = 1;
 }

maintainers/scripts/hydra-eval-failures.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env nix-shell
-#!nix-shell -i python3 -p 'python3.withPackages(ps: with ps; [ requests pyquery click ])'
+#!nix-shell -i python -p pythonFull pythonPackages.requests pythonPackages.pyquery pythonPackages.click
 
 # To use, just execute this script with --help to display help.
 
@@ -13,10 +13,10 @@ from pyquery import PyQuery as pq
 
 
 maintainers_json = subprocess.check_output([
-    'nix-instantiate', '-E', 'import ./maintainers/maintainer-list.nix {}', '--eval', '--json'
+    'nix-instantiate', '-E', 'import ./lib/maintainers.nix {}', '--eval', '--json'
 ])
 maintainers = json.loads(maintainers_json)
-MAINTAINERS = {v: k for k, v in maintainers.items()}
+MAINTAINERS = {v: k for k, v in maintainers.iteritems()}
 
 
 def get_response_text(url):
@@ -45,17 +45,6 @@ def get_maintainers(attr_name):
     except:
        return []
 
-def print_build(table_row):
-    a = pq(table_row)('a')[1]
-    print("- [ ] [{}]({})".format(a.text, a.get('href')), flush=True)
-    
-    maintainers = get_maintainers(a.text)
-    if maintainers:
-        print("  - maintainers: {}".format(", ".join(map(lambda u: '@' + u, maintainers))))
-    # TODO: print last three persons that touched this file
-    # TODO: pinpoint the diff that broke this build, or maybe it's transient or maybe it never worked?
-    
-    sys.stdout.flush()
 
 @click.command()
 @click.option(
@@ -84,17 +73,23 @@ def cli(jobset):
 
     # TODO: aborted evaluations
     # TODO: dependency failed without propagated builds
-    print('\nFailures:')
     for tr in d('img[alt="Failed"]').parents('tr'):
-        print_build(tr)
+        a = pq(tr)('a')[1]
+        print("- [ ] [{}]({})".format(a.text, a.get('href')))
 
-    print('\nDependency failures:')
-    for tr in d('img[alt="Dependency failed"]').parents('tr'):
-        print_build(tr)
+        sys.stdout.flush()
+
+        maintainers = get_maintainers(a.text)
+        if maintainers:
+            print("  - maintainers: {}".format(", ".join(map(lambda u: '@' + u, maintainers))))
+        # TODO: print last three persons that touched this file
+        # TODO: pinpoint the diff that broke this build, or maybe it's transient or maybe it never worked?
+
+        sys.stdout.flush()
 
 
 if __name__ == "__main__":
     try:
         cli()
-    except Exception as e:
+    except:
         import pdb;pdb.post_mortem()

maintainers/scripts/nix-generate-from-cpan.nix

@@ -4,7 +4,7 @@ stdenv.mkDerivation {
   name = "nix-generate-from-cpan-3";
 
   buildInputs = with perlPackages; [
-    makeWrapper perl CPANMeta GetoptLongDescriptive CPANPLUS Readonly LogLog4perl
+    makeWrapper perl CPANMeta GetoptLongDescriptive CPANPLUS Readonly Log4Perl
   ];
 
   phases = [ "installPhase" ];

maintainers/scripts/nixpkgs-lint.pl

@@ -1,5 +1,4 @@
-#! /usr/bin/env nix-shell
-#! nix-shell -i perl -p perl perlPackages.XMLSimple
+#! /run/current-system/sw/bin/perl -w
 
 use strict;
 use List::Util qw(min);

maintainers/scripts/update-python-libraries

@@ -262,7 +262,7 @@ def _update_package(path, target):
     if new_version == version:
         logging.info("Path {}: no update available for {}.".format(path, pname))
         return False
-    elif Version(new_version) <= Version(version):
+    elif new_version <= version:
         raise ValueError("downgrade for {}.".format(pname))
     if not new_sha256:
         raise ValueError("no file available for {}.".format(pname))

maintainers/scripts/update.nix

@@ -6,22 +6,11 @@
 # TODO: add assert statements
 
 let
-  /* Remove duplicate elements from the list based on some extracted value. O(n^2) complexity.
-   */
-  nubOn = f: list:
-    if list == [] then
-      []
-    else
-      let
-        x = pkgs.lib.head list;
-        xs = pkgs.lib.filter (p: f x != f p) (pkgs.lib.drop 1 list);
-      in
-        [x] ++ nubOn f xs;
 
   pkgs = import ./../../default.nix { };
 
   packagesWith = cond: return: set:
-    nubOn (pkg: pkg.updateScript)
+    pkgs.lib.unique
       (pkgs.lib.flatten
         (pkgs.lib.mapAttrsToList
           (name: pkg:
@@ -45,7 +34,7 @@ let
     let
       maintainer =
         if ! builtins.hasAttr maintainer' pkgs.lib.maintainers then
-          builtins.throw "Maintainer with name `${maintainer'} does not exist in `maintainers/maintainer-list.nix`."
+          builtins.throw "Maintainer with name `${maintainer'} does not exist in `lib/maintainers.nix`."
         else
           builtins.getAttr maintainer' pkgs.lib.maintainers;
     in
@@ -76,7 +65,7 @@ let
       if package == null then
         builtins.throw "Package with an attribute name `${name}` does not exists."
       else if ! builtins.hasAttr "updateScript" package then
-        builtins.throw "Package with an attribute name `${name}` does not have a `passthru.updateScript` attribute defined."
+        builtins.throw "Package with an attribute name `${name}` does have an `passthru.updateScript` defined."
       else
         package;