rtl8723bs: version bump

.editorconfig

@@ -1,28 +0,0 @@
-# EditorConfig configuration for nixpkgs
-# http://EditorConfig.org
-
-# Top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file, utf-8 charset
-[*]
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-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}]
-indent_style = space
-indent_size = 2
-
-# Match shell/python/perl scripts, set indent to spaces with width of four
-[*.{sh,py,pl}]
-indent_style = space
-indent_size = 4
-
-# Match diffs, avoid to trim trailing whitespace
-[*.{diff,patch}]
-trim_trailing_whitespace = false

.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

@@ -1,152 +0,0 @@
-# CODEOWNERS file
-#
-# This file is used to describe who owns what in this repository. This file does not
-# replace `meta.maintainers` but is instead used for other things than derivations
-# and modules, like documentation, package sets, and other assets.
-#
-# For documentation on this file, see https://help.github.com/articles/about-codeowners/
-# Mentioned users will get code review requests.
-
-# This file
-/.github/CODEOWNERS @edolstra
-
-# Libraries
-/lib                        @edolstra @nbp
-/lib/systems                @nbp @ericson2314 @matthewbauer
-/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 @matthewbauer
-/pkgs/top-level/splice.nix            @Ericson2314 @matthewbauer
-/pkgs/top-level/release-cross.nix     @Ericson2314 @matthewbauer
-/pkgs/stdenv/generic                  @Ericson2314 @matthewbauer
-/pkgs/stdenv/cross                    @Ericson2314 @matthewbauer
-/pkgs/build-support/cc-wrapper        @Ericson2314 @orivej
-/pkgs/build-support/bintools-wrapper  @Ericson2314 @orivej
-/pkgs/build-support/setup-hooks       @Ericson2314
-
-# NixOS Internals
-/nixos/default.nix          @nbp
-/nixos/lib/from-env.nix     @nbp
-/nixos/lib/eval-config.nix  @nbp
-/nixos/doc/manual/configuration/abstractions.xml      @nbp
-/nixos/doc/manual/configuration/config-file.xml       @nbp
-/nixos/doc/manual/configuration/config-syntax.xml     @nbp
-/nixos/doc/manual/configuration/modularity.xml        @nbp
-/nixos/doc/manual/development/assertions.xml          @nbp
-/nixos/doc/manual/development/meta-attributes.xml     @nbp
-/nixos/doc/manual/development/option-declarations.xml @nbp
-/nixos/doc/manual/development/option-def.xml          @nbp
-/nixos/doc/manual/development/option-types.xml        @nbp
-/nixos/doc/manual/development/replace-modules.xml     @nbp
-/nixos/doc/manual/development/writing-modules.xml     @nbp
-/nixos/doc/manual/man-nixos-option.xml                @nbp
-/nixos/modules/installer/tools/nixos-option.sh        @nbp
-
-# New NixOS modules
-/nixos/modules/module-list.nix @Infinisil
-
-# 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.section.md     @FRidh
-
-# Haskell
-/pkgs/development/compilers/ghc                       @basvandijk
-/pkgs/development/haskell-modules                     @basvandijk
-/pkgs/development/haskell-modules/default.nix         @basvandijk
-/pkgs/development/haskell-modules/generic-builder.nix @basvandijk
-/pkgs/development/haskell-modules/hoogle.nix          @basvandijk
-
-# Perl
-/pkgs/development/interpreters/perl @volth
-/pkgs/top-level/perl-packages.nix   @volth
-/pkgs/development/perl-modules      @volth
-
-# R
-/pkgs/applications/science/math/R   @peti
-/pkgs/development/r-modules         @peti
-
-# Ruby
-/pkgs/development/interpreters/ruby @alyssais @zimbatm
-/pkgs/development/ruby-modules      @alyssais @zimbatm
-
-# Rust
-/pkgs/development/compilers/rust @Mic92 @LnL7
-
-# Darwin-related
-/pkgs/stdenv/darwin         @NixOS/darwin-maintainers
-/pkgs/os-specific/darwin    @NixOS/darwin-maintainers
-
-# C compilers
-/pkgs/development/compilers/gcc @matthewbauer
-/pkgs/development/compilers/llvm @matthewbauer
-
-# Compatibility stuff
-/pkgs/top-level/unix-tools.nix @matthewbauer
-/pkgs/development/tools/xcbuild @matthewbauer
-
-# Beam-related (Erlang, Elixir, LFE, etc)
-/pkgs/development/beam-modules                  @gleber
-/pkgs/development/interpreters/erlang           @gleber
-/pkgs/development/interpreters/lfe              @gleber
-/pkgs/development/interpreters/elixir           @gleber
-/pkgs/development/tools/build-managers/rebar    @gleber
-/pkgs/development/tools/build-managers/rebar3   @gleber
-/pkgs/development/tools/erlang                  @gleber
-
-# Jetbrains
-/pkgs/applications/editors/jetbrains @edwtjo
-
-# Eclipse
-/pkgs/applications/editors/eclipse @rycee
-
-# Licenses
-/lib/licenses.nix @alyssais
-
-# Qt / KDE
-/pkgs/applications/kde @ttuegel
-/pkgs/desktops/plasma-5 @ttuegel
-/pkgs/development/libraries/kde-frameworks @ttuegel
-/pkgs/development/libraries/qt-5 @ttuegel
-
-# PostgreSQL and related stuff
-/pkgs/servers/sql/postgresql @thoughtpolice
-/nixos/modules/services/databases/postgresql.xml @thoughtpolice
-/nixos/modules/services/databases/postgresql.nix @thoughtpolice
-/nixos/tests/postgresql.nix @thoughtpolice
-
-# Hardened profile & related modules
-/nixos/modules/profiles/hardened.nix @joachifm
-/nixos/modules/security/hidepid.nix @joachifm
-/nixos/modules/security/lock-kernel-modules.nix @joachifm
-/nixos/modules/security/misc.nix @joachifm
-/nixos/tests/hardened.nix @joachifm
-/pkgs/os-specific/linux/kernel/hardened-config.nix @joachifm
-
-# Dhall
-/pkgs/development/dhall-modules      @Gabriel439 @Profpatsch
-/pkgs/development/interpreters/dhall @Gabriel439 @Profpatsch
-
-# Idris
-/pkgs/development/idris-modules @Infinisil
-
-# Bazel
-/pkgs/development/tools/build-managers/bazel @mboes @Profpatsch
-
-# NixOS modules for e-mail and dns services
-/nixos/modules/services/mail/mailman.nix    @peti
-/nixos/modules/services/mail/postfix.nix    @peti
-/nixos/modules/services/networking/bind.nix @peti
-/nixos/modules/services/mail/rspamd.nix     @peti
-
-# Emacs
-/pkgs/applications/editors/emacs-modes @adisbladis
-/pkgs/applications/editors/emacs       @adisbladis
-/pkgs/top-level/emacs-packages.nix     @adisbladis

.github/CONTRIBUTING.md

@@ -12,43 +12,21 @@ under the terms of [COPYING](../COPYING), which is an MIT-like license.
 
 ## Submitting changes
 
-* Format the commit messages in the following way:
+* Format the commits in the following way:
 
-  ```
-  (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
-
-  (Motivation for change. Additional information.)
-  ```
-
-  For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message).
+  `(pkg-name | service-name): (from -> to | init at version | refactor | etc)`
 
   Examples:
 
   * nginx: init at 2.0.1
-  * firefox: 54.0.1 -> 55.0
-  * nixos/hydra: add bazBaz option
-
-    Dual baz behavior is needed to do foo.
-  * nixos/nginx: refactor config generation
-
-    The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
+  * firefox: 3.0 -> 3.1.1
+  * hydra service: add bazBaz option
+  * nginx service: refactor config generation
 
 * `meta.description` should:
-  * Be capitalized.
-  * Not start with the package name.
-  * Not have a period at the end.
-* `meta.license` must be set and fit the upstream license.
-  * If there is no upstream license, `meta.license` should default to `stdenv.lib.licenses.unfree`.
-* `meta.maintainers` must be set.
+  * Be capitalized
+  * Not start with the package name
+  * Not have a dot at the end
 
-See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes) and on how to [submit changes to nixpkgs](https://nixos.org/nixpkgs/manual/#chap-submitting-changes).
+See the nixpkgs manual for more details on how to [Submit changes to nixpkgs](http://hydra.nixos.org/job/nixpkgs/trunk/manual/latest/download-by-type/doc/manual#chap-submitting-changes).
 
-## 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.
-
-For package version upgrades and such a one-line commit message is usually sufficient.
-
-## Reviewing contributions
-
-See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#sec-reviewing-contributions).

.github/ISSUE_TEMPLATE.md

@@ -8,4 +8,6 @@
 
 ## Technical details
 
-Please run `nix run nixpkgs.nix-info -c nix-info -m` and paste the result.
+* System: (NixOS: `nixos-version`, Ubuntu/Fedora: `lsb_release -a`, ...)
+* Nix version: (run `nix-env --version`)
+* Nixpkgs version: (run `nix-instantiate --eval '<nixpkgs>' -A lib.nixpkgsVersion`)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,37 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: '0.kind: bug'
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. ...
-2. ...
-3. ...
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here.
-
-**Metadata**
-Please run `nix run nixpkgs.nix-info -c nix-info -m` and paste the result.
-
-Maintainer information:
-```yaml
-# a list of nixpkgs attributes affected by the problem
-attribute:
-# a list of nixos modules affected by the problem
-module:
-```

.github/ISSUE_TEMPLATE/packaging_request.md

@@ -1,18 +0,0 @@
----
-name: Packaging requests
-about: For packages that are missing
-title: ''
-labels: '0.kind: packaging request'
-assignees: ''
-
----
-
-**Project description**
-_describe the project a little_
-
-**Metadata**
-
-* homepage URL:
-* source URL:
-* license: mit, bsd, gpl2+ , ...
-* platforms: unix, linux, darwin, ...

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,23 +1,19 @@
-<!-- Nixpkgs has a lot of new incoming Pull Requests, but not enough people to review this constant stream. Even if you aren't a committer, we would appreciate reviews of other PRs, especially simple ones like package updates. Just testing the relevant package/service and leaving a comment saying what you tested, how you tested it and whether it worked would be great. List of open PRs: <https://github.com/NixOS/nixpkgs/pulls>, for more about reviewing contributions: <https://hydra.nixos.org/job/nixpkgs/trunk/manual/latest/download/1/nixpkgs/manual.html#sec-reviewing-contributions>. Reviewing isn't mandatory, but it would help out a lot and reduce the average time-to-merge for all of us. Thanks a lot if you do! -->
 ###### Motivation for this change
 
 
 ###### Things done
 
-<!-- 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
-   - [ ] other Linux distributions
-- [ ] 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 nix-review --run "nix-review wip"`
+   - [ ] OS X
+   - [ ] Linux
+- [ ] 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)
-- [ ] Ensured that relevant documentation is up to date
 - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
 
-###### Notify maintainers
+---
 
-cc @

.gitignore

@@ -13,5 +13,4 @@ result-*
 .DS_Store
 
 /pkgs/development/libraries/qt-5/*/tmp/
-/pkgs/desktops/kde-5/*/tmp/
-/pkgs/development/mobile/androidenv/xml/*
+/pkgs/desktops/kde-5/*/tmp/

.mention-bot

@@ -0,0 +1,6 @@
+{
+  "userBlacklist": [
+    "civodul",
+    "jhasse"
+  ]
+}

.travis.yml

@@ -0,0 +1,12 @@
+matrix:
+    include:
+        - os: linux
+          language: generic
+          sudo: required
+          dist: trusty
+        - os: osx
+          language: generic
+          osx_image: xcode7.3
+before_install: ./maintainers/scripts/travis-nox-review-pr.sh nix
+install: ./maintainers/scripts/travis-nox-review-pr.sh nox
+script: ./maintainers/scripts/travis-nox-review-pr.sh build

.version

@@ -1 +1 @@
-19.09
+16.09

COPYING

@@ -1,4 +1,4 @@
-Copyright (c) 2003-2019 Eelco Dolstra and the Nixpkgs/NixOS contributors
+Copyright (c) 2003-2016 Eelco Dolstra and the Nixpkgs/NixOS contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,3 +18,14 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+======================================================================
+
+Note: the license above does not apply to the packages built by the
+Nix Packages collection, merely to the package descriptions (i.e., Nix
+expressions, build scripts, etc.).  Also, the license does not apply
+to some of the binaries used for bootstrapping Nixpkgs (e.g.,
+pkgs/stdenv/linux/tools/bash).  It also might not apply to patches
+included in Nixpkgs, which may be derivative works of the packages to
+which they apply.  The aforementioned artifacts are all covered by the
+licenses of the respective packages.

README.md

@@ -1,113 +1,43 @@
-<p align="center">
-  <a href="https://nixos.org/nixos"><img src="https://nixos.org/logo/nixos-hires.png" width="500px" alt="NixOS logo" /></a>
-</p>
+[<img src="http://nixos.org/logo/nixos-hires.png" width="500px" alt="logo" />](https://nixos.org/nixos)
 
-<p align="center">
-  <a href="https://www.codetriage.com/nixos/nixpkgs"><img src="https://www.codetriage.com/nixos/nixpkgs/badges/users.svg" alt="Code Triagers badge" /></a>
-  <a href="https://opencollective.com/nixos"><img src="https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporter&color=brightgreen" alt="Open Collective supporters" /></a>
-</p>
+[![Build Status](https://travis-ci.org/NixOS/nixpkgs.svg?branch=master)](https://travis-ci.org/NixOS/nixpkgs)
+[![Issue Stats](http://www.issuestats.com/github/nixos/nixpkgs/badge/pr?style=flat)](http://www.issuestats.com/github/nixos/nixpkgs)
+[![Issue Stats](http://www.issuestats.com/github/nixos/nixpkgs/badge/issue?style=flat)](http://www.issuestats.com/github/nixos/nixpkgs)
 
-[Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over
-40,000 software packages that can be installed with the
-[Nix](https://nixos.org/nix/) package manager. It also implements
-[NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution.
+Nixpkgs is a collection of packages for the [Nix](https://nixos.org/nix/) package
+manager. It is periodically built and tested by the [hydra](http://hydra.nixos.org/)
+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:
 
-# Manuals
+```
+% git remote add channels git://github.com/NixOS/nixpkgs-channels.git
+```
 
-* [NixOS Manual](https://nixos.org/nixos/manual) - how to install, configure, and maintain a purely-functional Linux distribution
-* [Nixpkgs Manual](https://nixos.org/nixpkgs/manual/) - contributing to Nixpkgs and using programming-language-specific Nix expressions
-* [Nix Package Manager Manual](https://nixos.org/nix/manual) - how to write Nix expresssions (programs), and how to use Nix command line tools
+For stability and maximum binary package support, it is recommended to maintain
+custom changes on top of one of the channels, e.g. `nixos-16.03` for the latest
+release and `nixos-unstable` for the latest successful build of master:
 
-# Community
+```
+% git remote update channels
+% git rebase channels/nixos-16.03
+```
 
-* [Discourse Forum](https://discourse.nixos.org/)
-* [IRC - #nixos on freenode.net](irc://irc.freenode.net/#nixos)
-* [NixOS Weekly](https://weekly.nixos.org/)
-* [Community-maintained wiki](https://nixos.wiki/)
+For pull-requests, please rebase onto nixpkgs `master`.
 
-# Other Project Repositories
-
-The sources of all offical Nix-related projects are in the [NixOS
-organization on GitHub](https://github.com/NixOS/). Here are some of
-the main ones:
-
-* [Nix](https://github.com/NixOS/nix) - the purely functional package manager
-* [NixOps](https://github.com/NixOS/nixops) - the tool to remotely deploy NixOS machines
-* [Nix RFCs](https://github.com/NixOS/rfcs) - the formal process for making substantial changes to the community
-* [NixOS homepage](https://github.com/NixOS/nixos-homepage) - the [NixOS.org](https://nixos.org) website
-* [hydra](https://github.com/NixOS/hydra) - our continuous integration system
-* [NixOS Artwork](https://github.com/NixOS/nixos-artwork) - NixOS artwork
-
-# Continuous Integration and Distribution
-
-Nixpkgs and NixOS are built and tested by our continuous integration
-system, [Hydra](https://hydra.nixos.org/).
+[NixOS](https://nixos.org/nixos/) linux distribution source code is located inside
+`nixos/` folder.
 
+* [NixOS installation instructions](https://nixos.org/nixos/manual/#ch-installation)
+* [Documentation (Nix Expression Language chapter)](https://nixos.org/nix/manual/#ch-expression-language)
+* [Manual (How to write packages for Nix)](https://nixos.org/nixpkgs/manual/)
+* [Manual (NixOS)](https://nixos.org/nixos/manual/)
+* [Nix Wiki](https://nixos.org/wiki/)
 * [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)
-* [Continuous package builds for the NixOS 19.03 release](https://hydra.nixos.org/jobset/nixos/release-19.03)
+* [Continuous package builds for 16.03 release](https://hydra.nixos.org/jobset/nixos/release-16.03)
 * [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
-* [Tests for the NixOS 19.03 release](https://hydra.nixos.org/job/nixos/release-19.03/tested#tabs-constituents)
+* [Tests for 16.03 release](https://hydra.nixos.org/job/nixos/release-16.03/tested#tabs-constituents)
 
-Artifacts successfully built with Hydra are published to cache at
-https://cache.nixos.org/. When successful build and test criteria are
-met, the Nixpkgs expressions are distributed via [Nix
-channels](https://nixos.org/nix/manual/#sec-channels). The channels
-are provided via a read-only mirror of the Nixpkgs repository called
-[nixpkgs-channels](https://github.com/NixOS/nixpkgs-channels).
+Communication:
 
-# Contributing
-
-Nixpkgs is among the most active projects on GitHub. While thousands
-of open issues and pull requests might seem a lot at first, it helps
-consider it in the context of the scope of the project. Nixpkgs
-describes how to build over 40,000 pieces of software and implements a
-Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse)
-page gives a sense of the project activity.
-
-Community contributions are always welcome through GitHub Issues and
-Pull Requests. When pull requests are made, our tooling automation bot,
-[OfBorg](https://github.com/NixOS/ofborg) will perform various checks
-to help ensure expression quality.
-
-The *Nixpkgs maintainers* are people who have assigned themselves to
-maintain specific individual packages. We encourage people who care
-about a package to assign themselves as a maintainer. When a pull
-request is made against a package, OfBorg will notify the appropriate
-maintainer(s). The *Nixpkgs committers* are people who have been given
-permission to merge.
-
-Most contributions are based on and merged into these branches:
-
-* `master` is the main branch where all small contributions go
-* `staging` is branched from master, changes that have a big impact on
-  Hydra builds go to this branch
-* `staging-next` is branched from staging and only fixes to stabilize
-  and security fixes with a big impact on Hydra builds should be
-  contributed to this branch. This branch is merged into master when
-  deemed of sufficiently high quality
-
-For more information about contributing to the project, please visit
-the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
-
-# Donations
-
-The infrastructure for NixOS and related projects is maintained by a
-nonprofit organization, the [NixOS
-Foundation](https://nixos.org/nixos/foundation.html). To ensure the
-continuity and expansion of the NixOS infrastructure, we are looking
-for donations to our organization.
-
-You can donate to the NixOS foundation by using Open Collective:
-
-<a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a>
-
-# License
-
-Nixpkgs is licensed under the [MIT License](COPYING).
-
-Note: MIT license does not apply to the packages built by Nixpkgs,
-merely to the files in this repository (the Nix expressions, build
-scripts, NixOS modules, etc.). It also might not apply to patches
-included in Nixpkgs, which may be derivative works of the packages to
-which they apply. The aforementioned artifacts are all covered by the
-licenses of the respective packages.
+* [Mailing list](http://lists.science.uu.nl/mailman/listinfo/nix-dev)
+* [IRC - #nixos on freenode.net](irc://irc.freenode.net/#nixos)

default.nix

@@ -2,27 +2,8 @@ let requiredVersion = import ./lib/minver.nix; in
 
 if ! builtins ? nixVersion || builtins.compareVersions requiredVersion builtins.nixVersion == 1 then
 
-  abort ''
-
-    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 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 ./nixos/doc/manual/release-notes}.
-
-    If you need further help, see https://nixos.org/nixos/support.html
-  ''
+  abort "This version of Nixpkgs requires Nix >= ${requiredVersion}, please upgrade! See https://nixos.org/wiki/How_to_update_when_Nix_is_too_old_to_evaluate_Nixpkgs"
 
 else
 
-  import ./pkgs/top-level/impure.nix
+  import ./pkgs/top-level

doc/.gitignore

@@ -1,8 +0,0 @@
-*.chapter.xml
-*.section.xml
-.version
-functions/library/generated
-functions/library/locations.xml
-highlightjs
-manual-full.xml
-out

doc/Makefile

@@ -1,110 +0,0 @@
-MD_TARGETS=$(addsuffix .xml, $(basename $(wildcard ./*.md ./**/*.md)))
-
-.PHONY: all
-all: validate format out/html/index.html out/epub/manual.epub
-
-.PHONY: debug
-debug:
-	nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml"
-
-.PHONY: format
-format: doc-support/result
-	find . -iname '*.xml' -type f | while read f; do \
-		echo $$f ;\
-		xmlformat --config-file "doc-support/result/xmlformat.conf" -i $$f ;\
-	done
-
-.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} doc-support/result .version manual-full.xml functions/library/locations.xml functions/library/generated
-	rm -rf ./out/ ./highlightjs
-
-.PHONY: validate
-validate: manual-full.xml doc-support/result
-	jing doc-support/result/docbook.rng manual-full.xml
-
-out/html/index.html: doc-support/result manual-full.xml style.css highlightjs
-	mkdir -p out/html
-	xsltproc \
-		--nonet --xinclude \
-		--output $@ \
-		doc-support/result/xhtml.xsl \
-		./manual-full.xml
-
-	mkdir -p out/html/highlightjs/
-	cp -r highlightjs out/html/
-
-	cp ./overrides.css out/html/
-	cp ./style.css out/html/style.css
-
-	mkdir -p out/html/images/callouts
-	cp doc-support/result/xsl/docbook/images/callouts/*.svg out/html/images/callouts/
-	chmod u+w -R out/html/
-
-out/epub/manual.epub: manual-full.xml
-	mkdir -p out/epub/scratch
-	xsltproc --nonet \
-		--output out/epub/scratch/ \
-		doc-support/result/epub.xsl \
-		./manual-full.xml
-
-	cp ./overrides.css out/epub/scratch/OEBPS
-	cp ./style.css out/epub/scratch/OEBPS
-	mkdir -p out/epub/scratch/OEBPS/images/callouts/
-	cp doc-support/result/xsl/docbook/images/callouts/*.svg out/epub/scratch/OEBPS/images/callouts/
-	echo "application/epub+zip" > mimetype
-	zip -0Xq "out/epub/manual.epub" mimetype
-	rm mimetype
-	cd "out/epub/scratch/" && zip -Xr9D "../manual.epub" *
-	rm -rf "out/epub/scratch/"
-
-highlightjs: doc-support/result
-	mkdir -p highlightjs
-	cp -r doc-support/result/highlightjs/highlight.pack.js highlightjs/
-	cp -r doc-support/result/highlightjs/LICENSE highlightjs/
-	cp -r doc-support/result/highlightjs/mono-blue.css highlightjs/
-	cp -r doc-support/result/highlightjs/loader.js highlightjs/
-
-
-manual-full.xml: ${MD_TARGETS} .version functions/library/locations.xml functions/library/generated *.xml **/*.xml **/**/*.xml
-	xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
-
-.version: doc-support/result
-	ln -rfs ./doc-support/result/version .version
-
-doc-support/result: doc-support/default.nix
-	(cd doc-support; nix-build)
-
-functions/library/locations.xml: doc-support/result
-	ln -rfs ./doc-support/result/function-locations.xml functions/library/locations.xml
-
-functions/library/generated: doc-support/result
-	ln -rfs ./doc-support/result/function-docs functions/library/generated
-
-%.section.xml: %.section.md
-	pandoc $^ -w docbook+smart \
-		-f markdown+smart \
-	  | sed -e 's|<ulink url=|<link xlink:href=|' \
-	      -e 's|</ulink>|</link>|' \
-	      -e 's|<sect. id=|<section xml:id=|' \
-	      -e 's|</sect[0-9]>|</section>|' \
-	      -e '1s| id=| xml:id=|' \
-	      -e '1s|\(<[^ ]* \)|\1xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" |' \
-	| cat  > $@
-
-%.chapter.xml: %.chapter.md
-	pandoc $^ -w docbook+smart \
-		--top-level-division=chapter \
-		-f markdown+smart \
-	  | sed -e 's|<ulink url=|<link xlink:href=|' \
-	      -e 's|</ulink>|</link>|' \
-	      -e 's|<sect. id=|<section xml:id=|' \
-	      -e 's|</sect[0-9]>|</section>|' \
-	      -e '1s| id=| xml:id=|' \
-	      -e '1s|\(<[^ ]* \)|\1|' \
-	| cat  > $@

doc/configuration.xml

@@ -1,298 +1,98 @@
 <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:
-<programlisting>
-{
-  nixpkgs.config = {
-    allowUnfree = true;
-  };
-}
-</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:
+
+<title><filename>~/.nixpkgs/config.nix</filename>: global configuration</title>
+
+<para>Nix packages can be configured to allow or deny certain options.</para>
+
+<para>To apply the configuration edit
+<filename>~/.nixpkgs/config.nix</filename> and set it like
+
 <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">
-  <title>Installing broken packages</title>
 
-  <para>
-   There are two ways to try compiling a package which has been marked as
-   broken.
-  </para>
+and will allow the Nix package manager to install unfree licensed packages.</para>
+
+<para>The configuration as listed also applies to NixOS under
+<option>nixpkgs.config</option> set.</para>
+
+<itemizedlist>
+
+  <listitem>
+    <para>Allow installing of packages that are distributed under
+    unfree license by setting <programlisting>allowUnfree =
+    true;</programlisting> or deny them by setting it to
+    <literal>false</literal>.</para>
+
+    <para>Same can be achieved by setting the environment variable:
 
-  <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:
 <programlisting>
-{
-  allowBroken = true;
-}
+$ export NIXPKGS_ALLOW_UNFREE=1
+</programlisting>
+
+    </para>
+  </listitem>
+
+  <listitem>
+    <para>Whenever unfree packages are not allowed, single packages
+    can still be allowed by a predicate function that accepts package
+    as an argument and should return a boolean:
+
+<programlisting>
+allowUnfreePredicate = (pkg: ...);
+</programlisting>
+
+    Example to allow flash player and visual studio code only:
+
+<programlisting>
+allowUnfreePredicate = with builtins; (pkg: elem (parseDrvName pkg.name).name [ "flashplayer" "vscode" ]);
+</programlisting>
+
+    </para>
+  </listitem>
+
+  <listitem>
+    <para>Whenever unfree packages are not allowed, packages can still
+    be whitelisted by their license:
+
+<programlisting>
+whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ];
 </programlisting>
     </para>
-   </listitem>
-  </itemizedlist>
- </section>
- <section xml:id="sec-allow-unsupported-system">
-  <title>Installing packages on unsupported systems</title>
+  </listitem>
 
-  <para>
-   There are also two ways to try compiling a package which has been marked as
-   unsuported for the given system.
-  </para>
+  <listitem>
+    <para>In addition to whitelisting licenses which are denied by the
+    <literal>allowUnfree</literal> setting, you can also explicitely
+    deny installation of packages which have a certain license:
 
-  <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;
-}
+blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ];
 </programlisting>
     </para>
-   </listitem>
-  </itemizedlist>
+  </listitem>
 
-  <para>
-   The difference between 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">
-  <title>Installing unfree packages</title>
+</itemizedlist>
 
-  <para>
-   There are several ways to tweak how Nix handles a package which has been
-   marked as unfree.
-  </para>
+<para>A complete list of licenses can be found in the file
+<filename>lib/licenses.nix</filename> of the nix package tree.</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:
-<programlisting>
-{
-  allowUnfreePredicate = (pkg: false);
-}
-</programlisting>
-    </para>
-    <para>
-     For a more useful example, try the following. This configuration only
-     allows unfree packages named flash player and visual studio code:
-<programlisting>
-{
-  allowUnfreePredicate = (pkg: builtins.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>:
-<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:
-<programlisting>
-{
-  blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ];
-}
-</programlisting>
-    </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>
-   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>:
-<programlisting>
-{
-  permittedInsecurePackages = [
-    "hello-1.2.3"
-  ];
-}
-</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:
-<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>
-   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 returns a
-   modified set of packages.
+<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>~/.nixpkgs/config.nix</filename> to overide nix packages.  It
+must be a function that takes pkgs as an argument and return modified
+set of packages.
+
 <programlisting>
 {
   packageOverrides = pkgs: rec {
@@ -300,246 +100,10 @@
   };
 }
 </programlisting>
-  </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>
+</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>
+</section>
 
-<screen>
-{
-  packageOverrides = pkgs: with pkgs; {
-    myPackages = pkgs.buildEnv {
-      name = "my-packages";
-      paths = [
-        aspell
-        bc
-        coreutils
-        gdb
-        ffmpeg
-        nixUnstable
-        emscripten
-        jq
-        nox
-        silver-searcher
-      ];
-    };
-  };
-}
-</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>
-
-<screen>
-{
-  packageOverrides = pkgs: with pkgs; {
-    myPackages = pkgs.buildEnv {
-      name = "my-packages";
-      paths = [
-        aspell
-        bc
-        coreutils
-        gdb
-        ffmpeg
-        nixUnstable
-        emscripten
-        jq
-        nox
-        silver-searcher
-      ];
-      pathsToLink = [ "/share" "/bin" ];
-    };
-  };
-}
-</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>
-  </section>
-
-  <section xml:id="sec-getting-documentation">
-   <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>
-
-<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" ];
-      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>
-
-<screen>
-{
-  packageOverrides = pkgs: with pkgs; rec {
-    myProfile = writeText "my-profile" ''
-      export PATH=$HOME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/sbin:/bin:/usr/sbin:/usr/bin
-      export MANPATH=$HOME/.nix-profile/share/man:/nix/var/nix/profiles/default/share/man:/usr/share/man
-    '';
-    myPackages = pkgs.buildEnv {
-      name = "my-packages";
-      paths = [
-        (runCommand "profile" {} ''
-          mkdir -p $out/etc/profile.d
-          cp ${myProfile} $out/etc/profile.d/my-profile.sh
-        '')
-        aspell
-        bc
-        coreutils
-        ffmpeg
-        man
-        nixUnstable
-        emscripten
-        jq
-        nox
-        silver-searcher
-      ];
-      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>
-
-<screen>
-#!/bin/sh
-if [ -d $HOME/.nix-profile/etc/profile.d ]; then
-  for i in $HOME/.nix-profile/etc/profile.d/*.sh; do
-    if [ -r $i ]; then
-      . $i
-    fi
-  done
-fi
-</screen>
-
-   <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>
-
-   <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>
-{
-  packageOverrides = pkgs: with pkgs; rec {
-    myProfile = writeText "my-profile" ''
-      export PATH=$HOME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/sbin:/bin:/usr/sbin:/usr/bin
-      export MANPATH=$HOME/.nix-profile/share/man:/nix/var/nix/profiles/default/share/man:/usr/share/man
-      export INFOPATH=$HOME/.nix-profile/share/info:/nix/var/nix/profiles/default/share/info:/usr/share/info
-    '';
-    myPackages = pkgs.buildEnv {
-      name = "my-packages";
-      paths = [
-        (runCommand "profile" {} ''
-          mkdir -p $out/etc/profile.d
-          cp ${myProfile} $out/etc/profile.d/my-profile.sh
-        '')
-        aspell
-        bc
-        coreutils
-        ffmpeg
-        man
-        nixUnstable
-        emscripten
-        jq
-        nox
-        silver-searcher
-        texinfoInteractive
-      ];
-      pathsToLink = [ "/share/man" "/share/doc" "/share/info" "/bin" "/etc" ];
-      extraOutputsToInstall = [ "man" "doc" "info" ];
-      postBuild = ''
-        if [ -x $out/bin/install-info -a -w $out/share/info ]; then
-          shopt -s nullglob
-          for i in $out/share/info/*.info $out/share/info/*.info.gz; do
-              $out/bin/install-info $i $out/share/info/dir
-          done
-        fi
-      '';
-    };
-  };
-}
-</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>
-  </section>
- </section>
 </chapter>

doc/contributing.xml

@@ -1,35 +1,20 @@
 <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. If you make modifications to
+the manual, it's important to build it before committing. You can do that as follows:
+
 <screen>
-<prompt>$ </prompt>cd /path/to/nixpkgs/doc
-<prompt>$ </prompt>nix-shell
-<prompt>[nix-shell]$ </prompt>make
+$ cd /path/to/nixpkgs
+$ nix-build doc
 </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:
-<screen>
-<prompt>$ </prompt>cd /path/to/nixpkgs/doc
-<prompt>$ </prompt>nix-shell
-<prompt>[nix-shell]$ </prompt>make clean
-<prompt>[nix-shell]$ </prompt>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,678 +0,0 @@
-<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>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. However, there are
-   significant advantages to rigorously distinguishing between build-time and
-   run-time environments! Significant, because the benefits apply 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.
-  </para>
- </section>
-<!--============================================================-->
- <section xml:id="sec-cross-packaging">
-  <title>Packaging in a cross-friendly manner</title>
-
-  <section xml:id="ssec-cross-platform-parameters">
-   <title>Platform parameters</title>
-
-   <para>
-    Nixpkgs follows the
-    <link
-     xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">conventions
-    of GNU autoconf</link>. We distinguish between 3 types of platforms when
-    building a derivation: <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
-    will 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 can be ignored.
-      </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 of specifying this single "target
-       platform" is thus pushed to build time of the compiler. The root cause
-       of this is that the compiler (which will be run on the host) and the
-       standard library/runtime (which will be run on the target) are built by
-       a single build process.
-      </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. The first component
-       corresponds to the CPU architecture of the platform and the second to
-       the operating system of the platform (<literal>[cpu]-[os]</literal>).
-       This format 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 <literal>x86_64-unknown-linux-gnu</literal> and
-       <literal>aarch64-apple-darwin14</literal>. This is a standard format
-       called the "LLVM target triple", as they are pioneered by LLVM. In the
-       4-part form, this corresponds to
-       <literal>[cpu]-[vendor]-[os]-[abi]</literal>. 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>. 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 onto 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="ssec-cross-dependency-categorization">
-   <title>Theory of dependency categorization</title>
-
-   <note>
-    <para>
-     This is a rather philosophical description that isn't very
-     Nixpkgs-specific. For an overview of all the relevant attributes given to
-     <varname>mkDerivation</varname>, see
-     <xref
-     linkend="ssec-stdenv-dependencies"/>. For a description of how
-     everything is implemented, see
-     <xref linkend="ssec-cross-dependency-implementation" />.
-    </para>
-   </note>
-
-   <para>
-    In this section we explore the relationship between both runtime and
-    build-time dependencies and the 3 Autoconf platforms.
-   </para>
-
-   <para>
-    A run time dependency between two packages requires that their host
-    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, has a shift in platforms between the
-    depending package and the depended-on package. "build time dependency"
-    means 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.
-   </para>
-
-   <para>
-    If both the dependency and depending packages aren't compilers or other
-    machine-code-producing tools, we're done. And indeed
-    <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>
-    have covered these simpler build-time and run-time (respectively) changes
-    for many years. But if the dependency does produce machine code, we might
-    need to worry about its target platform too. In principle, that target
-    platform might be any of the depending package's build, host, or target
-    platforms, but we prohibit dependencies from a "later" platform to an
-    earlier platform to limit confusion because we've never seen a legitimate
-    use for them.
-   </para>
-
-   <para>
-    Finally, if the depending package is a compiler or other
-    machine-code-producing tool, it might need dependencies that run at "emit
-    time". This is for compilers that (regrettably) insist on being built
-    together with their source langauges' standard libraries. Assuming build !=
-    host != target, a run-time dependency of the standard library cannot be run
-    at the compiler's build time or run time, but only at the run time of code
-    emitted by the compiler.
-   </para>
-
-   <para>
-    Putting this all together, that means we have dependencies in the form
-    "host → target", in at most the following six combinations:
-    <table>
-     <caption>Possible dependency types</caption>
-     <thead>
-      <tr>
-       <th>Dependency's host platform</th>
-       <th>Dependency's target platform</th>
-      </tr>
-     </thead>
-     <tbody>
-      <tr>
-       <td>build</td>
-       <td>build</td>
-      </tr>
-      <tr>
-       <td>build</td>
-       <td>host</td>
-      </tr>
-      <tr>
-       <td>build</td>
-       <td>target</td>
-      </tr>
-      <tr>
-       <td>host</td>
-       <td>host</td>
-      </tr>
-      <tr>
-       <td>host</td>
-       <td>target</td>
-      </tr>
-      <tr>
-       <td>target</td>
-       <td>target</td>
-      </tr>
-     </tbody>
-    </table>
-   </para>
-
-   <para>
-    Some examples will make this table clearer. Suppose there's some package
-    that is being built with a <literal>(build, host, target)</literal>
-    platform triple of <literal>(foo, bar, baz)</literal>. If it has a
-    build-time library dependency, that would be a "host → build" dependency
-    with a triple of <literal>(foo, foo, *)</literal> (the target platform is
-    irrelevant). If it needs a compiler to be built, that would be a "build →
-    host" dependency with a triple of <literal>(foo, foo, *)</literal> (the
-    target platform is irrelevant). That compiler, would be built with another
-    compiler, also "build → host" dependency, with a triple of <literal>(foo,
-    foo, foo)</literal>.
-   </para>
-  </section>
-
-  <section xml:id="ssec-cross-cookbook">
-   <title>Cross packaging cookbook</title>
-
-   <para>
-    Some frequently encountered problems when packaging for cross-compilation
-    should be answered here. Ideally, the information above is exhaustive, so
-    this section cannot provide any new information, but it is ludicrous and
-    cruel to expect everyone to spend effort working through the interaction of
-    many features just to figure out the same answer to the same common
-    problem. Feel free to add to this list!
-   </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>
- </section>
-<!--============================================================-->
- <section xml:id="sec-cross-usage">
-  <title>Cross-building packages</title>
-
-  <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>
-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>
-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>
-  </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.
-  </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>
-  </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 is that
-   <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 xml:id="sec-cross-infra">
-  <title>Cross-compilation infrastructure</title>
-
-  <section xml:id="ssec-cross-dependency-implementation">
-   <title>Implementation of dependencies</title>
-
-   <para>
-    The categorizes of dependencies developed in
-    <xref
-    linkend="ssec-cross-dependency-categorization"/> are specified as
-    lists of derivations given to <varname>mkDerivation</varname>, as
-    documented in <xref linkend="ssec-stdenv-dependencies"/>. In short,
-    each list of dependencies for "host → target" of "foo → bar" is called
-    <varname>depsFooBar</varname>, with exceptions for backwards
-    compatibility that <varname>depsBuildHost</varname> is instead called
-    <varname>nativeBuildInputs</varname> and <varname>depsHostTarget</varname>
-    is instead called <varname>buildInputs</varname>. Nixpkgs is now structured
-    so that each <varname>depsFooBar</varname> is automatically taken from
-    <varname>pkgsFooBar</varname>. (These <varname>pkgsFooBar</varname>s are
-    quite new, so there is no special case for
-    <varname>nativeBuildInputs</varname> and <varname>buildInputs</varname>.)
-    For example, <varname>pkgsBuildHost.gcc</varname> should be used at
-    build-time, while <varname>pkgsHostTarget.gcc</varname> should be used at
-    run-time.
-   </para>
-
-   <para>
-    Now, for most of Nixpkgs's history, there were no
-    <varname>pkgsFooBar</varname> attributes, and most packages have not been
-    refactored to use it explicitly. Prior to those, there were just
-    <varname>buildPackages</varname>, <varname>pkgs</varname>, and
-    <varname>targetPackages</varname>. Those are now redefined as aliases to
-    <varname>pkgsBuildHost</varname>, <varname>pkgsHostTarget</varname>, and
-    <varname>pkgsTargetTarget</varname>. It is acceptable, even
-    recommended, to use them for libraries to show that the host platform is
-    irrelevant.
-   </para>
-
-   <para>
-    But before that, there was just <varname>pkgs</varname>, even though both
-    <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>
-    existed. [Cross barely worked, and those were implemented with some hacks
-    on <varname>mkDerivation</varname> to override dependencies.] What this
-    means is the vast majority of packages do not use any explicit package set
-    to populate their dependencies, just using whatever
-    <varname>callPackage</varname> gives them even if they do correctly sort
-    their dependencies into the multiple lists described above. And indeed,
-    asking that users both sort their dependencies, <emphasis>and</emphasis>
-    take them from the right attribute set, is both too onerous and redundant,
-    so the recommended approach (for now) is to continue just categorizing by
-    list and not using an explicit package set.
-   </para>
-
-   <para>
-    To make this work, we "splice" together the six
-    <varname>pkgsFooBar</varname> package sets and have
-    <varname>callPackage</varname> actually take its arguments from that. This
-    is currently implemented in <filename>pkgs/top-level/splice.nix</filename>.
-    <varname>mkDerivation</varname> then, for each dependency attribute, pulls
-    the right derivation out from the splice. This splicing can be skipped when
-    not cross-compiling as the package sets are the same, but still is a bit
-    slow for cross-compiling. We'd like to do something better, but haven't
-    come up with anything yet.
-   </para>
-  </section>
-
-  <section xml:id="ssec-bootstrapping">
-   <title>Bootstrapping</title>
-
-   <para>
-    Each of the package sets described above come from a single bootstrapping
-    stage. While <filename>pkgs/top-level/default.nix</filename>, coordinates
-    the composition of stages at a high level,
-    <filename>pkgs/top-level/stage.nix</filename> "ties the knot" (creates the
-    fixed point) of each stage. The package sets are defined per-stage however,
-    so they can be thought of as edges between stages (the nodes) in a graph.
-    Compositions like <literal>pkgsBuildTarget.targetPackages</literal> can be
-    thought of as paths to this graph.
-   </para>
-
-   <para>
-    While there are many package sets, and thus many edges, the stages can also
-    be arranged in a linear chain. In other words, many of the edges are
-    redundant as far as connectivity is concerned. This hinges on the type of
-    bootstrapping we do. Currently for cross it is:
-    <orderedlist>
-     <listitem>
-      <para>
-       <literal>(native, native, native)</literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal>(native, native, foreign)</literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal>(native, foreign, foreign)</literal>
-      </para>
-     </listitem>
-    </orderedlist>
-    In each stage, <varname>pkgsBuildHost</varname> refers the the previous
-    stage, <varname>pkgsBuildBuild</varname> refers to the one before that, and
-    <varname>pkgsHostTarget</varname> refers to the current one, and
-    <varname>pkgsTargetTarget</varname> refers to the next one. When there is
-    no previous or next stage, they instead refer to the current stage. Note
-    how all the invariants regarding the mapping between dependency and depending
-    packages' build host and target platforms are preserved.
-    <varname>pkgsBuildTarget</varname> and <varname>pkgsHostHost</varname> are
-    more complex in that the stage fitting the requirements isn't always a
-    fixed chain of "prevs" and "nexts" away (modulo the "saturating"
-    self-references at the ends). We just special case each instead. All the primary
-    edges are implemented is in <filename>pkgs/stdenv/booter.nix</filename>,
-    and secondarily aliases in <filename>pkgs/top-level/stage.nix</filename>.
-   </para>
-
-   <note>
-    <para>
-     Note the native stages are bootstrapped in legacy ways that predate the
-     current cross implementation. This is why the the bootstrapping stages
-     leading up to the final stages are ignored inthe previous paragraph.
-    </para>
-   </note>
-
-   <para>
-    If one looks at the 3 platform triples, one can see that they overlap such
-    that one could put them together into a chain like:
-<programlisting>
-(native, native, native, foreign, foreign)
-</programlisting>
-    If one imagines the saturating self references at the end being replaced
-    with infinite stages, and then overlays those platform triples, one ends up
-    with the infinite tuple:
-<programlisting>
-(native..., native, native, native, foreign, foreign, foreign...)
-</programlisting>
-    On can then imagine any sequence of platforms such that there are bootstrap
-    stages with their 3 platforms determined by "sliding a window" that is the
-    3 tuple through the sequence. This was the original model for
-    bootstrapping. Without a target platform (assume a better world where all
-    compilers are multi-target and all standard libraries are built in their
-    own derivation), this is sufficient. Conversely if one wishes to cross
-    compile "faster", with a "Canadian Cross" bootstraping stage where
-    <literal>build != host != target</literal>, more bootstrapping stages are
-    needed since no sliding window providess the pesky
-    <varname>pkgsBuildTarget</varname> package set since it skips the Canadian
-    cross stage's "host".
-   </para>
-
-   <note>
-    <para>
-     It is much better to refer to <varname>buildPackages</varname> than
-     <varname>targetPackages</varname>, or more broadly package sets that do
-     not mention "target". There are three reasons for this.
-    </para>
-    <para>
-     First, it is because bootstrapping stages do not have a unique
-     <varname>targetPackages</varname>. For example a <literal>(x86-linux,
-     x86-linux, arm-linux)</literal> and <literal>(x86-linux, x86-linux,
-     x86-windows)</literal> package set both have a <literal>(x86-linux,
-     x86-linux, x86-linux)</literal> package set. Because there is no canonical
-     <varname>targetPackages</varname> for such a native (<literal>build ==
-     host == target</literal>) package set, we set their
-     <varname>targetPackages</varname>
-    </para>
-    <para>
-     Second, it is because this is a frequent source of hard-to-follow
-     "infinite recursions" / cycles. When only package sets that don't mention
-     target are used, the package set forms a directed acyclic graph. This
-     means that all cycles that exist are confined to one stage. This means
-     they are a lot smaller, and easier to follow in the code or a backtrace. It
-     also means they are present in native and cross builds alike, and so more
-     likely to be caught by CI and other users.
-    </para>
-    <para>
-     Thirdly, it is because everything target-mentioning only exists to
-     accommodate compilers with lousy build systems that insist on the compiler
-     itself and standard library being built together. Of course that is bad
-     because bigger derivations means longer rebuilds. It is also problematic because
-     it tends to make the standard libraries less like other libraries than
-     they could be, complicating code and build systems alike. Because of the
-     other problems, and because of these innate disadvantages, compilers ought
-     to be packaged another way where possible.
-    </para>
-   </note>
-
-   <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>
- </section>
-</chapter>

doc/default.nix

@@ -1,28 +1,89 @@
-{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
+with import ./.. { };
+with lib;
 let
-  lib = pkgs.lib;
-  doc-support = import ./doc-support { inherit pkgs nixpkgs; };
-in pkgs.stdenv.mkDerivation {
+  sources = sourceFilesBySuffices ./. [".xml"];
+  sources-langs = ./languages-frameworks;
+in
+stdenv.mkDerivation {
   name = "nixpkgs-manual";
 
-  buildInputs = with pkgs; [ pandoc libxml2 libxslt zip jing  xmlformat ];
 
-  src = ./.;
+  buildInputs = [ pandoc libxml2 libxslt ];
 
-  postPatch = ''
-    ln -s ${doc-support} ./doc-support/result
+  xsltFlags = ''
+    --param section.autolabel 1
+    --param section.label.includes.component.label 1
+    --param html.stylesheet 'style.css'
+    --param xref.with.number.and.title 1
+    --param toc.section.depth 3
+    --param admon.style '''
+    --param callout.graphics.extension '.gif'
   '';
 
-  installPhase = ''
-    dest="$out/share/doc/nixpkgs"
-    mkdir -p "$(dirname "$dest")"
-    mv out/html "$dest"
-    mv "$dest/index.html" "$dest/manual.html"
 
-    mv out/epub/manual.epub "$dest/nixpkgs-manual.epub"
+  buildCommand = let toDocbook = { useChapters ? false, inputFile, outputFile }:
+    let
+      extraHeader = ''xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" '';
+    in ''
+      {
+        pandoc '${inputFile}' -w docbook ${optionalString useChapters "--chapters"} \
+          --smart \
+          | sed -e 's|<ulink url=|<link xlink:href=|' \
+              -e 's|</ulink>|</link>|' \
+              -e 's|<sect. id=|<section xml:id=|' \
+              -e 's|</sect[0-9]>|</section>|' \
+              -e '1s| id=| xml:id=|' \
+              -e '1s|\(<[^ ]* \)|\1${extraHeader}|'
+      } > '${outputFile}'
+    '';
+  in
 
-    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
+  ''
+    ln -s '${sources}/'*.xml .
+    mkdir ./languages-frameworks
+    cp -s '${sources-langs}'/* ./languages-frameworks
+  ''
+  + toDocbook {
+      inputFile = ./introduction.md;
+      outputFile = "introduction.xml";
+      useChapters = true;
+    }
+  + toDocbook {
+      inputFile = ./languages-frameworks/python.md;
+      outputFile = "./languages-frameworks/python.xml";
+    }
+  + toDocbook {
+      inputFile = ./languages-frameworks/haskell.md;
+      outputFile = "./languages-frameworks/haskell.xml";
+    }
+  + toDocbook {
+      inputFile = ./../pkgs/development/idris-modules/README.md;
+      outputFile = "languages-frameworks/idris.xml";
+    }
+  + toDocbook {
+      inputFile = ./../pkgs/development/r-modules/README.md;
+      outputFile = "languages-frameworks/r.xml";
+    }
+  + ''
+    echo ${nixpkgsVersion} > .version
+
+    # validate against relaxng schema
+    xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
+    ${jing}/bin/jing ${docbook5}/xml/rng/docbook/docbook.rng manual-full.xml
+
+    dst=$out/share/doc/nixpkgs
+    mkdir -p $dst
+    xsltproc $xsltFlags --nonet --xinclude \
+      --output $dst/manual.html \
+      ${docbook5_xsl}/xml/xsl/docbook/xhtml/docbook.xsl \
+      ./manual.xml
+
+    cp ${./style.css} $dst/style.css
+
+    mkdir -p $dst/images/callouts
+    cp "${docbook5_xsl}/xml/xsl/docbook/images/callouts/"*.gif $dst/images/callouts/
+
+    mkdir -p $out/nix-support
+    echo "doc manual $dst manual.html" >> $out/nix-support/hydra-build-products
   '';
 }

doc/doc-support/default.nix

@@ -1,45 +0,0 @@
-{ pkgs ? (import ../.. {}), nixpkgs ? { }}:
-let
-  locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; };
-  functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; };
-  version = pkgs.lib.version;
-
-  epub-xsl = pkgs.writeText "epub.xsl" ''
-    <?xml version='1.0'?>
-    <xsl:stylesheet
-      xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-      version="1.0">
-      <xsl:import href="${pkgs.docbook_xsl_ns}/xml/xsl/docbook/epub/docbook.xsl" />
-      <xsl:import href="${./parameters.xml}"/>
-    </xsl:stylesheet>
-  '';
-
-  xhtml-xsl = pkgs.writeText "xhtml.xsl" ''
-    <?xml version='1.0'?>
-    <xsl:stylesheet
-      xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-      version="1.0">
-      <xsl:import href="${pkgs.docbook_xsl_ns}/xml/xsl/docbook/xhtml/docbook.xsl" />
-      <xsl:import href="${./parameters.xml}"/>
-    </xsl:stylesheet>
-  '';
-in pkgs.runCommand "doc-support" {}
-''
-  mkdir result
-  (
-    cd result
-    ln -s ${locationsXml} ./function-locations.xml
-    ln -s ${functionDocs} ./function-docs
-
-    ln -s ${pkgs.docbook5}/xml/rng/docbook/docbook.rng ./docbook.rng
-    ln -s ${pkgs.docbook_xsl_ns}/xml/xsl ./xsl
-    ln -s ${epub-xsl} ./epub.xsl
-    ln -s ${xhtml-xsl} ./xhtml.xsl
-
-    ln -s ${../../nixos/doc/xmlformat.conf} ./xmlformat.conf
-    ln -s ${pkgs.documentation-highlighter} ./highlightjs
-
-    echo -n "${version}" > ./version
-  )
-  mv result $out
-''

doc/doc-support/lib-function-docs.nix

@@ -1,26 +0,0 @@
-# Generates the documentation for library functons via nixdoc. To add
-# another library function file to this list, the include list in the
-# file `doc/functions/library.xml` must also be updated.
-
-{ pkgs ? import ./.. {}, locationsXml }:
-
-with pkgs; stdenv.mkDerivation {
-  name = "nixpkgs-lib-docs";
-  src = ./../../lib;
-
-  buildInputs = [ nixdoc ];
-  installPhase = ''
-    function docgen {
-      nixdoc -c "$1" -d "$2" -f "../lib/$1.nix"  > "$out/$1.xml"
-    }
-
-    mkdir -p $out
-    ln -s ${locationsXml} $out/locations.xml
-
-    docgen strings 'String manipulation functions'
-    docgen trivial 'Miscellaneous functions'
-    docgen lists 'List manipulation functions'
-    docgen debug 'Debugging functions'
-    docgen options 'NixOS / nixpkgs option handling'
-  '';
-}

doc/doc-support/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/doc-support/parameters.xml

@@ -1,14 +0,0 @@
-<?xml version='1.0'?>
-<xsl:stylesheet
-    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-    version="1.0">
- <xsl:param name="section.autolabel" select="1" />
- <xsl:param name="section.label.includes.component.label" select="1" />
- <xsl:param name="html.stylesheet" select="'style.css overrides.css highlightjs/mono-blue.css'" />
- <xsl:param name="html.script" select="'./highlightjs/highlight.pack.js ./highlightjs/loader.js'" />
- <xsl:param name="xref.with.number.and.title" select="1" />
- <xsl:param name="use.id.as.filename" select="1" />
- <xsl:param name="toc.section.depth" select="3" />
- <xsl:param name="admon.style" select="''" />
- <xsl:param name="callout.graphics.extension" select="'.svg'" />
-</xsl:stylesheet>

doc/functions.xml

@@ -1,24 +1,636 @@
 <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>
+	 xmlns:xlink="http://www.w3.org/1999/xlink"
+	 xml:id="chap-functions">
+
+<title>Functions reference</title>
+
+<para>
+  The nixpkgs repository has several utility functions to manipulate Nix expressions.
+</para>
+
+<section xml:id="sec-pkgs-overridePackages">
+  <title>pkgs.overridePackages</title>
+
+  <para>
+    This function inside the nixpkgs expression (<varname>pkgs</varname>)
+    can be used to override the set of packages itself.
+  </para>
+  <para>
+    Warning: this function is expensive and must not be used from within
+    the nixpkgs repository.
+  </para>
+  <para>
+    Example usage:
+
+    <programlisting>let
+  pkgs = import &lt;nixpkgs&gt; {};
+  newpkgs = pkgs.overridePackages (self: super: {
+    foo = super.foo.override { ... };
+  };
+in ...</programlisting>
+  </para>
+
+  <para>
+    The resulting <varname>newpkgs</varname> will have the new <varname>foo</varname>
+    expression, and all other expressions depending on <varname>foo</varname> will also
+    use the new <varname>foo</varname> expression.
+  </para>
+
+  <para>
+    The behavior of this function is similar to <link 
+    linkend="sec-modify-via-packageOverrides">config.packageOverrides</link>.
+  </para>
+
+  <para>
+    The <varname>self</varname> parameter refers to the final package set with the
+    applied overrides. Using this parameter may lead to infinite recursion if not
+    used consciously.
+  </para>
+
+  <para>
+    The <varname>super</varname> parameter refers to the old package set.
+    It's equivalent to <varname>pkgs</varname> in the above example.
+  </para>
+
+</section>
+
+<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>pkgs.overridePackages (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-overrideDerivation">
+  <title>&lt;pkg&gt;.overrideDerivation</title>
+
+  <warning>
+    <para>Do not use this function in Nixpkgs. Because it breaks
+    package abstraction and doesn’t provide error checking for
+    function arguments, it is only intended for ad-hoc customisation
+    (such as in <filename>~/.nixpkgs/config.nix</filename>).
+   </para>
+
+   <para>
+    Additionally, <varname>overrideDerivation</varname> forces an evaluation
+    of the Derivation which can be quite a performance penalty if there are many
+    overrides used.
+   </para>
+  </warning>
+
+  <para>
+    The function <varname>overrideDerivation</varname> is usually available for all the
+    derivations in the nixpkgs expression (<varname>pkgs</varname>).
+  </para> 
+  <para>
+    It is used to create a new derivation by overriding the attributes of
+    the original derivation according to the given 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 name, src and patches 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>
+
+</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 xml:id="sec-fhs-environments">
+  <title>buildFHSChrootEnv/buildFHSUserEnv</title>
+
+  <para>
+    <function>buildFHSChrootEnv</function> and
+    <function>buildFHSUserEnv</function> provide a way to build and run
+    FHS-compatible lightweight sandboxes. They get their own isolated root with
+    binded <filename>/nix/store</filename>, so their 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.
+  </para>
+
+  <para>
+    <function>buildFHSChrootEnv</function> allows to create persistent
+    environments, which can be constructed, deconstructed and entered by
+    multiple users at once. A downside is that it requires
+    <literal>root</literal> access for both those who create and destroy and
+    those who enter it. It can be useful to create environments for daemons that
+    one can enter and observe.
+  </para>
+
+  <para>
+    <function>buildFHSUserEnv</function> uses Linux namespaces feature to create
+    temporary lightweight environments which are destroyed after all child
+    processes exit. It does not require root access, and can be useful to create
+    sandboxes and wrap applications.
+  </para>
+
+  <para>
+    Those functions both rely on <function>buildFHSEnv</function>, which creates
+    an actual directory structure given a list of necessary packages and extra
+    build commands.
+    <function>buildFHSChrootEnv</function> and <function>buildFHSUserEnv</function>
+    both accept those arguments which are passed to
+    <function>buildFHSEnv</function>:
+  </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).</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).</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>extraBuildCommandsMulti</literal>, but
+    executed only on multilib architectures.</para></listitem>
+    </varlistentry>
+  </variablelist>
+
+  <para>
+    Additionally, <function>buildFHSUserEnv</function> accepts
+    <literal>runScript</literal> parameter, which is a command that would be
+    executed inside the sandbox and passed all the command line arguments. It
+    default to <literal>bash</literal>.
+  </para>
+  <para>
+    It also uses <literal>CHROOTENV_EXTRA_BINDS</literal> environment variable
+    for binding extra directories in the sandbox to outside places. The format of
+    the variable is <literal>/mnt=test-mnt:/data</literal>, where
+    <literal>/mnt</literal> would be mounted as <literal>/test-mnt</literal>
+    and <literal>/data</literal> would be mounted as <literal>/data</literal>.
+    <literal>extraBindMounts</literal> array argument to
+    <function>buildFHSUserEnv</function> function is prepended to this variable.
+    Latter entries take priority if defined several times -- i.e. in case of
+    <literal>/data=data1:/data=data2</literal> the actual bind path would be
+    <literal>/data2</literal>.
+  </para>
+  <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>
-  The nixpkgs repository has several utility functions to manipulate Nix
-  expressions.
+  <varname>pkgs.dockerTools</varname> is a set of functions for creating and
+  manipulating Docker images according to the
+  <link xlink:href="https://github.com/docker/docker/blob/master/image/spec/v1.md#docker-image-specification-v100">
+   Docker Image Specification v1.0.0
+  </link>. Docker itself is not used to perform any of the operations done by these
+  functions.
  </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/fetchers.xml" />
- <xi:include href="functions/trivial-builders.xml" />
- <xi:include href="functions/fhs-environments.xml" />
- <xi:include href="functions/shell.xml" />
- <xi:include href="functions/dockertools.xml" />
- <xi:include href="functions/snaptools.xml" />
- <xi:include href="functions/appimagetools.xml" />
- <xi:include href="functions/prefer-remote-fetch.xml" />
- <xi:include href="functions/nix-gitignore.xml" />
- <xi:include href="functions/ocitools.xml" />
+
+ <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/docker/docker/blob/master/image/spec/v1.md#container-runconfig-field-descriptions">
+      Docker Image Specification v1.0.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>
+
+ </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/appimagetools.xml

@@ -1,118 +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-appimageTools">
- <title>pkgs.appimageTools</title>
-
- <para>
-  <varname>pkgs.appimageTools</varname> is a set of functions for extracting
-  and wrapping <link xlink:href="https://appimage.org/">AppImage</link> files.
-  They are meant to be used if traditional packaging from source is infeasible,
-  or it would take too long. To quickly run an AppImage file,
-  <literal>pkgs.appimage-run</literal> can be used as well.
- </para>
-
- <warning>
-  <para>
-   The <varname>appimageTools</varname> API is unstable and may be subject to
-   backwards-incompatible changes in the future.
-  </para>
- </warning>
-
- <section xml:id="ssec-pkgs-appimageTools-formats">
-  <title>AppImage formats</title>
-
-  <para>
-   There are different formats for AppImages, see
-   <link xlink:href="https://github.com/AppImage/AppImageSpec/blob/74ad9ca2f94bf864a4a0dac1f369dd4f00bd1c28/draft.md#image-format">the
-   specification</link> for details.
-  </para>
-
-  <itemizedlist>
-   <listitem>
-    <para>
-     Type 1 images are ISO 9660 files that are also ELF executables.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Type 2 images are ELF executables with an appended filesystem.
-    </para>
-   </listitem>
-  </itemizedlist>
-
-  <para>
-   They can be told apart with <command>file -k</command>:
-  </para>
-
-<screen>
-<prompt>$ </prompt>file -k type1.AppImage
-type1.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) ISO 9660 CD-ROM filesystem data 'AppImage' (Lepton 3.x), scale 0-0,
-spot sensor temperature 0.000000, unit celsius, color scheme 0, calibration: offset 0.000000, slope 0.000000, dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 2.6.18, BuildID[sha1]=d629f6099d2344ad82818172add1d38c5e11bc6d, stripped\012- data
-
-<prompt>$ </prompt>file -k type2.AppImage
-type2.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) (Lepton 3.x), scale 232-60668, spot sensor temperature -4.187500, color scheme 15, show scale bar, calibration: offset -0.000000, slope 0.000000 (Lepton 2.x), scale 4111-45000, spot sensor temperature 412442.250000, color scheme 3, minimum point enabled, calibration: offset -75402534979642766821519867692934234112.000000, slope 5815371847733706829839455140374904832.000000, dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 2.6.18, BuildID[sha1]=79dcc4e55a61c293c5e19edbd8d65b202842579f, stripped\012- data
-</screen>
-
-  <para>
-   Note how the type 1 AppImage is described as an <literal>ISO 9660 CD-ROM
-   filesystem</literal>, and the type 2 AppImage is not.
-  </para>
- </section>
-
- <section xml:id="ssec-pkgs-appimageTools-wrapping">
-  <title>Wrapping</title>
-
-  <para>
-   Depending on the type of AppImage you're wrapping, you'll have to use
-   <varname>wrapType1</varname> or <varname>wrapType2</varname>.
-  </para>
-
-<programlisting>
-appimageTools.wrapType2 { # or wrapType1
-  name = "patchwork"; <co xml:id='ex-appimageTools-wrapping-1' />
-  src = fetchurl { <co xml:id='ex-appimageTools-wrapping-2' />
-    url = https://github.com/ssbc/patchwork/releases/download/v3.11.4/Patchwork-3.11.4-linux-x86_64.AppImage;
-    sha256 =  "1blsprpkvm0ws9b96gb36f0rbf8f5jgmw4x6dsb1kswr4ysf591s";
-  };
-  extraPkgs = pkgs: with pkgs; [ ]; <co xml:id='ex-appimageTools-wrapping-3' />
-}</programlisting>
-
-  <calloutlist>
-   <callout arearefs='ex-appimageTools-wrapping-1'>
-    <para>
-     <varname>name</varname> specifies the name of the resulting image.
-    </para>
-   </callout>
-   <callout arearefs='ex-appimageTools-wrapping-2'>
-    <para>
-     <varname>src</varname> specifies the AppImage file to extract.
-    </para>
-   </callout>
-   <callout arearefs='ex-appimageTools-wrapping-2'>
-    <para>
-     <varname>extraPkgs</varname> allows you to pass a function to include
-     additional packages inside the FHS environment your AppImage is going to
-     run in. There are a few ways to learn which dependencies an application
-     needs:
-     <itemizedlist>
-      <listitem>
-       <para>
-        Looking through the extracted AppImage files, reading its scripts and
-        running <command>patchelf</command> and <command>ldd</command> on its
-        executables. This can also be done in <command>appimage-run</command>,
-        by setting <command>APPIMAGE_DEBUG_EXEC=bash</command>.
-       </para>
-      </listitem>
-      <listitem>
-       <para>
-        Running <command>strace -vfefile</command> on the wrapped executable,
-        looking for libraries that can't be found.
-       </para>
-      </listitem>
-     </itemizedlist>
-    </para>
-   </callout>
-  </calloutlist>
- </section>
-</section>

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,606 +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 it can be 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' />
-    #!${pkgs.runtimeShell}
-    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 images</command>, the newly created images will be listed
-    like this:
-   </para>
-<screen><![CDATA[
-$ docker images
-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 images
-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-buildLayeredImage">
-  <title>buildLayeredImage</title>
-
-  <para>
-   Create a Docker image with many of the store paths being on their own layer
-   to improve sharing between images.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>name</varname>
-    </term>
-    <listitem>
-     <para>
-      The name of the resulting image.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>tag</varname> <emphasis>optional</emphasis>
-    </term>
-    <listitem>
-     <para>
-      Tag of the generated image.
-     </para>
-     <para>
-      <emphasis>Default:</emphasis> the output path's hash
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>contents</varname> <emphasis>optional</emphasis>
-    </term>
-    <listitem>
-     <para>
-      Top level paths in the container. Either a single derivation, or a list
-      of derivations.
-     </para>
-     <para>
-      <emphasis>Default:</emphasis> <literal>[]</literal>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>config</varname> <emphasis>optional</emphasis>
-    </term>
-    <listitem>
-     <para>
-      Run-time configuration of the container. A full list of the options are
-      available at 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>
-     <para>
-      <emphasis>Default:</emphasis> <literal>{}</literal>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>created</varname> <emphasis>optional</emphasis>
-    </term>
-    <listitem>
-     <para>
-      Date and time the layers were created. Follows the same
-      <literal>now</literal> exception supported by
-      <literal>buildImage</literal>.
-     </para>
-     <para>
-      <emphasis>Default:</emphasis> <literal>1970-01-01T00:00:01Z</literal>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>maxLayers</varname> <emphasis>optional</emphasis>
-    </term>
-    <listitem>
-     <para>
-      Maximum number of layers to create.
-     </para>
-     <para>
-      <emphasis>Default:</emphasis> <literal>100</literal>
-     </para>
-     <para>
-      <emphasis>Maximum:</emphasis> <literal>125</literal>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>extraCommands</varname> <emphasis>optional</emphasis>
-    </term>
-    <listitem>
-     <para>
-       Shell commands to run while building the final layer, without access
-       to most of the layer contents. Changes to this layer are "on top"
-       of all the other layers, so can create additional directories
-       and files.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <section xml:id="dockerTools-buildLayeredImage-arg-contents">
-   <title>Behavior of <varname>contents</varname> in the final image</title>
-
-   <para>
-    Each path directly listed in <varname>contents</varname> will have a
-    symlink in the root of the image.
-   </para>
-
-   <para>
-    For example:
-<programlisting><![CDATA[
-pkgs.dockerTools.buildLayeredImage {
-  name = "hello";
-  contents = [ pkgs.hello ];
-}
-]]></programlisting>
-    will create symlinks for all the paths in the <literal>hello</literal>
-    package:
-<screen><![CDATA[
-/bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello
-/share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info
-/share/locale/bg/LC_MESSAGES/hello.mo -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/locale/bg/LC_MESSAGES/hello.mo
-]]></screen>
-   </para>
-  </section>
-
-  <section xml:id="dockerTools-buildLayeredImage-arg-config">
-   <title>Automatic inclusion of <varname>config</varname> references</title>
-
-   <para>
-    The closure of <varname>config</varname> is automatically included in the
-    closure of the final image.
-   </para>
-
-   <para>
-    This allows you to make very simple Docker images with very little code.
-    This container will start up and run <command>hello</command>:
-<programlisting><![CDATA[
-pkgs.dockerTools.buildLayeredImage {
-  name = "hello";
-  config.Cmd = [ "${pkgs.hello}/bin/hello" ];
-}
-]]></programlisting>
-   </para>
-  </section>
-
-  <section xml:id="dockerTools-buildLayeredImage-arg-maxLayers">
-   <title>Adjusting <varname>maxLayers</varname></title>
-
-   <para>
-    Increasing the <varname>maxLayers</varname> increases the number of layers
-    which have a chance to be shared between different images.
-   </para>
-
-   <para>
-    Modern Docker installations support up to 128 layers, however older
-    versions support as few as 42.
-   </para>
-
-   <para>
-    If the produced image will not be extended by other Docker builds, it is
-    safe to set <varname>maxLayers</varname> to <literal>128</literal>. However
-    it will be impossible to extend the image further.
-   </para>
-
-   <para>
-    The first (<literal>maxLayers-2</literal>) most "popular" paths will have
-    their own individual layers, then layer #<literal>maxLayers-1</literal>
-    will contain all the remaining "unpopular" paths, and finally layer
-    #<literal>maxLayers</literal> will contain the Image configuration.
-   </para>
-
-   <para>
-    Docker's Layers are not inherently ordered, they are content-addressable
-    and are not explicitly layered until they are composed in to an Image.
-   </para>
-  </section>
- </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 it 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' />
-  finalImageName = "nix"; <co xml:id='ex-dockerTools-pullImage-3' />
-  finalImageTag = "1.11";  <co xml:id='ex-dockerTools-pullImage-4' />
-  sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; <co xml:id='ex-dockerTools-pullImage-5' />
-  os = "linux"; <co xml:id='ex-dockerTools-pullImage-6' />
-  arch = "x86_64"; <co xml:id='ex-dockerTools-pullImage-7' />
-}
-</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. This argument is required.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-3'>
-    <para>
-     <varname>finalImageName</varname>, if specified, this is the name 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 equal to
-     <varname>imageName</varname>.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-4'>
-    <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-5'>
-    <para>
-     <varname>sha256</varname> is the checksum of the whole fetched image. This
-     argument is required.
-    </para>
-   </callout>
-   <callout arearefs='ex-dockerTools-pullImage-6'>
-    <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-7'>
-    <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>
-
-  <para>
-    <literal>nix-prefetch-docker</literal> command can be used to get required
-    image parameters:
-
-<screen>
-<prompt>$ </prompt>nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5
-</screen>
-
-    Since a given <varname>imageName</varname> may transparently refer to a
-    manifest list of images which support multiple architectures and/or
-    operating systems, you can supply the <option>--os</option> and
-    <option>--arch</option> 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.
-
-<screen>
-<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux
-</screen>
-
-    Desired image name and tag can be set using
-    <option>--final-image-name</option> and <option>--final-image-tag</option>
-    arguments:
-
-<screen>
-<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod
-</screen>
-  </para>
- </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 it can be 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 = ''
-    #!${pkgs.runtimeShell}
-    ${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> is necessary for shadow-utils to
-   manipulate users and groups.
-  </para>
- </section>
-</section>

doc/functions/fetchers.xml

@@ -1,194 +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-fetchers">
- <title>Fetcher functions</title>
-
- <para>
-  When using Nix, you will frequently need to download source code and other
-  files from the internet. Nixpkgs comes with a few helper functions that allow
-  you to fetch fixed-output derivations in a structured way.
- </para>
-
- <para>
-  The two fetcher primitives are <function>fetchurl</function> and
-  <function>fetchzip</function>. Both of these have two required arguments, a
-  URL and a hash. The hash is typically <literal>sha256</literal>, although
-  many more hash algorithms are supported. Nixpkgs contributors are currently
-  recommended to use <literal>sha256</literal>. This hash will be used by Nix
-  to identify your source. A typical usage of fetchurl is provided below.
- </para>
-
-<programlisting><![CDATA[
-{ stdenv, fetchurl }:
-
-stdenv.mkDerivation {
-  name = "hello";
-  src = fetchurl {
-    url = "http://www.example.org/hello.tar.gz";
-    sha256 = "1111111111111111111111111111111111111111111111111111";
-  };
-}
-]]></programlisting>
-
- <para>
-  The main difference between <function>fetchurl</function> and
-  <function>fetchzip</function> is in how they store the contents.
-  <function>fetchurl</function> will store the unaltered contents of the URL
-  within the Nix store. <function>fetchzip</function> on the other hand will
-  decompress the archive for you, making files and directories directly
-  accessible in the future. <function>fetchzip</function> can only be used with
-  archives. Despite the name, <function>fetchzip</function> is not limited to
-  .zip files and can also be used with any tarball.
- </para>
-
- <para>
-  <function>fetchpatch</function> works very similarly to
-  <function>fetchurl</function> with the same arguments expected. It expects
-  patch files as a source and and performs normalization on them before
-  computing the checksum. For example it will remove comments or other unstable
-  parts that are sometimes added by version control systems and can change over
-  time.
- </para>
-
- <para>
-  Other fetcher functions allow you to add source code directly from a VCS such
-  as subversion or git. These are mostly straightforward names based on the
-  name of the command used with the VCS system. Because they give you a working
-  repository, they act most like <function>fetchzip</function>.
- </para>
-
- <variablelist>
-  <varlistentry>
-   <term>
-    <literal>fetchsvn</literal>
-   </term>
-   <listitem>
-    <para>
-     Used with Subversion. Expects <literal>url</literal> to a Subversion
-     directory, <literal>rev</literal>, and <literal>sha256</literal>.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchgit</literal>
-   </term>
-   <listitem>
-    <para>
-     Used with Git. Expects <literal>url</literal> to a Git repo,
-     <literal>rev</literal>, and <literal>sha256</literal>.
-     <literal>rev</literal> in this case can be full the git commit id (SHA1
-     hash) or a tag name like <literal>refs/tags/v1.0</literal>.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchfossil</literal>
-   </term>
-   <listitem>
-    <para>
-     Used with Fossil. Expects <literal>url</literal> to a Fossil archive,
-     <literal>rev</literal>, and <literal>sha256</literal>.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchcvs</literal>
-   </term>
-   <listitem>
-    <para>
-     Used with CVS. Expects <literal>cvsRoot</literal>, <literal>tag</literal>,
-     and <literal>sha256</literal>.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchhg</literal>
-   </term>
-   <listitem>
-    <para>
-     Used with Mercurial. Expects <literal>url</literal>,
-     <literal>rev</literal>, and <literal>sha256</literal>.
-    </para>
-   </listitem>
-  </varlistentry>
- </variablelist>
-
- <para>
-  A number of fetcher functions wrap part of <function>fetchurl</function> and
-  <function>fetchzip</function>. They are mainly convenience functions intended
-  for commonly used destinations of source code in Nixpkgs. These wrapper
-  fetchers are listed below.
- </para>
-
- <variablelist>
-  <varlistentry>
-   <term>
-    <literal>fetchFromGitHub</literal>
-   </term>
-   <listitem>
-    <para>
-     <function>fetchFromGitHub</function> expects four arguments.
-     <literal>owner</literal> is a string corresponding to the GitHub user or
-     organization that controls this repository. <literal>repo</literal>
-     corresponds to the name of the software repository. These are located at
-     the top of every GitHub HTML page as
-     <literal>owner</literal>/<literal>repo</literal>. <literal>rev</literal>
-     corresponds to the Git commit hash or tag (e.g <literal>v1.0</literal>)
-     that will be downloaded from Git. Finally, <literal>sha256</literal>
-     corresponds to the hash of the extracted directory. Again, other hash
-     algorithms are also available but <literal>sha256</literal> is currently
-     preferred.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchFromGitLab</literal>
-   </term>
-   <listitem>
-    <para>
-     This is used with GitLab repositories. The arguments expected are very
-     similar to fetchFromGitHub above.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchFromBitbucket</literal>
-   </term>
-   <listitem>
-    <para>
-     This is used with BitBucket repositories. The arguments expected are very
-     similar to fetchFromGitHub above.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchFromSavannah</literal>
-   </term>
-   <listitem>
-    <para>
-     This is used with Savannah repositories. The arguments expected are very
-     similar to fetchFromGitHub above.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>fetchFromRepoOrCz</literal>
-   </term>
-   <listitem>
-    <para>
-     This is used with repo.or.cz repositories. The arguments expected are very
-     similar to fetchFromGitHub above.
-    </para>
-   </listitem>
-  </varlistentry>
- </variablelist>
-</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,29 +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/asserts.xml" />
-
- <xi:include href="./library/attrsets.xml" />
-
-<!-- These docs are generated via nixdoc. To add another generated
-      library function file to this list, the file
-      `lib-function-docs.nix` must also be updated. -->
-
- <xi:include href="./library/generated/strings.xml" />
-
- <xi:include href="./library/generated/trivial.xml" />
-
- <xi:include href="./library/generated/lists.xml" />
-
- <xi:include href="./library/generated/debug.xml" />
-
- <xi:include href="./library/generated/options.xml" />
-</section>

doc/functions/library/asserts.xml

@@ -1,117 +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-asserts">
- <title>Assert functions</title>
-
- <section xml:id="function-library-lib.asserts.assertMsg">
-  <title><function>lib.asserts.assertMsg</function></title>
-
-  <subtitle><literal>assertMsg :: Bool -> String -> Bool</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.asserts.assertMsg" />
-
-  <para>
-   Print a trace message if <literal>pred</literal> is false.
-  </para>
-
-  <para>
-   Intended to be used to augment asserts with helpful error messages.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>pred</varname>
-    </term>
-    <listitem>
-     <para>
-      Condition under which the <varname>msg</varname> should
-      <emphasis>not</emphasis> be printed.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>msg</varname>
-    </term>
-    <listitem>
-     <para>
-      Message to print.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.asserts.assertMsg-example-false">
-   <title>Printing when the predicate is false</title>
-<programlisting><![CDATA[
-assert lib.asserts.assertMsg ("foo" == "bar") "foo is not bar, silly"
-stderr> trace: foo is not bar, silly
-stderr> assert failed
-]]></programlisting>
-  </example>
- </section>
-
- <section xml:id="function-library-lib.asserts.assertOneOf">
-  <title><function>lib.asserts.assertOneOf</function></title>
-
-  <subtitle><literal>assertOneOf :: String -> String ->
-      StringList -> Bool</literal>
-  </subtitle>
-
-  <xi:include href="./locations.xml" xpointer="lib.asserts.assertOneOf" />
-
-  <para>
-   Specialized <function>asserts.assertMsg</function> for checking if
-   <varname>val</varname> is one of the elements of <varname>xs</varname>.
-   Useful for checking enums.
-  </para>
-
-  <variablelist>
-   <varlistentry>
-    <term>
-     <varname>name</varname>
-    </term>
-    <listitem>
-     <para>
-      The name of the variable the user entered <varname>val</varname> into,
-      for inclusion in the error message.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>val</varname>
-    </term>
-    <listitem>
-     <para>
-      The value of what the user provided, to be compared against the values in
-      <varname>xs</varname>.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>xs</varname>
-    </term>
-    <listitem>
-     <para>
-      The list of valid values.
-     </para>
-    </listitem>
-   </varlistentry>
-  </variablelist>
-
-  <example xml:id="function-library-lib.asserts.assertOneOf-example">
-   <title>Ensuring a user provided a possible value</title>
-<programlisting><![CDATA[
-let sslLibrary = "bearssl";
-in lib.asserts.assertOneOf "sslLibrary" sslLibrary [ "openssl" "bearssl" ];
-=> false
-stderr> trace: sslLibrary must be one of "openssl", "libressl", but is: "bearssl"
-        ]]></programlisting>
-  </example>
- </section>
-</section>

doc/functions/nix-gitignore.xml

@@ -1,84 +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-nix-gitignore">
- <title>pkgs.nix-gitignore</title>
-
- <para>
-  <function>pkgs.nix-gitignore</function> is a function that acts similarly to
-  <literal>builtins.filterSource</literal> but also allows filtering with the
-  help of the gitignore format.
- </para>
-
- <section xml:id="sec-pkgs-nix-gitignore-usage">
-  <title>Usage</title>
-
-  <para>
-   <literal>pkgs.nix-gitignore</literal> exports a number of functions, but
-   you'll most likely need either <literal>gitignoreSource</literal> or
-   <literal>gitignoreSourcePure</literal>. As their first argument, they both
-   accept either 1. a file with gitignore lines or 2. a string with gitignore
-   lines, or 3. a list of either of the two. They will be concatenated into a
-   single big string.
-  </para>
-
-<programlisting><![CDATA[
-{ pkgs ? import <nixpkgs> {} }:
-
- nix-gitignore.gitignoreSource [] ./source
-     # Simplest version
-
- nix-gitignore.gitignoreSource "supplemental-ignores\n" ./source
-     # This one reads the ./source/.gitignore and concats the auxiliary ignores
-
- nix-gitignore.gitignoreSourcePure "ignore-this\nignore-that\n" ./source
-     # Use this string as gitignore, don't read ./source/.gitignore.
-
- nix-gitignore.gitignoreSourcePure ["ignore-this\nignore-that\n", ~/.gitignore] ./source
-     # It also accepts a list (of strings and paths) that will be concatenated
-     # once the paths are turned to strings via readFile.
-  ]]></programlisting>
-
-  <para>
-   These functions are derived from the <literal>Filter</literal> functions by
-   setting the first filter argument to <literal>(_: _: true)</literal>:
-  </para>
-
-<programlisting><![CDATA[
-gitignoreSourcePure = gitignoreFilterSourcePure (_: _: true);
-gitignoreSource = gitignoreFilterSource (_: _: true);
-  ]]></programlisting>
-
-  <para>
-   Those filter functions accept the same arguments the
-   <literal>builtins.filterSource</literal> function would pass to its filters,
-   thus <literal>fn: gitignoreFilterSourcePure fn ""</literal> should be
-   extensionally equivalent to <literal>filterSource</literal>. The file is
-   blacklisted iff it's blacklisted by either your filter or the
-   gitignoreFilter.
-  </para>
-
-  <para>
-   If you want to make your own filter from scratch, you may use
-  </para>
-
-<programlisting><![CDATA[
-gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root;
-  ]]></programlisting>
- </section>
-
- <section xml:id="sec-pkgs-nix-gitignore-usage-recursive">
-  <title>gitignore files in subdirectories</title>
-
-  <para>
-   If you wish to use a filter that would search for .gitignore files in
-   subdirectories, just like git does by default, use this function:
-  </para>
-
-<programlisting><![CDATA[
-gitignoreFilterRecursiveSource = filter: patterns: root:
-# OR
-gitignoreRecursiveSource = gitignoreFilterSourcePure (_: _: true);
-  ]]></programlisting>
- </section>
-</section>

doc/functions/ocitools.xml

@@ -1,76 +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-ociTools">
- <title>pkgs.ociTools</title>
-
- <para>
-  <varname>pkgs.ociTools</varname> is a set of functions for creating
-  containers according to the
-  <link xlink:href="https://github.com/opencontainers/runtime-spec">OCI
-  container specification v1.0.0</link>. Beyond that it makes no assumptions
-  about the container runner you choose to use to run the created container.
- </para>
-
- <section xml:id="ssec-pkgs-ociTools-buildContainer">
-  <title>buildContainer</title>
-
-  <para>
-   This function creates a simple OCI container that runs a single command
-   inside of it. An OCI container consists of a <varname>config.json</varname>
-   and a rootfs directory.The nix store of the container will contain all
-   referenced dependencies of the given command.
-  </para>
-
-  <para>
-   The parameters of <varname>buildContainer</varname> with an example value
-   are described below:
-  </para>
-
-  <example xml:id='ex-ociTools-buildContainer'>
-   <title>Build Container</title>
-<programlisting>
-buildContainer {
-  args = [ (with pkgs; writeScript "run.sh" ''
-    #!${bash}/bin/bash
-    ${coreutils}/bin/exec ${bash}/bin/bash
-  '').outPath ]; <co xml:id='ex-ociTools-buildContainer-1' />
-
-  mounts = {
-    "/data" = {
-      type = "none";
-      source = "/var/lib/mydata";
-      options = [ "bind" ];
-    };
-  };<co xml:id='ex-ociTools-buildContainer-2' />
-
-  readonly = false; <co xml:id='ex-ociTools-buildContainer-3' />
-}
-
-    </programlisting>
-   <calloutlist>
-    <callout arearefs='ex-ociTools-buildContainer-1'>
-     <para>
-      <varname>args</varname> specifies a set of arguments to run inside the container.
-      This is the only required argument for <varname>buildContainer</varname>.
-      All referenced packages inside the derivation will be made available
-      inside the container
-     </para>
-    </callout>
-    <callout arearefs='ex-ociTools-buildContainer-2'>
-     <para>
-      <varname>mounts</varname> specifies additional mount points chosen by the
-      user. By default only a minimal set of necessary filesystems are mounted
-      into the container (e.g procfs, cgroupfs)
-     </para>
-    </callout>
-    <callout arearefs='ex-ociTools-buildContainer-3'>
-     <para>
-       <varname>readonly</varname> makes the container's rootfs read-only if it is set to true.
-       The default value is false <literal>false</literal>.
-     </para>
-    </callout>
-   </calloutlist>
-  </example>
- </section>
-</section>

doc/functions/overrides.xml

@@ -1,212 +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.
- </para>
-
- <para>
-  These functions are used to make changes to packages, returning only single
-  packages. <link xlink:href="#chap-overlays">Overlays</link>, on the other
-  hand, can be used to combine the overridden packages across the entire
-  package set of Nixpkgs.
- </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>
-<!-- TODO: move below programlisting to a new section about extending and overlays
-           and reference it
-  -->
-<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>stdenv.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 it 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/prefer-remote-fetch.xml

@@ -1,25 +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-prefer-remote-fetch">
- <title>prefer-remote-fetch overlay</title>
-
- <para>
-  <function>prefer-remote-fetch</function> is an overlay that download sources
-  on remote builder. This is useful when the evaluating machine has a slow
-  upload while the builder can fetch faster directly from the source. To use
-  it, put the following snippet as a new overlay:
-<programlisting>
-self: super:
-  (super.prefer-remote-fetch self super)
-</programlisting>
-  A full configuration example for that sets the overlay up for your own
-  account, could look like this
-<screen>
-<prompt>$ </prompt>mkdir ~/.config/nixpkgs/overlays/
-<prompt>$ </prompt>cat &gt; ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix &lt;&lt;EOF
-  self: super: super.prefer-remote-fetch self super
-EOF
-</screen>
- </para>
-</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/functions/snap/example-firefox.nix

@@ -1,28 +0,0 @@
-let
-  inherit (import <nixpkgs> { }) snapTools firefox;
-in snapTools.makeSnap {
-  meta = {
-    name = "nix-example-firefox";
-    summary = firefox.meta.description;
-    architectures = [ "amd64" ];
-    apps.nix-example-firefox = {
-      command = "${firefox}/bin/firefox";
-      plugs = [
-        "pulseaudio"
-        "camera"
-        "browser-support"
-        "avahi-observe"
-        "cups-control"
-        "desktop"
-        "desktop-legacy"
-        "gsettings"
-        "home"
-        "network"
-        "mount-observe"
-        "removable-media"
-        "x11"
-      ];
-    };
-    confinement = "strict";
-  };
-}

doc/functions/snap/example-hello.nix

@@ -1,12 +0,0 @@
-let
-  inherit (import <nixpkgs> { }) snapTools hello;
-in snapTools.makeSnap {
-  meta = {
-    name = "hello";
-    summary = hello.meta.description;
-    description = hello.meta.longDescription;
-    architectures = [ "amd64" ];
-    confinement = "strict";
-    apps.hello.command = "${hello}/bin/hello";
-  };
-}

doc/functions/snaptools.xml

@@ -1,74 +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-snapTools">
- <title>pkgs.snapTools</title>
-
- <para>
-  <varname>pkgs.snapTools</varname> is a set of functions for creating
-  Snapcraft images. Snap and Snapcraft is not used to perform these operations.
- </para>
-
- <section xml:id="ssec-pkgs-snapTools-makeSnap-signature">
-  <title>The makeSnap Function</title>
-
-  <para>
-   <function>makeSnap</function> takes a single named argument,
-   <parameter>meta</parameter>. This argument mirrors
-   <link xlink:href="https://docs.snapcraft.io/snap-format">the upstream
-   <filename>snap.yaml</filename> format</link> exactly.
-  </para>
-
-  <para>
-   The <parameter>base</parameter> should not be be specified, as
-   <function>makeSnap</function> will force set it.
-  </para>
-
-  <para>
-   Currently, <function>makeSnap</function> does not support creating GUI
-   stubs.
-  </para>
- </section>
-
- <section xml:id="ssec-pkgs-snapTools-build-a-snap-hello">
-  <title>Build a Hello World Snap</title>
-
-  <example xml:id="ex-snapTools-buildSnap-hello">
-   <title>Making a Hello World Snap</title>
-   <para>
-    The following expression packages GNU Hello as a Snapcraft snap.
-   </para>
-<programlisting><xi:include href="./snap/example-hello.nix" parse="text" /></programlisting>
-   <para>
-    <command>nix-build</command> this expression and install it with
-    <command>snap install ./result --dangerous</command>.
-    <command>hello</command> will now be the Snapcraft version of the package.
-   </para>
-  </example>
- </section>
-
- <section xml:id="ssec-pkgs-snapTools-build-a-snap-firefox">
-  <title>Build a Hello World Snap</title>
-
-  <example xml:id="ex-snapTools-buildSnap-firefox">
-   <title>Making a Graphical Snap</title>
-   <para>
-    Graphical programs require many more integrations with the host. This
-    example uses Firefox as an example, because it is one of the most
-    complicated programs we could package.
-   </para>
-<programlisting><xi:include href="./snap/example-firefox.nix" parse="text" /></programlisting>
-   <para>
-    <command>nix-build</command> this expression and install it with
-    <command>snap install ./result --dangerous</command>.
-    <command>nix-example-firefox</command> will now be the Snapcraft version of
-    the Firefox package.
-   </para>
-   <para>
-    The specific meaning behind plugs can be looked up in the
-    <link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft
-    interface documentation</link>.
-   </para>
-  </example>
- </section>
-</section>

doc/functions/trivial-builders.xml

@@ -1,113 +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-trivial-builders">
- <title>Trivial builders</title>
-
- <para>
-  Nixpkgs provides a couple of functions that help with building derivations.
-  The most important one, <function>stdenv.mkDerivation</function>, has already
-  been documented above. The following functions wrap
-  <function>stdenv.mkDerivation</function>, making it easier to use in certain
-  cases.
- </para>
-
- <variablelist>
-  <varlistentry>
-   <term>
-    <literal>runCommand</literal>
-   </term>
-   <listitem>
-    <para>
-     This takes three arguments, <literal>name</literal>,
-     <literal>env</literal>, and <literal>buildCommand</literal>.
-     <literal>name</literal> is just the name that Nix will append to the store
-     path in the same way that <literal>stdenv.mkDerivation</literal> uses its
-     <literal>name</literal> attribute. <literal>env</literal> is an attribute
-     set specifying environment variables that will be set for this derivation.
-     These attributes are then passed to the wrapped
-     <literal>stdenv.mkDerivation</literal>. <literal>buildCommand</literal>
-     specifies the commands that will be run to create this derivation. Note
-     that you will need to create <literal>$out</literal> for Nix to register
-     the command as successful.
-    </para>
-    <para>
-     An example of using <literal>runCommand</literal> is provided below.
-    </para>
-<programlisting>
-(import &lt;nixpkgs&gt; {}).runCommand "my-example" {} ''
-  echo My example command is running
-
-  mkdir $out
-
-  echo I can write data to the Nix store > $out/message
-
-  echo I can also run basic commands like:
-
-  echo ls
-  ls
-
-  echo whoami
-  whoami
-
-  echo date
-  date
-''
-</programlisting>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>runCommandCC</literal>
-   </term>
-   <listitem>
-    <para>
-     This works just like <literal>runCommand</literal>. The only difference is
-     that it also provides a C compiler in <literal>buildCommand</literal>’s
-     environment. To minimize your dependencies, you should only use this if
-     you are sure you will need a C compiler as part of running your command.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>writeTextFile</literal>, <literal>writeText</literal>, <literal>writeTextDir</literal>, <literal>writeScript</literal>, <literal>writeScriptBin</literal>
-   </term>
-   <listitem>
-    <para>
-     These functions write <literal>text</literal> to the Nix store. This is
-     useful for creating scripts from Nix expressions.
-     <literal>writeTextFile</literal> takes an attribute set and expects two
-     arguments, <literal>name</literal> and <literal>text</literal>.
-     <literal>name</literal> corresponds to the name used in the Nix store
-     path. <literal>text</literal> will be the contents of the file. You can
-     also set <literal>executable</literal> to true to make this file have the
-     executable bit set.
-    </para>
-    <para>
-     Many more commands wrap <literal>writeTextFile</literal> including
-     <literal>writeText</literal>, <literal>writeTextDir</literal>,
-     <literal>writeScript</literal>, and <literal>writeScriptBin</literal>.
-     These are convenience functions over <literal>writeTextFile</literal>.
-    </para>
-   </listitem>
-  </varlistentry>
-  <varlistentry>
-   <term>
-    <literal>symlinkJoin</literal>
-   </term>
-   <listitem>
-    <para>
-     This can be used to put many derivations into the same directory
-     structure. It works by creating a new derivation and adding symlinks to
-     each of the paths listed. It expects two arguments,
-     <literal>name</literal>, and <literal>paths</literal>.
-     <literal>name</literal> is the name used in the Nix store path for the
-     created derivation. <literal>paths</literal> is a list of paths that will
-     be symlinked. These paths can be to Nix store derivations or any other
-     subdirectory contained within.
-    </para>
-   </listitem>
-  </varlistentry>
- </variablelist>
-</section>

doc/introduction.chapter.md

@@ -1,51 +0,0 @@
----
-title: Introduction
-author: Frederik Rietdijk
-date: 2015-11-25
----
-
-# Introduction
-
-The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
-[Nix package manager](http://nixos.org/nix/), released under a
-[permissive MIT/X11 license](https://github.com/NixOS/nixpkgs/blob/master/COPYING).
-Packages are available for several platforms, and can be used with the Nix
-package manager on most GNU/Linux distributions as well as NixOS.
-
-This manual primarily describes how to write packages for the Nix Packages collection
-(Nixpkgs). Thus it’s mainly for packagers and developers who want to add packages to
-Nixpkgs. If you like to learn more about the Nix package manager and the Nix
-expression language, then you are kindly referred to the [Nix manual](http://nixos.org/nix/manual/).
-
-## Overview of Nixpkgs
-
-Nix expressions describe how to build packages from source and are collected in
-the [nixpkgs repository](https://github.com/NixOS/nixpkgs). Also included in the
-collection are Nix expressions for
-[NixOS modules](http://nixos.org/nixos/manual/index.html#sec-writing-modules).
-With these expressions the Nix package manager can build binary packages.
-
-Packages, including the Nix packages collection, are distributed through
-[channels](http://nixos.org/nix/manual/#sec-channels). The collection is
-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
-security updates. More up to date packages and modules are available via the
-`nixos-unstable` channel.
-
-Both `nixos-unstable` and `nixpkgs` follow the `master` branch of the Nixpkgs
-repository, although both do lag the `master` branch by generally
-[a couple of days](http://howoldis.herokuapp.com/). Updates to a channel are
-distributed as soon as all tests for that channel pass, e.g.
-[this table](http://hydra.nixos.org/job/nixpkgs/trunk/unstable#tabs-constituents)
-shows the status of tests for the `nixpkgs` channel.
-
-The tests are conducted by a cluster called [Hydra](http://nixos.org/hydra/),
-which also builds binary packages from the Nix expressions in Nixpkgs for
-`x86_64-linux`, `i686-linux` and `x86_64-darwin`.
-The binaries are made available via a [binary cache](https://cache.nixos.org).
-
-The current Nix expressions of the channels are available in the
-[`nixpkgs-channels`](https://github.com/NixOS/nixpkgs-channels) repository,
-which has branches corresponding to the available channels.

doc/introduction.md

@@ -0,0 +1,53 @@
+---
+title: Introduction
+author: Frederik Rietdijk
+date: 2015-11-25
+---
+
+# Introduction
+
+The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
+[Nix package manager](http://nixos.org/nix/), released under a
+[permissive MIT/X11 license](https://github.com/NixOS/nixpkgs/blob/master/COPYING).
+Packages are available for several platforms, and can be used with the Nix
+package manager on most GNU/Linux distributions as well as NixOS.
+
+This manual primarily describes how to write packages for the Nix Packages collection
+(Nixpkgs). Thus it’s mainly for packagers and developers who want to add packages to
+Nixpkgs. If you like to learn more about the Nix package manager and the Nix
+expression language, then you are kindly referred to the [Nix manual](http://nixos.org/nix/manual/).
+
+## Overview of Nixpkgs
+
+Nix expressions describe how to build packages from source and are collected in
+the [nixpkgs repository](https://github.com/NixOS/nixpkgs). Also included in the
+collection are Nix expressions for
+[NixOS modules](http://nixos.org/nixos/manual/index.html#sec-writing-modules).
+With these expressions the Nix package manager can build binary packages.
+
+Packages, including the Nix packages collection, are distributed through
+[channels](http://nixos.org/nix/manual/#sec-channels). The collection is
+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. 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.
+
+Both `nixos-unstable` and `nixpkgs` follow the `master` branch of the Nixpkgs
+repository, although both do lag the `master` branch by generally
+[a couple of days](http://howoldis.herokuapp.com/). Updates to a channel are
+distributed as soon as all tests for that channel pass, e.g.
+[this table](http://hydra.nixos.org/job/nixpkgs/trunk/unstable#tabs-constituents)
+shows the status of tests for the `nixpkgs` channel.
+
+The tests are conducted by a cluster called [Hydra](http://nixos.org/hydra/),
+which also builds binary packages from the Nix expressions in Nixpkgs for
+`x86_64-linux`, `i686-linux` and `x86_64-darwin`.
+The binaries are made available via a [binary cache](https://cache.nixos.org).
+
+The current Nix expressions of the channels are available in the
+[`nixpkgs-channels`](https://github.com/NixOS/nixpkgs-channels) repository,
+which has branches corresponding to the available channels. There is also the
+[Nixpkgs Monitor](http://monitor.nixos.org) which keeps track of updates
+and security vulnerabilities.

doc/languages-frameworks/android.section.md

@@ -1,239 +0,0 @@
----
-title: Android
-author: Sander van der Burg
-date: 2018-11-18
----
-# Android
-
-The Android build environment provides three major features and a number of
-supporting features.
-
-Deploying an Android SDK installation with plugins
---------------------------------------------------
-The first use case is deploying the SDK with a desired set of plugins or subsets
-of an SDK.
-
-```nix
-with import <nixpkgs> {};
-
-let
-  androidComposition = androidenv.composeAndroidPackages {
-    toolsVersion = "25.2.5";
-    platformToolsVersion = "27.0.1";
-    buildToolsVersions = [ "27.0.3" ];
-    includeEmulator = false;
-    emulatorVersion = "27.2.0";
-    platformVersions = [ "24" ];
-    includeSources = false;
-    includeDocs = false;
-    includeSystemImages = false;
-    systemImageTypes = [ "default" ];
-    abiVersions = [ "armeabi-v7a" ];
-    lldbVersions = [ "2.0.2558144" ];
-    cmakeVersions = [ "3.6.4111459" ];
-    includeNDK = false;
-    ndkVersion = "16.1.4479499";
-    useGoogleAPIs = false;
-    useGoogleTVAddOns = false;
-    includeExtras = [
-      "extras;google;gcm"
-    ];
-  };
-in
-androidComposition.androidsdk
-```
-
-The above function invocation states that we want an Android SDK with the above
-specified plugin versions. By default, most plugins are disabled. Notable
-exceptions are the tools, platform-tools and build-tools sub packages.
-
-The following parameters are supported:
-
-* `toolsVersion`, specifies the version of the tools package to use
-* `platformsToolsVersion` specifies the version of the `platform-tools` plugin
-* `buildToolsVersion` specifies the versions of the `build-tools` plugins to
-  use.
-* `includeEmulator` specifies whether to deploy the emulator package (`false`
-  by default). When enabled, the version of the emulator to deploy can be
-  specified by setting the `emulatorVersion` parameter.
-* `includeDocs` specifies whether the documentation catalog should be included.
-* `lldbVersions` specifies what LLDB versions should be deployed.
-* `cmakeVersions` specifies which CMake versions should be deployed.
-* `includeNDK` specifies that the Android NDK bundle should be included.
-  Defaults to: `false`.
-* `ndkVersion` specifies the NDK version that we want to use.
-* `includeExtras` is an array of identifier strings referring to arbitrary
-  add-on packages that should be installed.
-* `platformVersions` specifies which platform SDK versions should be included.
-
-For each platform version that has been specified, we can apply the following
-options:
-
-* `includeSystemImages` specifies whether a system image for each platform SDK
-  should be included.
-* `includeSources` specifies whether the sources for each SDK version should be
-  included.
-* `useGoogleAPIs` specifies that for each selected platform version the
-  Google API should be included.
-* `useGoogleTVAddOns` specifies that for each selected platform version the
-  Google TV add-on should be included.
-
-For each requested system image we can specify the following options:
-
-* `systemImageTypes` specifies what kind of system images should be included.
-  Defaults to: `default`.
-* `abiVersions` specifies what kind of ABI version of each system image should
-  be included. Defaults to: `armeabi-v7a`.
-
-Most of the function arguments have reasonable default settings.
-
-When building the above expression with:
-
-```bash
-$ nix-build
-```
-
-The Android SDK gets deployed with all desired plugin versions.
-
-We can also deploy subsets of the Android SDK. For example, to only the the
-`platform-tools` package, you can evaluate the following expression:
-
-```nix
-with import <nixpkgs> {};
-
-let
-  androidComposition = androidenv.composeAndroidPackages {
-    # ...
-  };
-in
-androidComposition.platform-tools
-```
-
-Using predefine Android package compositions
---------------------------------------------
-In addition to composing an Android package set manually, it is also possible
-to use a predefined composition that contains all basic packages for a specific
-Android version, such as version 9.0 (API-level 28).
-
-The following Nix expression can be used to deploy the entire SDK with all basic
-plugins:
-
-```nix
-with import <nixpkgs> {};
-
-androidenv.androidPkgs_9_0.androidsdk
-```
-
-It is also possible to use one plugin only:
-
-```nix
-with import <nixpkgs> {};
-
-androidenv.androidPkgs_9_0.platform-tools
-```
-
-Building an Android application
--------------------------------
-In addition to the SDK, it is also possible to build an Ant-based Android
-project and automatically deploy all the Android plugins that a project
-requires.
-
-```nix
-with import <nixpkgs> {};
-
-androidenv.buildApp {
-  name = "MyAndroidApp";
-  src = ./myappsources;
-  release = true;
-
-  # If release is set to true, you need to specify the following parameters
-  keyStore = ./keystore;
-  keyAlias = "myfirstapp";
-  keyStorePassword = "mykeystore";
-  keyAliasPassword = "myfirstapp";
-
-  # Any Android SDK parameters that install all the relevant plugins that a
-  # build requires
-  platformVersions = [ "24" ];
-
-  # When we include the NDK, then ndk-build is invoked before Ant gets invoked
-  includeNDK = true;
-}
-```
-
-Aside from the app-specific build parameters (`name`, `src`, `release` and
-keystore parameters), the `buildApp {}` function supports all the function
-parameters that the SDK composition function (the function shown in the
-previous section) supports.
-
-This build function is particularly useful when it is desired to use
-[Hydra](http://nixos.org/hydra): the Nix-based continuous integration solution
-to build Android apps. An Android APK gets exposed as a build product and can be
-installed on any Android device with a web browser by navigating to the build
-result page.
-
-Spawning emulator instances
----------------------------
-For testing purposes, it can also be quite convenient to automatically generate
-scripts that spawn emulator instances with all desired configuration settings.
-
-An emulator spawn script can be configured by invoking the `emulateApp {}`
-function:
-
-```nix
-with import <nixpkgs> {};
-
-androidenv.emulateApp {
-  name = "emulate-MyAndroidApp";
-  platformVersion = "28";
-  abiVersion = "x86_64"; # armeabi-v7a, mips, x86
-  systemImageType = "google_apis_playstore";
-}
-```
-
-It is also possible to specify an APK to deploy inside the emulator
-and the package and activity names to launch it:
-
-```nix
-with import <nixpkgs> {};
-
-androidenv.emulateApp {
-  name = "emulate-MyAndroidApp";
-  platformVersion = "24";
-  abiVersion = "armeabi-v7a"; # mips, x86, x86_64
-  systemImageType = "default";
-  useGoogleAPIs = false;
-  app = ./MyApp.apk;
-  package = "MyApp";
-  activity = "MainActivity";
-}
-```
-
-In addition to prebuilt APKs, you can also bind the APK parameter to a
-`buildApp {}` function invocation shown in the previous example.
-
-Querying the available versions of each plugin
-----------------------------------------------
-When using any of the previously shown functions, it may be a bit inconvenient
-to find out what options are supported, since the Android SDK provides many
-plugins.
-
-A shell script in the `pkgs/development/mobile/androidenv/` sub directory can be used to retrieve all
-possible options:
-
-```bash
-sh ./querypackages.sh packages build-tools
-```
-
-The above command-line instruction queries all build-tools versions in the
-generated `packages.nix` expression.
-
-Updating the generated expressions
-----------------------------------
-Most of the Nix expressions are generated from XML files that the Android
-package manager uses. To update the expressions run the `generate.sh` script
-that is stored in the `pkgs/development/mobile/androidenv/` sub directory:
-
-```bash
-sh ./generate.sh
-```

doc/languages-frameworks/beam.xml

@@ -1,138 +1,65 @@
 <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 &amp; Elixir)</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 Virtial Machine and, as far as we know,
+      from a packaging perspective all languages that run on Beam are
+      interchangable. The things that do change, like the build
+      system, are transperant to the users of the package. So we make
+      no distinction.
     </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>
-   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">
+  </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>
+    <title>Rebar3</title>
+    <para>
+      By default Rebar3 wants to manage it's own dependencies. In the
+      normal non-Nix, this is perfectly acceptable. In the Nix world it
+      is not. To support this we have created two versions of rebar3,
+      <literal>rebar3</literal> and <literal>rebar3-open</literal>. The
+      <literal>rebar3</literal> version has been patched to remove the
+      ability to download anything from it. If you are not running it a
+      nix-shell or a nix-build then its probably not going to work for
+      you. <literal>rebar3-open</literal> is the normal, un-modified
+      rebar3. It should work exactly as would any other version of
+      rebar3. Any Erlang package should rely on
+      <literal>rebar3</literal> and thats really what you should be
+      using too.
+    </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 you would expect. There
+      is a bootstrap process that needs to be run for both of
+      them. However, that is supported by the
+      <literal>buildMix</literal> and <literal>buildErlangMk</literal> derivations.
+    </para>
   </section>
- </section>
 
- <section xml:id="how-to-install-beam-packages">
-  <title>How to Install BEAM Packages</title>
+</section>
 
+<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 in the top level simply because
+    they are not relevant to the vast majority of Nix users. They are
+    installable using the <literal>beamPackages</literal> attribute
+    set.
+
+    You can list the avialable packages in the
+    <literal>beamPackages</literal> with the following command:
   </para>
 
-<screen>
-<prompt>$ </prompt>nix-env -f &quot;&lt;nixpkgs&gt;&quot; -qaP -A beamPackages
+  <programlisting>
+$ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -qaP -A beamPackages
 beamPackages.esqlite    esqlite-0.2.1
 beamPackages.goldrush   goldrush-0.1.7
 beamPackages.ibrowse    ibrowse-4.2.2
@@ -140,256 +67,192 @@ beamPackages.jiffy      jiffy-0.14.5
 beamPackages.lager      lager-3.0.2
 beamPackages.meck       meck-0.8.3
 beamPackages.rebar3-pc  pc-1.1.0
-</screen>
-
+  </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>
-
-<screen>
-<prompt>$ </prompt>nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
-</screen>
-
+  <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 packages corresponds to the name
+    of that particular package in Hex or its OTP Application/Release name.
   </para>
- </section>
-
- <section xml:id="packaging-beam-applications">
-  <title>Packaging BEAM Applications</title>
-
+</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
+    <title>Erlang Applications</title>
+    <section xml:id="rebar3-packages">
+      <title>Rebar3 Packages</title>
+      <para>
+        There is a Nix functional called
+        <literal>buildRebar3</literal>. We use this function to make a
+        derivation that understands how to build the rebar3 project. For
+        example, the epression we use to build the <link
         xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>
-     as follows:
-    </para>
+        project follows.
+      </para>
+      <programlisting>
+        {stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }:
 
-<programlisting>
-{ stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }:
+          buildRebar3 rec {
+            name = "hex2nix";
+            version = "0.0.1";
 
-buildRebar3 rec {
-  name = "hex2nix";
-  version = "0.0.1";
+            src = fetchFromGitHub {
+              owner = "ericbmerritt";
+              repo = "hex2nix";
+              rev = "${version}";
+              sha256 = "1w7xjidz1l5yjmhlplfx7kphmnpvqm67w99hd2m7kdixwdxq0zqg";
+            };
 
-  src = fetchFromGitHub {
-    owner = "ericbmerritt";
-    repo = "hex2nix";
-    rev = "${version}";
-    sha256 = "1w7xjidz1l5yjmhlplfx7kphmnpvqm67w99hd2m7kdixwdxq0zqg";
-  };
+          beamDeps = [ ibrowse jsx erlware_commons ];
+        }
+      </programlisting>
+      <para>
+        The only visible difference between this derivation and
+        something like <literal>stdenv.mkDerivation</literal> is that we
+        have added <literal>erlangDeps</literal> to the derivation. If
+        you add your Beam dependencies here they will be correctly
+        handled by the system.
+      </para>
+      <para>
+        If your package needs to compile native code via Rebar's port
+        compilation mechenism. You should 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 almost identically to Rebar. The only real
+        difference is that <literal>buildErlangMk</literal> is called
+        instead of <literal>buildRebar3</literal>
+      </para>
+      <programlisting>
+        { buildErlangMk, fetchHex,  cowlib, ranch }:
+          buildErlangMk {
+            name = "cowboy";
+            version = "1.0.4";
+            src = fetchHex {
+              pkg = "cowboy";
+              version = "1.0.4";
+              sha256 =
+                "6a0edee96885fae3a8dd0ac1f333538a42e807db638a9453064ccfdaa6b9fdac";
+            };
+            beamDeps  = [ cowlib ranch ];
 
-  beamDeps = [ ibrowse jsx erlware_commons ];
-}
-</programlisting>
+            meta = {
+              description = ''Small, fast, modular HTTP server written in
+                            Erlang.'';
+              license = stdenv.lib.licenses.isc;
+              homepage = "https://github.com/ninenines/cowboy";
+            };
+        }
+      </programlisting>
+    </section>
+    <section xml:id="mix-packages">
+      <title>Mix Packages</title>
+      <para>
+        Mix functions almost identically to Rebar. The only real
+        difference is that <literal>buildMix</literal> is called
+        instead of <literal>buildRebar3</literal>
+      </para>
+      <programlisting>
+        { buildMix, fetchHex, plug, absinthe }:
+        buildMix {
+          name = "absinthe_plug";
+          version = "1.0.0";
+          src = fetchHex {
+            pkg = "absinthe_plug";
+            version = "1.0.0";
+            sha256 =
+              "08459823fe1fd4f0325a8bf0c937a4520583a5a26d73b193040ab30a1dfc0b33";
+          };
+          beamDeps  = [ plug absinthe];
 
-    <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 {
-  name = "cowboy";
-  version = "1.0.4";
-
-  src = fetchHex {
-    pkg = "cowboy";
-    version = "1.0.4";
-    sha256 = "6a0edee96885fae3a8dd0ac1f333538a42e807db638a9453064ccfdaa6b9fdac";
-  };
-
-  beamDeps = [ cowlib ranch ];
-
-  meta = {
-    description = ''
-      Small, fast, modular HTTP server written in Erlang
-    '';
-    license = stdenv.lib.licenses.isc;
-    homepage = https://github.com/ninenines/cowboy;
-  };
-}
-</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 {
-  name = "absinthe_plug";
-  version = "1.0.0";
-
-  src = fetchHex {
-    pkg = "absinthe_plug";
-    version = "1.0.0";
-    sha256 = "08459823fe1fd4f0325a8bf0c937a4520583a5a26d73b193040ab30a1dfc0b33";
-  };
-
-  beamDeps = [ plug absinthe ];
-
-  meta = {
-    description = ''
-      A plug for Absinthe, an experimental GraphQL toolkit
-    '';
-    license = stdenv.lib.licenses.bsd3;
-    homepage = https://github.com/CargoSense/absinthe_plug;
-  };
-}
-</programlisting>
-
-    <para>
-     Alternatively, we can use <literal>buildHex</literal> as a shortcut:
-    </para>
-
-<programlisting>
-{ buildHex, buildMix, plug, absinthe }:
-
-buildHex {
-  name = "absinthe_plug";
-  version = "1.0.0";
-
-  sha256 = "08459823fe1fd4f0325a8bf0c937a4520583a5a26d73b193040ab30a1dfc0b33";
-
-  builder = buildMix;
-
-  beamDeps = [ plug absinthe ];
-
-  meta = {
-    description = ''
-      A plug for Absinthe, an experimental GraphQL toolkit
-    '';
-    license = stdenv.lib.licenses.bsd3;
-    homepage = https://github.com/CargoSense/absinthe_plug;
- };
-}
-</programlisting>
-   </section>
+          meta = {
+            description = ''A plug for Absinthe, an experimental GraphQL
+                            toolkit'';
+            license = stdenv.lib.licenses.bsd3;
+            homepage = "https://github.com/CargoSense/absinthe_plug";
+         };
+       }
+      </programlisting>
+    </section>
   </section>
- </section>
-
- <section xml:id="how-to-develop">
-  <title>How to Develop</title>
-
+</section>
+<section xml:id="how-to-develop">
+  <title>How to develop</title>
   <section xml:id="accessing-an-environment">
-   <title>Accessing an Environment</title>
+    <title>Accessing an Environment</title>
+    <para>
+      Often, all you want to do is be able to access a valid
+      environment that contains a specific package and its
+      dependencies. we can do that with the <literal>env</literal>
+      part of a derivation. For example, lets say we want to access an
+      erlang repl with ibrowse loaded up. We could do the following.
+    </para>
+    <programlisting>
+      ~/w/nixpkgs ❯❯❯ 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]
 
-   <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>
-
-<screen>
-<prompt>$ </prompt><userinput>nix-shell -A beamPackages.ibrowse.env --run "erl"</userinput>
-<computeroutput>Erlang/OTP 18 [erts-7.0] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false]
-
-Eshell V7.0  (abort with ^G)</computeroutput>
-<prompt>1> </prompt><userinput>m(ibrowse).</userinput>
-<computeroutput>Module: ibrowse
-MD5: 3b3e0137d0cbb28070146978a3392945
-Compiled: January 10 2016, 23:34
-Object file: /nix/store/g1rlf65rdgjs4abbyj4grp37ry7ywivj-ibrowse-4.2.2/lib/erlang/lib/ibrowse-4.2.2/ebin/ibrowse.beam
-Compiler options:  [{outdir,"/tmp/nix-build-ibrowse-4.2.2.drv-0/hex-source-ibrowse-4.2.2/_build/default/lib/ibrowse/ebin"},
-debug_info,debug_info,nowarn_shadow_vars,
-warn_unused_import,warn_unused_vars,warnings_as_errors,
-{i,"/tmp/nix-build-ibrowse-4.2.2.drv-0/hex-source-ibrowse-4.2.2/_build/default/lib/ibrowse/include"}]
-Exports:
-add_config/1                  send_req_direct/7
-all_trace_off/0               set_dest/3
-code_change/3                 set_max_attempts/3
-get_config_value/1            set_max_pipeline_size/3
-get_config_value/2            set_max_sessions/3
-get_metrics/0                 show_dest_status/0
-get_metrics/2                 show_dest_status/1
-handle_call/3                 show_dest_status/2
-handle_cast/2                 spawn_link_worker_process/1
-handle_info/2                 spawn_link_worker_process/2
-init/1                        spawn_worker_process/1
-module_info/0                 spawn_worker_process/2
-module_info/1                 start/0
-rescan_config/0               start_link/0
-rescan_config/1               stop/0
-send_req/3                    stop_worker_process/1
-send_req/4                    stream_close/1
-send_req/5                    stream_next/1
-send_req/6                    terminate/2
-send_req_direct/4             trace_off/0
-send_req_direct/5             trace_off/2
-send_req_direct/6             trace_on/0
-trace_on/2
-ok</computeroutput>
-<prompt>2></prompt>
-</screen>
-
-   <para>
-    Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key
-    to this functionality.
-   </para>
+      Eshell V7.0  (abort with ^G)
+      1> m(ibrowse).
+      Module: ibrowse
+      MD5: 3b3e0137d0cbb28070146978a3392945
+      Compiled: January 10 2016, 23:34
+      Object file: /nix/store/g1rlf65rdgjs4abbyj4grp37ry7ywivj-ibrowse-4.2.2/lib/erlang/lib/ibrowse-4.2.2/ebin/ibrowse.beam
+      Compiler options:  [{outdir,"/tmp/nix-build-ibrowse-4.2.2.drv-0/hex-source-ibrowse-4.2.2/_build/default/lib/ibrowse/ebin"},
+      debug_info,debug_info,nowarn_shadow_vars,
+      warn_unused_import,warn_unused_vars,warnings_as_errors,
+      {i,"/tmp/nix-build-ibrowse-4.2.2.drv-0/hex-source-ibrowse-4.2.2/_build/default/lib/ibrowse/include"}]
+      Exports:
+      add_config/1                  send_req_direct/7
+      all_trace_off/0               set_dest/3
+      code_change/3                 set_max_attempts/3
+      get_config_value/1            set_max_pipeline_size/3
+      get_config_value/2            set_max_sessions/3
+      get_metrics/0                 show_dest_status/0
+      get_metrics/2                 show_dest_status/1
+      handle_call/3                 show_dest_status/2
+      handle_cast/2                 spawn_link_worker_process/1
+      handle_info/2                 spawn_link_worker_process/2
+      init/1                        spawn_worker_process/1
+      module_info/0                 spawn_worker_process/2
+      module_info/1                 start/0
+      rescan_config/0               start_link/0
+      rescan_config/1               stop/0
+      send_req/3                    stop_worker_process/1
+      send_req/4                    stream_close/1
+      send_req/5                    stream_next/1
+      send_req/6                    terminate/2
+      send_req_direct/4             trace_off/0
+      send_req_direct/5             trace_off/2
+      send_req_direct/6             trace_on/0
+      trace_on/2
+      ok
+      2>
+    </programlisting>
+    <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. Many times we need to create a
+      <literal>shell.nix</literal> file and do our development inside
+      of the environment specified by that file. This file looks a lot
+      like the packageing described above. The main difference is that
+      <literal>src</literal> points to project root and we call the
+      package directly.
+    </para>
+    <programlisting>
 { pkgs ? import &quot;&lt;nixpkgs&quot;&gt; {} }:
 
 with pkgs;
@@ -401,24 +264,20 @@ let
         name = "hex2nix";
         version = "0.1.0";
         src = ./.;
-        beamDeps = [ ibrowse jsx erlware_commons ];
+        erlangDeps = [ ibrowse jsx erlware_commons ];
       };
   drv = beamPackages.callPackage f {};
 
 in
-
-  drv
-</programlisting>
-
-   <section xml:id="building-in-a-shell">
-    <title>Building in a Shell (for Mix Projects)</title>
-
+ drv
+    </programlisting>
+    <section xml:id="building-in-a-shell">
+    <title>Building in a shell</title>
     <para>
-     We can leverage the support of the derivation, irrespective of the build
-     derivation, by calling the commands themselves.
+      We can leveral the support of the Derivation, regardless of
+      which build Derivation is called by calling the commands themselv.s
     </para>
-
-<programlisting>
+    <programlisting>
 # =============================================================================
 # Variables
 # =============================================================================
@@ -474,55 +333,44 @@ plt:
 analyze: build plt
         $(NIX_SHELL) --run "mix dialyzer --no-compile"
 
-</programlisting>
-
+    </programlisting>
     <para>
-     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.
+      If you add the <literal>shell.nix</literal> as described and
+      user rebar as follows things should simply work. Aside from the
+      <literal>test</literal>, <literal>plt</literal>, and
+      <literal>analyze</literal> the talks work just fine for all of
+      the build Derivations.
     </para>
-   </section>
   </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>
-
-<screen>
-<prompt>$ </prompt>nix-build -A beamPackages
-</screen>
-
-  <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>
+</section>
+<section xml:id="generating-packages-from-hex-with-hex2nix">
+  <title>Generating Packages from Hex with Hex2Nix</title>
+  <para>
+    Updating the Hex packages requires the use of the
+    <literal>hex2nix</literal> tool. Given the path to the Erlang
+    modules (usually
+    <literal>pkgs/development/erlang-modules</literal>). It will
+    happily dump a file called
+    <literal>hex-packages.nix</literal>. That file will contain all
+    the packages that use a recognized build system in Hex. However,
+    it can't know whether or not all those packages are buildable.
+    </para>
+    <para>
+      To make life easier for our users, it makes good sense to go
+      ahead and attempt to build all those packages and remove the
+      ones that don't build. To do that, simply run the command (in
+      the root of your <literal>nixpkgs</literal> repository). that follows.
+    </para>
+    <programlisting>
+$ nix-build -A beamPackages
+    </programlisting>
+    <para>
+      That will build every package in
+      <literal>beamPackages</literal>. Then you can go through and
+      manually remove the ones that fail. Hopefully, someone will
+      improve <literal>hex2nix</literal> in the future to automate
+      that.
+    </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,64 +1,41 @@
 <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 extensions (plugins) might require OCaml and sometimes other OCaml
-  packages. The <literal>coq.ocamlPackages</literal> attribute can be used to
-  depend on the same package set Coq was built against.
- </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 {
-  name = "coq${coq.coq-version}-multinomials-${version}";
-  version = "1.0";
-  src = fetchFromGitHub {
-    owner = "math-comp";
-    repo = "multinomials";
-    rev = version;
-    sha256 = "1qmbxp1h81cy3imh627pznmng0kvv37k4hrwi2faa101s6bcx55m";
+<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. The exact
+    versions that were used to build Coq are saved in the
+    <literal>coq.ocaml</literal> and <literal>coq.camlp5</literal>
+    attributes.
+  </para>
+  <para>
+    Here is a simple package example. It is a pure Coq library, thus it
+    only depends on Coq. 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, fetchurl, coq}:
+stdenv.mkDerivation {
+  src = fetchurl {
+    url = http://coq.inria.fr/pylons/contribs/files/Karatsuba/v8.4/Karatsuba.tar.gz;
+    sha256 = "0ymfpv4v49k4fm63nq6gcl1hbnnxrvjjp7yzc4973n49b853c5b1";
   };
 
+  name = "coq-karatsuba";
+
   buildInputs = [ coq ];
-  propagatedBuildInputs = [ mathcomp ];
 
   installFlags = "COQLIB=$(out)/lib/coq/${coq.coq-version}/";
-
-  meta = {
-    description = "A Coq/SSReflect Library for Monoidal Rings and Multinomials";
-    inherit (src.meta) homepage;
-    license = stdenv.lib.licenses.cecill-b;
-    inherit (coq.meta) platforms;
-  };
-
-  passthru = {
-    compatibleCoqVersions = v: builtins.elem v [ "8.5" "8.6" "8.7" ];
-  };
 }
 </programlisting>
 </section>
+

doc/languages-frameworks/crystal.section.md

@@ -1,71 +0,0 @@
-# Crystal
-
-## Building a Crystal package
-
-This section uses [Mint](https://github.com/mint-lang/mint) as an example for how to build a Crystal package.
-
-If the Crystal project has any dependencies, the first step is to get a `shards.nix` file encoding those. Get a copy of the project and go to its root directory such that its `shard.lock` file is in the current directory, then run `crystal2nix` in it
-```bash
-$ git clone https://github.com/mint-lang/mint
-$ cd mint
-$ git checkout 0.5.0
-$ nix-shell -p crystal2nix --run crystal2nix
-```
-
-This should have generated a `shards.nix` file.
-
-Next create a Nix file for your derivation and use `pkgs.crystal.buildCrystalPackage` as follows:
-```nix
-with import <nixpkgs> {};
-crystal.buildCrystalPackage rec {
-  pname = "mint";
-  version = "0.5.0";
-
-  src = fetchFromGitHub {
-    owner = "mint-lang";
-    repo = "mint";
-    rev = version;
-    sha256 = "0vxbx38c390rd2ysvbwgh89v2232sh5rbsp3nk9wzb70jybpslvl";
-  };
-
-  # Insert the path to your shards.nix file here
-  shardsFile = ./shards.nix;
-
-  ...
-}
-```
-
-This won't build anything yet, because we haven't told it what files build. We can specify a mapping from binary names to source files with the `crystalBinaries` attribute. The project's compilation instructions should show this. For Mint, the binary is called "mint", which is compiled from the source file `src/mint.cr`, so we'll specify this as follows:
-
-```nix
-  crystalBinaries.mint.src = "src/mint.cr";
-
-  # ...
-```
-
-Additionally you can override the default `crystal build` options (which are currently `--release --progress --no-debug --verbose`) with
-
-```nix
-  crystalBinaries.mint.options = [ "--release" "--verbose" ];
-```
-
-Depending on the project, you might need additional steps to get it to compile successfully. In Mint's case, we need to link against openssl, so in the end the Nix file looks as follows:
-
-```nix
-with import <nixpkgs> {};
-crystal.buildCrystalPackage rec {
-  version = "0.5.0";
-  pname = "mint";
-  src = fetchFromGitHub {
-    owner = "mint-lang";
-    repo = "mint";
-    rev = version;
-    sha256 = "0vxbx38c390rd2ysvbwgh89v2232sh5rbsp3nk9wzb70jybpslvl";
-  };
-
-  shardsFile = ./shards.nix;
-  crystalBinaries.mint.src = "src/mint.cr";
-
-  buildInputs = [ openssl_1_0_2 ];
-}
-```

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,241 +1,124 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-go">
- <title>Go</title>
 
- <section xml:id="ssec-go-modules">
-  <title>Go modules</title>
+<title>Go</title>
 
-  <para>
-   The function <varname> buildGoModule </varname> builds Go programs managed
-   with Go modules. It builds a
-   <link xlink:href="https://github.com/golang/go/wiki/Modules">Go
-   modules</link> through a two phase build:
-   <itemizedlist>
-    <listitem>
-     <para>
-      An intermediate fetcher derivation. This derivation will be used to fetch
-      all of the dependencies of the Go module.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      A final derivation will use the output of the intermediate derivation to
-      build the binaries and produce the final output.
-     </para>
-    </listitem>
-   </itemizedlist>
-  </para>
+<para>The function <varname>buildGoPackage</varname> builds
+standard Go packages.
+</para>
 
-  <example xml:id='ex-buildGoModule'>
-   <title>buildGoModule</title>
+<example xml:id='ex-buildGoPackage'><title>buildGoPackage</title>
 <programlisting>
-pet = buildGoModule rec {
-  name = "pet-${version}";
-  version = "0.3.4";
-
+net = buildGoPackage rec {
+  name = "go.net-${rev}";
+  goPackagePath = "golang.org/x/net"; <co xml:id='ex-buildGoPackage-1' />
+  subPackages = [ "ipv4" "ipv6" ]; <co xml:id='ex-buildGoPackage-2' />
+  rev = "e0403b4e005";
   src = fetchFromGitHub {
-    owner = "knqyf263";
-    repo = "pet";
-    rev = "v${version}";
-    sha256 = "0m2fzpqxk7hrbxsgqplkg7h2p7gv6s1miymv3gvw0cz039skag0s";
+    inherit rev;
+    owner = "golang";
+    repo = "net";
+    sha256 = "1g7cjzw4g4301a3yqpbk8n1d4s97sfby2aysl275x04g0zh8jxqp";
   };
-
-  modSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j"; <co xml:id='ex-buildGoModule-1' />
-
-  subPackages = [ "." ]; <co xml:id='ex-buildGoModule-2' />
-
-  meta = with lib; {
-    description = "Simple command-line snippet manager, written in Go";
-    homepage = https://github.com/knqyf263/pet;
-    license = licenses.mit;
-    maintainers = with maintainers; [ kalbasit ];
-    platforms = platforms.linux ++ platforms.darwin;
-  };
-}
+  goPackageAliases = [ "code.google.com/p/go.net" ]; <co xml:id='ex-buildGoPackage-3' />
+  propagatedBuildInputs = [ goPackages.text ]; <co xml:id='ex-buildGoPackage-4' />
+  buildFlags = "--tags release"; <co xml:id='ex-buildGoPackage-5' />
+  disabled = isGo13;<co xml:id='ex-buildGoPackage-6' />
+};
 </programlisting>
-  </example>
+</example>
 
-  <para>
-   <xref linkend='ex-buildGoModule'/> is an example expression using
-   buildGoModule, the following arguments are of special significance to the
-   function:
-   <calloutlist>
-    <callout arearefs='ex-buildGoModule-1'>
-     <para>
-      <varname>modSha256</varname> is the hash of the output of the
-      intermediate fetcher derivation.
-     </para>
-    </callout>
-    <callout arearefs='ex-buildGoModule-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>
-    </callout>
-   </calloutlist>
-  </para>
- </section>
+<para><xref linkend='ex-buildGoPackage'/> is an example expression using buildGoPackage,
+the following arguments are of special significance to the function:
 
- <section xml:id="ssec-go-legacy">
-  <title>Go legacy</title>
+<calloutlist>
 
-  <para>
-   The function <varname> buildGoPackage </varname> builds legacy Go programs,
-   not supporting Go modules.
-  </para>
+  <callout arearefs='ex-buildGoPackage-1'>
+    <para>
+      <varname>goPackagePath</varname> specifies the package's canonical Go import path.
+    </para>
+  </callout>
 
-  <example xml:id='ex-buildGoPackage'>
-   <title>buildGoPackage</title>
-<programlisting>
-deis = buildGoPackage rec {
-  name = "deis-${version}";
-  version = "1.13.0";
+  <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>code.google.com/p/go.net/ipv4</literal> and
+      <literal>code.google.com/p/go.net/ipv6</literal> will be built.
+    </para>
+  </callout>
 
-  goPackagePath = "github.com/deis/deis"; <co xml:id='ex-buildGoPackage-1' />
-  subPackages = [ "client" ]; <co xml:id='ex-buildGoPackage-2' />
+  <callout arearefs='ex-buildGoPackage-3'>
+    <para>
+      <varname>goPackageAliases</varname> is a list of alternative import paths
+      that are valid for this library.
+      Packages that depend on this library will automatically rename
+      import paths that match any of the aliases to <literal>goPackagePath</literal>.
+    </para>
+    <para>
+      In this example imports will be renamed from
+      <literal>code.google.com/p/go.net</literal> to
+      <literal>golang.org/x/net</literal> in every package that depend on the
+      <literal>go.net</literal> library.
+    </para>
+  </callout>
 
-  src = fetchFromGitHub {
-    owner = "deis";
-    repo = "deis";
-    rev = "v${version}";
-    sha256 = "1qv9lxqx7m18029lj8cw3k7jngvxs4iciwrypdy0gd2nnghc68sw";
-  };
+  <callout arearefs='ex-buildGoPackage-4'>
+    <para>
+      <varname>propagatedBuildInputs</varname> is where the dependencies of a Go library are
+      listed. Only libraries should list <varname>propagatedBuildInputs</varname>. If a standalone
+      program is being built instead, use <varname>buildInputs</varname>. If a library's tests require
+      additional dependencies that are not propagated, they should be listed in <varname>buildInputs</varname>.
+    </para>
+  </callout>
 
-  goDeps = ./deps.nix; <co xml:id='ex-buildGoPackage-3' />
+  <callout arearefs='ex-buildGoPackage-5'>
+    <para>
+      <varname>buildFlags</varname> is a list of flags passed to the go build command.
+    </para>
+  </callout>
 
-  buildFlags = "--tags release"; <co xml:id='ex-buildGoPackage-4' />
-}
-</programlisting>
-  </example>
+  <callout arearefs='ex-buildGoPackage-6'>
+    <para>
+      If <varname>disabled</varname> is <literal>true</literal>,
+      nix will refuse to build this package.
+    </para>
+    <para>
+      In this example the package will not be built for go 1.3. The <literal>isGo13</literal>
+      is an utility function that returns <literal>true</literal> if go used to build the
+      package has version 1.3.x.
+    </para>
+  </callout>
 
-  <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>
+</calloutlist>
 
-  <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>
+</para>
 
-  <example xml:id='ex-goDeps'>
-   <title>deps.nix</title>
-<programlisting>
-[ <co xml:id='ex-goDeps-1' />
-  {
-    goPackagePath = "gopkg.in/yaml.v2"; <co xml:id='ex-goDeps-2' />
-    fetch = {
-      type = "git"; <co xml:id='ex-goDeps-3' />
-      url = "https://gopkg.in/yaml.v2";
-      rev = "a83829b6f1293c91addabc89d0571c246397bbf4";
-      sha256 = "1m4dsmk90sbi17571h6pld44zxz7jc4lrnl4f27dpd1l8g5xvjhh";
-    };
-  }
-  {
-    goPackagePath = "github.com/docopt/docopt-go";
-    fetch = {
-      type = "git";
-      url = "https://github.com/docopt/docopt-go";
-      rev = "784ddc588536785e7299f7272f39101f7faccc3f";
-      sha256 = "0wwz48jl9fvl1iknvn9dqr4gfy1qs03gxaikrxxp9gry6773v3sj";
-    };
-  }
-]
-</programlisting>
-  </example>
+<para>
+Reusable Go libraries may be found in the <varname>goPackages</varname> set. You can test
+build a Go package as follows:
 
-  <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>
-   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>
-<prompt>$ </prompt>nix-build -A deis.bin
+$ nix-build -A goPackages.net
 </screen>
-   or build all outputs with:
-<screen>
-<prompt>$ </prompt>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:
+</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>
- </section>
+</para>
+
+  <para>To extract dependency information from a Go package in automated way use <link xlink:href="https://github.com/kamilchm/go2nix">go2nix</link>.</para>
 </section>
+

doc/languages-frameworks/haskell.md

@@ -0,0 +1,808 @@
+---
+title: User's Guide for Haskell in Nixpkgs
+author: Peter Simons
+date: 2015-06-01
+---
+# User's Guide to the Haskell Infrastructure
+
+
+## How to install Haskell packages
+
+Nixpkgs distributes build instructions for all Haskell packages registered on
+[Hackage](http://hackage.haskell.org/), but strangely enough normal Nix package
+lookups don't seem to discover any of them, except for the default version of ghc, cabal-install, and stack:
+
+    $ nix-env -i alex
+    error: selector ‘alex’ matches no derivations
+    $ nix-env -qa ghc
+    ghc-7.10.2
+
+The Haskell package set is not registered in the top-level namespace because it
+is *huge*. If all Haskell packages were visible to these commands, then
+name-based search/install operations would be much slower than they are now. We
+avoided that by keeping all Haskell-related packages in a separate attribute
+set called `haskellPackages`, which the following command will list:
+
+    $ nix-env -f "<nixpkgs>" -qaP -A haskellPackages
+    haskellPackages.a50         a50-0.5
+    haskellPackages.abacate     haskell-abacate-0.0.0.0
+    haskellPackages.abcBridge   haskell-abcBridge-0.12
+    haskellPackages.afv         afv-0.1.1
+    haskellPackages.alex        alex-3.1.4
+    haskellPackages.Allure      Allure-0.4.101.1
+    haskellPackages.alms        alms-0.6.7
+    [... some 8000 entries omitted  ...]
+
+To install any of those packages into your profile, refer to them by their
+attribute path (first column):
+
+    $ nix-env -f "<nixpkgs>" -iA haskellPackages.Allure ...
+
+The attribute path of any Haskell packages corresponds to the name of that
+particular package on Hackage: the package `cabal-install` has the attribute
+`haskellPackages.cabal-install`, and so on. (Actually, this convention causes
+trouble with packages like `3dmodels` and `4Blocks`, because these names are
+invalid identifiers in the Nix language. The issue of how to deal with these
+rare corner cases is currently unresolved.)
+
+Haskell packages who's Nix name (second column) begins with a `haskell-` prefix
+are packages that provide a library whereas packages without that prefix
+provide just executables. Libraries may provide executables too, though: the
+package `haskell-pandoc`, for example, installs both a library and an
+application. You can install and use Haskell executables just like any other
+program in Nixpkgs, but using Haskell libraries for development is a bit
+trickier and we'll address that subject in great detail in section [How to
+create a development environment].
+
+Attribute paths are deterministic inside of Nixpkgs, but the path necessary to
+reach Nixpkgs varies from system to system. We dodged that problem by giving
+`nix-env` an explicit `-f "<nixpkgs>"` parameter, but if you call `nix-env`
+without that flag, then chances are the invocation fails:
+
+    $ nix-env -iA haskellPackages.cabal-install
+    error: attribute ‘haskellPackages’ in selection path
+           ‘haskellPackages.cabal-install’ not found
+
+On NixOS, for example, Nixpkgs does *not* exist in the top-level namespace by
+default. To figure out the proper attribute path, it's easiest to query for the
+path of a well-known Nixpkgs package, i.e.:
+
+    $ nix-env -qaP coreutils
+    nixos.coreutils  coreutils-8.23
+
+If your system responds like that (most NixOS installations will), then the
+attribute path to `haskellPackages` is `nixos.haskellPackages`. Thus, if you
+want to use `nix-env` without giving an explicit `-f` flag, then that's the way
+to do it:
+
+    $ nix-env -qaP -A nixos.haskellPackages
+    $ nix-env -iA nixos.haskellPackages.cabal-install
+
+Our current default compiler is GHC 7.10.x and the `haskellPackages` set
+contains packages built with that particular version. Nixpkgs contains the
+latest major release of every GHC since 6.10.4, however, and there is a whole
+family of package sets available that defines Hackage packages built with each
+of those compilers, too:
+
+    $ nix-env -f "<nixpkgs>" -qaP -A haskell.packages.ghc6123
+    $ nix-env -f "<nixpkgs>" -qaP -A haskell.packages.ghc763
+
+The name `haskellPackages` is really just a synonym for
+`haskell.packages.ghc7102`, because we prefer that package set internally and
+recommend it to our users as their default choice, but ultimately you are free
+to compile your Haskell packages with any GHC version you please. The following
+command displays the complete list of available compilers:
+
+    $ nix-env -f "<nixpkgs>" -qaP -A haskell.compiler
+    haskell.compiler.ghc6104        ghc-6.10.4
+    haskell.compiler.ghc6123        ghc-6.12.3
+    haskell.compiler.ghc704         ghc-7.0.4
+    haskell.compiler.ghc722         ghc-7.2.2
+    haskell.compiler.ghc742         ghc-7.4.2
+    haskell.compiler.ghc763         ghc-7.6.3
+    haskell.compiler.ghc784         ghc-7.8.4
+    haskell.compiler.ghc7102        ghc-7.10.2
+    haskell.compiler.ghcHEAD        ghc-7.11.20150402
+    haskell.compiler.ghcNokinds     ghc-nokinds-7.11.20150704
+    haskell.compiler.ghcjs          ghcjs-0.1.0
+    haskell.compiler.jhc            jhc-0.8.2
+    haskell.compiler.uhc            uhc-1.1.9.0
+
+We have no package sets for `jhc` or `uhc` yet, unfortunately, but for every
+version of GHC listed above, there exists a package set based on that compiler.
+Also, the attributes `haskell.compiler.ghcXYC` and
+`haskell.packages.ghcXYC.ghc` are synonymous for the sake of convenience.
+
+## How to create a development environment
+
+### How to install a compiler
+
+A simple development environment consists of a Haskell compiler and one or both
+of the tools `cabal-install` and `stack`. We saw in section
+[How to install Haskell packages] how you can install those programs into your
+user profile:
+
+    $ nix-env -f "<nixpkgs>" -iA haskellPackages.ghc haskellPackages.cabal-install
+
+Instead of the default package set `haskellPackages`, you can also use the more
+precise name `haskell.compiler.ghc7102`, which has the advantage that it refers
+to the same GHC version regardless of what Nixpkgs considers "default" at any
+given time.
+
+Once you've made those tools available in `$PATH`, it's possible to build
+Hackage packages the same way people without access to Nix do it all the time:
+
+    $ cabal get lens-4.11 && cd lens-4.11
+    $ cabal install -j --dependencies-only
+    $ cabal configure
+    $ cabal build
+
+If you enjoy working with Cabal sandboxes, then that's entirely possible too:
+just execute the command
+
+    $ cabal sandbox init
+
+before installing the required dependencies.
+
+The `nix-shell` utility makes it easy to switch to a different compiler
+version; just enter the Nix shell environment with the command
+
+    $ nix-shell -p haskell.compiler.ghc784
+
+to bring GHC 7.8.4 into `$PATH`. Alternatively, you can use Stack instead of
+`nix-shell` directly to select compiler versions and other build tools
+per-project. It uses `nix-shell` under the hood when Nix support is turned on.
+See [How to build a Haskell project using Stack].
+
+If you're using `cabal-install`, re-running `cabal configure` inside the spawned
+shell switches your build to use that compiler instead. If you're working on
+a project that doesn't depend on any additional system libraries outside of GHC,
+then it's even sufficient to just run the `cabal configure` command inside of
+the shell:
+
+    $ nix-shell -p haskell.compiler.ghc784 --command "cabal configure"
+
+Afterwards, all other commands like `cabal build` work just fine in any shell
+environment, because the configure phase recorded the absolute paths to all
+required tools like GHC in its build configuration inside of the `dist/`
+directory. Please note, however, that `nix-collect-garbage` can break such an
+environment because the Nix store paths created by `nix-shell` aren't "alive"
+anymore once `nix-shell` has terminated. If you find that your Haskell builds
+no longer work after garbage collection, then you'll have to re-run `cabal
+configure` inside of a new `nix-shell` environment.
+
+### How to install a compiler with libraries
+
+GHC expects to find all installed libraries inside of its own `lib` directory.
+This approach works fine on traditional Unix systems, but it doesn't work for
+Nix, because GHC's store path is immutable once it's built. We cannot install
+additional libraries into that location. As a consequence, our copies of GHC
+don't know any packages except their own core libraries, like `base`,
+`containers`, `Cabal`, etc.
+
+We can register additional libraries to GHC, however, using a special build
+function called `ghcWithPackages`. That function expects one argument: a
+function that maps from an attribute set of Haskell packages to a list of
+packages, which determines the libraries known to that particular version of
+GHC. For example, the Nix expression `ghcWithPackages (pkgs: [pkgs.mtl])`
+generates a copy of GHC that has the `mtl` library registered in addition to
+its normal core packages:
+
+    $ nix-shell -p "haskellPackages.ghcWithPackages (pkgs: [pkgs.mtl])"
+
+    [nix-shell:~]$ ghc-pkg list mtl
+    /nix/store/zy79...-ghc-7.10.2/lib/ghc-7.10.2/package.conf.d:
+        mtl-2.2.1
+
+This function allows users to define their own development environment by means
+of an override. After adding the following snippet to `~/.nixpkgs/config.nix`,
+
+    {
+      packageOverrides = super: let self = super.pkgs; in
+      {
+        myHaskellEnv = self.haskell.packages.ghc7102.ghcWithPackages
+                         (haskellPackages: with haskellPackages; [
+                           # libraries
+                           arrows async cgi criterion
+                           # tools
+                           cabal-install haskintex
+                         ]);
+      };
+    }
+
+it's possible to install that compiler with `nix-env -f "<nixpkgs>" -iA
+myHaskellEnv`. If you'd like to switch that development environment to a
+different version of GHC, just replace the `ghc7102` bit in the previous
+definition with the appropriate name. Of course, it's also possible to define
+any number of these development environments! (You can't install two of them
+into the same profile at the same time, though, because that would result in
+file conflicts.)
+
+The generated `ghc` program is a wrapper script that re-directs the real
+GHC executable to use a new `lib` directory --- one that we specifically
+constructed to contain all those packages the user requested:
+
+    $ cat $(type -p ghc)
+    #! /nix/store/xlxj...-bash-4.3-p33/bin/bash -e
+    export NIX_GHC=/nix/store/19sm...-ghc-7.10.2/bin/ghc
+    export NIX_GHCPKG=/nix/store/19sm...-ghc-7.10.2/bin/ghc-pkg
+    export NIX_GHC_DOCDIR=/nix/store/19sm...-ghc-7.10.2/share/doc/ghc/html
+    export NIX_GHC_LIBDIR=/nix/store/19sm...-ghc-7.10.2/lib/ghc-7.10.2
+    exec /nix/store/j50p...-ghc-7.10.2/bin/ghc "-B$NIX_GHC_LIBDIR" "$@"
+
+The variables `$NIX_GHC`, `$NIX_GHCPKG`, etc. point to the *new* store path
+`ghcWithPackages` constructed specifically for this environment. The last line
+of the wrapper script then executes the real `ghc`, but passes the path to the
+new `lib` directory using GHC's `-B` flag.
+
+The purpose of those environment variables is to work around an impurity in the
+popular [ghc-paths](http://hackage.haskell.org/package/ghc-paths) library. That
+library promises to give its users access to GHC's installation paths. Only,
+the library can't possible know that path when it's compiled, because the path
+GHC considers its own is determined only much later, when the user configures
+it through `ghcWithPackages`. So we [patched
+ghc-paths](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/haskell-modules/patches/ghc-paths-nix.patch)
+to return the paths found in those environment variables at run-time rather
+than trying to guess them at compile-time.
+
+To make sure that mechanism works properly all the time, we recommend that you
+set those variables to meaningful values in your shell environment, too, i.e.
+by adding the following code to your `~/.bashrc`:
+
+    if type >/dev/null 2>&1 -p ghc; then
+      eval "$(egrep ^export "$(type -p ghc)")"
+    fi
+
+If you are certain that you'll use only one GHC environment which is located in
+your user profile, then you can use the following code, too, which has the
+advantage that it doesn't contain any paths from the Nix store, i.e. those
+settings always remain valid even if a `nix-env -u` operation updates the GHC
+environment in your profile:
+
+    if [ -e ~/.nix-profile/bin/ghc ]; then
+      export NIX_GHC="$HOME/.nix-profile/bin/ghc"
+      export NIX_GHCPKG="$HOME/.nix-profile/bin/ghc-pkg"
+      export NIX_GHC_DOCDIR="$HOME/.nix-profile/share/doc/ghc/html"
+      export NIX_GHC_LIBDIR="$HOME/.nix-profile/lib/ghc-$($NIX_GHC --numeric-version)"
+    fi
+
+### How to install a compiler with libraries, hoogle and documentation indexes
+
+If you plan to use your environment for interactive programming, not just
+compiling random Haskell code, you might want to replace `ghcWithPackages` in
+all the listings above with `ghcWithHoogle`.
+
+This environment generator not only produces an environment with GHC and all
+the specified libraries, but also generates a `hoogle` and `haddock` indexes
+for all the packages, and provides a wrapper script around `hoogle` binary that
+uses all those things. A precise name for this thing would be
+"`ghcWithPackagesAndHoogleAndDocumentationIndexes`", which is, regrettably, too
+long and scary.
+
+For example, installing the following environment
+
+    {
+      packageOverrides = super: let self = super.pkgs; in
+      {
+        myHaskellEnv = self.haskellPackages.ghcWithHoogle
+                         (haskellPackages: with haskellPackages; [
+                           # libraries
+                           arrows async cgi criterion
+                           # tools
+                           cabal-install haskintex
+                         ]);
+      };
+    }
+
+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-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).
+
+After you've marveled enough at that try adding the following to your
+`~/.ghc/ghci.conf`
+
+    :def hoogle \s -> return $ ":! hoogle search -cl --count=15 \"" ++ s ++ "\""
+    :def doc \s -> return $ ":! hoogle search -cl --info \"" ++ s ++ "\""
+
+and test it by typing into `ghci`:
+
+    :hoogle a -> a
+    :doc a -> a
+
+Be sure to note the links to `haddock` files in the output. With any modern and
+properly configured terminal emulator you can just click those links to
+navigate there.
+
+Finally, you can run
+
+    hoogle server -p 8080
+
+and navigate to http://localhost:8080/ for your own local
+[Hoogle](https://www.haskell.org/hoogle/). Note, however, that Firefox and
+possibly other browsers disallow navigation from `http:` to `file:` URIs for
+security reasons, which might be quite an inconvenience. See [this
+page](http://kb.mozillazine.org/Links_to_local_pages_do_not_work) for
+workarounds.
+
+### How to build a Haskell project using Stack
+
+[Stack](http://haskellstack.org) is a popular build tool for Haskell projects.
+It has first-class support for Nix. Stack can optionally use Nix to
+automatically select the right version of GHC and other build tools to build,
+test and execute apps in an existing project downloaded from somewhere on the
+Internet. Pass the `--nix` flag to any `stack` command to do so, e.g.
+
+    $ git clone --recursive http://github.com/yesodweb/wai
+    $ cd wai
+    $ stack --nix build
+
+If you want `stack` to use Nix by default, you can add a `nix` section to the
+`stack.yaml` file, as explained in the [Stack documentation][stack-nix-doc]. For
+example:
+
+    nix:
+      enable: true
+      packages: [pkgconfig zeromq zlib]
+
+The example configuration snippet above tells Stack to create an ad hoc
+environment for `nix-shell` as in the below section, in which the `pkgconfig`,
+`zeromq` and `zlib` packages from Nixpkgs are available. All `stack` commands
+will implicitly be executed inside this ad hoc environment.
+
+Some projects have more sophisticated needs. For examples, some ad hoc
+environments might need to expose Nixpkgs packages compiled in a certain way, or
+with extra environment variables. In these cases, you'll need a `shell` field
+instead of `packages`:
+
+    nix:
+      enable: true
+      shell-file: shell.nix
+
+For more on how to write a `shell.nix` file see the below section. You'll need
+to express a derivation. Note that Nixpkgs ships with a convenience wrapper
+function around `mkDerivation` called `haskell.lib.buildStackProject` to help you
+create this derivation in exactly the way Stack expects. All of the same inputs
+as `mkDerivation` can be provided. For example, to build a Stack project that
+including packages that link against a version of the R library compiled with
+special options turned on:
+
+    with (import <nixpkgs> { });
+
+    let R = pkgs.R.override { enableStrictBarrier = true; };
+    in
+	haskell.lib.buildStackProject {
+      name = "HaskellR";
+	  buildInputs = [ R zeromq zlib ];
+    }
+
+[stack-nix-doc]: http://docs.haskellstack.org/en/stable/nix_integration.html
+
+### How to create ad hoc environments for `nix-shell`
+
+The easiest way to create an ad hoc development environment is to run
+`nix-shell` with the appropriate GHC environment given on the command-line:
+
+    nix-shell -p "haskellPackages.ghcWithPackages (pkgs: with pkgs; [mtl pandoc])"
+
+For more sophisticated use-cases, however, it's more convenient to save the
+desired configuration in a file called `shell.nix` that looks like this:
+
+    { nixpkgs ? import <nixpkgs> {}, compiler ? "ghc7102" }:
+    let
+      inherit (nixpkgs) pkgs;
+      ghc = pkgs.haskell.packages.${compiler}.ghcWithPackages (ps: with ps; [
+              monad-par mtl
+            ]);
+    in
+    pkgs.stdenv.mkDerivation {
+      name = "my-haskell-env-0";
+      buildInputs = [ ghc ];
+      shellHook = "eval $(egrep ^export ${ghc}/bin/ghc)";
+    }
+
+Now run `nix-shell` --- or even `nix-shell --pure` --- to enter a shell
+environment that has the appropriate compiler in `$PATH`. If you use `--pure`,
+then add all other packages that your development environment needs into the
+`buildInputs` attribute. If you'd like to switch to a different compiler
+version, then pass an appropriate `compiler` argument to the expression, i.e.
+`nix-shell --argstr compiler ghc784`.
+
+If you need such an environment because you'd like to compile a Hackage package
+outside of Nix --- i.e. because you're hacking on the latest version from Git
+---, then the package set provides suitable nix-shell environments for you
+already! Every Haskell package has an `env` attribute that provides a shell
+environment suitable for compiling that particular package. If you'd like to
+hack the `lens` library, for example, then you just have to check out the
+source code and enter the appropriate environment:
+
+      $ cabal get lens-4.11 && cd lens-4.11
+      Downloading lens-4.11...
+      Unpacking to lens-4.11/
+
+      $ nix-shell "<nixpkgs>" -A haskellPackages.lens.env
+      [nix-shell:/tmp/lens-4.11]$
+
+At point, you can run `cabal configure`, `cabal build`, and all the other
+development commands. Note that you need `cabal-install` installed in your
+`$PATH` already to use it here --- the `nix-shell` environment does not provide
+it.
+
+## How to create Nix builds for your own private Haskell packages
+
+If your own Haskell packages have build instructions for Cabal, then you can
+convert those automatically into build instructions for Nix using the
+`cabal2nix` utility, which you can install into your profile by running
+`nix-env -i cabal2nix`.
+
+### How to build a stand-alone project
+
+For example, let's assume that you're working on a private project called
+`foo`. To generate a Nix build expression for it, change into the project's
+top-level directory and run the command:
+
+    $ cabal2nix . >foo.nix
+
+Then write the following snippet into a file called `default.nix`:
+
+    { nixpkgs ? import <nixpkgs> {}, compiler ? "ghc7102" }:
+    nixpkgs.pkgs.haskell.packages.${compiler}.callPackage ./foo.nix { }
+
+Finally, store the following code in a file called `shell.nix`:
+
+    { nixpkgs ? import <nixpkgs> {}, compiler ? "ghc7102" }:
+    (import ./default.nix { inherit nixpkgs compiler; }).env
+
+At this point, you can run `nix-build` to have Nix compile your project and
+install it into a Nix store path. The local directory will contain a symlink
+called `result` after `nix-build` returns that points into that location. Of
+course, passing the flag `--argstr compiler ghc763` allows switching the build
+to any version of GHC currently supported.
+
+Furthermore, you can call `nix-shell` to enter an interactive development
+environment in which you can use `cabal configure` and `cabal build` to develop
+your code. That environment will automatically contain a proper GHC derivation
+with all the required libraries registered as well as all the system-level
+libraries your package might need.
+
+If your package does not depend on any system-level libraries, then it's
+sufficient to run
+
+    $ nix-shell --command "cabal configure"
+
+once to set up your build. `cabal-install` determines the absolute paths to all
+resources required for the build and writes them into a config file in the
+`dist/` directory. Once that's done, you can run `cabal build` and any other
+command for that project even outside of the `nix-shell` environment. This
+feature is particularly nice for those of us who like to edit their code with
+an IDE, like Emacs' `haskell-mode`, because it's not necessary to start Emacs
+inside of nix-shell just to make it find out the necessary settings for
+building the project; `cabal-install` has already done that for us.
+
+If you want to do some quick-and-dirty hacking and don't want to bother setting
+up a `default.nix` and `shell.nix` file manually, then you can use the
+`--shell` flag offered by `cabal2nix` to have it generate a stand-alone
+`nix-shell` environment for you. With that feature, running
+
+    $ cabal2nix --shell . >shell.nix
+    $ nix-shell --command "cabal configure"
+
+is usually enough to set up a build environment for any given Haskell package.
+You can even use that generated file to run `nix-build`, too:
+
+    $ nix-build shell.nix
+
+### How to build projects that depend on each other
+
+If you have multiple private Haskell packages that depend on each other, then
+you'll have to register those packages in the Nixpkgs set to make them visible
+for the dependency resolution performed by `callPackage`. First of all, change
+into each of your projects top-level directories and generate a `default.nix`
+file with `cabal2nix`:
+
+    $ cd ~/src/foo && cabal2nix . >default.nix
+    $ cd ~/src/bar && cabal2nix . >default.nix
+
+Then edit your `~/.nixpkgs/config.nix` file to register those builds in the
+default Haskell package set:
+
+      {
+        packageOverrides = super: let self = super.pkgs; in
+        {
+          haskellPackages = super.haskellPackages.override {
+            overrides = self: super: {
+              foo = self.callPackage ../src/foo {};
+              bar = self.callPackage ../src/bar {};
+            };
+          };
+        };
+      }
+
+Once that's accomplished, `nix-env -f "<nixpkgs>" -qA haskellPackages` will
+show your packages like any other package from Hackage, and you can build them
+
+    $ nix-build "<nixpkgs>" -A haskellPackages.foo
+
+or enter an interactive shell environment suitable for building them:
+
+    $ nix-shell "<nixpkgs>" -A haskellPackages.bar.env
+
+## Miscellaneous Topics
+
+### How to build with profiling enabled
+
+Every Haskell package set takes a function called `overrides` that you can use
+to manipulate the package as much as you please. One useful application of this
+feature is to replace the default `mkDerivation` function with one that enables
+library profiling for all packages. To accomplish that, add configure the
+following snippet in your `~/.nixpkgs/config.nix` file:
+
+    {
+      packageOverrides = super: let self = super.pkgs; in
+      {
+        profiledHaskellPackages = self.haskellPackages.override {
+          overrides = self: super: {
+            mkDerivation = args: super.mkDerivation (args // {
+              enableLibraryProfiling = true;
+            });
+          };
+        };
+      };
+    }
+
+Then, replace instances of `haskellPackages` in the `cabal2nix`-generated
+`default.nix` or `shell.nix` files with `profiledHaskellPackages`.
+
+### How to override package versions in a compiler-specific package set
+
+Nixpkgs provides the latest version of
+[`ghc-events`](http://hackage.haskell.org/package/ghc-events), which is 0.4.4.0
+at the time of this writing. This is fine for users of GHC 7.10.x, but GHC
+7.8.4 cannot compile that binary. Now, one way to solve that problem is to
+register an older version of `ghc-events` in the 7.8.x-specific package set.
+The first step is to generate Nix build instructions with `cabal2nix`:
+
+    $ cabal2nix cabal://ghc-events-0.4.3.0 >~/.nixpkgs/ghc-events-0.4.3.0.nix
+
+Then add the override in `~/.nixpkgs/config.nix`:
+
+    {
+      packageOverrides = super: let self = super.pkgs; in
+      {
+        haskell = super.haskell // {
+          packages = super.haskell.packages // {
+            ghc784 = super.haskell.packages.ghc784.override {
+              overrides = self: super: {
+                ghc-events = self.callPackage ./ghc-events-0.4.3.0.nix {};
+              };
+            };
+          };
+        };
+      };
+    }
+
+This code is a little crazy, no doubt, but it's necessary because the intuitive
+version
+
+    haskell.packages.ghc784 = super.haskell.packages.ghc784.override {
+      overrides = self: super: {
+        ghc-events = self.callPackage ./ghc-events-0.4.3.0.nix {};
+      };
+    };
+
+doesn't do what we want it to: that code replaces the `haskell` package set in
+Nixpkgs with one that contains only one entry,`packages`, which contains only
+one entry `ghc784`. This override loses the `haskell.compiler` set, and it
+loses the `haskell.packages.ghcXYZ` sets for all compilers but GHC 7.8.4. To
+avoid that problem, we have to perform the convoluted little dance from above,
+iterating over each step in hierarchy.
+
+Once it's accomplished, however, we can install a variant of `ghc-events`
+that's compiled with GHC 7.8.4:
+
+    nix-env -f "<nixpkgs>" -iA haskell.packages.ghc784.ghc-events
+
+Unfortunately, it turns out that this build fails again while executing the
+test suite! Apparently, the release archive on Hackage is missing some data
+files that the test suite requires, so we cannot run it. We accomplish that by
+re-generating the Nix expression with the `--no-check` flag:
+
+    $ cabal2nix --no-check cabal://ghc-events-0.4.3.0 >~/.nixpkgs/ghc-events-0.4.3.0.nix
+
+Now the builds succeeds.
+
+Of course, in the concrete example of `ghc-events` this whole exercise is not
+an ideal solution, because `ghc-events` can analyze the output emitted by any
+version of GHC later than 6.12 regardless of the compiler version that was used
+to build the `ghc-events' executable, so strictly speaking there's no reason to
+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 recover from GHC's infamous non-deterministic library ID bug
+
+GHC and distributed build farms don't get along well:
+
+    https://ghc.haskell.org/trac/ghc/ticket/4012
+
+When you see an error like this one
+
+    package foo-0.7.1.0 is broken due to missing package
+    text-1.2.0.4-98506efb1b9ada233bb5c2b2db516d91
+
+then you have to download and re-install `foo` and all its dependents from
+scratch:
+
+    # nix-store -q --referrers /nix/store/*-haskell-text-1.2.0.4 \
+      | xargs -L 1 nix-store --repair-path --option binary-caches http://hydra.nixos.org
+
+If you're using additional Hydra servers other than `hydra.nixos.org`, then it
+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:
+
+    rm /nix/var/nix/binary-cache-v3.sqlite
+    rm /nix/var/nix/manifests/*
+    rm /nix/var/nix/channel-cache/*
+
+### How to use the Haste Haskell-to-Javascript transpiler
+
+Open a shell with `haste-compiler` and `haste-cabal-install` (you don't actually need
+`node`, but it can be useful to test stuff):
+
+    $ nix-shell -p "haskellPackages.ghcWithPackages (self: with self; [haste-cabal-install haste-compiler])" -p nodejs
+
+You may not need the following step but if `haste-boot` fails to compile all the
+packages it needs, this might do the trick
+
+    $ haste-cabal update
+
+`haste-boot` builds a set of core libraries so that they can be used from Javascript
+transpiled programs:
+
+    $ haste-boot
+
+Transpile and run a "Hello world" program:
+
+    $ echo 'module Main where main = putStrLn "Hello world"' > hello-world.hs
+    $ hastec --onexec hello-world.hs
+    $ node hello-world.js
+    Hello world
+
+### Builds on Darwin fail with `math.h` not found
+
+Users of GHC on Darwin have occasionally reported that builds fail, because the
+compiler complains about a missing include file:
+
+    fatal error: 'math.h' file not found
+
+The issue has been discussed at length in [ticket
+6390](https://github.com/NixOS/nixpkgs/issues/6390), and so far no good
+solution has been proposed. As a work-around, users who run into this problem
+can configure the environment variables
+
+    export NIX_CFLAGS_COMPILE="-idirafter /usr/include"
+    export NIX_CFLAGS_LINK="-L/usr/lib"
+
+in their `~/.bashrc` file to avoid the compiler error.
+
+### Builds using Stack complain about missing system libraries
+
+    --  While building package zlib-0.5.4.2 using:
+      runhaskell -package=Cabal-1.22.4.0 -clear-package-db [... lots of flags ...]
+    Process exited with code: ExitFailure 1
+    Logs have been written to: /home/foo/src/stack-ide/.stack-work/logs/zlib-0.5.4.2.log
+
+    Configuring zlib-0.5.4.2...
+    Setup.hs: Missing dependency on a foreign library:
+    * Missing (or bad) header file: zlib.h
+    This problem can usually be solved by installing the system package that
+    provides this library (you may need the "-dev" version). If the library is
+    already installed but in a non-standard location then you can use the flags
+    --extra-include-dirs= and --extra-lib-dirs= to specify where it is.
+    If the header file does exist, it may contain errors that are caught by the C
+    compiler at the preprocessing stage. In this case you can re-run configure
+    with the verbosity flag -v3 to see the error messages.
+
+When you run the build inside of the nix-shell environment, the system
+is configured to find libz.so without any special flags -- the compiler
+and linker "just know" how to find it. Consequently, Cabal won't record
+any search paths for libz.so in the package description, which means
+that the package works fine inside of nix-shell, but once you leave the
+shell the shared object can no longer be found. That issue is by no
+means specific to Stack: you'll have that problem with any other
+Haskell package that's built inside of nix-shell but run outside of that
+environment.
+
+You can remedy this issue in several ways. The easiest is to add a `nix` section
+to the `stack.yaml` like the following:
+
+    nix:
+      enable: true
+	  packages: [ zlib ]
+
+Stack's Nix support knows to add `${zlib}/lib` and `${zlib}/include` as an
+`--extra-lib-dirs` and `extra-include-dirs`, respectively. Alternatively, you
+can achieve the same effect by hand. First of all, run
+
+    $ nix-build --no-out-link "<nixpkgs>" -A zlib
+    /nix/store/alsvwzkiw4b7ip38l4nlfjijdvg3fvzn-zlib-1.2.8
+
+to find out the store path of the system's zlib library. Now, you can
+
+1) add that path (plus a "/lib" suffix) to your $LD_LIBRARY_PATH
+   environment variable to make sure your system linker finds libz.so
+   automatically. It's no pretty solution, but it will work.
+
+2) As a variant of (1), you can also install any number of system
+   libraries into your user's profile (or some other profile) and point
+   $LD_LIBRARY_PATH to that profile instead, so that you don't have to
+   list dozens of those store paths all over the place.
+
+3) The solution I prefer is to call stack with an appropriate
+   --extra-lib-dirs flag like so:
+
+    $ stack --extra-lib-dirs=/nix/store/alsvwzkiw4b7ip38l4nlfjijdvg3fvzn-zlib-1.2.8/lib build
+
+   Typically, you'll need --extra-include-dirs as well. It's possible
+   to add those flag to the project's "stack.yaml" or your user's
+   global "~/.stack/global/stack.yaml" file so that you don't have to
+   specify them manually every time. But again, you're likely better off using
+   Stack's Nix support instead.
+
+   The same thing applies to `cabal configure`, of course, if you're
+   building with `cabal-install` instead of Stack.
+
+### Creating statically linked binaries
+
+There are two levels of static linking. The first option is to configure the
+build with the Cabal flag `--disable-executable-dynamic`. In Nix expressions,
+this can be achieved by setting the attribute:
+
+    enableSharedExecutables = false;
+
+That gives you a binary with statically linked Haskell libraries and
+dynamically linked system libraries.
+
+To link both Haskell libraries and system libraries statically, the additional
+flags `--ghc-option=-optl=-static --ghc-option=-optl=-pthread` need to be used.
+In Nix, this is accomplished with:
+
+    configureFlags = [ "--ghc-option=-optl=-static" "--ghc-option=-optl=-pthread" ];
+
+It's important to realize, however, that most system libraries in Nix are built
+as shared libraries only, i.e. there is just no static library available that
+Cabal could link!
+
+
+## Other resources
+
+- The Youtube video [Nix Loves Haskell](https://www.youtube.com/watch?v=BsBhi_r-OeE)
+  provides an introduction into Haskell NG aimed at beginners. The slides are
+  available at http://cryp.to/nixos-meetup-3-slides.pdf and also -- in a form
+  ready for cut & paste -- at
+  https://github.com/NixOS/cabal2nix/blob/master/doc/nixos-meetup-3-slides.md.
+
+- Another Youtube video is [Escaping Cabal Hell with Nix](https://www.youtube.com/watch?v=mQd3s57n_2Y),
+  which discusses the subject of Haskell development with Nix but also provides
+  a basic introduction to Nix as well, i.e. it's suitable for viewers with
+  almost no prior Nix experience.
+
+- Oliver Charles wrote a very nice [Tutorial how to develop Haskell packages with Nix](http://wiki.ocharles.org.uk/Nix).
+
+- The *Journey into the Haskell NG infrastructure* series of postings
+  describe the new Haskell infrastructure in great detail:
+
+    - [Part 1](http://lists.science.uu.nl/pipermail/nix-dev/2015-January/015591.html)
+      explains the differences between the old and the new code and gives
+      instructions how to migrate to the new setup.
+
+    - [Part 2](http://lists.science.uu.nl/pipermail/nix-dev/2015-January/015608.html)
+      looks in-depth at how to tweak and configure your setup by means of
+      overrides.
+
+    - [Part 3](http://lists.science.uu.nl/pipermail/nix-dev/2015-April/016912.html)
+      describes the infrastructure that keeps the Haskell package set in Nixpkgs
+      up-to-date.

doc/languages-frameworks/idris.section.md

@@ -1,144 +0,0 @@
-# Idris packages
-
-## Installing Idris
-
-The easiest way to get a working idris version is to install the `idris` attribute:
-
-```
-$ # On NixOS
-$ nix-env -i nixos.idris
-$ # On non-NixOS
-$ nix-env -i nixpkgs.idris
-```
-
-This however only provides the `prelude` and `base` libraries. To install idris with additional libraries, you can use the `idrisPackages.with-packages` function, e.g. in an overlay in `~/.config/nixpkgs/overlays/my-idris.nix`:
-
-```nix
-self: super: {
-  myIdris = with self.idrisPackages; with-packages [ contrib pruviloj ];
-}
-```
-
-And then:
-
-```
-$ # On NixOS
-$ nix-env -iA nixos.myIdris
-$ # On non-NixOS
-$ nix-env -iA nixpkgs.myIdris
-```
-
-To see all available Idris packages:
-```
-$ # On NixOS
-$ nix-env -qaPA nixos.idrisPackages
-$ # On non-NixOS
-$ nix-env -qaPA nixpkgs.idrisPackages
-```
-
-Similarly, entering a `nix-shell`:
-```
-$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
-```
-
-## Starting Idris with library support
-
-To have access to these libraries in idris, call it with an argument `-p <library name>` for each library:
-
-```
-$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
-[nix-shell:~]$ idris -p contrib -p pruviloj
-```
-
-A listing of all available packages the Idris binary has access to is available via `--listlibs`:
-
-```
-$ idris --listlibs
-00prelude-idx.ibc
-pruviloj
-base
-contrib
-prelude
-00pruviloj-idx.ibc
-00base-idx.ibc
-00contrib-idx.ibc
-```
-
-## Building an Idris project with Nix
-
-As an example of how a Nix expression for an Idris package can be created, here is the one for `idrisPackages.yaml`:
-
-```nix
-{ build-idris-package
-, fetchFromGitHub
-, contrib
-, lightyear
-, lib
-}:
-build-idris-package  {
-  name = "yaml";
-  version = "2018-01-25";
-
-  # This is the .ipkg file that should be built, defaults to the package name
-  # In this case it should build `Yaml.ipkg` instead of `yaml.ipkg`
-  # This is only necessary because the yaml packages ipkg file is
-  # different from its package name here.
-  ipkgName = "Yaml";
-  # Idris dependencies to provide for the build
-  idrisDeps = [ contrib lightyear ];
-
-  src = fetchFromGitHub {
-    owner = "Heather";
-    repo = "Idris.Yaml";
-    rev = "5afa51ffc839844862b8316faba3bafa15656db4";
-    sha256 = "1g4pi0swmg214kndj85hj50ccmckni7piprsxfdzdfhg87s0avw7";
-  };
-
-  meta = {
-    description = "Idris YAML lib";
-    homepage = https://github.com/Heather/Idris.Yaml;
-    license = lib.licenses.mit;
-    maintainers = [ lib.maintainers.brainrape ];
-  };
-}
-```
-
-Assuming this file is saved as `yaml.nix`, it's buildable using
-
-```
-$ nix-build -E '(import <nixpkgs> {}).idrisPackages.callPackage ./yaml.nix {}'
-```
-
-Or it's possible to use
-
-```nix
-with import <nixpkgs> {};
-
-{
-  yaml = idrisPackages.callPackage ./yaml.nix {};
-}
-```
-
-in another file (say `default.nix`) to be able to build it with
-
-```
-$ nix-build -A yaml
-```
-
-## Passing options to `idris` commands
-
-The `build-idris-package` function provides also optional input values to set additional options for the used `idris` commands.
-
-Specifically, you can set `idrisBuildOptions`, `idrisTestOptions`, `idrisInstallOptions` and `idrisDocOptions` to provide additional options to the `idris` command respectively when building, testing, installing and generating docs for your package.
-
-For example you could set
-
-```
-build-idris-package {
-  idrisBuildOptions = [ "--log" "1" "--verbose" ]
-
-  ...
-}
-```
-
-to require verbose output during `idris` build phase.

doc/languages-frameworks/index.xml

@@ -1,36 +1,32 @@
 <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="android.section.xml" />
- <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="ios.section.xml" />
- <xi:include href="java.xml" />
- <xi:include href="lua.xml" />
- <xi:include href="node.section.xml" />
- <xi:include href="ocaml.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="titanium.section.xml" />
- <xi:include href="vim.section.xml" />
- <xi:include href="emscripten.section.xml" />
- <xi:include href="crystal.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.xml" />
+<xi:include href="idris.xml" /> <!-- generated from ../../pkgs/development/idris-modules/README.md  -->
+<xi:include href="java.xml" />
+<xi:include href="lua.xml" />
+<xi:include href="perl.xml" />
+<xi:include href="python.xml" />
+<xi:include href="qt.xml" />
+<xi:include href="r.xml" /> <!-- generated from ../../pkgs/development/r-modules/README.md  -->
+<xi:include href="ruby.xml" />
+<xi:include href="texlive.xml" />
+
+
 </chapter>

doc/languages-frameworks/ios.section.md

@@ -1,219 +0,0 @@
----
-title: iOS
-author: Sander van der Burg
-date: 2018-11-18
----
-# iOS
-
-This component is basically a wrapper/workaround that makes it possible to
-expose an Xcode installation as a Nix package by means of symlinking to the
-relevant executables on the host system.
-
-Since Xcode can't be packaged with Nix, nor we can publish it as a Nix package
-(because of its license) this is basically the only integration strategy
-making it possible to do iOS application builds that integrate with other
-components of the Nix ecosystem
-
-The primary objective of this project is to use the Nix expression language to
-specify how iOS apps can be built from source code, and to automatically spawn
-iOS simulator instances for testing.
-
-This component also makes it possible to use [Hydra](http://nixos.org/hydra),
-the Nix-based continuous integration server to regularly build iOS apps and to
-do wireless ad-hoc installations of enterprise IPAs on iOS devices through
-Hydra.
-
-The Xcode build environment implements a number of features.
-
-Deploying a proxy component wrapper exposing Xcode
---------------------------------------------------
-The first use case is deploying a Nix package that provides symlinks to the Xcode
-installation on the host system. This package can be used as a build input to
-any build function implemented in the Nix expression language that requires
-Xcode.
-
-```nix
-let
-  pkgs = import <nixpkgs> {};
-
-  xcodeenv = import ./xcodeenv {
-    inherit (pkgs) stdenv;
-  };
-in
-xcodeenv.composeXcodeWrapper {
-  version = "9.2";
-  xcodeBaseDir = "/Applications/Xcode.app";
-}
-```
-
-By deploying the above expression with `nix-build` and inspecting its content
-you will notice that several Xcode-related executables are exposed as a Nix
-package:
-
-```bash
-$ ls result/bin
-lrwxr-xr-x  1 sander  staff  94  1 jan  1970 Simulator -> /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app/Contents/MacOS/Simulator
-lrwxr-xr-x  1 sander  staff  17  1 jan  1970 codesign -> /usr/bin/codesign
-lrwxr-xr-x  1 sander  staff  17  1 jan  1970 security -> /usr/bin/security
-lrwxr-xr-x  1 sander  staff  21  1 jan  1970 xcode-select -> /usr/bin/xcode-select
-lrwxr-xr-x  1 sander  staff  61  1 jan  1970 xcodebuild -> /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild
-lrwxr-xr-x  1 sander  staff  14  1 jan  1970 xcrun -> /usr/bin/xcrun
-```
-
-Building an iOS application
----------------------------
-We can build an iOS app executable for the simulator, or an IPA/xcarchive file
-for release purposes, e.g. ad-hoc, enterprise or store installations, by
-executing the `xcodeenv.buildApp {}` function:
-
-```nix
-let
-  pkgs = import <nixpkgs> {};
-
-  xcodeenv = import ./xcodeenv {
-    inherit (pkgs) stdenv;
-  };
-in
-xcodeenv.buildApp {
-  name = "MyApp";
-  src = ./myappsources;
-  sdkVersion = "11.2";
-
-  target = null; # Corresponds to the name of the app by default
-  configuration = null; # Release for release builds, Debug for debug builds
-  scheme = null; # -scheme will correspond to the app name by default
-  sdk = null; # null will set it to 'iphonesimulator` for simulator builds or `iphoneos` to real builds
-  xcodeFlags = "";
-
-  release = true;
-  certificateFile = ./mycertificate.p12;
-  certificatePassword = "secret";
-  provisioningProfile = ./myprovisioning.profile;
-  signMethod = "ad-hoc"; # 'enterprise' or 'store'
-  generateIPA = true;
-  generateXCArchive = false;
-
-  enableWirelessDistribution = true;
-  installURL = "/installipa.php";
-  bundleId = "mycompany.myapp";
-  appVersion = "1.0";
-
-  # Supports all xcodewrapper parameters as well
-  xcodeBaseDir = "/Applications/Xcode.app";
-}
-```
-
-The above function takes a variety of parameters:
-* The `name` and `src` parameters are mandatory and specify the name of the app
-  and the location where the source code resides
-* `sdkVersion` specifies which version of the iOS SDK to use.
-
-It also possile to adjust the `xcodebuild` parameters. This is only needed in
-rare circumstances. In most cases the default values should suffice:
-
-* Specifies which `xcodebuild` target to build. By default it takes the target
-  that has the same name as the app.
-* The `configuration` parameter can be overridden if desired. By default, it
-  will do a debug build for the simulator and a release build for real devices.
-* The `scheme` parameter specifies which `-scheme` parameter to propagate to
-  `xcodebuild`. By default, it corresponds to the app name.
-* The `sdk` parameter specifies which SDK to use. By default, it picks
-  `iphonesimulator` for simulator builds and `iphoneos` for release builds.
-* The `xcodeFlags` parameter specifies arbitrary command line parameters that
-  should be propagated to `xcodebuild`.
-
-By default, builds are carried out for the iOS simulator. To do release builds
-(builds for real iOS devices), you must set the `release` parameter to `true`.
-In addition, you need to set the following parameters:
-
-* `certificateFile` refers to a P12 certificate file.
-* `certificatePassword` specifies the password of the P12 certificate.
-* `provisioningProfile` refers to the provision profile needed to sign the app
-* `signMethod` should refer to `ad-hoc` for signing the app with an ad-hoc
-  certificate, `enterprise` for enterprise certificates and `app-store` for App
-  store certificates.
-* `generateIPA` specifies that we want to produce an IPA file (this is probably
-  what you want)
-* `generateXCArchive` specifies thet we want to produce an xcarchive file.
-
-When building IPA files on Hydra and when it is desired to allow iOS devices to
-install IPAs by browsing to the Hydra build products page, you can enable the
-`enableWirelessDistribution` parameter.
-
-When enabled, you need to configure the following options:
-
-* The `installURL` parameter refers to the URL of a PHP script that composes the
-  `itms-services://` URL allowing iOS devices to install the IPA file.
-* `bundleId` refers to the bundle ID value of the app
-* `appVersion` refers to the app's version number
-
-To use wireless adhoc distributions, you must also install the corresponding
-PHP script on a web server (see section: 'Installing the PHP script for wireless
-ad hoc installations from Hydra' for more information).
-
-In addition to the build parameters, you can also specify any parameters that
-the `xcodeenv.composeXcodeWrapper {}` function takes. For example, the
-`xcodeBaseDir` parameter can be overridden to refer to a different Xcode
-version.
-
-Spawning simulator instances
-----------------------------
-In addition to building iOS apps, we can also automatically spawn simulator
-instances:
-
-```nix
-let
-  pkgs = import <nixpkgs> {};
-
-  xcodeenv = import ./xcodeenv {
-    inherit (pkgs) stdenv;
-  };
-in
-xcode.simulateApp {
-  name = "simulate";
-
-  # Supports all xcodewrapper parameters as well
-  xcodeBaseDir = "/Applications/Xcode.app";
-}
-```
-
-The above expression produces a script that starts the simulator from the
-provided Xcode installation. The script can be started as follows:
-
-```bash
-./result/bin/run-test-simulator
-```
-
-By default, the script will show an overview of UDID for all available simulator
-instances and asks you to pick one. You can also provide a UDID as a
-command-line parameter to launch an instance automatically:
-
-```bash
-./result/bin/run-test-simulator 5C93129D-CF39-4B1A-955F-15180C3BD4B8
-```
-
-You can also extend the simulator script to automatically deploy and launch an
-app in the requested simulator instance:
-
-```nix
-let
-  pkgs = import <nixpkgs> {};
-
-  xcodeenv = import ./xcodeenv {
-    inherit (pkgs) stdenv;
-  };
-in
-xcode.simulateApp {
-  name = "simulate";
-  bundleId = "mycompany.myapp";
-  app = xcode.buildApp {
-    # ...
-  };
-
-  # Supports all xcodewrapper parameters as well
-  xcodeBaseDir = "/Applications/Xcode.app";
-}
-```
-
-By providing the result of an `xcode.buildApp {}` function and configuring the
-app bundle id, the app gets deployed automatically and started.

doc/languages-frameworks/java.xml

@@ -1,53 +1,50 @@
 <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 = "...";
   src = fetchurl { ... };
 
-  nativeBuildInputs = [ jdk ant ];
+  buildInputs = [ jdk ant ];
 
   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 = [ libfoo ];
-nativeBuildInputs = [ jdk ];
+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>
-nativeBuildInputs = [ makeWrapper ];
+buildInputs = [ makeWrapper ];
 
 installPhase =
   ''
@@ -56,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>:
-<programlisting>
---set JAVA_HOME ${jdk.home}
-</programlisting>
- </para>
+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:
 
- <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:
 <programlisting>
-nativeBuildInputs = [ gcj ant ];
+buildInputs = [ jre ant ecj ];
 </programlisting>
-  Here, Ant will automatically use <command>gij</command> (the GNU Java
-  Runtime) instead of the OpenJRE.
- </para>
+
+(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>
+
 </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 {
@@ -29,20 +31,21 @@ fileSystem = buildLuaPackage {
     maintainers = with maintainers; [ flosse ];
   };
 };
-</programlisting>
- </para>
+  </programlisting>
+</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

@@ -1,51 +0,0 @@
-Node.js packages
-================
-The `pkgs/development/node-packages` folder contains a generated collection of
-[NPM packages](https://npmjs.com/) that can be installed with the Nix package
-manager.
-
-As a rule of thumb, the package set should only provide *end user* software
-packages, such as command-line utilities. Libraries should only be added to the
-package set if there is a non-NPM package that requires it.
-
-When it is desired to use NPM libraries in a development project, use the
-`node2nix` generator directly on the `package.json` configuration file of the
-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 10.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
-build system it uses. Here are some examples:
-
-* `node-gyp`
-* `node-gyp-builder`
-* `node-pre-gyp`
-
-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-v10.nix`:
-
-```nix
-dat = nodePackages.dat.override (oldAttrs: {
-  buildInputs = oldAttrs.buildInputs ++ [ nodePackages.node-gyp-build ];
-});
-```
-
-To add a package from NPM to nixpkgs:
-
- 1. Modify `pkgs/development/node-packages/node-packages-v10.json` to add, update
-    or remove package entries. (Or `pkgs/development/node-packages/node-packages-v8.json`
-    for packages depending on Node.js 8.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>`
- 4. Add and commit all modified and generated files.
-
-For more information about the generation process, consult the
-[README.md](https://github.com/svanderburg/node2nix) file of the `node2nix`
-tool.

doc/languages-frameworks/ocaml.xml

@@ -1,97 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xml:id="sec-language-ocaml">
- <title>OCaml</title>
-
- <para>
-  OCaml libraries should be installed in
-  <literal>$(out)/lib/ocaml/${ocaml.version}/site-lib/</literal>. Such
-  directories are automatically added to the <literal>$OCAMLPATH</literal>
-  environment variable when building another package that depends on them or
-  when opening a <literal>nix-shell</literal>.
- </para>
-
- <para>
-  Given that most of the OCaml ecosystem is now built with dune, nixpkgs
-  includes a convenience build support function called
-  <literal>buildDunePackage</literal> that will build an OCaml package using
-  dune, OCaml and findlib and any additional dependencies provided as
-  <literal>buildInputs</literal> or <literal>propagatedBuildInputs</literal>.
- </para>
-
- <para>
-  Here is a simple package example. It defines an (optional) attribute
-  <literal>minimumOCamlVersion</literal> that will be used to throw a
-  descriptive evaluation error if building with an older OCaml is attempted. It
-  uses the <literal>fetchFromGitHub</literal> fetcher to get its source. It
-  sets the <literal>doCheck</literal> (optional) attribute to
-  <literal>true</literal> which means that tests will be run with <literal>dune
-  runtest -p angstrom</literal> after the build (<literal>dune build -p
-  angstrom</literal>) is complete. It uses <literal>alcotest</literal> as a
-  build input (because it is needed to run the tests) and
-  <literal>bigstringaf</literal> and <literal>result</literal> as propagated
-  build inputs (thus they will also be available to libraries depending on this
-  library). The library will be installed using the
-  <literal>angstrom.install</literal> file that dune generates.
- </para>
-
-<programlisting>
-{ stdenv, fetchFromGitHub, buildDunePackage, alcotest, result, bigstringaf }:
-
-buildDunePackage rec {
-  pname = "angstrom";
-  version = "0.10.0";
-
-  minimumOCamlVersion = "4.03";
-
-  src = fetchFromGitHub {
-    owner  = "inhabitedtype";
-    repo   = pname;
-    rev    = version;
-    sha256 = "0lh6024yf9ds0nh9i93r9m6p5psi8nvrqxl5x7jwl13zb0r9xfpw";
-  };
-
-  buildInputs = [ alcotest ];
-  propagatedBuildInputs = [ bigstringaf result ];
-  doCheck = true;
-
-  meta = {
-    homepage = https://github.com/inhabitedtype/angstrom;
-    description = "OCaml parser combinators built for speed and memory efficiency";
-    license = stdenv.lib.licenses.bsd3;
-    maintainers = with stdenv.lib.maintainers; [ sternenseemann ];
-  };
-}
-</programlisting>
-
- <para>
-  Here is a second example, this time using a source archive generated with
-  <literal>dune-release</literal>. It is a good idea to use this archive when
-  it is available as it will usually contain substituted variables such as a
-  <literal>%%VERSION%%</literal> field. This library does not depend on any
-  other OCaml library and no tests are run after building it.
- </para>
-
-<programlisting>
-{ stdenv, fetchurl, buildDunePackage }:
-
-buildDunePackage rec {
-  pname = "wtf8";
-  version = "1.0.1";
-
-  minimumOCamlVersion = "4.01";
-
-  src = fetchurl {
-    url = "https://github.com/flowtype/ocaml-${pname}/releases/download/v${version}/${pname}-${version}.tbz";
-    sha256 = "1msg3vycd3k8qqj61sc23qks541cxpb97vrnrvrhjnqxsqnh6ygq";
-  };
-
-  meta = with stdenv.lib; {
-    homepage = https://github.com/flowtype/ocaml-wtf8;
-    description = "WTF-8 is a superset of UTF-8 that allows unpaired surrogates.";
-    license = licenses.mit;
-    maintainers = [ maintainers.eqyiel ];
-  };
-}
-</programlisting>
-</section>

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,73 +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:
-<screen>
-<prompt>$ </prompt>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:
-<screen>
-<prompt>$ </prompt>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. (This can cause this shebang line
-     to become too long for Darwin to handle; see the note below.)
-    </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>
+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:
+
+<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>
+
+<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 }:
 
@@ -110,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";
@@ -136,88 +137,45 @@ ClassC3Componentised = buildPerlPackage rec {
   ];
 };
 </programlisting>
- </para>
 
- <para>
-  On Darwin, if a script has too many
-  <literal>-I<replaceable>dir</replaceable></literal> flags in its first line
-  (its “shebang line”), it will not run. This can be worked around by calling
-  the <literal>shortenPerlShebang</literal> function from the
-  <literal>postInstall</literal> phase:
-<programlisting>
-{ stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }:
+</para>
 
-ImageExifTool = buildPerlPackage {
-  pname = "Image-ExifTool";
-  version = "11.50";
+<section xml:id="ssec-generation-from-CPAN"><title>Generation from CPAN</title>
 
-  src = fetchurl {
-    url = "https://www.sno.phy.queensu.ca/~phil/exiftool/Image-ExifTool-11.50.tar.gz";
-    sha256 = "0d8v48y94z8maxkmw1rv7v9m0jg2dc8xbp581njb6yhr7abwqdv3";
-  };
-
-  buildInputs = stdenv.lib.optional stdenv.isDarwin shortenPerlShebang;
-  postInstall = stdenv.lib.optional stdenv.isDarwin ''
-    shortenPerlShebang $out/bin/exiftool
-  '';
-};
-</programlisting>
- This will remove the <literal>-I</literal> flags from the shebang line,
- rewrite them in the <literal>use lib</literal> form, and put them on the next
- line instead. This function can be given any number of Perl scripts as
- arguments; it will modify them in-place.
- </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>
+<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>
-<prompt>$ </prompt>nix-env -i nix-generate-from-cpan
+$ 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>
-<prompt>$ </prompt>nix-generate-from-cpan XML::Simple
-  XMLSimple = buildPerlPackage rec {
-    name = "XML-Simple-2.22";
+$ nix-generate-from-cpan XML::Simple
+  XMLSimple = buildPerlPackage {
+    name = "XML-Simple-2.20";
     src = fetchurl {
-      url = "mirror://cpan/authors/id/G/GR/GRANTM/${name}.tar.gz";
-      sha256 = "b9450ef22ea9644ae5d6ada086dc4300fa105be050a2030ebd4efd28c198eb49";
+      url = mirror://cpan/authors/id/G/GR/GRANTM/XML-Simple-2.20.tar.gz;
+      sha256 = "5cff13d0802792da1eb45895ce1be461903d98ec97c9c953bc8406af7294434a";
     };
     propagatedBuildInputs = [ XMLNamespaceSupport XMLSAX XMLSAXExpat ];
     meta = {
-      description = "An API for simple XML files";
-      license = with stdenv.lib.licenses; [ artistic1 gpl1Plus ];
+      description = "Easily read/write XML (esp config files)";
+      license = "perl";
     };
   };
 </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.md

@@ -0,0 +1,741 @@
+# Python
+
+## User Guide
+
+Several versions of Python are available on Nix as well as a high amount of
+packages. The default interpreter is CPython 2.7.
+
+### Using Python
+
+#### Installing Python and packages
+
+It is important to make a distinction between Python packages that are
+used as libraries, and applications that are written in Python.
+
+Applications on Nix are installed typically into your user
+profile imperatively using `nix-env -i`, and on NixOS declaratively by adding the
+package name to `environment.systemPackages` in `/etc/nixos/configuration.nix`.
+Dependencies such as libraries are automatically installed and should not be
+installed explicitly.
+
+The same goes for Python applications and libraries. Python applications can be
+installed in your profile, but Python libraries you would like to use to develop
+cannot. If you do install libraries in your profile, then you will end up with
+import errors.
+
+#### Python environments using `nix-shell`
+
+The recommended method for creating Python environments for development is with
+`nix-shell`. Executing
+
+```sh
+$ nix-shell -p python35Packages.numpy python35Packages.toolz
+```
+
+opens a Nix shell which has available the requested packages and dependencies.
+Now you can launch the Python interpreter (which is itself a dependency)
+
+```sh
+[nix-shell:~] python3
+```
+
+If the packages were not available yet in the Nix store, Nix would download or
+build them automatically. A convenient option with `nix-shell` is the `--run`
+option, with which you can execute a command in the `nix-shell`. Let's say we
+want the above environment and directly run the Python interpreter
+
+```sh
+$ nix-shell -p python35Packages.numpy python35Packages.toolz --run "python3"
+```
+
+This way you can use the `--run` option also to directly run a script
+
+```sh
+$ nix-shell -p python35Packages.numpy python35Packages.toolz --run "python3 myscript.py"
+```
+
+In fact, for this specific use case there is a more convenient method. You can
+add a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) to your script
+specifying which dependencies Nix shell needs. With the following shebang, you
+can use `nix-shell myscript.py` and it will make available all dependencies and
+run the script in the `python3` shell.
+
+```py
+#! /usr/bin/env nix-shell
+#! nix-shell -i python3 -p python3Packages.numpy
+
+import numpy
+
+print(numpy.__version__)
+```
+
+Likely you do not want to type your dependencies each and every time. What you
+can do is write a simple Nix expression which sets up an environment for you,
+requiring you only to type `nix-shell`. Say we want to have Python 3.5, `numpy`
+and `toolz`, like before, in an environment. With a `shell.nix` file
+containing
+
+```nix
+with import <nixpkgs> {};
+
+(pkgs.python35.withPackages (ps: [ps.numpy ps.toolz])).env
+```
+executing `nix-shell` gives you again a Nix shell from which you can run Python.
+
+What's happening here?
+
+1. We begin with importing the Nix Packages collections. `import <nixpkgs>` import the `<nixpkgs>` function, `{}` calls it and the `with` statement brings all attributes of `nixpkgs` in the local scope. Therefore we can now use `pkgs`.
+2. Then we create a Python 3.5 environment with the `withPackages` function.
+3. The `withPackages` function expects us to provide a function as an argument that takes the set of all python packages and returns a list of packages to include in the environment. Here, we select the packages `numpy` and `toolz` from the package set.
+4. And finally, for in interactive use we return the environment by using the `env` attribute.
+
+### Developing with Python
+
+
+Now that you know how to get a working Python environment on Nix, it is time to go forward and start actually developing with Python.
+We will first have a look at how Python packages are packaged on Nix. Then, we will look how you can use development mode with your code.
+
+#### Python packaging on Nix
+
+On Nix all packages are built by functions. The main function in Nix for building Python packages is [`buildPythonPackage`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/python-modules/generic/default.nix).
+Let's see how we would build the `toolz` package. According to [`python-packages.nix`](https://raw.githubusercontent.com/NixOS/nixpkgs/master/pkgs/top-level/python-packages.nix) `toolz` is build using
+
+```nix
+toolz = buildPythonPackage rec{
+  name = "toolz-${version}";
+  version = "0.7.4";
+
+  src = pkgs.fetchurl{
+    url = "mirror://pypi/t/toolz/toolz-${version}.tar.gz";
+    sha256 = "43c2c9e5e7a16b6c88ba3088a9bfc82f7db8e13378be7c78d6c14a5f8ed05afd";
+  };
+
+  meta = {
+    homepage = "http://github.com/pytoolz/toolz/";
+    description = "List processing tools and functional utilities";
+    license = licenses.bsd3;
+    maintainers = with maintainers; [ fridh ];
+  };
+};
+```
+
+What happens here? The function `buildPythonPackage` is called and as argument
+it accepts a set. In this case the set is a recursive set ([`rec`](http://nixos.org/nix/manual/#sec-constructs)).
+One of the arguments is the name of the package, which consists of a basename
+(generally following the name on PyPi) and a version. Another argument, `src`
+specifies the source, which in this case is fetched from an url. `fetchurl` not
+only downloads the target file, but also validates its hash. Furthermore, we
+specify some (optional) [meta information](http://nixos.org/nixpkgs/manual/#chap-meta).
+
+The output of the function is a derivation, which is an attribute with the name
+`toolz` of the set `pythonPackages`. Actually, sets are created for all interpreter versions,
+so `python27Packages`, `python34Packages`, `python35Packages` and `pypyPackages`.
+
+The above example works when you're directly working on
+`pkgs/top-level/python-packages.nix` in the Nixpkgs repository. Often though,
+you will want to test a Nix expression outside of the Nixpkgs tree. If you
+create a `shell.nix` file with the following contents
+
+```nix
+with import <nixpkgs> {};
+
+pkgs.python35Packages.buildPythonPackage rec {
+  name = "toolz-${version}";
+  version = "0.7.4";
+
+  src = pkgs.fetchurl{
+    url = "mirror://pypi/t/toolz/toolz-${version}.tar.gz";
+    sha256 = "43c2c9e5e7a16b6c88ba3088a9bfc82f7db8e13378be7c78d6c14a5f8ed05afd";
+  };
+
+  meta = {
+    homepage = "http://github.com/pytoolz/toolz/";
+    description = "List processing tools and functional utilities";
+    license = licenses.bsd3;
+    maintainers = with maintainers; [ fridh ];
+  };
+}
+```
+
+and then execute `nix-shell` will result in an environment in which you can use
+Python 3.5 and the `toolz` package. As you can see we had to explicitly mention
+for which Python version we want to build a package.
+
+The above example considered only a single package. Generally you will want to use multiple packages.
+If we create a `shell.nix` file with the following contents
+
+```nix
+with import <nixpkgs> {};
+
+( let
+    toolz = pkgs.python35Packages.buildPythonPackage rec {
+      name = "toolz-${version}";
+      version = "0.7.4";
+
+      src = pkgs.fetchurl{
+        url = "mirror://pypi/t/toolz/toolz-${version}.tar.gz";
+        sha256 = "43c2c9e5e7a16b6c88ba3088a9bfc82f7db8e13378be7c78d6c14a5f8ed05afd";
+      };
+
+      meta = {
+        homepage = "http://github.com/pytoolz/toolz/";
+        description = "List processing tools and functional utilities";
+        license = licenses.bsd3;
+        maintainers = with maintainers; [ fridh ];
+      };
+    };
+
+  in pkgs.python35.withPackages (ps: [ps.numpy toolz])
+).env
+```
+
+and again execute `nix-shell`, then we get a Python 3.5 environment with our
+locally defined package as well as `numpy` which is build according to the
+definition in Nixpkgs. What did we do here? Well, we took the Nix expression
+that we used earlier to build a Python environment, and said that we wanted to
+include our own version of `toolz`. To introduce our own package in the scope of
+`withPackages` we used a
+[`let`](http://nixos.org/nix/manual/#sec-constructs) expression.
+You can see that we used `ps.numpy` to select numpy from the nixpkgs package set (`ps`).
+But we do not take `toolz` from the nixpkgs package set this time.
+Instead, `toolz` will resolve to our local definition that we introduced with `let`.
+
+### Handling dependencies
+
+Our example, `toolz`, doesn't have any dependencies on other Python
+packages or system libraries. According to the manual,  `buildPythonPackage`
+uses the arguments `buildInputs` and `propagatedBuildInputs` to specify dependencies. If something is
+exclusively a build-time dependency, then the dependency should be included as a
+`buildInput`, but if it is (also) a runtime dependency, then it should be added
+to `propagatedBuildInputs`. Test dependencies are considered build-time dependencies.
+
+The following example shows which arguments are given to `buildPythonPackage` in
+order to build [`datashape`](https://github.com/blaze/datashape).
+
+```nix
+datashape = buildPythonPackage rec {
+  name = "datashape-${version}";
+  version = "0.4.7";
+
+  src = pkgs.fetchurl {
+    url = "mirror://pypi/D/DataShape/${name}.tar.gz";
+    sha256 = "14b2ef766d4c9652ab813182e866f493475e65e558bed0822e38bf07bba1a278";
+  };
+
+  buildInputs = with self; [ pytest ];
+  propagatedBuildInputs = with self; [ numpy multipledispatch dateutil ];
+
+  meta = {
+    homepage = https://github.com/ContinuumIO/datashape;
+    description = "A data description language";
+    license = licenses.bsd2;
+    maintainers = with maintainers; [ fridh ];
+  };
+};
+```
+
+We can see several runtime dependencies, `numpy`, `multipledispatch`, and
+`dateutil`. Furthermore, we have one `buildInput`, i.e. `pytest`. `pytest` is a
+test runner and is only used during the `checkPhase` and is therefore not added
+to `propagatedBuildInputs`.
+
+In the previous case we had only dependencies on other Python packages to consider.
+Occasionally you have also system libraries to consider. E.g., `lxml` provides
+Python bindings to `libxml2` and `libxslt`. These libraries are only required
+when building the bindings and are therefore added as `buildInputs`.
+
+```nix
+lxml = buildPythonPackage rec {
+  name = "lxml-3.4.4";
+
+  src = pkgs.fetchurl {
+    url = "mirror://pypi/l/lxml/${name}.tar.gz";
+    sha256 = "16a0fa97hym9ysdk3rmqz32xdjqmy4w34ld3rm3jf5viqjx65lxk";
+  };
+
+  buildInputs = with self; [ pkgs.libxml2 pkgs.libxslt ];
+
+  meta = {
+    description = "Pythonic binding for the libxml2 and libxslt libraries";
+    homepage = http://lxml.de;
+    license = licenses.bsd3;
+    maintainers = with maintainers; [ sjourdois ];
+  };
+};
+```
+
+In this example `lxml` and Nix are able to work out exactly where the relevant
+files of the dependencies are. This is not always the case.
+
+The example below shows bindings to The Fastest Fourier Transform in the West, commonly known as
+FFTW. On Nix we have separate packages of FFTW for the different types of floats
+(`"single"`, `"double"`, `"long-double"`). The bindings need all three types,
+and therefore we add all three as `buildInputs`. The bindings don't expect to
+find each of them in a different folder, and therefore we have to set `LDFLAGS`
+and `CFLAGS`.
+
+```nix
+pyfftw = buildPythonPackage rec {
+  name = "pyfftw-${version}";
+  version = "0.9.2";
+
+  src = pkgs.fetchurl {
+    url = "mirror://pypi/p/pyFFTW/pyFFTW-${version}.tar.gz";
+    sha256 = "f6bbb6afa93085409ab24885a1a3cdb8909f095a142f4d49e346f2bd1b789074";
+  };
+
+  buildInputs = [ pkgs.fftw pkgs.fftwFloat pkgs.fftwLongDouble];
+
+  propagatedBuildInputs = with self; [ numpy scipy ];
+
+  # Tests cannot import pyfftw. pyfftw works fine though.
+  doCheck = false;
+
+  LDFLAGS="-L${pkgs.fftw}/lib -L${pkgs.fftwFloat}/lib -L${pkgs.fftwLongDouble}/lib"
+  CFLAGS="-I${pkgs.fftw}/include -I${pkgs.fftwFloat}/include -I${pkgs.fftwLongDouble}/include"
+  '';
+
+  meta = {
+    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 ];
+    maintainer = with maintainers; [ fridh ];
+  };
+};
+```
+Note also the line `doCheck = false;`, we explicitly disabled running the test-suite.
+
+
+#### Develop local package
+
+As a Python developer you're likely aware of [development mode](http://pythonhosted.org/setuptools/setuptools.html#development-mode) (`python setup.py develop`);
+instead of installing the package this command creates a special link to the project code.
+That way, you can run updated code without having to reinstall after each and every change you make.
+Development mode is also available on Nix as [explained](http://nixos.org/nixpkgs/manual/#ssec-python-development) in the Nixpkgs manual.
+Let's see how you can use it.
+
+In the previous Nix expression the source was fetched from an url. We can also refer to a local source instead using
+
+```nix
+src = ./path/to/source/tree;
+```
+
+If we create a `shell.nix` file which calls `buildPythonPackage`, and if `src`
+is a local source, and if the local source has a `setup.py`, then development
+mode is activated.
+
+In the following example we create a simple environment that
+has a Python 3.5 version of our package in it, as well as its dependencies and
+other packages we like to have in the environment, all specified with `propagatedBuildInputs`.
+Indeed, we can just add any package we like to have in our environment to `propagatedBuildInputs`.
+
+```nix
+with import <nixpkgs>;
+with pkgs.python35Packages;
+
+buildPythonPackage rec {
+  name = "mypackage";
+  src = ./path/to/package/source;
+  propagatedBuildInputs = [ pytest numpy pkgs.libsndfile ];
+};
+```
+
+It is important to note that due to how development mode is implemented on Nix it is not possible to have multiple packages simultaneously in development mode.
+
+
+### Organising your packages
+
+So far we discussed how you can use Python on Nix, and how you can develop with
+it. We've looked at how you write expressions to package Python packages, and we
+looked at how you can create environments in which specified packages are
+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 yourself a repository with your
+own packages. The important functions here are `import` and `callPackage`.
+
+### Including a derivation using `callPackage`
+
+Earlier we created a Python environment using `withPackages`, and included the
+`toolz` package via a `let` expression.
+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
+{ pkgs, buildPythonPackage }:
+
+buildPythonPackage rec {
+  name = "toolz-${version}";
+  version = "0.7.4";
+
+  src = pkgs.fetchurl{
+    url = "mirror://pypi/t/toolz/toolz-${version}.tar.gz";
+    sha256 = "43c2c9e5e7a16b6c88ba3088a9bfc82f7db8e13378be7c78d6c14a5f8ed05afd";
+  };
+
+  meta = {
+    homepage = "http://github.com/pytoolz/toolz/";
+    description = "List processing tools and functional utilities";
+    license = licenses.bsd3;
+    maintainers = with maintainers; [ fridh ];
+  };
+};
+```
+
+It takes two arguments, `pkgs` and `buildPythonPackage`.
+We now call this function using `callPackage` in the definition of our environment
+
+```nix
+with import <nixpkgs> {};
+
+( let
+    toolz = pkgs.callPackage ~/path/to/toolz/release.nix { pkgs=pkgs; buildPythonPackage=pkgs.python35Packages.buildPythonPackage; };
+  in pkgs.python35.withPackages (ps: [ ps.numpy toolz ])
+).env
+```
+
+Important to remember is that the Python version for which the package is made
+depends on the `python` derivation that is passed to `buildPythonPackage`. Nix
+tries to automatically pass arguments when possible, which is why generally you
+don't explicitly define which `python` derivation should be used. In the above
+example we use `buildPythonPackage` that is part of the set `python35Packages`,
+and in this case the `python35` interpreter is automatically used.
+
+
+
+## Reference
+
+### Interpreters
+
+Versions 2.6, 2.7, 3.3, 3.4 and 3.5 of the CPython interpreter are available on
+Nix and are available as `python26`, `python27`, `python33`, `python34` and
+`python35`. The PyPy interpreter is also available as `pypy`. Currently, the
+aliases `python` and `python3` correspond to respectively `python27` and
+`python35`. The Nix expressions for the interpreters can be found in
+`pkgs/development/interpreters/python`.
+
+
+#### Missing modules standard library
+
+The interpreters `python26` and `python27` do not include modules that
+require external dependencies. This is done in order to reduce the closure size.
+The following modules need to be added as `buildInput` explicitly:
+
+* `python.modules.bsddb`
+* `python.modules.curses`
+* `python.modules.curses_panel`
+* `python.modules.crypt`
+* `python.modules.gdbm`
+* `python.modules.sqlite3`
+* `python.modules.tkinter`
+* `python.modules.readline`
+
+For convenience `python27Full` and `python26Full` are provided with all
+modules included.
+
+All packages depending on any Python interpreter get appended
+`out/{python.sitePackages}` to `$PYTHONPATH` if such directory
+exists.
+
+#### Attributes on interpreters packages
+
+Each interpreter has the following attributes:
+
+- `libPrefix`. Name of the folder in `${python}/lib/` for corresponding interpreter.
+- `interpreter`. Alias for `${python}/bin/${executable}`.
+- `buildEnv`. Function to build python interpreter environments with extra packages bundled together. See section *python.buildEnv function* for usage and documentation.
+- `withPackages`. Simpler interface to `buildEnv`. See section *python.withPackages function* for usage and documentation.
+- `sitePackages`. Alias for `lib/${libPrefix}/site-packages`.
+- `executable`. Name of the interpreter executable, ie `python3.4`.
+
+### Building packages and applications
+
+Python packages (libraries) and applications that use `setuptools` or
+`distutils` are typically built with respectively the `buildPythonPackage` and
+`buildPythonApplication` functions.
+
+All Python packages reside in `pkgs/top-level/python-packages.nix` and all
+applications elsewhere. Some packages are also defined in
+`pkgs/development/python-modules`. It is important that these packages are
+called in `pkgs/top-level/python-packages.nix` and not elsewhere, to guarantee
+the right version of the package is built.
+
+Based on the packages defined in `pkgs/top-level/python-packages.nix` an
+attribute set is created for each available Python interpreter. The available
+sets are
+
+* `pkgs.python26Packages`
+* `pkgs.python27Packages`
+* `pkgs.python33Packages`
+* `pkgs.python34Packages`
+* `pkgs.python35Packages`
+* `pkgs.pypyPackages`
+
+and the aliases
+
+* `pkgs.pythonPackages` pointing to `pkgs.python27Packages`
+* `pkgs.python3Packages` pointing to `pkgs.python35Packages`
+
+#### `buildPythonPackage` function
+
+The `buildPythonPackage` function is implemented in
+`pkgs/development/python-modules/generic/default.nix`
+
+and can be used as:
+
+    twisted = buildPythonPackage {
+      name = "twisted-8.1.0";
+
+      src = pkgs.fetchurl {
+        url = http://tmrc.mit.edu/mirror/twisted/Twisted/8.1/Twisted-8.1.0.tar.bz2;
+        sha256 = "0q25zbr4xzknaghha72mq57kh53qw1bf8csgp63pm9sfi72qhirl";
+      };
+
+      propagatedBuildInputs = [ self.ZopeInterface ];
+
+      meta = {
+        homepage = http://twistedmatrix.com/;
+        description = "Twisted, an event-driven networking engine written in Python";
+        license = stdenv.lib.licenses.mit; };
+      };
+
+The `buildPythonPackage` mainly does four things:
+
+* In the `buildPhase`, it calls `${python.interpreter} setup.py bdist_wheel` to build a wheel binary zipfile.
+* In the `installPhase`, it installs the wheel file using `pip install *.whl`.
+* In the `postFixup` phase, the `wrapPythonPrograms` bash function is called to wrap all programs in the `$out/bin/*` directory to include `$PYTHONPATH` and `$PATH` environment variables.
+* In the `installCheck` phase, `${python.interpreter} setup.py test` is ran.
+
+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’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 `buildInputs`.
+
+By default `meta.platforms` is set to the same value
+as the interpreter unless overriden otherwise.
+
+##### `buildPythonPackage` parameters
+
+All parameters from `mkDerivation` function are still supported.
+
+* `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`.
+* `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. Options are `setup` for when the source has a `setup.py` and `setuptools` is used to build a wheel, and `wheel` in case the source is already a binary wheel. The default value is `setup`.
+
+#### `buildPythonApplication` function
+
+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.
+
+#### 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.
+Saving the following as `default.nix`
+
+    with import <nixpkgs> {};
+
+    python.buildEnv.override {
+      extraLibs = [ pkgs.pythonPackages.pyramid ];
+      ignoreCollisions = true;
+    }
+
+and running `nix-build` will create
+
+    /nix/store/cf1xhjwzmdki7fasgr4kz6di72ykicl5-python-2.7.8-env
+
+with wrapped binaries in `bin/`.
+
+You can also use the `env` attribute to create local environments with needed
+packages installed. This is somewhat comparable to `virtualenv`. For example,
+running `nix-shell` with the following `shell.nix`
+
+    with import <nixpkgs> {};
+
+    (python3.buildEnv.override {
+      extraLibs = with python3Packages; [ numpy requests ];
+    }).env
+
+will drop you into a shell where Python will have the
+specified packages in its path.
+
+
+##### `python.buildEnv` arguments
+
+* `extraLibs`: List of packages installed inside the environment.
+* `postBuild`: Shell command executed after the build of environment.
+* `ignoreCollisions`: Ignore file collisions inside the environment (default is `false`).
+
+#### 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 
+of the packages to be included in the environment. Using the `withPackages` function, the previous
+example for the Pyramid Web Framework environment can be written like this:
+
+    with import <nixpkgs> {};
+
+    python.withPackages (ps: [ps.pyramid])
+
+`withPackages` passes the correct package set for the specific interpreter version as an 
+argument to the function. In the above example, `ps` equals `pythonPackages`.
+But you can also easily switch to using python3:
+    
+    with import <nixpkgs> {};
+
+    python3.withPackages (ps: [ps.pyramid])
+
+Now, `ps` is set to `python3Packages`, matching the version of the interpreter.
+
+As `python.withPackages` simply uses `python.buildEnv` under the hood, it also supports the `env`
+attribute. The `shell.nix` file from the previous section can thus be also written like this:
+
+    with import <nixpkgs> {};
+
+    (python33.withPackages (ps: [ps.numpy ps.requests])).env
+
+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`.
+
+### Development mode
+
+Development or editable mode is supported. To develop Python packages
+`buildPythonPackage` has additional logic inside `shellPhase` to run `pip
+install -e . --prefix $TMPDIR/`for the package.
+
+Warning: `shellPhase` is executed only if `setup.py` exists.
+
+Given a `default.nix`:
+
+    with import <nixpkgs> {};
+
+    buildPythonPackage { name = "myproject";
+
+    buildInputs = with pkgs.pythonPackages; [ pyramid ];
+
+    src = ./.; }
+
+Running `nix-shell` with no arguments should give you
+the environment in which the package would be build with
+`nix-build`.
+
+Shortcut to setup environments with C headers/libraries and python packages:
+
+    $ nix-shell -p pythonPackages.pyramid zlib libjpeg git
+
+Note: There is a boolean value `lib.inNixShell` set to `true` if nix-shell is invoked.
+
+### Tools
+
+Packages inside nixpkgs are written by hand. However many tools exist in
+community to help save time. No tool is preferred at the moment.
+
+- [python2nix](https://github.com/proger/python2nix) by Vladimir Kirillov
+- [pypi2nix](https://github.com/garbas/pypi2nix) by Rok Garbas
+- [pypi2nix](https://github.com/offlinehacker/pypi2nix) by Jaka Hudoklin
+
+## FAQ
+
+### How to solve circular dependencies?
+
+Consider the packages `A` and `B` that depend on each other. When packaging `B`,
+a solution is to override package `A` not to depend on `B` as an input. The same
+should also be done when packaging `A`.
+
+### How to override a Python package?
+
+Recursively updating a package can be done with `pkgs.overridePackages` as explained in the Nixpkgs manual.
+Python attribute sets are created for each interpreter version. We will therefore override the attribute set for the interpreter version we're interested.
+In the following example we change the name of the package `pandas` to `foo`.
+```
+newpkgs = pkgs.overridePackages(self: super: rec {
+  python35Packages = super.python35Packages.override {
+    self = python35Packages // { pandas = python35Packages.pandas.override{name="foo";};};
+  };
+});
+```
+This can be tested with
+```
+with import <nixpkgs> {};
+
+(let
+
+newpkgs = pkgs.overridePackages(self: super: rec {
+  python35Packages = super.python35Packages.override {
+    self = python35Packages // { pandas = python35Packages.pandas.override{name="foo";};};
+  };
+});
+in newpkgs.python35.withPackages (ps: [ps.blaze])
+).env
+```
+A typical use case is to switch to another version of a certain package. For example, in the Nixpkgs repository we have multiple versions of `django` and `scipy`.
+In the following example we use a different version of `scipy`. All packages in `newpkgs` will now use the updated `scipy` version.
+```
+with import <nixpkgs> {};
+
+(let
+
+newpkgs = pkgs.overridePackages(self: super: rec {
+  python35Packages = super.python35Packages.override {
+    self = python35Packages // { scipy = python35Packages.scipy_0_16;};
+  };
+});
+in newpkgs.python35.withPackages (ps: [ps.blaze])
+).env
+```
+The requested package `blaze` depends upon `pandas` which itself depends on `scipy`.
+
+
+### `install_data` / `data_files` problems
+
+If you get the following error:
+
+    could not create '/nix/store/6l1bvljpy8gazlsw2aw9skwwp4pmvyxw-python-2.7.8/etc':
+    Permission denied
+
+This is a [known bug](https://bitbucket.org/pypa/setuptools/issue/130/install_data-doesnt-respect-prefix) in setuptools.
+Setuptools `install_data` does not respect `--prefix`. An example of such package using the feature is `pkgs/tools/X11/xpra/default.nix`.
+As workaround install it as an extra `preInstall` step:
+
+    ${python.interpreter} setup.py install_data --install-dir=$out --root=$out
+    sed -i '/ = data\_files/d' setup.py
+
+
+###  Rationale of non-existent global site-packages
+
+On most operating systems a global `site-packages` is maintained. This however
+becomes problematic if you want to run multiple Python versions or have multiple
+versions of certain libraries for your projects. Generally, you would solve such
+issues by creating virtual environments using `virtualenv`.
+
+On Nix each package has an isolated dependency tree which, in the case of
+Python, guarantees the right versions of the interpreter and libraries or
+packages are available. There is therefore no need to maintain a global `site-packages`.
+
+If you want to create a Python environment for development, then the recommended
+method is to use `nix-shell`, either with or without the `python.buildEnv`
+function.
+
+
+## Contributing
+
+### Contributing guidelines
+
+Following rules are desired to be respected:
+
+* Make sure package builds for all python interpreters. Use `disabled` argument to `buildPythonPackage` to set unsupported interpreters.
+* If tests need to be disabled for a package, make sure you leave a comment about reasoning.
+* Packages in `pkgs/top-level/python-packages.nix` are sorted quasi-alphabetically to avoid merge conflicts.
+* Python libraries are supposed to be in `python-packages.nix` and packaged with `buildPythonPackage`. Python applications live outside of `python-packages.nix` and are packaged with `buildPythonApplication`.

doc/languages-frameworks/qt.xml

@@ -1,185 +1,70 @@
 <section xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="sec-language-qt">
- <title>Qt</title>
 
- <para>
-   This section describes the differences between Nix expressions for Qt
-   libraries and applications and Nix expressions for other C++ software. Some
-   knowledge of the latter is assumed. There are primarily two problems which
-   the Qt infrastructure is designed to address: ensuring consistent versioning
-   of all dependencies and finding dependencies at runtime.
- </para>
+<title>Qt</title>
 
- <example xml:id='qt-default-nix'>
-   <title>Nix expression for a Qt package (<filename>default.nix</filename>)</title>
-   <programlisting>
-{ mkDerivation, lib, qtbase }: <co xml:id='qt-default-nix-co-1' />
+<para>The information in this section applies to Qt 5.5 and later.</para>
 
-mkDerivation { <co xml:id='qt-default-nix-co-2' />
-  pname = "myapp";
-  version = "1.0";
+<para>Qt is an application development toolkit for C++. Although it is
+not a distinct programming language, there are special considerations
+for packaging Qt-based programs and libraries. A small set of tools
+and conventions has grown out of these considerations.</para>
 
-  buildInputs = [ qtbase ]; <co xml:id='qt-default-nix-co-3' />
-}
-   </programlisting>
- </example>
+<section xml:id="ssec-qt-libraries"><title>Libraries</title>
 
- <calloutlist>
-   <callout arearefs='qt-default-nix-co-1'>
-     <para>
-       Import <literal>mkDerivation</literal> and Qt (such as
-       <literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis>
-       import Qt package sets; the Qt versions of dependencies may not be
-       coherent, causing build and runtime failures.
-     </para>
-   </callout>
-   <callout arearefs='qt-default-nix-co-2'>
-     <para>
-       Use <literal>mkDerivation</literal> instead of
-       <literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal>
-       is a wrapper around <literal>stdenv.mkDerivation</literal> which
-       applies some Qt-specific settings.
-       This deriver accepts the same arguments as
-       <literal>stdenv.mkDerivation</literal>; refer to
-       <xref linkend='chap-stdenv' /> for details.
-     </para>
-     <para>
-       To use another deriver instead of
-       <literal>stdenv.mkDerivation</literal>, use
-       <literal>mkDerivationWith</literal>:
-<programlisting>
-mkDerivationWith myDeriver {
-  # ...
-}
-</programlisting>
-       If you cannot use <literal>mkDerivationWith</literal>, please refer to
-       <xref linkend='qt-runtime-dependencies' />.
-     </para>
-   </callout>
-   <callout arearefs='qt-default-nix-co-3'>
-     <para>
-       <literal>mkDerivation</literal> accepts the same arguments as
-       <literal>stdenv.mkDerivation</literal>, such as
-       <literal>buildInputs</literal>.
-     </para>
-   </callout>
- </calloutlist>
-
- <formalpara xml:id='qt-runtime-dependencies'>
-   <title>Locating runtime dependencies</title>
-   <para>
-     Qt applications need to be wrapped to find runtime dependencies.  If you
-     cannot use <literal>mkDerivation</literal> or
-     <literal>mkDerivationWith</literal> above, include
-     <literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>:
-<programlisting>
-stdenv.mkDerivation {
-  # ...
-
-  nativeBuildInputs = [ wrapQtAppsHook ];
-}
-</programlisting>
-   </para>
- </formalpara>
-
- <para>
-   Entries added to <literal>qtWrapperArgs</literal> are used to modify the
-   wrappers created by <literal>wrapQtAppsHook</literal>. The entries are
-   passed as arguments to <xref linkend='fun-wrapProgram' />.
-<programlisting>
-mkDerivation {
-  # ...
-
-  qtWrapperArgs = [ ''--prefix PATH : /path/to/bin'' ];
-}
-</programlisting>
- </para>
-
- <para>
-  Set <literal>dontWrapQtApps</literal> to stop applications from being
-  wrapped automatically. It is required to wrap applications manually with
-  <literal>wrapQtApp</literal>, using the syntax of
-  <xref linkend='fun-wrapProgram' />:
-<programlisting>
-mkDerivation {
-  # ...
-
-  dontWrapQtApps = true;
-  preFixup = ''
-      wrapQtApp "$out/bin/myapp" --prefix PATH : /path/to/bin
-  '';
-}
-</programlisting>
- </para>
-
- <note>
-  <para>
-    <literal>wrapQtAppsHook</literal> ignores files that are non-ELF executables.
-    This means that scripts won't be automatically wrapped so you'll need to manually
-    wrap them as previously mentioned. An example of when you'd always need to do this
-    is with Python applications that use PyQT.
-  </para>
- </note>
-
- <para>
-  Libraries are built with every available version of Qt. Use the <literal>meta.broken</literal>
-  attribute to disable the package for unsupported Qt versions:
-<programlisting>
-mkDerivation {
-  # ...
-
-  # Disable this library with Qt &lt; 5.9.0
-  meta.broken = builtins.compareVersions qtbase.version "5.9.0" &lt; 0;
-}
-</programlisting>
- </para>
-
- <formalpara>
-   <title>Adding a library to Nixpkgs</title>
-   <para>
-     Add a Qt library to <filename>all-packages.nix</filename> by adding it to the
-     collection inside <literal>mkLibsForQt5</literal>. This ensures that the
-     library is built with every available version of Qt as needed.
-     <example xml:id='qt-library-all-packages-nix'>
-       <title>Adding a Qt library to <filename>all-packages.nix</filename></title>
-<programlisting>
-{
-  # ...
-
-  mkLibsForQt5 = self: with self; {
-    # ...
-
-    mylib = callPackage ../path/to/mylib {};
-  };
-
-  # ...
-}
-</programlisting>
-     </example>
-   </para>
- </formalpara>
-
- <formalpara>
-   <title>Adding an application to Nixpkgs</title>
-   <para>
-     Add a Qt application to <filename>all-packages.nix</filename> using
-     <literal>libsForQt5.callPackage</literal> instead of the usual
-     <literal>callPackage</literal>. The former ensures that all dependencies
-     are built with the same version of Qt.
-     <example xml:id='qt-application-all-packages-nix'>
-       <title>Adding a Qt application to <filename>all-packages.nix</filename></title>
-<programlisting>
-{
-  # ...
-
-  myapp = libsForQt5.callPackage ../path/to/myapp/ {};
-
-  # ...
-}
-</programlisting>
-     </example>
-   </para>
- </formalpara>
+<para>Packages that provide libraries should be listed in
+<varname>qt5LibsFun</varname> so that the library is built with each
+Qt version. A set of packages is provided for each version of Qt; for
+example, <varname>qt5Libs</varname> always provides libraries built
+with the latest version, <varname>qt55Libs</varname> provides
+libraries built with Qt 5.5, and so on. To avoid version conflicts, no
+top-level attributes are created for these packages.</para>
 
 </section>
+
+<section xml:id="ssec-qt-programs"><title>Programs</title>
+
+<para>Application packages do not need to be built with every Qt
+version. To ensure consistency between the package's dependencies,
+call the package with <literal>qt5Libs.callPackage</literal> instead
+of the usual <literal>callPackage</literal>. An older version may be
+selected in case of incompatibility. For example, to build with Qt
+5.5, call the package with
+<literal>qt55Libs.callPackage</literal>.</para>
+
+<para>Several environment variables must be set at runtime for Qt
+applications to function correctly, including:</para>
+
+<itemizedlist>
+  <listitem><para><envar>QT_PLUGIN_PATH</envar></para></listitem>
+  <listitem><para><envar>QML_IMPORT_PATH</envar></para></listitem>
+  <listitem><para><envar>QML2_IMPORT_PATH</envar></para></listitem>
+  <listitem><para><envar>XDG_DATA_DIRS</envar></para></listitem>
+</itemizedlist>
+
+<para>To ensure that these are set correctly, the program must be wrapped by
+invoking <literal>wrapQtProgram <replaceable>program</replaceable></literal>
+during installation (for example, during
+<literal>fixupPhase</literal>). <literal>wrapQtProgram</literal>
+accepts the same options as <literal>makeWrapper</literal>.
+</para>
+
+</section>
+
+<section xml:id="ssec-qt-kde"><title>KDE</title>
+
+<para>Many of the considerations above also apply to KDE packages,
+especially the need to set the correct environment variables at
+runtime. To ensure that this is done, invoke <literal>wrapKDEProgram
+<replaceable>program</replaceable></literal> during
+installation. <literal>wrapKDEProgram</literal> also generates a
+<literal>ksycoca</literal> database so that required data and services
+can be found. Like its Qt counterpart,
+<literal>wrapKDEProgram</literal> accepts the same options as
+<literal>makeWrapper</literal>.</para>
+
+</section>
+
+</section>
+

doc/languages-frameworks/r.section.md

@@ -1,120 +0,0 @@
-R packages
-==========
-
-## Installation
-
-Define an environment for R that contains all the libraries that you'd like to
-use by adding the following snippet to your $HOME/.config/nixpkgs/config.nix file:
-
-```nix
-{
-    packageOverrides = super: let self = super.pkgs; in
-    {
-
-        rEnv = super.rWrapper.override {
-            packages = with self.rPackages; [
-                devtools
-                ggplot2
-                reshape2
-                yaml
-                optparse
-                ];
-        };
-    };
-}
-```
-
-Then you can use `nix-env -f "<nixpkgs>" -iA rEnv` to install it into your user
-profile. The set of available libraries can be discovered by running the
-command `nix-env -f "<nixpkgs>" -qaP -A rPackages`. The first column from that
-output is the name that has to be passed to rWrapper in the code snipped above.
-
-However, if you'd like to add a file to your project source to make the
-environment available for other contributors, you can create a `default.nix`
-file like so:
-```nix
-let
-  pkgs = import <nixpkgs> {};
-  stdenv = pkgs.stdenv;
-in with pkgs; {
-  myProject = stdenv.mkDerivation {
-    name = "myProject";
-    version = "1";
-    src = if pkgs.lib.inNixShell then null else nix;
-
-    buildInputs = with rPackages; [
-      R
-      ggplot2
-      knitr
-    ];
-  };
-}
-```
-and then run `nix-shell .` to be dropped into a shell with those packages
-available.
-
-## RStudio
-
-RStudio uses a standard set of packages and ignores any custom R
-environments or installed packages you may have.  To create a custom
-environment, see `rstudioWrapper`, which functions similarly to
-`rWrapper`:
-
-```nix
-{
-    packageOverrides = super: let self = super.pkgs; in
-    {
-
-        rstudioEnv = super.rstudioWrapper.override {
-            packages = with self.rPackages; [
-                dplyr
-                ggplot2
-                reshape2
-                ];
-        };
-    };
-}
-```
-
-Then like above, `nix-env -f "<nixpkgs>" -iA rstudioEnv` will install
-this into your user profile.
-
-Alternatively, you can create a self-contained `shell.nix` without the need to
-modify any configuration files:
-
-```nix
-{ pkgs ? import <nixpkgs> {}
-}:
-
-pkgs.rstudioWrapper.override {
-  packages = with pkgs.rPackages; [ dplyr ggplot2 reshape2 ];
-}
-
-```
-
-Executing `nix-shell` will then drop you into an environment equivalent to the
-one above. If you need additional packages just add them to the list and
-re-enter the shell.
-
-## Updating the package set
-
-```bash
-nix-shell generate-shell.nix
-
-Rscript generate-r-packages.R cran  > cran-packages.nix.new
-mv cran-packages.nix.new cran-packages.nix
-
-Rscript generate-r-packages.R bioc  > bioc-packages.nix.new
-mv bioc-packages.nix.new bioc-packages.nix
-```
-
-`generate-r-packages.R <repo>` reads  `<repo>-packages.nix`, therefor the renaming.
-
-
-## Testing if the Nix-expression could be evaluated
-
-```bash
-nix-build test-evaluation.nix --dry-run
-```
-
-If this exits fine, the expression is ok. If not, you have to edit `default.nix`

doc/languages-frameworks/ruby.section.md

@@ -1,365 +0,0 @@
----
-title: Ruby
-author: Michael Fellinger
-date: 2019-05-23
----
-
-# Ruby
-
-## User Guide
-
-### Using Ruby
-
-#### Overview
-
-Several versions of Ruby interpreters are available on Nix, as well as over 250 gems and many applications written in Ruby.
-The attribute `ruby` refers to the default Ruby interpreter, which is currently
-MRI 2.5. It's also possible to refer to specific versions, e.g. `ruby_2_6`, `jruby`, or `mruby`.
-
-In the nixpkgs tree, Ruby packages can be found throughout, depending on what
-they do, and are called from the main package set. Ruby gems, however are
-separate sets, and there's one default set for each interpreter (currently MRI
-only).
-
-There are two main approaches for using Ruby with gems.
-One is to use a specifically locked `Gemfile` for an application that has very strict dependencies.
-The other is to depend on the common gems, which we'll explain further down, and
-rely on them being updated regularly.
-
-The interpreters have common attributes, namely `gems`, and `withPackages`. So
-you can refer to `ruby.gems.nokogiri`, or `ruby_2_5.gems.nokogiri` to get the
-Nokogiri gem already compiled and ready to use.
-
-Since not all gems have executables like `nokogiri`, it's usually more
-convenient to use the `withPackages` function like this:
-`ruby.withPackages (p: with p; [ nokogiri ])`. This will also make sure that the
-Ruby in your environment will be able to find the gem and it can be used in your
-Ruby code (for example via `ruby` or `irb` executables) via `require "nokogiri"`
-as usual.
-
-#### Temporary Ruby environment with `nix-shell`
-
-Rather than having a single Ruby environment shared by all Ruby
-development projects on a system, Nix allows you to create separate
-environments per project.  `nix-shell` gives you the possibility to
-temporarily load another environment akin to a combined `chruby` or
-`rvm` and `bundle exec`.
-
-There are two methods for loading a shell with Ruby packages. The first and
-recommended method is to create an environment with `ruby.withPackages` and load
-that.
-
-```shell
-nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])"
-```
-
-The other method, which is not recommended, is to create an environment and list
-all the packages directly.
-
-```shell
-nix-shell -p ruby.gems.nokogiri ruby.gems.pry
-```
-
-Again, it's possible to launch the interpreter from the shell. The Ruby
-interpreter has the attribute `gems` which contains all Ruby gems for that
-specific interpreter.
-
-##### Load environment from `.nix` expression
-
-As explained in the Nix manual, `nix-shell` can also load an expression from a
-`.nix` file. Say we want to have Ruby 2.5, `nokogori`, and `pry`. Consider a
-`shell.nix` file with:
-
-```nix
-with import <nixpkgs> {};
-ruby.withPackages (ps: with ps; [ nokogiri pry ])
-```
-
-What's happening here?
-
-1. We begin with importing the Nix Packages collections. `import <nixpkgs>`
-   imports the `<nixpkgs>` function, `{}` calls it and the `with` statement
-   brings all attributes of `nixpkgs` in the local scope. These attributes form
-   the main package set.
-2. Then we create a Ruby environment with the `withPackages` function.
-3. The `withPackages` function expects us to provide a function as an argument
-   that takes the set of all ruby gems and returns a list of packages to include
-   in the environment. Here, we select the packages `nokogiri` and `pry` from
-   the package set.
-
-##### Execute command with `--run`
-
-A convenient flag for `nix-shell` is `--run`. It executes a command in the
-`nix-shell`. We can e.g. directly open a `pry` REPL:
-
-```shell
-nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])" --run "pry"
-```
-
-Or immediately require `nokogiri` in pry:
-
-```shell
-nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])" --run "pry -rnokogiri"
-```
-
-Or run a script using this environment:
-
-```shell
-nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])" --run "ruby example.rb"
-```
-
-##### Using `nix-shell` as shebang
-
-In fact, for the last case, there is a more convenient method. You can add a
-[shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) to your script
-specifying which dependencies `nix-shell` needs. With the following shebang, you
-can just execute `./example.rb`, and it will run with all dependencies.
-
-```ruby
-#! /usr/bin/env nix-shell
-#! nix-shell -i ruby -p "ruby.withPackages (ps: with ps; [ nokogiri rest-client ])"
-
-require 'nokogiri'
-require 'rest-client'
-
-body = RestClient.get('http://example.com').body
-puts Nokogiri::HTML(body).at('h1').text
-```
-
-### Developing with Ruby
-
-#### Using an existing Gemfile
-
-In most cases, you'll already have a `Gemfile.lock` listing all your dependencies.
-This can be used to generate a `gemset.nix` which is used to fetch the gems and
-combine them into a single environment.
-The reason why you need to have a separate file for this, is that Nix requires
-you to have a checksum for each input to your build.
-Since the `Gemfile.lock` that `bundler` generates doesn't provide us with
-checksums, we have to first download each gem, calculate its SHA256, and store
-it in this separate file.
-
-So the steps from having just a `Gemfile` to a `gemset.nix` are:
-
-```shell
-bundle lock
-bundix
-```
-
-If you already have a `Gemfile.lock`, you can simply run `bundix` and it will
-work the same.
-
-To update the gems in your `Gemfile.lock`, you may use the `bundix -l` flag,
-which will create a new `Gemfile.lock` in case the `Gemfile` has a more recent
-time of modification.
-
-Once the `gemset.nix` is generated, it can be used in a
-`bundlerEnv` derivation. Here is an example you could use for your `shell.nix`:
-
-```nix
-# ...
-let
-  gems = bundlerEnv {
-    name = "gems-for-some-project";
-    gemdir = ./.;
-  };
-in mkShell { buildInputs = [ gems gems.wrappedRuby ]; }
-```
-
-With this file in your directory, you can run `nix-shell` to build and use the gems.
-The important parts here are `bundlerEnv` and `wrappedRuby`.
-
-The `bundlerEnv` is a wrapper over all the gems in your gemset. This means that
-all the `/lib` and `/bin` directories will be available, and the executables of
-all gems (even of indirect dependencies) will end up in your `$PATH`.
-The `wrappedRuby` provides you with all executables that come with Ruby itself,
-but wrapped so they can easily find the gems in your gemset.
-
-One common issue that you might have is that you have Ruby 2.6, but also
-`bundler` in your gemset. That leads to a conflict for `/bin/bundle` and
-`/bin/bundler`. You can resolve this by wrapping either your Ruby or your gems
-in a `lowPrio` call. So in order to give the `bundler` from your gemset
-priority, it would be used like this:
-
-```nix
-# ...
-mkShell { buildInputs = [ gems (lowPrio gems.wrappedRuby) ]; }
-```
-
-
-#### Gem-specific configurations and workarounds
-
-In some cases, especially if the gem has native extensions, you might need to
-modify the way the gem is built.
-
-This is done via a common configuration file that includes all of the
-workarounds for each gem.
-
-This file lives at `/pkgs/development/ruby-modules/gem-config/default.nix`,
-since it already contains a lot of entries, it should be pretty easy to add the
-modifications you need for your needs.
-
-In the meanwhile, or if the modification is for a private gem, you can also add
-the configuration to only your own environment.
-
-Two places that allow this modification are the `ruby` derivation, or `bundlerEnv`.
-
-Here's the `ruby` one:
-
-```nix
-{ pg_version ? "10", pkgs ? import <nixpkgs> { } }:
-let
-  myRuby = pkgs.ruby.override {
-    defaultGemConfig = pkgs.defaultGemConfig // {
-      pg = attrs: {
-        buildFlags =
-        [ "--with-pg-config=${pkgs."postgresql_${pg_version}"}/bin/pg_config" ];
-      };
-    };
-  };
-in myRuby.withPackages (ps: with ps; [ pg ])
-```
-
-And an example with `bundlerEnv`:
-
-```nix
-{ pg_version ? "10", pkgs ? import <nixpkgs> { } }:
-let
-  gems = pkgs.bundlerEnv {
-    name = "gems-for-some-project";
-    gemdir = ./.;
-    gemConfig = pkgs.defaultGemConfig // {
-      pg = attrs: {
-        buildFlags =
-        [ "--with-pg-config=${pkgs."postgresql_${pg_version}"}/bin/pg_config" ];
-      };
-    };
-  };
-in mkShell { buildInputs = [ gems gems.wrappedRuby ]; }
-```
-
-And finally via overlays:
-
-```nix
-{ pg_version ? "10" }:
-let
-  pkgs = import <nixpkgs> {
-    overlays = [
-      (self: super: {
-        defaultGemConfig = super.defaultGemConfig // {
-          pg = attrs: {
-            buildFlags = [
-              "--with-pg-config=${
-                pkgs."postgresql_${pg_version}"
-              }/bin/pg_config"
-            ];
-          };
-        };
-      })
-    ];
-  };
-in pkgs.ruby.withPackages (ps: with ps; [ pg ])
-```
-
-Then we can get whichever postgresql version we desire and the `pg` gem will
-always reference it correctly:
-
-```shell
-$ nix-shell --argstr pg_version 9_4 --run 'ruby -rpg -e "puts PG.library_version"'
-90421
-
-$ nix-shell --run 'ruby -rpg -e "puts PG.library_version"'
-100007
-```
-
-Of course for this use-case one could also use overlays since the configuration
-for `pg` depends on the `postgresql` alias, but for demonstration purposes this
-has to suffice.
-
-#### Adding a gem to the default gemset
-
-Now that you know how to get a working Ruby environment with Nix, it's time to
-go forward and start actually developing with Ruby.
-We will first have a look at how Ruby gems are packaged on Nix. Then, we will
-look at how you can use development mode with your code.
-
-All gems in the standard set are automatically generated from a single
-`Gemfile`. The dependency resolution is done with `bundler` and makes it more
-likely that all gems are compatible to each other.
-
-In order to add a new gem to nixpkgs, you can put it into the
-`/pkgs/development/ruby-modules/with-packages/Gemfile` and run
-`./maintainers/scripts/update-ruby-packages`.
-
-To test that it works, you can then try using the gem with:
-
-```shell
-NIX_PATH=nixpkgs=$PWD nix-shell -p "ruby.withPackages (ps: with ps; [ name-of-your-gem ])"
-```
-
-#### Packaging applications
-
-A common task is to add a ruby executable to nixpkgs, popular examples would be
-`chef`, `jekyll`, or `sass`. A good way to do that is to use the `bundlerApp`
-function, that allows you to make a package that only exposes the listed
-executables, otherwise the package may cause conflicts through common paths like
-`bin/rake` or `bin/bundler` that aren't meant to be used.
-
-The absolute easiest way to do that is to write a
-`Gemfile` along these lines:
-
-```ruby
-source 'https://rubygems.org' do
-  gem 'mdl'
-end
-```
-
-If you want to package a specific version, you can use the standard Gemfile
-syntax for that, e.g. `gem 'mdl', '0.5.0'`, but if you want the latest stable
-version anyway, it's easier to update by simply running the `bundle lock` and
-`bundix` steps again.
-
-Now you can also also make a `default.nix` that looks like this:
-
-```nix
-{ lib, bundlerApp }:
-
-bundlerApp {
-  pname = "mdl";
-  gemdir = ./.;
-  exes = [ "mdl" ];
-}
-```
-
-All that's left to do is to generate the corresponding `Gemfile.lock` and
-`gemset.nix` as described above in the `Using an existing Gemfile` section.
-
-##### Packaging executables that require wrapping
-
-Sometimes your app will depend on other executables at runtime, and tries to
-find it through the `PATH` environment variable.
-
-In this case, you can provide a `postBuild` hook to `bundlerApp` that wraps the
-gem in another script that prefixes the `PATH`.
-
-Of course you could also make a custom `gemConfig` if you know exactly how to
-patch it, but it's usually much easier to maintain with a simple wrapper so the
-patch doesn't have to be adjusted for each version.
-
-Here's another example:
-
-```nix
-{ lib, bundlerApp, makeWrapper, git, gnutar, gzip }:
-
-bundlerApp {
-  pname = "r10k";
-  gemdir = ./.;
-  exes = [ "r10k" ];
-
-  buildInputs = [ makeWrapper ];
-
-  postBuild = ''
-    wrapProgram $out/bin/r10k --prefix PATH : ${lib.makeBinPath [ git gnutar gzip ]}
-  '';
-}
-```

doc/languages-frameworks/ruby.xml

@@ -1,19 +1,13 @@
 <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
@@ -22,7 +16,8 @@ $ cd sensu
 $ cat > Gemfile
 source 'https://rubygems.org'
 gem 'sensu'
-$ $(nix-build '<nixpkgs>' -A bundix --no-out-link)/bin/bundix --magic
+$ nix-shell -p bundler --command "bundler package --path /tmp/vendor/bundle"
+$ $(nix-build '<nixpkgs>' -A bundix)/bin/bundix
 $ cat > default.nix
 { lib, bundlerEnv, ruby }:
 
@@ -31,8 +26,9 @@ bundlerEnv rec {
 
   version = (import gemset).sensu.version;
   inherit ruby;
-  # expects Gemfile, Gemfile.lock and gemset.nix in the same directory
-  gemdir = ./.;
+  gemfile = ./Gemfile;
+  lockfile = ./Gemfile.lock;
+  gemset = ./gemset.nix;
 
   meta = with lib; {
     description = "A monitoring framework that aims to be simple, malleable, and scalable";
@@ -44,73 +40,15 @@ 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>
-  Updating Ruby packages can then be done like this:
- </para>
-
-<screen>
-<![CDATA[$ cd pkgs/servers/monitoring/sensu
-$ nix-shell -p bundler --run 'bundle lock --update'
-$ nix-shell -p bundix --run 'bundix'
-]]>
-</screen>
-
- <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 }:
-
-bundlerApp {
-  pname = "corundum";
-  gemdir = ./.;
-  exes = [ "corundum-skel" ];
-
-  meta = with lib; {
-    description = "Tool and libraries for maintaining Ruby gems.";
-    homepage    = https://github.com/nyarly/corundum;
-    license     = licenses.mit;
-    maintainers = [ maintainers.nyarly ];
-    platforms   = platforms.unix;
-  };
-}]]>
-</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>
-  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 also have two helpful items, <literal>env</literal> and <literal>wrapper</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> lile this:</para>
 
 <programlisting>
 <![CDATA[let env = bundlerEnv {
@@ -124,12 +62,18 @@ bundlerApp {
 
 in stdenv.mkDerivation {
   name = "my-script";
-  buildInputs = [ env.wrappedRuby ];
+
+  buildInputs = [ env.wrapper ];
+
   script = ./my-script.rb;
+
   buildCommand = ''
+    mkdir -p $out/bin
     install -D -m755 $script $out/bin/my-script
     patchShebangs $out/bin/my-script
   '';
 }]]>
 </programlisting>
+
 </section>
+

doc/languages-frameworks/rust.section.md

@@ -1,399 +0,0 @@
----
-title: Rust
-author: Matthias Beyer
-date: 2017-03-05
----
-
-# User's Guide to the Rust Infrastructure
-
-To install the rust compiler and cargo put
-
-```
-rustc
-cargo
-```
-
-into the `environment.systemPackages` or bring them into
-scope with `nix-shell -p rustc cargo`.
-
-> If you are using NixOS and you want to use rust without a nix expression you
-> probably want to add the following in your `configuration.nix` to build
-> crates with C dependencies.
->
->     environment.systemPackages = [binutils gcc gnumake openssl pkgconfig]
-
-For daily builds (beta and nightly) use either rustup from
-nixpkgs or use the [Rust nightlies
-overlay](#using-the-rust-nightlies-overlay).
-
-## Compiling Rust applications with Cargo
-
-Rust applications are packaged by using the `buildRustPackage` helper from `rustPlatform`:
-
-```
-rustPlatform.buildRustPackage rec {
-  name = "ripgrep-${version}";
-  version = "0.4.0";
-
-  src = fetchFromGitHub {
-    owner = "BurntSushi";
-    repo = "ripgrep";
-    rev = "${version}";
-    sha256 = "0y5d1n6hkw85jb3rblcxqas2fp82h3nghssa4xqrhqnz25l799pj";
-  };
-
-  cargoSha256 = "0q68qyl2h6i0qsz82z840myxlnjay8p1w5z7hfyr8fqp7wgwa9cx";
-
-  meta = with stdenv.lib; {
-    description = "A fast line-oriented regex search tool, similar to ag and ack";
-    homepage = https://github.com/BurntSushi/ripgrep;
-    license = licenses.unlicense;
-    maintainers = [ maintainers.tailhook ];
-    platforms = platforms.all;
-  };
-}
-```
-
-`buildRustPackage` requires a `cargoSha256` attribute which is computed over
-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.
-
-## Compiling Rust crates using Nix instead of Cargo
-
-### Simple operation
-
-When run, `cargo build` produces a file called `Cargo.lock`,
-containing pinned versions of all dependencies. Nixpkgs contains a
-tool called `carnix` (`nix-env -iA nixos.carnix`), which can be used
-to turn a `Cargo.lock` into a Nix expression.
-
-That Nix expression calls `rustc` directly (hence bypassing Cargo),
-and can be used to compile a crate and all its dependencies. Here is
-an example for a minimal `hello` crate:
-
-
-    $ cargo new hello
-    $ cd hello
-    $ cargo build
-     Compiling hello v0.1.0 (file:///tmp/hello)
-      Finished dev [unoptimized + debuginfo] target(s) in 0.20 secs
-    $ carnix -o hello.nix --src ./. Cargo.lock --standalone
-    $ nix-build hello.nix -A hello_0_1_0
-
-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;
-    # ... (content skipped)
-in
-rec {
-  hello = f: hello_0_1_0 { features = hello_0_1_0_features { hello_0_1_0 = f; }; };
-  hello_0_1_0_ = { dependencies?[], buildDependencies?[], features?[] }: buildRustCrate {
-    crateName = "hello";
-    version = "0.1.0";
-    authors = [ "pe@pijul.org <pe@pijul.org>" ];
-    src = ./.;
-    inherit dependencies buildDependencies features;
-  };
-  hello_0_1_0 = { features?(hello_0_1_0_features {}) }: hello_0_1_0_ {};
-  hello_0_1_0_features = f: updateFeatures f (rec {
-        hello_0_1_0.default = (f.hello_0_1_0.default or true);
-    }) [ ];
-}
-```
-
-In particular, note that the argument given as `--src` is copied
-verbatim to the source. If we look at a more complicated
-dependencies, for instance by adding a single line `libc="*"` to our
-`Cargo.toml`, we first need to run `cargo build` to update the
-`Cargo.lock`. Then, `carnix` needs to be run again, and produces the
-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;
-    # ... (content skipped)
-in
-rec {
-  hello = f: hello_0_1_0 { features = hello_0_1_0_features { hello_0_1_0 = f; }; };
-  hello_0_1_0_ = { dependencies?[], buildDependencies?[], features?[] }: buildRustCrate {
-    crateName = "hello";
-    version = "0.1.0";
-    authors = [ "pe@pijul.org <pe@pijul.org>" ];
-    src = ./.;
-    inherit dependencies buildDependencies features;
-  };
-  libc_0_2_36_ = { dependencies?[], buildDependencies?[], features?[] }: buildRustCrate {
-    crateName = "libc";
-    version = "0.2.36";
-    authors = [ "The Rust Project Developers" ];
-    sha256 = "01633h4yfqm0s302fm0dlba469bx8y6cs4nqc8bqrmjqxfxn515l";
-    inherit dependencies buildDependencies features;
-  };
-  hello_0_1_0 = { features?(hello_0_1_0_features {}) }: hello_0_1_0_ {
-    dependencies = mapFeatures features ([ libc_0_2_36 ]);
-  };
-  hello_0_1_0_features = f: updateFeatures f (rec {
-    hello_0_1_0.default = (f.hello_0_1_0.default or true);
-    libc_0_2_36.default = true;
-  }) [ libc_0_2_36_features ];
-  libc_0_2_36 = { features?(libc_0_2_36_features {}) }: libc_0_2_36_ {
-    features = mkFeatures (features.libc_0_2_36 or {});
-  };
-  libc_0_2_36_features = f: updateFeatures f (rec {
-    libc_0_2_36.default = (f.libc_0_2_36.default or true);
-    libc_0_2_36.use_std =
-      (f.libc_0_2_36.use_std or false) ||
-      (f.libc_0_2_36.default or false) ||
-      (libc_0_2_36.default or false);
-  }) [];
-}
-```
-
-Here, the `libc` crate has no `src` attribute, so `buildRustCrate`
-will fetch it from [crates.io](https://crates.io). A `sha256`
-attribute is still needed for Nix purity.
-
-### Handling external dependencies
-
-Some crates require external libraries. For crates from
-[crates.io](https://crates.io), such libraries can be specified in
-`defaultCrateOverrides` package in nixpkgs itself.
-
-Starting from that file, one can add more overrides, to add features
-or build inputs by overriding the hello crate in a seperate file.
-
-```
-with import <nixpkgs> {};
-((import ./hello.nix).hello {}).override {
-  crateOverrides = defaultCrateOverrides // {
-    hello = attrs: { buildInputs = [ openssl ]; };
-  };
-}
-```
-
-Here, `crateOverrides` is expected to be a attribute set, where the
-key is the crate name without version number and the value a function.
-The function gets all attributes passed to `buildRustCrate` as first
-argument and returns a set that contains all attribute that should be
-overwritten.
-
-For more complicated cases, such as when parts of the crate's
-derivation depend on the the crate's version, the `attrs` argument of
-the override above can be read, as in the following example, which
-patches the derivation:
-
-```
-with import <nixpkgs> {};
-((import ./hello.nix).hello {}).override {
-  crateOverrides = defaultCrateOverrides // {
-    hello = attrs: lib.optionalAttrs (lib.versionAtLeast attrs.version "1.0")  {
-      postPatch = ''
-        substituteInPlace lib/zoneinfo.rs \
-          --replace "/usr/share/zoneinfo" "${tzdata}/share/zoneinfo"
-      '';
-    };
-  };
-}
-```
-
-Another situation is when we want to override a nested
-dependency. This actually works in the exact same way, since the
-`crateOverrides` parameter is forwarded to the crate's
-dependencies. For instance, to override the build inputs for crate
-`libc` in the example above, where `libc` is a dependency of the main
-crate, we could do:
-
-```
-with import <nixpkgs> {};
-((import hello.nix).hello {}).override {
-  crateOverrides = defaultCrateOverrides // {
-    libc = attrs: { buildInputs = []; };
-  };
-}
-```
-
-### Options and phases configuration
-
-Actually, the overrides introduced in the previous section are more
-general. A number of other parameters can be overridden:
-
-- The version of rustc used to compile the crate:
-
-  ```
-  (hello {}).override { rust = pkgs.rust; };
-  ```
-
-- Whether to build in release mode or debug mode (release mode by
-  default):
-
-  ```
-  (hello {}).override { release = false; };
-  ```
-
-- Whether to print the commands sent to rustc when building
-  (equivalent to `--verbose` in cargo:
-
-  ```
-  (hello {}).override { verbose = false; };
-  ```
-
-- Extra arguments to be passed to `rustc`:
-
-  ```
-  (hello {}).override { extraRustcOpts = "-Z debuginfo=2"; };
-  ```
-
-- Phases, just like in any other derivation, can be specified using
-  the following attributes: `preUnpack`, `postUnpack`, `prePatch`,
-  `patches`, `postPatch`, `preConfigure` (in the case of a Rust crate,
-  this is run before calling the "build" script), `postConfigure`
-  (after the "build" script),`preBuild`, `postBuild`, `preInstall` and
-  `postInstall`. As an example, here is how to create a new module
-  before running the build script:
-
-  ```
-  (hello {}).override {
-    preConfigure = ''
-       echo "pub const PATH=\"${hi.out}\";" >> src/path.rs"
-    '';
-  };
-  ```
-
-### Features
-
-One can also supply features switches. For example, if we want to
-compile `diesel_cli` only with the `postgres` feature, and no default
-features, we would write:
-
-```
-(callPackage ./diesel.nix {}).diesel {
-  default = false;
-  postgres = true;
-}
-```
-
-Where `diesel.nix` is the file generated by Carnix, as explained above.
-
-
-## Setting Up `nix-shell`
-Oftentimes you want to develop code from within `nix-shell`. Unfortunately
-`buildRustCrate` does not support common `nix-shell` operations directly
-(see [this issue](https://github.com/NixOS/nixpkgs/issues/37945))
-so we will use `stdenv.mkDerivation` instead.
-
-Using the example `hello` project above, we want to do the following:
-- Have access to `cargo` and `rustc`
-- Have the `openssl` library available to a crate through it's _normal_
-  compilation mechanism (`pkg-config`).
-
-A typical `shell.nix` might look like:
-
-```
-with import <nixpkgs> {};
-
-stdenv.mkDerivation {
-  name = "rust-env";
-  nativeBuildInputs = [
-    rustc cargo
-
-    # Example Build-time Additional Dependencies
-    pkgconfig
-  ];
-  buildInputs = [
-    # Example Run-time Additional Dependencies
-    openssl
-  ];
-
-  # Set Environment Variables
-  RUST_BACKTRACE = 1;
-}
-```
-
-You should now be able to run the following:
-```
-$ nix-shell --pure
-$ cargo build
-$ cargo test
-```
-
-### Controlling Rust Version Inside `nix-shell`
-To control your rust version (i.e. use nightly) from within `shell.nix` (or
-other nix expressions) you can use the following `shell.nix`
-
-```
-# Latest Nightly
-with import <nixpkgs> {};
-let src = fetchFromGitHub {
-      owner = "mozilla";
-      repo = "nixpkgs-mozilla";
-      # commit from: 2019-05-15
-      rev = "9f35c4b09fd44a77227e79ff0c1b4b6a69dff533";
-      sha256 = "18h0nvh55b5an4gmlgfbvwbyqj91bklf1zymis6lbdh75571qaz0";
-   };
-in
-with import "${src.out}/rust-overlay.nix" pkgs pkgs;
-stdenv.mkDerivation {
-  name = "rust-env";
-  buildInputs = [
-    # Note: to use use stable, just replace `nightly` with `stable`
-    latest.rustChannels.nightly.rust
-
-    # Add some extra dependencies from `pkgs`
-    pkgconfig openssl
-  ];
-
-  # Set Environment Variables
-  RUST_BACKTRACE = 1;
-}
-```
-
-Now run:
-```
-$ rustc --version
-rustc 1.26.0-nightly (188e693b3 2018-03-26)
-```
-
-To see that you are using nightly.
-
-
-## Using the Rust nightlies overlay
-
-Mozilla provides an overlay for nixpkgs to bring a nightly version of Rust into scope.
-This overlay can _also_ be used to install recent unstable or stable versions
-of Rust, if desired.
-
-To use this overlay, clone
-[nixpkgs-mozilla](https://github.com/mozilla/nixpkgs-mozilla),
-and create a symbolic link to the file
-[rust-overlay.nix](https://github.com/mozilla/nixpkgs-mozilla/blob/master/rust-overlay.nix)
-in the `~/.config/nixpkgs/overlays` directory.
-
-    $ git clone https://github.com/mozilla/nixpkgs-mozilla.git
-    $ mkdir -p ~/.config/nixpkgs/overlays
-    $ ln -s $(pwd)/nixpkgs-mozilla/rust-overlay.nix ~/.config/nixpkgs/overlays/rust-overlay.nix
-
-The latest version can be installed with the following command:
-
-    $ nix-env -Ai nixos.latest.rustChannels.stable.rust
-
-Or using the attribute with nix-shell:
-
-    $ nix-shell -p nixos.latest.rustChannels.stable.rust
-
-To install the beta or nightly channel, "stable" should be substituted by
-"nightly" or "beta", or
-use the function provided by this overlay to pull a version based on a
-build date.
-
-The overlay automatically updates itself as it uses the same source as
-[rustup](https://www.rustup.rs/).

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>
+      </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:
@@ -44,56 +29,31 @@ texlive.combine {
   # elem tlType [ "run" "bin" "doc" "source" ]
   # there are also other attributes: version, name
 }
-</programlisting>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     You can list packages e.g. by <command>nix repl</command>.
-<programlisting><![CDATA[
-$ nix repl
-nix-repl> :l <nixpkgs>
-nix-repl> texlive.collection-<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>
+      </programlisting>
+    </para></listitem>
+    <listitem><para>
+      You can list packages e.g. by <command>nix-repl</command>.
+      <programlisting>
+$ nix-repl
+nix-repl> texlive.collection-&lt;TAB>
+      </programlisting>
+    </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/titanium.section.md

@@ -1,115 +0,0 @@
----
-title: Titanium
-author: Sander van der Burg
-date: 2018-11-18
----
-# Titanium
-
-The Nixpkgs repository contains facilities to deploy a variety of versions of
-the [Titanium SDK](https://www.appcelerator.com) versions, a cross-platform
-mobile app development framework using JavaScript as an implementation language,
-and includes a function abstraction making it possible to build Titanium
-applications for Android and iOS devices from source code.
-
-Not all Titanium features supported -- currently, it can only be used to build
-Android and iOS apps.
-
-Building a Titanium app
------------------------
-We can build a Titanium app from source for Android or iOS and for debugging or
-release purposes by invoking the `titaniumenv.buildApp {}` function:
-
-```nix
-titaniumenv.buildApp {
-  name = "myapp";
-  src = ./myappsource;
-
-  preBuild = "";
-  target = "android"; # or 'iphone'
-  tiVersion = "7.1.0.GA";
-  release = true;
-
-  androidsdkArgs = {
-    platformVersions = [ "25" "26" ];
-  };
-  androidKeyStore = ./keystore;
-  androidKeyAlias = "myfirstapp";
-  androidKeyStorePassword = "secret";
-
-  xcodeBaseDir = "/Applications/Xcode.app";
-  xcodewrapperArgs = {
-    version = "9.3";
-  };
-  iosMobileProvisioningProfile = ./myprovisioning.profile;
-  iosCertificateName = "My Company";
-  iosCertificate = ./mycertificate.p12;
-  iosCertificatePassword = "secret";
-  iosVersion = "11.3";
-  iosBuildStore = false;
-
-  enableWirelessDistribution = true;
-  installURL = "/installipa.php";
-}
-```
-
-The `titaniumenv.buildApp {}` function takes the following parameters:
-
-* The `name` parameter refers to the name in the Nix store.
-* The `src` parameter refers to the source code location of the app that needs
-  to be built.
-* `preRebuild` contains optional build instructions that are carried out before
-  the build starts.
-* `target` indicates for which device the app must be built. Currently only
-  'android' and 'iphone' (for iOS) are supported.
-* `tiVersion` can be used to optionally override the requested Titanium version
-  in `tiapp.xml`. If not specified, it will use the version in `tiapp.xml`.
-* `release` should be set to true when building an app for submission to the
-  Google Playstore or Apple Appstore. Otherwise, it should be false.
-
-When the `target` has been set to `android`, we can configure the following
-parameters:
-
-* The `androidSdkArgs` parameter refers to an attribute set that propagates all
-  parameters to the `androidenv.composeAndroidPackages {}` function. This can
-  be used to install all relevant Android plugins that may be needed to perform
-  the Android build. If no parameters are given, it will deploy the platform
-  SDKs for API-levels 25 and 26 by default.
-
-When the `release` parameter has been set to true, you need to provide
-parameters to sign the app:
-
-* `androidKeyStore` is the path to the keystore file
-* `androidKeyAlias` is the key alias
-* `androidKeyStorePassword` refers to the password to open the keystore file.
-
-When the `target` has been set to `iphone`, we can configure the following
-parameters:
-
-* The `xcodeBaseDir` parameter refers to the location where Xcode has been
-  installed. When none value is given, the above value is the default.
-* The `xcodewrapperArgs` parameter passes arbitrary parameters to the
-  `xcodeenv.composeXcodeWrapper {}` function. This can, for example, be used
-  to adjust the default version of Xcode.
-
-When `release` has been set to true, you also need to provide the following
-parameters:
-
-* `iosMobileProvisioningProfile` refers to a mobile provisioning profile needed
-  for signing.
-* `iosCertificateName` refers to the company name in the P12 certificate.
-* `iosCertificate` refers to the path to the P12 file.
-* `iosCertificatePassword` contains the password to open the P12 file.
-* `iosVersion` refers to the iOS SDK version to use. It defaults to the latest
-  version.
-* `iosBuildStore` should be set to `true` when building for the Apple Appstore
-  submission. For enterprise or ad-hoc builds it should be set to `false`.
-
-When `enableWirelessDistribution` has been enabled, you must also provide the
-path of the PHP script (`installURL`) (that is included with the iOS build
-environment) to enable wireless ad-hoc installations.
-
-Emulating or simulating the app
--------------------------------
-It is also possible to simulate the correspond iOS simulator build by using
-`xcodeenv.simulateApp {}` and emulate an Android APK by using
-`androidenv.emulateApp {}`.

doc/languages-frameworks/vim.section.md

@@ -1,277 +0,0 @@
----
-title: User's Guide for Vim in Nixpkgs
-author: Marc Weber
-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.
-
-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-plug
-
-## Custom configuration
-
-Adding custom .vimrc lines can be done using the following code:
-
-```nix
-vim_configurable.customize {
-  # `name` specifies the name of the executable and package
-  name = "vim-with-plugins";
-
-  vimrcConfig.customRC = ''
-    set hidden
-  '';
-}
-```
-
-This configuration is used when Vim is invoked with the command specified as name, in this case `vim-with-plugins`.
-
-For Neovim the `configure` argument can be overridden to achieve the same:
-
-```nix
-neovim.override {
-  configure = {
-    customRC = ''
-      # here your custom configuration goes!
-    '';
-  };
-}
-```
-
-If you want to use `neovim-qt` as a graphical editor, you can configure it by overriding Neovim in an overlay
-or passing it an overridden Neovimn:
-
-```nix
-neovim-qt.override {
-  neovim = neovim.override {
-    configure = {
-      customRC = ''
-        # your custom configuration
-      '';
-    };
-  };
-}
-```
-
-## Managing plugins with Vim packages
-
-To store you plugins in Vim packages (the native Vim plugin manager, see `:help packages`) the following example can be used:
-
-```nix
-vim_configurable.customize {
-  vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {
-    # loaded on launch
-    start = [ youcompleteme fugitive ];
-    # manually loadable by calling `:packadd $plugin-name`
-    # however, if a Vim plugin has a dependency that is not explicitly listed in
-    # opt that dependency will always be added to start to avoid confusion.
-    opt = [ phpCompletion elm-vim ];
-    # To automatically load a plugin when opening a filetype, add vimrc lines like:
-    # autocmd FileType php :packadd phpCompletion
-  };
-}
-```
-
-`myVimPackage` is an arbitrary name for the generated package. You can choose any name you like.
-For Neovim the syntax is:
-
-```nix
-neovim.override {
-  configure = {
-    customRC = ''
-      # here your custom configuration goes!
-    '';
-    packages.myVimPackage = with pkgs.vimPlugins; {
-      # see examples below how to use custom packages
-      start = [ ];
-      # If a Vim plugin has a dependency that is not explicitly listed in
-      # opt that dependency will always be added to start to avoid confusion.
-      opt = [ ];
-    };
-  };
-}
-```
-
-The resulting package can be added to `packageOverrides` in `~/.nixpkgs/config.nix` to make it installable:
-
-```nix
-{
-  packageOverrides = pkgs: with pkgs; {
-    myVim = vim_configurable.customize {
-      # `name` specifies the name of the executable and package
-      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 vim-plug
-
-To use [vim-plug](https://github.com/junegunn/vim-plug) to manage your Vim
-plugins the following example can be used:
-
-```nix
-vim_configurable.customize {
-  vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {
-    # loaded on launch
-    plug.plugins = [ youcompleteme fugitive phpCompletion elm-vim ];
-  };
-}
-```
-
-For Neovim the syntax is:
-
-```nix
-neovim.override {
-  configure = {
-    customRC = ''
-      # here your custom configuration goes!
-    '';
-    plug.plugins = with pkgs.vimPlugins; [
-      vim-go
-    ];
-  };
-}
-```
-
-## Managing plugins with VAM
-
-### Handling dependencies of Vim plugins
-
-VAM introduced .json files supporting dependencies without versioning
-assuming that "using latest version" is ok most of the time.
-
-### Example
-
-First create a vim-scripts file having one plugin name per line. Example:
-
-```
-"tlib"
-{'name': 'vim-addon-sql'}
-{'filetype_regex': '\%(vim)$', 'names': ['reload', 'vim-dev-plugin']}
-```
-
-Such vim-scripts file can be read by VAM as well like this:
-
-```vim
-call vam#Scripts(expand('~/.vim-scripts'), {})
-```
-
-Create a default.nix file:
-
-```nix
-{ nixpkgs ? import <nixpkgs> {}, compiler ? "ghc7102" }:
-nixpkgs.vim_configurable.customize { name = "vim"; vimrcConfig.vam.pluginDictionaries = [ "vim-addon-vim2nix" ]; }
-```
-
-Create a generate.vim file:
-
-```vim
-ActivateAddons vim-addon-vim2nix
-let vim_scripts = "vim-scripts"
-call nix#ExportPluginsForNix({
-\  'path_to_nixpkgs': eval('{"'.substitute(substitute(substitute($NIX_PATH, ':', ',', 'g'), '=',':', 'g'), '\([:,]\)', '"\1"',"g").'"}')["nixpkgs"],
-\  'cache_file': '/tmp/vim2nix-cache',
-\  'try_catch': 0,
-\  'plugin_dictionaries': ["vim-addon-manager"]+map(readfile(vim_scripts), 'eval(v:val)')
-\ })
-```
-
-Then run
-
-```bash
-nix-shell -p vimUtils.vim_with_vim2nix --command "vim -c 'source generate.vim'"
-```
-
-You should get a Vim buffer with the nix derivations (output1) and vam.pluginDictionaries (output2).
-You can add your Vim to your system's configuration file like this and start it by "vim-my":
-
-```
-my-vim =
-  let plugins = let inherit (vimUtils) buildVimPluginFrom2Nix; in {
-    copy paste output1 here
-  }; in vim_configurable.customize {
-    name = "vim-my";
-
-    vimrcConfig.vam.knownPlugins = plugins; # optional
-    vimrcConfig.vam.pluginDictionaries = [
-       copy paste output2 here
-    ];
-
-    # Pathogen would be
-    # vimrcConfig.pathogen.knownPlugins = plugins; # plugins
-    # vimrcConfig.pathogen.pluginNames = ["tlib"];
-  };
-```
-
-Sample output1:
-
-```
-"reload" = buildVimPluginFrom2Nix { # created by nix#NixDerivation
-  name = "reload";
-  src = fetchgit {
-    url = "git://github.com/xolox/vim-reload";
-    rev = "0a601a668727f5b675cb1ddc19f6861f3f7ab9e1";
-    sha256 = "0vb832l9yxj919f5hfg6qj6bn9ni57gnjd3bj7zpq7d4iv2s4wdh";
-  };
-  dependencies = ["nim-misc"];
-
-};
-[...]
-```
-
-Sample output2:
-
-```nix
-[
-  ''vim-addon-manager''
-  ''tlib''
-  { "name" = ''vim-addon-sql''; }
-  { "filetype_regex" = ''\%(vim)$$''; "names" = [ ''reload'' ''vim-dev-plugin'' ]; }
-]
-```
-
-## Adding new plugins to nixpkgs
-
-Nix expressions for Vim plugins are stored in [pkgs/misc/vim-plugins](/pkgs/misc/vim-plugins). For the vast majority of plugins, Nix expressions are automatically generated by running [`./update.py`](/pkgs/misc/vim-plugins/update.py). This creates a [generated.nix](/pkgs/misc/vim-plugins/generated.nix) file based on the plugins listed in [vim-plugin-names](/pkgs/misc/vim-plugins/vim-plugin-names). Plugins are listed in alphabetical order in `vim-plugin-names` using the format `[github username]/[repository]`. For example https://github.com/scrooloose/nerdtree becomes `scrooloose/nerdtree`.
-
-Some plugins require overrides in order to function properly. Overrides are placed in [overrides.nix](/pkgs/misc/vim-plugins/overrides.nix). Overrides are most often required when a plugin requires some dependencies, or extra steps are required during the build process. For example `deoplete-fish` requires both `deoplete-nvim` and `vim-fish`, and so the following override was added:
-
-```
-deoplete-fish = super.deoplete-fish.overrideAttrs(old: {
-  dependencies = with super; [ deoplete-nvim vim-fish ];
-});
-```
-
-Sometimes plugins require an override that must be changed when the plugin is updated. This can cause issues when Vim plugins are auto-updated but the associated override isn't updated. For these plugins, the override should be written so that it specifies all information required to install the plugin, and running `./update.py` doesn't change the derivation for the plugin. Manually updating the override is required to update these types of plugins. An example of such a plugin is `LanguageClient-neovim`.
-
-To add a new plugin:
-
-  1. run `./update.py` and create a commit named "vimPlugins: Update",
-  2. add the new plugin to [vim-plugin-names](/pkgs/misc/vim-plugins/vim-plugin-names) and add overrides if required to [overrides.nix](/pkgs/misc/vim-plugins/overrides.nix),
-  3. run `./update.py` again and create a commit named "vimPlugins.[name]: init at [version]" (where `name` and `version` can be found in [generated.nix](/pkgs/misc/vim-plugins/generated.nix)), and
-  4. create a pull request.
-
-## Important repositories
-
-- [vim-pi](https://bitbucket.org/vimcommunity/vim-pi) is a plugin repository
-  from VAM plugin manager meant to be used by others as well used by
-
-- [vim2nix](https://github.com/MarcWeber/vim-addon-vim2nix) which generates the
-  .nix code

doc/manual.xml

@@ -1,25 +1,25 @@
 <book xmlns="http://docbook.org/ns/docbook"
       xmlns:xi="http://www.w3.org/2001/XInclude">
- <info>
-  <title>Nixpkgs Users and 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="package-specific-user-notes.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.xml" />
+  <xi:include href="quick-start.xml" />
+  <xi:include href="stdenv.xml" />
+  <xi:include href="multiple-output.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="package-notes.xml" />
+  <xi:include href="coding-conventions.xml" />
+  <xi:include href="submitting-changes.xml" />
+  <xi:include href="contributing.xml" />
+
 </book>

doc/meta.xml

@@ -1,41 +1,44 @@
 <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 = https://www.gnu.org/software/hello/manual/;
-  license = licenses.gpl3Plus;
-  maintainers = [ maintainers.eelco ];
-  platforms = platforms.all;
+  homepage = http://www.gnu.org/software/hello/manual/;
+  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>
-<prompt>$ </prompt>nix-env -qa hello --json
+$ nix-env -qa hello --json
 {
     "hello": {
         "meta": {
             "description": "A program that produces a familiar, friendly greeting",
-            "homepage": "https://www.gnu.org/software/hello/manual/",
+            "homepage": "http://www.gnu.org/software/hello/manual/",
             "license": {
                 "fullName": "GNU General Public License version 3 or later",
                 "shortName": "GPLv3+",
@@ -50,7 +53,7 @@ meta = with stdenv.lib; {
                 "x86_64-linux",
                 "armv5tel-linux",
                 "armv7l-linux",
-                "mips32-linux",
+                "mips64el-linux",
                 "x86_64-darwin",
                 "i686-cygwin",
                 "i686-freebsd",
@@ -67,376 +70,254 @@ meta = with stdenv.lib; {
 
 
 </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>
-<prompt>$ </prompt>nix-env -qa hello --description
+$ 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>https://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>https://ftp.gnu.org/gnu/hello/</literal>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>changelog</varname>
-    </term>
-    <listitem>
-     <para>
-      A link or a list of links to the location of Changelog for a package.
-     A link may use expansion to refer to the correct changelog version.
-             Example:
-      <literal>"https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v${version}"</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>tests</varname>
-    </term>
-    <listitem>
-     <warning>
-      <para>
-       This attribute is special in that it is not actually under the
-       <literal>meta</literal> attribute set but rather under the
-       <literal>passthru</literal> attribute set. This is due to how
-       <literal>meta</literal> attributes work, and the fact that they
-       are supposed to contain only metadata, not derivations.
-      </para>
-     </warning>
-     <para>
-      An attribute set with as values tests. A test is a derivation, which
-      builds successfully when the test passes, and fails to build otherwise. A
-      derivation that is a test needs to have <literal>meta.timeout</literal>
-      defined.
-     </para>
-     <para>
-      The NixOS tests are available as <literal>nixosTests</literal> in
-      parameters of derivations. For instance, the OpenSMTPD derivation
-      includes lines similar to:
-<programlisting>
-{ /* ... */, nixosTests }:
-{
-  # ...
-  passthru.tests = {
-    basic-functionality-and-dovecot-integration = nixosTests.opensmtpd;
-  };
-}
-</programlisting>
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
-     <varname>timeout</varname>
-    </term>
-    <listitem>
-     <para>
-      A timeout (in seconds) for building the derivation. If the derivation
-      takes longer than this time to build, it can fail due to breaking the
-      timeout. However, all computers do not have the same computing power,
-      hence some builders may decide to apply a multiplicative factor to this
-      value. When filling this value in, try to keep it approximately
-      consistent with other values already present in
-      <literal>nixpkgs</literal>.
-     </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> in
+    <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/platforms.nix">
+    <filename>nixpkgs/lib/platforms.nix</filename></link> defines various common
+    lists 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,326 +5,87 @@
 <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>
+  <warning><para>Currently <command>nix-env</command> almost always installs all outputs until https://github.com/NixOS/nix/pull/815 gets merged.</para></warning>
   <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 first output is added (<varname>.dev</varname> by convention) and also <varname>propagatedBuildOutputs</varname> of that package which by default contain <varname>$outputBin</varname> and <varname>$outputLib</varname>. (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>
 
-  <para>
-   In some cases it may be desirable to combine different outputs under a
-   single store path. A function <literal>symlinkJoin</literal> can be used to
-   do this. (Note that it may negate some closure size benefits of using a
-   multiple-output package.)
-  </para>
- </section>
- <section xml:id="sec-multiple-outputs-">
-  <title>Writing a split derivation</title>
+<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 = [ "dev" "out" "bin" "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 usually be <varname>dev</varname>; typically you also want to have the main <varname>out</varname> output, as it catches any files that didn't get elsewhere.</para>
 
-  <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. 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>
-
-   <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>
-    <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>
+    <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>
+      <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>
+        $outputDocdev</varname></term><listitem><para>
+        is for <emphasis>developer</emphasis> documentation.  Currently we count gtk-doc and man3 pages in there.  It goes to <varname>docdev</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>doc</varname> or <varname>$outputBin</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>doc</varname> or <varname>$outputMan</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

@@ -61,10 +61,10 @@ stdenv.mkDerivation {
   builder = ./builder.sh;
   src = fetchurl {
     url = http://ftp.nluug.nl/gnu/binutils/binutils-2.16.1.tar.bz2;
-    sha256 = "1ian3kwh2vg6hr3ymrv48s04gijs539vzrq62xr76bxbhbwnz2np";
+    md5 = "6a9d529efb285071dad10e1f3d2b2967";
   };
   inherit noSysDirs;
-  configureFlags = [ "--target=arm-linux" ];
+  configureFlags = "--target=arm-linux";
 }
 ---
 
@@ -78,14 +78,14 @@ 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";
+  name = "linux-headers-2.6.13.4-arm";
   builder = ./builder.sh;
   src = fetchurl {
-    url = http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.13.1.tar.bz2;
-    sha256 = "12qxmc827fjhaz53kjy7vyrzsaqcg78amiqsb3qm20z26w705lma";
+    url = http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.13.4.tar.bz2;
+    md5 = "94768d7eef90a9d8174639b2a7d3f58d";
   };
 }
 ---
@@ -152,7 +152,9 @@ stdenv.mkDerivation {
   builder = ./builder.sh;
   src = fetchurl {
     url = ftp://ftp.nluug.nl/pub/gnu/gcc/gcc-4.0.2/gcc-core-4.0.2.tar.bz2;
-    sha256 = "02fxh0asflm8825w23l2jq1wvs7hbnam0jayrivg7zdv2ifnc0rc";
+    md5 = "f7781398ada62ba255486673e6274b26";
+    #url = ftp://ftp.nluug.nl/pub/gnu/gcc/gcc-4.0.2/gcc-4.0.2.tar.bz2;
+    #md5 = "a659b8388cac9db2b13e056e574ceeb0";
   };
   # !!! apply only if noSysDirs is set
   patches = [./no-sys-dirs.patch ./gcc-inhibit.patch];

doc/old/update-upstream-data.txt

@@ -0,0 +1,14 @@
+Semi-automatic source information updating using "update-upstream-data.sh" script and "src-{,info-}for-*.nix"
+
+1. Recognizing when a pre-existing package uses this mechanism.
+
+Packages using this automatical update mechanism have src-info-for-default.nix and src-for-default.nix next to default.nix. src-info-for-default.nix describes getting the freshest source from upstream web site; src-for-default.nix is a generated file with the current data about used source. Both files define a simple attrSet. 
+
+src-info-for-default.nix (for a file grabbed via http) contains at least downloadPage attribute - it is the page we need to look at to find out the latest version. It also contains baseName that is used for automatical generation of package name containing version. It can contain extra data for trickier cases.
+
+src-for-default.nix will contain advertisedUrl (raw URL chosen on the site; its change prompts regeneration of source data), url for fetchurl, hash, version retrieved from the download URL and suggested package name.
+
+2. Updating a package
+
+nixpkgs/pkgs/build-support/upstream-updater directory contains some scripts. The worker script is called update-upstream-data.sh. This script requires main expression name (e.g. default.nix). It can optionally accpet a second parameter, URL which will be used instead of getting one by parsing the downloadPage (version extraction, mirror URL creation etc. will still be run). After running the script, check src-for-default.nix (or replace default.nix with expression name, if there are seceral expressions in the directory) for new version information.
+

doc/overlays.xml

@@ -1,195 +0,0 @@
-<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 using overlays.
-  Overlays are used to add layers in the fixed-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 can be set either explicitly in a Nix expression, or
-   through <literal>&lt;nixpkgs-overlays></literal> or user configuration
-   files.
-  </para>
-
-  <section xml:id="sec-overlays-argument">
-   <title>Set overlays in NixOS or Nix expressions</title>
-
-   <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
-    <link xlink:href="#sec-overlays-lookup">looked</link> up independently.
-   </para>
-
-   <para>
-    The list of overlays can be passed explicitly when importing nixpkgs, for
-    example <literal>import &lt;nixpkgs> { overlays = [ overlay1 overlay2 ];
-    }</literal>.
-   </para>
-
-   <para>
-    Further overlays can be added by calling the <literal>pkgs.extend</literal>
-    or <literal>pkgs.appendOverlays</literal>, although it is often preferable
-    to avoid these functions, because they recompute the Nixpkgs fixpoint,
-    which is somewhat expensive to do.
-   </para>
-  </section>
-
-  <section xml:id="sec-overlays-lookup">
-   <title>Install overlays via configuration lookup</title>
-
-   <para>
-    The list of overlays is determined as follows.
-   </para>
-
-   <para>
-    <orderedlist>
-     <listitem>
-      <para>
-       First, if an
-       <link xlink:href="#sec-overlays-argument"><varname>overlays</varname>
-       argument</link> to the Nixpkgs function itself is given, then that is
-       used and no path lookup will be performed.
-      </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>
-    Because overlays that are set in NixOS configuration do not affect
-    non-NixOS operations such as <literal>nix-env</literal>, the
-    <filename>overlays.nix</filename> option 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>
-
-<!-- TODO: Example of sharing overlays between NixOS configuration
-     and configuration lookup. Also reference the example
-     from the sec-overlays-argument paragraph about NixOS.
- -->
-  </section>
- </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>
-
-<programlisting>
-self: super:
-
-{
-  boost = super.boost.override {
-    python = self.python3;
-  };
-  rr = super.callPackage ./pkgs/rr {
-    stdenv = self.stdenv_32bit;
-  };
-}
-</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 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>
-   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,9 +0,0 @@
-.docbook .xref img[src^=images\/callouts\/],
-.screen img,
-.programlisting img {
-    width: 1em;
-}
-
-.calloutlist img {
-    width: 1.5em;
-}

doc/package-notes.xml

@@ -1,239 +1,272 @@
 <chapter xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xml:id="chap-package-notes">
- <title>Package Notes</title>
- <para>
-  This chapter contains information about how to use and maintain the Nix
-  expressions for a number of specific packages, such as the Linux kernel or
-  X.org.
- </para>
+
+<title>Package Notes</title>
+
+<para>This chapter contains information about how to use and maintain
+the Nix expressions for a number of specific packages, such as the
+Linux kernel or X.org.</para>
+
+
 <!--============================================================-->
- <section xml:id="sec-linux-kernel">
-  <title>Linux kernel</title>
 
-  <para>
-   The Nix expressions to build the Linux kernel are in
-   <link
-xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel"><filename>pkgs/os-specific/linux/kernel</filename></link>.
-  </para>
+<section xml:id="sec-linux-kernel">
 
-  <para>
-   The function that builds the kernel has an argument
-   <varname>kernelPatches</varname> which should be a list of <literal>{name,
-   patch, extraConfig}</literal> attribute sets, where <varname>name</varname>
-   is the name of the patch (which is included in the kernel’s
-   <varname>meta.description</varname> attribute), <varname>patch</varname> is
-   the patch itself (possibly compressed), and <varname>extraConfig</varname>
-   (optional) is a string specifying extra options to be concatenated to the
-   kernel configuration file (<filename>.config</filename>).
-  </para>
+<title>Linux kernel</title>
+
+<para>The Nix expressions to build the Linux kernel are in <link
+xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel"><filename>pkgs/os-specific/linux/kernel</filename></link>.</para>
+
+<para>The function that builds the kernel has an argument
+<varname>kernelPatches</varname> which should be a list of
+<literal>{name, patch, extraConfig}</literal> attribute sets, where
+<varname>name</varname> is the name of the patch (which is included in
+the kernel’s <varname>meta.description</varname> attribute),
+<varname>patch</varname> is the patch itself (possibly compressed),
+and <varname>extraConfig</varname> (optional) is a string specifying
+extra options to be concatenated to the kernel configuration file
+(<filename>.config</filename>).</para>
+
+<para>The kernel derivation exports an attribute
+<varname>features</varname> specifying whether optional functionality
+is or isn’t enabled.  This is used in NixOS to implement
+kernel-specific behaviour.  For instance, if the kernel has the
+<varname>iwlwifi</varname> feature (i.e. has built-in support for
+Intel wireless chipsets), then NixOS doesn’t have to build the
+external <varname>iwlwifi</varname> package:
 
-  <para>
-   The kernel derivation exports an attribute <varname>features</varname>
-   specifying whether optional functionality is or isn’t enabled. This is
-   used in NixOS to implement kernel-specific behaviour. For instance, if the
-   kernel has the <varname>iwlwifi</varname> feature (i.e. has built-in support
-   for Intel wireless chipsets), then NixOS doesn’t have to build the
-   external <varname>iwlwifi</varname> package:
 <programlisting>
 modulesTree = [kernel]
   ++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi
   ++ ...;
 </programlisting>
-  </para>
 
-  <para>
-   How to add a new (major) version of the Linux kernel to Nixpkgs:
-   <orderedlist>
-    <listitem>
-     <para>
-      Copy the old Nix expression (e.g. <filename>linux-2.6.21.nix</filename>)
-      to the new one (e.g. <filename>linux-2.6.22.nix</filename>) and update
-      it.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Add the new kernel to <filename>all-packages.nix</filename> (e.g., create
-      an attribute <varname>kernel_2_6_22</varname>).
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Now we’re going to update the kernel configuration. First unpack the
-      kernel. Then for each supported platform (<literal>i686</literal>,
-      <literal>x86_64</literal>, <literal>uml</literal>) do the following:
+</para>
+
+<para>How to add a new (major) version of the Linux kernel to Nixpkgs:
+
+<orderedlist>
+
+  <listitem>
+    <para>Copy the old Nix expression
+    (e.g. <filename>linux-2.6.21.nix</filename>) to the new one
+    (e.g. <filename>linux-2.6.22.nix</filename>) and update it.</para>
+  </listitem>
+
+  <listitem>
+    <para>Add the new kernel to <filename>all-packages.nix</filename>
+    (e.g., create an attribute
+    <varname>kernel_2_6_22</varname>).</para>
+  </listitem>
+
+  <listitem>
+    <para>Now we’re going to update the kernel configuration.  First
+    unpack the kernel.  Then for each supported platform
+    (<literal>i686</literal>, <literal>x86_64</literal>,
+    <literal>uml</literal>) do the following:
+
       <orderedlist>
-       <listitem>
-        <para>
-         Make an copy from the old config (e.g.
-         <filename>config-2.6.21-i686-smp</filename>) to the new one (e.g.
-         <filename>config-2.6.22-i686-smp</filename>).
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Copy the config file for this platform (e.g.
-         <filename>config-2.6.22-i686-smp</filename>) to
-         <filename>.config</filename> in the kernel source tree.
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Run <literal>make oldconfig
-         ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal> and answer
-         all questions. (For the uml configuration, also add
-         <literal>SHELL=bash</literal>.) Make sure to keep the configuration
-         consistent between platforms (i.e. don’t enable some feature on
-         <literal>i686</literal> and disable it on <literal>x86_64</literal>).
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         If needed you can also run <literal>make menuconfig</literal>:
-<screen>
-<prompt>$ </prompt>nix-env -i ncurses
-<prompt>$ </prompt>export NIX_CFLAGS_LINK=-lncurses
-<prompt>$ </prompt>make menuconfig ARCH=<replaceable>arch</replaceable></screen>
-        </para>
-       </listitem>
-       <listitem>
-        <para>
-         Copy <filename>.config</filename> over the new config file (e.g.
-         <filename>config-2.6.22-i686-smp</filename>).
-        </para>
-       </listitem>
+
+        <listitem>
+          <para>Make an copy from the old
+          config (e.g. <filename>config-2.6.21-i686-smp</filename>) to
+          the new one
+          (e.g. <filename>config-2.6.22-i686-smp</filename>).</para>
+        </listitem>
+
+        <listitem>
+          <para>Copy the config file for this platform
+          (e.g. <filename>config-2.6.22-i686-smp</filename>) to
+          <filename>.config</filename> in the kernel source tree.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>Run <literal>make oldconfig
+          ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal>
+          and answer all questions.  (For the uml configuration, also
+          add <literal>SHELL=bash</literal>.)  Make sure to keep the
+          configuration consistent between platforms (i.e. don’t
+          enable some feature on <literal>i686</literal> and disable
+          it on <literal>x86_64</literal>).
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>If needed you can also run <literal>make
+          menuconfig</literal>:
+
+            <screen>
+$ nix-env -i ncurses
+$ export NIX_CFLAGS_LINK=-lncurses
+$ make menuconfig ARCH=<replaceable>arch</replaceable></screen>
+          
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>Copy <filename>.config</filename> over the new config
+          file (e.g. <filename>config-2.6.22-i686-smp</filename>).</para>
+        </listitem>
+
       </orderedlist>
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      Test building the kernel: <literal>nix-build -A kernel_2_6_22</literal>.
-      If it compiles, ship it! For extra credit, try booting NixOS with it.
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      It may be that the new kernel requires updating the external kernel
-      modules and kernel-dependent packages listed in the
-      <varname>linuxPackagesFor</varname> function in
-      <filename>all-packages.nix</filename> (such as the NVIDIA drivers, AUFS,
-      etc.). If the updated packages aren’t backwards compatible with older
-      kernels, you may need to keep the older versions around.
-     </para>
-    </listitem>
-   </orderedlist>
-  </para>
- </section>
+    
+    </para>
+    
+  </listitem>
+
+  <listitem>
+    <para>Test building the kernel: <literal>nix-build -A
+    kernel_2_6_22</literal>.  If it compiles, ship it!  For extra
+    credit, try booting NixOS with it.</para>
+  </listitem>
+
+  <listitem>
+    <para>It may be that the new kernel requires updating the external
+    kernel modules and kernel-dependent packages listed in the
+    <varname>linuxPackagesFor</varname> function in
+    <filename>all-packages.nix</filename> (such as the NVIDIA drivers,
+    AUFS, etc.).  If the updated packages aren’t backwards compatible
+    with older kernels, you may need to keep the older versions
+    around.</para>
+  </listitem>
+
+</orderedlist>
+
+</para>
+
+</section>
+
+
 <!--============================================================-->
- <section xml:id="sec-xorg">
-  <title>X.org</title>
 
-  <para>
-   The Nix expressions for the X.org packages reside in
-   <filename>pkgs/servers/x11/xorg/default.nix</filename>. This file is
-   automatically generated from lists of tarballs in an X.org release. As such
-   it should not be modified directly; rather, you should modify the lists, the
-   generator script or the file
-   <filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you can
-   override or add to the derivations produced by the generator.
-  </para>
+<section xml:id="sec-xorg">
+
+<title>X.org</title>
+
+<para>The Nix expressions for the X.org packages reside in
+<filename>pkgs/servers/x11/xorg/default.nix</filename>.  This file is
+automatically generated from lists of tarballs in an X.org release.
+As such it should not be modified directly; rather, you should modify
+the lists, the generator script or the file
+<filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you
+can override or add to the derivations produced by the
+generator.</para>
+
+<para>The generator is invoked as follows:
 
-  <para>
-   The generator is invoked as follows:
 <screen>
-<prompt>$ </prompt>cd pkgs/servers/x11/xorg
-<prompt>$ </prompt>cat tarballs-7.5.list extra.list old.list \
+$ cd pkgs/servers/x11/xorg
+$ cat tarballs-7.5.list extra.list old.list \
   | perl ./generate-expr-from-tarballs.pl
 </screen>
-   For each of the tarballs in the <filename>.list</filename> files, the script
-   downloads it, unpacks it, and searches its <filename>configure.ac</filename>
-   and <filename>*.pc.in</filename> files for dependencies. This information is
-   used to generate <filename>default.nix</filename>. The generator caches
-   downloaded tarballs between runs. Pay close attention to the <literal>NOT
-   FOUND: <replaceable>name</replaceable></literal> messages at the end of the
-   run, since they may indicate missing dependencies. (Some might be optional
-   dependencies, however.)
-  </para>
 
-  <para>
-   A file like <filename>tarballs-7.5.list</filename> contains all tarballs in
-   a X.org release. It can be generated like this:
+For each of the tarballs in the <filename>.list</filename> files, the
+script downloads it, unpacks it, and searches its
+<filename>configure.ac</filename> and <filename>*.pc.in</filename>
+files for dependencies.  This information is used to generate
+<filename>default.nix</filename>.  The generator caches downloaded
+tarballs between runs.  Pay close attention to the <literal>NOT FOUND:
+<replaceable>name</replaceable></literal> messages at the end of the
+run, since they may indicate missing dependencies.  (Some might be
+optional dependencies, however.)</para>
+
+<para>A file like <filename>tarballs-7.5.list</filename> contains all
+tarballs in a X.org release.  It can be generated like this:
+
 <screen>
-<prompt>$ </prompt>export i="mirror://xorg/X11R7.4/src/everything/"
-<prompt>$ </prompt>cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \
+$ export i="mirror://xorg/X11R7.4/src/everything/"
+$ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \
   | perl -e 'while (&lt;>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'i'}$2\n"; }; }' \
   | sort > tarballs-7.4.list
 </screen>
-   <filename>extra.list</filename> contains libraries that aren’t part of
-   X.org proper, but are closely related to it, such as
-   <literal>libxcb</literal>. <filename>old.list</filename> contains some
-   packages that were removed from X.org, but are still needed by some people
-   or by other packages (such as <varname>imake</varname>).
-  </para>
 
-  <para>
-   If the expression for a package requires derivation attributes that the
-   generator cannot figure out automatically (say, <varname>patches</varname>
-   or a <varname>postInstall</varname> hook), you should modify
-   <filename>pkgs/servers/x11/xorg/overrides.nix</filename>.
-  </para>
- </section>
+<filename>extra.list</filename> contains libraries that aren’t part of
+X.org proper, but are closely related to it, such as
+<literal>libxcb</literal>.  <filename>old.list</filename> contains
+some packages that were removed from X.org, but are still needed by
+some people or by other packages (such as
+<varname>imake</varname>).</para>
+
+<para>If the expression for a package requires derivation attributes
+that the generator cannot figure out automatically (say,
+<varname>patches</varname> or a <varname>postInstall</varname> hook),
+you should modify
+<filename>pkgs/servers/x11/xorg/overrides.nix</filename>.</para>
+
+</section>
+
+
+
 <!--============================================================-->
+
 <!--
-<section xml:id="sec-package-notes-gnome">
+<section>
   <title>Gnome</title>
   <para>* Expression is auto-generated</para>
   <para>* How to update</para>
 </section>
 -->
+
+
 <!--============================================================-->
+
 <!--
-<section xml:id="sec-package-notes-gcc">
+<section>
   <title>GCC</title>
   <para>…</para>
 </section>
 -->
+
 <!--============================================================-->
- <section xml:id="sec-eclipse">
+
+<section xml:id="sec-eclipse">
+
   <title>Eclipse</title>
 
   <para>
-   The Nix expressions related to the Eclipse platform and IDE are in
-   <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse"><filename>pkgs/applications/editors/eclipse</filename></link>.
+    The Nix expressions related to the Eclipse platform and IDE are in
+    <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse"><filename>pkgs/applications/editors/eclipse</filename></link>.
   </para>
 
   <para>
-   Nixpkgs provides a number of packages that will install Eclipse in its
-   various forms. These range from the bare-bones Eclipse Platform to the more
-   fully featured Eclipse SDK or Scala-IDE packages and multiple version are
-   often available. It is possible to list available Eclipse packages by
-   issuing the command:
+    Nixpkgs provides a number of packages that will install Eclipse in
+    its various forms, these range from the bare-bones Eclipse
+    Platform to the more fully featured Eclipse SDK or Scala-IDE
+    packages and multiple version are often available. It is possible
+    to list available Eclipse packages by issuing the command:
+
 <screen>
-<prompt>$ </prompt>nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses --description
+$ nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses --description
 </screen>
-   Once an Eclipse variant is installed it can be run using the
-   <command>eclipse</command> command, as expected. From within Eclipse it is
-   then possible to install plugins in the usual manner by either manually
-   specifying an Eclipse update site or by installing the Marketplace Client
-   plugin and using it to discover and install other plugins. This installation
-   method provides an Eclipse installation that closely resemble a manually
-   installed Eclipse.
+
+    Once an Eclipse variant is installed it can be run using the
+    <command>eclipse</command> command, as expected. From within
+    Eclipse it is then possible to install plugins in the usual manner
+    by either manually specifying an Eclipse update site or by
+    installing the Marketplace Client plugin and using it to discover
+    and install other plugins. This installation method provides an
+    Eclipse installation that closely resemble a manually installed
+    Eclipse.
   </para>
 
   <para>
-   If you prefer to install plugins in a more declarative manner then Nixpkgs
-   also offer a number of Eclipse plugins that can be installed in an
-   <emphasis>Eclipse environment</emphasis>. This type of environment is
-   created using the function <varname>eclipseWithPlugins</varname> found
-   inside the <varname>nixpkgs.eclipses</varname> attribute set. This function
-   takes as argument <literal>{ eclipse, plugins ? [], jvmArgs ? [] }</literal>
-   where <varname>eclipse</varname> is a one of the Eclipse packages described
-   above, <varname>plugins</varname> is a list of plugin derivations, and
-   <varname>jvmArgs</varname> is a list of arguments given to the JVM running
-   the Eclipse. For example, say you wish to install the latest Eclipse
-   Platform with the popular Eclipse Color Theme plugin and also allow Eclipse
-   to use more RAM. You could then add
+    If you prefer to install plugins in a more declarative manner then
+    Nixpkgs also offer a number of Eclipse plugins that can be
+    installed in an <emphasis>Eclipse environment</emphasis>. This
+    type of environment is created using the function
+    <varname>eclipseWithPlugins</varname> found inside the
+    <varname>nixpkgs.eclipses</varname> attribute set. This function
+    takes as argument <literal>{ eclipse, plugins ? [], jvmArgs ? []
+    }</literal> where <varname>eclipse</varname> is a one of the
+    Eclipse packages described above, <varname>plugins</varname> is a
+    list of plugin derivations, and <varname>jvmArgs</varname> is a
+    list of arguments given to the JVM running the Eclipse. For
+    example, say you wish to install the latest Eclipse Platform with
+    the popular Eclipse Color Theme plugin and also allow Eclipse to
+    use more RAM. You could then add
+
 <screen>
 packageOverrides = pkgs: {
   myEclipse = with pkgs.eclipses; eclipseWithPlugins {
@@ -243,38 +276,42 @@ packageOverrides = pkgs: {
   };
 }
 </screen>
-   to your Nixpkgs configuration
-   (<filename>~/.config/nixpkgs/config.nix</filename>) and install it by
-   running <command>nix-env -f '&lt;nixpkgs&gt;' -iA myEclipse</command> and
-   afterward run Eclipse as usual. It is possible to find out which plugins are
-   available for installation using <varname>eclipseWithPlugins</varname> by
-   running
+
+    to your Nixpkgs configuration
+    (<filename>~/.nixpkgs/config.nix</filename>) and install it by
+    running <command>nix-env -f '&lt;nixpkgs&gt;' -iA
+    myEclipse</command> and afterward run Eclipse as usual. It is
+    possible to find out which plugins are available for installation
+    using <varname>eclipseWithPlugins</varname> by running
+
 <screen>
-<prompt>$ </prompt>nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses.plugins --description
+$ nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses.plugins --description
 </screen>
   </para>
 
   <para>
-   If there is a need to install plugins that are not available in Nixpkgs then
-   it may be possible to define these plugins outside Nixpkgs using the
-   <varname>buildEclipseUpdateSite</varname> and
-   <varname>buildEclipsePlugin</varname> functions found in the
-   <varname>nixpkgs.eclipses.plugins</varname> attribute set. Use the
-   <varname>buildEclipseUpdateSite</varname> function to install a plugin
-   distributed as an Eclipse update site. This function takes <literal>{ name,
-   src }</literal> as argument where <literal>src</literal> indicates the
-   Eclipse update site archive. All Eclipse features and plugins within the
-   downloaded update site will be installed. When an update site archive is not
-   available then the <varname>buildEclipsePlugin</varname> function can be
-   used to install a plugin that consists of a pair of feature and plugin JARs.
-   This function takes an argument <literal>{ name, srcFeature, srcPlugin
-   }</literal> where <literal>srcFeature</literal> and
-   <literal>srcPlugin</literal> are the feature and plugin JARs, respectively.
+    If there is a need to install plugins that are not available in
+    Nixpkgs then it may be possible to define these plugins outside
+    Nixpkgs using the <varname>buildEclipseUpdateSite</varname> and
+    <varname>buildEclipsePlugin</varname> functions found in the
+    <varname>nixpkgs.eclipses.plugins</varname> attribute set. Use the
+    <varname>buildEclipseUpdateSite</varname> function to install a
+    plugin distributed as an Eclipse update site. This function takes
+    <literal>{ name, src }</literal> as argument where
+    <literal>src</literal> indicates the Eclipse update site archive.
+    All Eclipse features and plugins within the downloaded update site
+    will be installed. When an update site archive is not available
+    then the <varname>buildEclipsePlugin</varname> function can be
+    used to install a plugin that consists of a pair of feature and
+    plugin JARs. This function takes an argument <literal>{ name,
+    srcFeature, srcPlugin }</literal> where
+    <literal>srcFeature</literal> and <literal>srcPlugin</literal> are
+    the feature and plugin JARs, respectively.
   </para>
 
   <para>
-   Expanding the previous example with two plugins using the above functions we
-   have
+    Expanding the previous example with two plugins using the above
+    functions we have
 <screen>
 packageOverrides = pkgs: {
   myEclipse = with pkgs.eclipses; eclipseWithPlugins {
@@ -306,285 +343,43 @@ packageOverrides = pkgs: {
 }
 </screen>
   </para>
- </section>
- <section xml:id="sec-elm">
-  <title>Elm</title>
 
-  <para>
-   To start a development environment do <command>nix-shell -p elmPackages.elm elmPackages.elm-format</command>
-  </para>
+</section>
 
-  <para>
-   To update Elm compiler, see
-   <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>.
-  </para>
+<section xml:id="sec-elm">
 
-  <para>
-   To package Elm applications,
-   <link xlink:href="https://github.com/hercules-ci/elm2nix#elm2nix">read about
-   elm2nix</link>.
-  </para>
- </section>
- <section xml:id="sec-kakoune">
-  <title>Kakoune</title>
+<title>Elm</title>
 
-  <para>
-   Kakoune can be built to autoload plugins:
-<programlisting>(kakoune.override {
-  configure = {
-    plugins = with pkgs.kakounePlugins; [ parinfer-rust ];
-  };
-})</programlisting>
-  </para>
- </section>
- <section xml:id="sec-shell-helpers">
-  <title>Interactive shell helpers</title>
+<para>
+The Nix expressions for Elm reside in
+<filename>pkgs/development/compilers/elm</filename>. They are generated
+automatically by <command>update-elm.rb</command> script. One should
+specify versions of Elm packages inside the script, clear the
+<filename>packages</filename> directory and run the script from inside it.
+<literal>elm-reactor</literal> is special because it also has Elm package
+dependencies. The process is not automated very much for now -- you should
+get the <literal>elm-reactor</literal> source tree (e.g. with
+<command>nix-shell</command>) and run <command>elm2nix.rb</command> inside
+it. Place the resulting <filename>package.nix</filename> file into
+<filename>packages/elm-reactor-elm.nix</filename>.
+</para>
 
-  <para>
-   Some packages provide the shell integration to be more useful. But unlike
-   other systems, nix doesn't have a standard share directory location. This is
-   why a bunch <command>PACKAGE-share</command> scripts are shipped that print
-   the location of the corresponding shared folder. Current list of such
-   packages is as following:
-   <itemizedlist>
-    <listitem>
-     <para>
-      <literal>autojump</literal>: <command>autojump-share</command>
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      <literal>fzf</literal>: <command>fzf-share</command>
-     </para>
-    </listitem>
-   </itemizedlist>
-   E.g. <literal>autojump</literal> can then used in the .bashrc like this:
+</section>
+
+<section xml:id="sec-autojump">
+
+<title>Autojump</title>
+
+<para>
+  autojump needs the shell integration to be useful but unlike other systems,
+  nix doesn't have a standard share directory location. This is why a
+  <command>autojump-share</command> script is shipped that prints the location
+  of the shared folder. This can then be used in the .bashrc like this:
 <screen>
   source "$(autojump-share)/autojump.bash"
 </screen>
-  </para>
- </section>
- <section xml:id="sec-weechat">
-  <title>Weechat</title>
+</para>
 
-  <para>
-   Weechat can be configured to include your choice of plugins, reducing its
-   closure size from the default configuration which includes all available
-   plugins. To make use of this functionality, install an expression that
-   overrides its configuration such as
-<programlisting>weechat.override {configure = {availablePlugins, ...}: {
-    plugins = with availablePlugins; [ python perl ];
-  }
-}</programlisting>
-   If the <literal>configure</literal> function returns an attrset without the
-   <literal>plugins</literal> attribute, <literal>availablePlugins</literal>
-   will be used automatically.
-  </para>
+</section>
 
-  <para>
-   The plugins currently available are <literal>python</literal>,
-   <literal>perl</literal>, <literal>ruby</literal>, <literal>guile</literal>,
-   <literal>tcl</literal> and <literal>lua</literal>.
-  </para>
-
-  <para>
-   The python and perl plugins allows the addition of extra libraries. For
-   instance, the <literal>inotify.py</literal> script in weechat-scripts
-   requires D-Bus or libnotify, and the <literal>fish.py</literal> script
-   requires pycrypto. To use these scripts, use the plugin's
-   <literal>withPackages</literal> attribute:
-<programlisting>weechat.override { configure = {availablePlugins, ...}: {
-    plugins = with availablePlugins; [
-            (python.withPackages (ps: with ps; [ pycrypto python-dbus ]))
-        ];
-    };
-}
-</programlisting>
-  </para>
-
-  <para>
-   In order to also keep all default plugins installed, it is possible to use
-   the following method:
-<programlisting>weechat.override { configure = { availablePlugins, ... }: {
-  plugins = builtins.attrValues (availablePlugins // {
-    python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]);
-  });
-}; }
-</programlisting>
-  </para>
-
-  <para>
-   WeeChat allows to set defaults on startup using the
-   <literal>--run-command</literal>. The <literal>configure</literal> method
-   can be used to pass commands to the program:
-<programlisting>weechat.override {
-  configure = { availablePlugins, ... }: {
-    init = ''
-      /set foo bar
-      /server add freenode chat.freenode.org
-    '';
-  };
-}</programlisting>
-   Further values can be added to the list of commands when running
-   <literal>weechat --run-command "your-commands"</literal>.
-  </para>
-
-  <para>
-   Additionally it's possible to specify scripts to be loaded when starting
-   <literal>weechat</literal>. These will be loaded before the commands from
-   <literal>init</literal>:
-<programlisting>weechat.override {
-  configure = { availablePlugins, ... }: {
-    scripts = with pkgs.weechatScripts; [
-      weechat-xmpp weechat-matrix-bridge wee-slack
-    ];
-    init = ''
-      /set plugins.var.python.jabber.key "val"
-    '':
-  };
-}</programlisting>
-  </para>
-
-  <para>
-   In <literal>nixpkgs</literal> there's a subpackage which contains
-   derivations for WeeChat scripts. Such derivations expect a
-   <literal>passthru.scripts</literal> attribute which contains a list of all
-   scripts inside the store path. Furthermore all scripts have to live in
-   <literal>$out/share</literal>. An exemplary derivation looks like this:
-<programlisting>{ stdenv, fetchurl }:
-
-stdenv.mkDerivation {
-  name = "exemplary-weechat-script";
-  src = fetchurl {
-    url = "https://scripts.tld/your-scripts.tar.gz";
-    sha256 = "...";
-  };
-  passthru.scripts = [ "foo.py" "bar.lua" ];
-  installPhase = ''
-    mkdir $out/share
-    cp foo.py $out/share
-    cp bar.lua $out/share
-  '';
-}</programlisting>
-  </para>
- </section>
- <section xml:id="sec-ibus-typing-booster">
-  <title>ibus-engines.typing-booster</title>
-
-  <para>
-   This package is an ibus-based completion method to speed up typing.
-  </para>
-
-  <section xml:id="sec-ibus-typing-booster-activate">
-   <title>Activating the engine</title>
-
-   <para>
-    IBus needs to be configured accordingly to activate
-    <literal>typing-booster</literal>. The configuration depends on the desktop
-    manager in use. For detailed instructions, please refer to the
-    <link xlink:href="https://mike-fabian.github.io/ibus-typing-booster/documentation.html">upstream
-    docs</link>.
-   </para>
-
-   <para>
-    On NixOS you need to explicitly enable <literal>ibus</literal> with given
-    engines before customizing your desktop to use
-    <literal>typing-booster</literal>. This can be achieved using the
-    <literal>ibus</literal> module:
-<programlisting>{ pkgs, ... }: {
-  i18n.inputMethod = {
-    enabled = "ibus";
-    ibus.engines = with pkgs.ibus-engines; [ typing-booster ];
-  };
-}</programlisting>
-   </para>
-  </section>
-
-  <section xml:id="sec-ibus-typing-booster-customize-hunspell">
-   <title>Using custom hunspell dictionaries</title>
-
-   <para>
-    The IBus engine is based on <literal>hunspell</literal> to support
-    completion in many languages. By default the dictionaries
-    <literal>de-de</literal>, <literal>en-us</literal>, <literal>fr-moderne</literal>
-    <literal>es-es</literal>, <literal>it-it</literal>,
-    <literal>sv-se</literal> and <literal>sv-fi</literal> are in use. To add
-    another dictionary, the package can be overridden like this:
-<programlisting>ibus-engines.typing-booster.override {
-  langs = [ "de-at" "en-gb" ];
-}</programlisting>
-   </para>
-
-   <para>
-    <emphasis>Note: each language passed to <literal>langs</literal> must be an
-    attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis>
-   </para>
-  </section>
-
-  <section xml:id="sec-ibus-typing-booster-emoji-picker">
-   <title>Built-in emoji picker</title>
-
-   <para>
-    The <literal>ibus-engines.typing-booster</literal> package contains a
-    program named <literal>emoji-picker</literal>. To display all emojis
-    correctly, a special font such as <literal>noto-fonts-emoji</literal> is
-    needed:
-   </para>
-
-   <para>
-    On NixOS it can be installed using the following expression:
-<programlisting>{ pkgs, ... }: {
-  fonts.fonts = with pkgs; [ noto-fonts-emoji ];
-}</programlisting>
-   </para>
-  </section>
- </section>
- <section xml:id="sec-nginx">
-  <title>Nginx</title>
-
-  <para>
-    <link xlink:href="https://nginx.org/">Nginx</link> is a
-    reverse proxy and lightweight webserver.
-  </para>
-
-  <section xml:id="sec-nginx-etag">
-   <title>ETags on static files served from the Nix store</title>
-
-   <para>
-     HTTP has a couple different mechanisms for caching to prevent
-     clients from having to download the same content repeatedly
-     if a resource has not changed since the last time it was requested.
-     When nginx is used as a server for static files, it implements
-     the caching mechanism based on the
-     <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"><literal>Last-Modified</literal></link>
-     response header automatically; unfortunately, it works by using
-     filesystem timestamps to determine the value of the
-     <literal>Last-Modified</literal> header. This doesn't give the
-     desired behavior when the file is in the Nix store, because all
-     file timestamps are set to 0 (for reasons related to build
-     reproducibility).
-   </para>
-
-   <para>
-     Fortunately, HTTP supports an alternative (and more effective)
-     caching mechanism: the
-    <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"><literal>ETag</literal></link>
-    response header. The value of the <literal>ETag</literal> header
-    specifies some identifier for the particular content that the
-    server is sending (e.g. a hash). When a client makes a second
-    request for the same resource, it sends that value back in an
-    <literal>If-None-Match</literal> header. If the ETag value is
-    unchanged, then the server does not need to resend the content.
-   </para>
-
-   <para>
-    As of NixOS 19.09, the nginx package in Nixpkgs is patched such
-    that when nginx serves a file out of <filename>/nix/store</filename>,
-    the hash in the store path is used as the <literal>ETag</literal>
-    header in the HTTP response, thus providing proper caching functionality.
-    This happens automatically; you do not need to do modify any
-    configuration to get this behavior.
-   </para>
-  </section>
- </section>
 </chapter>

doc/package-specific-user-notes.xml

@@ -1,482 +0,0 @@
-<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="package-specific-user-notes">
- <title>Package-specific usage notes</title>
- <para>
-         These chapters includes some notes
-         that apply to specific packages and should
-         answer some of the frequently asked questions
-         related to Nixpkgs use.
-
-  Some useful information related to package use
-  can be found in <link linkend="chap-package-notes">package-specific development notes</link>.
-
- </para>
- <section xml:id="opengl">
-  <title>OpenGL</title>
-
-  <para>
-   Packages that use OpenGL have NixOS desktop as their primary target. The
-   current solution for loading the GPU-specific drivers is based on
-   <literal>libglvnd</literal> and looks for the driver implementation in
-   <literal>LD_LIBRARY_PATH</literal>. If you are using a non-NixOS
-   GNU/Linux/X11 desktop with free software video drivers, consider launching
-   OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of
-   <literal>libglvnd</literal> and <literal>mesa_drivers</literal> in
-   <literal>LD_LIBRARY_PATH</literal>. For proprietary video drivers you might
-   have luck with also adding the corresponding video driver package.
-  </para>
- </section>
- <section xml:id="locales">
-  <title>Locales</title>
-
-  <para>
-   To allow simultaneous use of packages linked against different versions of
-   <literal>glibc</literal> with different locale archive formats Nixpkgs
-   patches <literal>glibc</literal> to rely on
-   <literal>LOCALE_ARCHIVE</literal> environment variable.
-  </para>
-
-  <para>
-   On non-NixOS distributions this variable is obviously not set. This can
-   cause regressions in language support or even crashes in some
-   Nixpkgs-provided programs. The simplest way to mitigate this problem is
-   exporting the <literal>LOCALE_ARCHIVE</literal> variable pointing to
-   <literal>${glibcLocales}/lib/locale/locale-archive</literal>. The drawback
-   (and the reason this is not the default) is the relatively large (a hundred
-   MiB) size of the full set of locales. It is possible to build a custom set
-   of locales by overriding parameters <literal>allLocales</literal> and
-   <literal>locales</literal> of the package.
-  </para>
- </section>
-
- <section xml:id="sec-emacs">
-  <title>Emacs</title>
-
-  <section xml:id="sec-emacs-config">
-   <title>Configuring Emacs</title>
-
-   <para>
-    The Emacs package comes with some extra helpers to make it easier to
-    configure. <varname>emacsWithPackages</varname> allows you to manage
-    packages from ELPA. This means that you will not have to install that
-    packages from within Emacs. For instance, if you wanted to use
-    <literal>company</literal>, <literal>counsel</literal>,
-    <literal>flycheck</literal>, <literal>ivy</literal>,
-    <literal>magit</literal>, <literal>projectile</literal>, and
-    <literal>use-package</literal> you could use this as a
-    <filename>~/.config/nixpkgs/config.nix</filename> override:
-   </para>
-
-<screen>
-{
-  packageOverrides = pkgs: with pkgs; {
-    myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [
-      company
-      counsel
-      flycheck
-      ivy
-      magit
-      projectile
-      use-package
-    ]));
-  }
-}
-</screen>
-
-   <para>
-    You can install it like any other packages via <command>nix-env -iA
-    myEmacs</command>. However, this will only install those packages. It will
-    not <literal>configure</literal> them for us. To do this, we need to
-    provide a configuration file. Luckily, it is possible to do this from
-    within Nix! By modifying the above example, we can make Emacs load a custom
-    config file. The key is to create a package that provide a
-    <filename>default.el</filename> file in
-    <filename>/share/emacs/site-start/</filename>. Emacs knows to load this
-    file automatically when it starts.
-   </para>
-
-<screen>
-{
-  packageOverrides = pkgs: with pkgs; rec {
-    myEmacsConfig = writeText "default.el" ''
-;; initialize package
-
-(require 'package)
-(package-initialize 'noactivate)
-(eval-when-compile
-  (require 'use-package))
-
-;; load some packages
-
-(use-package company
-  :bind ("&lt;C-tab&gt;" . company-complete)
-  :diminish company-mode
-  :commands (company-mode global-company-mode)
-  :defer 1
-  :config
-  (global-company-mode))
-
-(use-package counsel
-  :commands (counsel-descbinds)
-  :bind (([remap execute-extended-command] . counsel-M-x)
-         ("C-x C-f" . counsel-find-file)
-         ("C-c g" . counsel-git)
-         ("C-c j" . counsel-git-grep)
-         ("C-c k" . counsel-ag)
-         ("C-x l" . counsel-locate)
-         ("M-y" . counsel-yank-pop)))
-
-(use-package flycheck
-  :defer 2
-  :config (global-flycheck-mode))
-
-(use-package ivy
-  :defer 1
-  :bind (("C-c C-r" . ivy-resume)
-         ("C-x C-b" . ivy-switch-buffer)
-         :map ivy-minibuffer-map
-         ("C-j" . ivy-call))
-  :diminish ivy-mode
-  :commands ivy-mode
-  :config
-  (ivy-mode 1))
-
-(use-package magit
-  :defer
-  :if (executable-find "git")
-  :bind (("C-x g" . magit-status)
-         ("C-x G" . magit-dispatch-popup))
-  :init
-  (setq magit-completing-read-function 'ivy-completing-read))
-
-(use-package projectile
-  :commands projectile-mode
-  :bind-keymap ("C-c p" . projectile-command-map)
-  :defer 5
-  :config
-  (projectile-global-mode))
-    '';
-    myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [
-      (runCommand "default.el" {} ''
-mkdir -p $out/share/emacs/site-lisp
-cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el
-'')
-      company
-      counsel
-      flycheck
-      ivy
-      magit
-      projectile
-      use-package
-    ]));
-  };
-}
-</screen>
-
-   <para>
-    This provides a fairly full Emacs start file. It will load in addition to
-    the user's presonal config. You can always disable it by passing
-    <command>-q</command> to the Emacs command.
-   </para>
-
-   <para>
-    Sometimes <varname>emacsWithPackages</varname> is not enough, as this
-    package set has some priorities imposed on packages (with the lowest
-    priority assigned to Melpa Unstable, and the highest for packages manually
-    defined in <filename>pkgs/top-level/emacs-packages.nix</filename>). But you
-    can't control this priorities when some package is installed as a
-    dependency. You can override it on per-package-basis, providing all the
-    required dependencies manually - but it's tedious and there is always a
-    possibility that an unwanted dependency will sneak in through some other
-    package. To completely override such a package you can use
-    <varname>overrideScope'</varname>.
-   </para>
-
-<screen>
-overrides = self: super: rec {
-  haskell-mode = self.melpaPackages.haskell-mode;
-  ...
-};
-((emacsPackagesGen emacs).overrideScope' overrides).emacsWithPackages (p: with p; [
-  # here both these package will use haskell-mode of our own choice
-  ghc-mod
-  dante
-])
-</screen>
-  </section>
- </section>
-
- <section xml:id="dlib">
-  <title>DLib</title>
-
-  <para>
-    <link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which
-    provides several machine learning algorithms.
-  </para>
-
-  <section xml:id="compiling-without-avx-support">
-   <title>Compiling without AVX support</title>
-
-   <para>
-     Especially older CPUs don't support
-     <link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link>
-     (<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by DLib to
-     optimize their algorithms.
-   </para>
-
-   <para>
-    On the affected hardware errors like <literal>Illegal instruction</literal> will occur.
-    In those cases AVX support needs to be disabled:
-<programlisting>self: super: {
-  dlib = super.dlib.override { avxSupport = false; };
-}</programlisting>
-   </para>
-  </section>
- </section>
-
- <section xml:id="unfree-software">
-  <title>Unfree software</title>
-
-  <para>
-   All users of Nixpkgs are free software users, and many users (and
-   developers) of Nixpkgs want to limit and tightly control their exposure to
-   unfree software. At the same time, many users need (or want)
-   to run some specific
-   pieces of proprietary software. Nixpkgs includes some expressions for unfree
-   software packages. By default unfree software cannot be installed and
-   doesn’t show up in searches. To allow installing unfree software in a
-   single Nix invocation one can export
-   <literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users
-   can set <literal>allowUnfree</literal> in the Nixpkgs configuration.
-  </para>
-
-  <para>
-   Fine-grained control is possible by defining
-   <literal>allowUnfreePredicate</literal> function in config; it takes the
-   <literal>mkDerivation</literal> parameter attrset and returns
-   <literal>true</literal> for unfree packages that should be allowed.
-  </para>
- </section>
-
- <section xml:id="sec-steam">
-  <title>Steam</title>
-
-  <section xml:id="sec-steam-nix">
-   <title>Steam in Nix</title>
-
-   <para>
-    Steam is distributed as a <filename>.deb</filename> file, for now only as
-    an i686 package (the amd64 package only has documentation). When unpacked,
-    it has a script called <filename>steam</filename> that in Ubuntu (their
-    target distro) would go to <filename>/usr/bin </filename>. When run for the
-    first time, this script copies some files to the user's home, which include
-    another script that is the ultimate responsible for launching the steam
-    binary, which is also in $HOME.
-   </para>
-
-   <para>
-    Nix problems and constraints:
-    <itemizedlist>
-     <listitem>
-      <para>
-       We don't have <filename>/bin/bash</filename> and many scripts point
-       there. Similarly for <filename>/usr/bin/python</filename> .
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       We don't have the dynamic loader in <filename>/lib </filename>.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       The <filename>steam.sh</filename> script in $HOME can not be patched, as
-       it is checked and rewritten by steam.
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       The steam binary cannot be patched, it's also checked.
-      </para>
-     </listitem>
-    </itemizedlist>
-   </para>
-
-   <para>
-    The current approach to deploy Steam in NixOS is composing a FHS-compatible
-    chroot environment, as documented
-    <link xlink:href="http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html">here</link>.
-    This allows us to have binaries in the expected paths without disrupting
-    the system, and to avoid patching them to work in a non FHS environment.
-   </para>
-  </section>
-
-  <section xml:id="sec-steam-play">
-   <title>How to play</title>
-
-   <para>
-    For 64-bit systems it's important to have
-<programlisting>hardware.opengl.driSupport32Bit = true;</programlisting>
-    in your <filename>/etc/nixos/configuration.nix</filename>. You'll also need
-<programlisting>hardware.pulseaudio.support32Bit = true;</programlisting>
-    if you are using PulseAudio - this will enable 32bit ALSA apps integration.
-    To use the Steam controller or other Steam supported controllers such as
-    the DualShock 4 or Nintendo Switch Pro, you need to add
-<programlisting>hardware.steam-hardware.enable = true;</programlisting>
-    to your configuration.
-   </para>
-  </section>
-
-  <section xml:id="sec-steam-troub">
-   <title>Troubleshooting</title>
-
-   <para>
-    <variablelist>
-     <varlistentry>
-      <term>
-       Steam fails to start. What do I do?
-      </term>
-      <listitem>
-       <para>
-        Try to run
-<programlisting>strace steam</programlisting>
-        to see what is causing steam to fail.
-       </para>
-      </listitem>
-     </varlistentry>
-     <varlistentry>
-      <term>
-       Using the FOSS Radeon or nouveau (nvidia) drivers
-      </term>
-      <listitem>
-       <itemizedlist>
-        <listitem>
-         <para>
-          The <literal>newStdcpp</literal> parameter was removed since NixOS
-          17.09 and should not be needed anymore.
-         </para>
-        </listitem>
-        <listitem>
-         <para>
-          Steam ships statically linked with a version of libcrypto that
-          conflics with the one dynamically loaded by radeonsi_dri.so. If you
-          get the error
-<programlisting>steam.sh: line 713: 7842 Segmentation fault (core dumped)</programlisting>
-          have a look at
-          <link xlink:href="https://github.com/NixOS/nixpkgs/pull/20269">this
-          pull request</link>.
-         </para>
-        </listitem>
-       </itemizedlist>
-      </listitem>
-     </varlistentry>
-     <varlistentry>
-      <term>
-       Java
-      </term>
-      <listitem>
-       <orderedlist>
-        <listitem>
-         <para>
-          There is no java in steam chrootenv by default. If you get a message
-          like
-<programlisting>/home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found</programlisting>
-          You need to add
-<programlisting> steam.override { withJava = true; };</programlisting>
-          to your configuration.
-         </para>
-        </listitem>
-       </orderedlist>
-      </listitem>
-     </varlistentry>
-    </variablelist>
-   </para>
-  </section>
-
-  <section xml:id="sec-steam-run">
-   <title>steam-run</title>
-
-   <para>
-    The FHS-compatible chroot used for steam can also be used to run other
-    linux games that expect a FHS environment. To do it, add
-<programlisting>pkgs.(steam.override {
-          nativeOnly = true;
-          newStdcpp = true;
-        }).run</programlisting>
-    to your configuration, rebuild, and run the game with
-<programlisting>steam-run ./foo</programlisting>
-   </para>
-  </section>
- </section>
-
- <section xml:id="sec-citrix">
-  <title>Citrix Receiver &amp; Citrix Workspace App</title>
-
-  <para>
-   <note>
-    <para>
-     Please note that the <literal>citrix_receiver</literal> package has been deprecated since its
-     development was <link xlink:href="https://docs.citrix.com/en-us/citrix-workspace-app.html">discontinued by upstream</link>
-     and will be replaced by <link xlink:href="https://www.citrix.com/products/workspace-app/">the citrix workspace app</link>.
-    </para>
-   </note>
-   <link xlink:href="https://www.citrix.com/products/receiver/">Citrix Receiver</link> and
-   <link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix Workspace App</link>
-   are a remote desktop viewers which provide access to
-   <link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link>
-   installations.
-  </para>
-
-  <section xml:id="sec-citrix-base">
-   <title>Basic usage</title>
-
-   <para>
-    The tarball archive needs to be downloaded manually as the license
-    agreements of the vendor for
-    <link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">Citrix Receiver</link>
-    or <link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix Workspace</link>
-    need to be accepted first.
-    Then run <command>nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz</command>.
-    With the archive available
-    in the store the package can be built and installed with Nix.
-   </para>
-
-   <warning>
-    <title>Caution with <command>nix-shell</command> installs</title>
-    <para>
-     It's recommended to install <literal>Citrix Receiver</literal>
-     and/or <literal>Citrix Workspace</literal> using
-     <literal>nix-env -i</literal> or globally to
-     ensure that the <literal>.desktop</literal> files are installed properly
-     into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it won't be possible to
-     open <literal>.ica</literal> files automatically from the browser to start
-     a Citrix connection.
-    </para>
-   </warning>
-  </section>
-
-  <section xml:id="sec-citrix-custom-certs">
-   <title>Custom certificates</title>
-
-   <para>
-    The <literal>Citrix Receiver</literal> and <literal>Citrix Workspace App</literal>
-    in <literal>nixpkgs</literal> trust several certificates
-    <link xlink:href="https://curl.haxx.se/docs/caextract.html">from the
-    Mozilla database</link> by default. However several companies using Citrix
-    might require their own corporate certificate. On distros with imperative
-    packaging these certs can be stored easily in
-    <link xlink:href="https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/"><literal>$ICAROOT</literal></link>,
-    however this directory is a store path in <literal>nixpkgs</literal>. In
-    order to work around this issue the package provides a simple mechanism to
-    add custom certificates without rebuilding the entire package using
-    <literal>symlinkJoin</literal>:
-<programlisting>
-<![CDATA[with import <nixpkgs> { config.allowUnfree = true; };
-let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in
-citrix_workspace.override { # the same applies for `citrix_receiver` if used.
-  inherit extraCerts;
-}]]>
-</programlisting>
-   </para>
-  </section>
- </section>
-</chapter>

doc/platform-notes.xml

@@ -1,105 +0,0 @@
-<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>
-
-  <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.
-    </para>
-<programlisting>
-stdenv.mkDerivation {
-  name = "libfoo-1.2.3";
-  # ...
-  buildPhase = ''
-    $CC -o hello hello.c
-  '';
-}
-</programlisting>
-   </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>.
-    </para>
-<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>
-    <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.
-    </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>
-stdenv.mkDerivation {
-  name = "libfoo-1.2.3";
-  # ...
-  prePatch = ''
-    substituteInPlace Makefile \
-        --replace '/usr/bin/xcrun clang' clang
-  '';
-}
-</programlisting>
-    <para>
-     The package <literal>xcbuild</literal> can be used to build projects that
-     really depend on Xcode. However, this replacement is not 100% compatible
-     with Xcode and can occasionally cause issues.
-    </para>
-   </listitem>
-  </itemizedlist>
- </section>
-</chapter>

doc/quick-start.xml

@@ -1,223 +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>
-<prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs
-<prompt>$ </prompt>cd nixpkgs</screen>
+$ 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>
-<prompt>$ </prompt>mkdir pkgs/development/libraries/libfoo</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>
-<prompt>$ </prompt>emacs pkgs/development/libraries/libfoo/default.nix
-<prompt>$ </prompt>git add pkgs/development/libraries/libfoo/default.nix</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>
-        <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>
-<prompt>$ </prompt>emacs pkgs/top-level/all-packages.nix</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>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>
+$ nix-env -f . -iA libfoo</screen>
+
     </para>
-   </listitem>
-   <listitem>
-    <para>
-     To test whether the package builds, run the following command from the
-     root of the nixpkgs source tree:
-<screen>
-<prompt>$ </prompt>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>
-<prompt>$ </prompt>nix-env -f . -iA libfoo</screen>
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     Optionally commit the new package and open a pull request <link
-     xlink:href="https://github.com/NixOS/nixpkgs/pulls">to nixpkgs</link>, or
-     use <link
-     xlink:href="https://discourse.nixos.org/t/about-the-patches-category/477">
-     the Patches category</link> on Discourse for sending a patch without a
-     GitHub account.
-    </para>
-   </listitem>
-  </orderedlist>
- </para>
+  </listitem>
+
+  <listitem>
+    <para>Optionally commit the new package and open a pull request, or send a patch to
+    <literal>nix-dev@cs.uu.nl</literal>.</para>
+  </listitem>
+
+
+</orderedlist>
+
+</para>
+
 </chapter>

doc/reviewing-contributions.xml

@@ -1,619 +0,0 @@
-<chapter xmlns="http://docbook.org/ns/docbook"
-        xmlns:xlink="http://www.w3.org/1999/xlink"
-        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
-  responsive to the comments is the key to avoid this issue. GitHub provides
-  sort 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
-  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.
-  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
-  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>
-
-  <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>
-
-  <para>
-   It can happen that non-trivial updates include patches or more complex
-   changes.
-  </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 (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>
-    <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 meta field information is correct.
-    </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>
-    </itemizedlist>
-   </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.
-<screen>
-<prompt>$ </prompt>git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co
-  xml:id='reviewing-rebase-1' />
-<prompt>$ </prompt>git fetch channels nixos-unstable <co xml:id='reviewing-rebase-2' />
-<prompt>$ </prompt>git fetch origin pull/PRNUMBER/head <co xml:id='reviewing-rebase-3' />
-<prompt>$ </prompt>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/Mic92/nix-review">nix-review</link>
-       tool can be used to review a pull request content in a single command.
-       <varname>PRNUMBER</varname> should be replaced by the number at the end
-       of the pull request title. You can also provide the full github pull
-       request url.
-      </para>
-<screen>
-<prompt>$ </prompt>nix-shell -p nix-review --run "nix-review pr PRNUMBER"
-</screen>
-     </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>
-<screen>
-##### Reviewed points
-
-- [ ] package name fits guidelines
-- [ ] package version fits guidelines
-- [ ] package build on ARCHITECTURE
-- [ ] executables tested on ARCHITECTURE
-- [ ] all depending packages build
-
-##### Possible improvements
-
-##### Comments
-
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-new-packages">
-  <title>New packages</title>
-
-  <para>
-   New packages are a common type of pull requests. These pull requests
-   consists in adding a new nix-expression for a package.
-  </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>
-    </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>
-    <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>
-    </itemizedlist>
-   </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>
-    </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>
-<screen>
-##### Reviewed points
-
-- [ ] package path fits guidelines
-- [ ] package name fits guidelines
-- [ ] package version fits guidelines
-- [ ] package build on ARCHITECTURE
-- [ ] executables tested on ARCHITECTURE
-- [ ] `meta.description` is set and fits guidelines
-- [ ] `meta.license` fits upstream license
-- [ ] `meta.platforms` is set
-- [ ] `meta.maintainers` is set
-- [ ] build time only dependencies are declared in `nativeBuildInputs`
-- [ ] source is fetched using the appropriate function
-- [ ] phases are respected
-- [ ] patches that are remotely available are fetched with `fetchpatch`
-
-##### Possible improvements
-
-##### Comments
-
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-module-updates">
-  <title>Module updates</title>
-
-  <para>
-   Module updates are submissions changing modules in some ways. These often
-   contains changes to the options or introduce new options.
-  </para>
-
-  <para>
-   Reviewing process
-  </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>
-
-  <example xml:id="reviewing-contributions-sample-module-update">
-   <title>Sample template for a module update review</title>
-<screen>
-##### Reviewed points
-
-- [ ] changes are backward compatible
-- [ ] removed options are declared with `mkRemovedOptionModule`
-- [ ] changes that are not backward compatible are documented in release notes
-- [ ] module tests succeed on ARCHITECTURE
-- [ ] options types are appropriate
-- [ ] options description is set
-- [ ] options example is provided
-- [ ] documentation affected by the changes is updated
-
-##### Possible improvements
-
-##### Comments
-
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-new-modules">
-  <title>New modules</title>
-
-  <para>
-   New modules submissions introduce a new module to NixOS.
-  </para>
-
-  <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 xml:id="reviewing-contributions-sample-new-module">
-   <title>Sample template for a new module review</title>
-<screen>
-##### Reviewed points
-
-- [ ] module path fits the guidelines
-- [ ] module tests succeed on ARCHITECTURE
-- [ ] options have appropriate types
-- [ ] options have default
-- [ ] options have example
-- [ ] options have descriptions
-- [ ] No unneeded package is added to environment.systemPackages
-- [ ] meta.maintainers is set
-- [ ] module documentation is declared in meta.doc
-
-##### Possible improvements
-
-##### Comments
-
-</screen>
-  </example>
- </section>
- <section xml:id="reviewing-contributions-other-submissions">
-  <title>Other submissions</title>
-
-  <para>
-   Other type of submissions requires different reviewing steps.
-  </para>
-
-  <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>
-   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>
-   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
-proposition and should be modified to what the community agrees to be the right
-policy.
-
-<para>Please note that contributors with commit rights unactive for more than
-  three months will have their commit rights revoked.</para>
--->
-
-  <para>
-   In a case a contributor definitively leaves the Nix community, they should
-   create an issue or post on
-   <link
-   xlink:href="https://discourse.nixos.org">Discourse</link> with
-   references of packages and modules they maintain so the maintainership can
-   be taken over by other contributors.
-  </para>
- </section>
-</chapter>

doc/shell.nix

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

doc/style.css

@@ -9,7 +9,6 @@
 body
 {
     font-family: "Nimbus Sans L", sans-serif;
-    font-size: 1em;
     background: white;
     margin: 2em 1em 2em 1em;
 }
@@ -29,28 +28,9 @@ h2 /* chapters, appendices, subtitle */
     font-size: 180%;
 }
 
-div.book
-{
-    text-align: center;
-}
-
-div.book > div
-{
-    /*
-     * based on https://medium.com/@zkareemz/golden-ratio-62b3b6d4282a
-     * we do 70 characters per line to fit code listings better
-     * 70 * (font-size / 1.618)
-     * expression for emacs:
-     * (* 70 (/ 1 1.618))
-     */
-    max-width: 43.2em;
-    text-align: left;
-    margin: auto;
-}
-
 /* Extra space between chapters, appendices. */
-div.chapter > div.titlepage h2, div.appendix > div.titlepage h2
-{
+div.chapter > div.titlepage h2, div.appendix > div.titlepage h2 
+{ 
     margin-top: 1.5em;
 }
 
@@ -122,9 +102,9 @@ pre.screen, pre.programlisting
 {
     border: 1px solid #b0b0b0;
     padding: 3px 3px;
-    margin-left: 0.5em;
-    margin-right: 0.5em;
-
+    margin-left: 1.5em;
+    margin-right: 1.5em;
+    color: #600000;
     background: #f4f4f8;
     font-family: monospace;
     border-radius: 0.4em;
@@ -138,6 +118,7 @@ div.example pre.programlisting
     margin: 0 0 0 0;
 }
 
+
 /***************************************************************************
                                Notes, warnings etc:
  ***************************************************************************/
@@ -191,7 +172,7 @@ div.navfooter *
 
 
 /***************************************************************************
-                        Links colors and highlighting:
+                        Links colors and highlighting: 
  ***************************************************************************/
 
 a { text-decoration: none; }
@@ -228,7 +209,7 @@ tt, code
 .term
 {
     font-weight: bold;
-
+    
 }
 
 div.variablelist dd p, div.glosslist dd p
@@ -268,24 +249,7 @@ 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,512 +1,320 @@
 <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>
-<prompt>$ </prompt>git checkout 0998212
-<prompt>$ </prompt>git checkout -b 'fix/pkg-name-update'
+$ 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)
+(pkg-name | service-name): (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>Examples:
+
+<itemizedlist>
+<listitem>
+<para>
+<command>nginx: init at 2.0.1</command>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<command>firefox: 3.0 -> 3.1.1</command>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<command>hydra service: add bazBaz option</command>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<command>nginx service: 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 | service): 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>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>
-     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>
+    <listitem>
+      <para>
+        It should only see non-breaking commits that do not cause mass rebuilds.
+      </para>
+    </listitem>
   </itemizedlist>
- </section>
- <section xml:id="submitting-changes-pull-request-template">
-  <title>Pull Request Template</title>
+</section>
 
-  <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>nix-review</command></title>
-
-   <para>
-    If you are updating a package's version, you can use nix-review to make
-    sure all packages that depend on the updated package still compile
-    correctly. The <command>nix-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 changes from pull request number 12345:
-<screen>nix-shell -p nix-review --run "nix-review pr 12345"</screen>
-   </para>
-
-   <para>
-    review uncommitted changes:
-<screen>nix-shell -p nix-review --run "nix-review wip"</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
-    request.
-   </para>
-  </section>
- </section>
- <section xml:id="submitting-changes-hotfixing-pull-requests">
-  <title>Hotfixing pull requests</title>
+<section>
+  <title>Staging 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'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-commit-policy">
-  <title>Commit policy</title>
+</section>
+
+<section>
+  <title>Stable release branches</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 xml:id="submitting-changes-master-branch">
-   <title>Master branch</title>
-
-   <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.
@@ -514,9 +322,11 @@ The original commit message describing the reason why the world was torn apart.
 (cherry picked from commit abcdef)
 Reason: I just had a gut feeling that this would also be wanted by people from
 the stone age.
-</screen>
+      </screen>
     </listitem>
-   </itemizedlist>
-  </section>
- </section>
+  </itemizedlist>
+</section>
+
+</section>
 </chapter>
+

lib/asserts.nix

@@ -1,44 +0,0 @@
-{ lib }:
-
-rec {
-
-  /* Print a trace message if pred is false.
-     Intended to be used to augment asserts with helpful error messages.
-
-     Example:
-       assertMsg false "nope"
-       => false
-       stderr> trace: nope
-
-       assert (assertMsg ("foo" == "bar") "foo is not bar, silly"); ""
-       stderr> trace: foo is not bar, silly
-       stderr> assert failed at …
-
-     Type:
-       assertMsg :: Bool -> String -> Bool
-  */
-  # TODO(Profpatsch): add tests that check stderr
-  assertMsg = pred: msg:
-    if pred
-    then true
-    else builtins.trace msg false;
-
-  /* Specialized `assertMsg` for checking if val is one of the elements
-     of a list. Useful for checking enums.
-
-     Example:
-       let sslLibrary = "libressl"
-       in assertOneOf "sslLibrary" sslLibrary [ "openssl" "bearssl" ]
-       => false
-       stderr> trace: sslLibrary must be one of "openssl", "bearssl", but is: "libressl"
-
-     Type:
-       assertOneOf :: String -> ComparableVal -> List ComparableVal -> Bool
-  */
-  assertOneOf = name: val: xs: assertMsg
-    (lib.elem val xs)
-    "${name} must be one of ${
-      lib.generators.toPretty {} xs}, but is: ${
-        lib.generators.toPretty {} val}";
-
-}

lib/attrsets.nix

@@ -1,12 +1,12 @@
-{ lib }:
 # Operations on attribute sets.
 
-let
+with {
   inherit (builtins) head tail length;
-  inherit (lib.trivial) and;
-  inherit (lib.strings) concatStringsSep;
-  inherit (lib.lists) fold concatMap concatLists;
-in
+  inherit (import ./trivial.nix) or;
+  inherit (import ./default.nix) fold;
+  inherit (import ./strings.nix) concatStringsSep;
+  inherit (import ./lists.nix) concatMap concatLists all deepSeqList;
+};
 
 rec {
   inherit (builtins) attrNames listToAttrs hasAttr isAttrs getAttr;
@@ -94,15 +94,6 @@ rec {
   attrValues = builtins.attrValues or (attrs: attrVals (attrNames attrs) attrs);
 
 
-  /* Given a set of attribute names, return the set of the corresponding
-     attributes from the given set.
-
-     Example:
-       getAttrs [ "a" "b" ] { a = 1; b = 2; c = 3; }
-       => { a = 1; b = 2; }
-  */
-  getAttrs = names: attrs: genAttrs names (name: attrs.${name});
-
   /* Collect each attribute named `attr' from a list of attribute
      sets.  Sets that don't contain the named attribute are ignored.
 
@@ -125,7 +116,7 @@ rec {
     listToAttrs (concatMap (name: let v = set.${name}; in if pred name v then [(nameValuePair name v)] else []) (attrNames set));
 
 
-  /* Filter an attribute set recursively by removing all attributes for
+  /* Filter an attribute set recursivelly by removing all attributes for
      which the given predicate return false.
 
      Example:
@@ -154,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;
 
@@ -204,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
@@ -306,17 +296,12 @@ rec {
 
   /* Converts a store path to a fake derivation. */
   toDerivation = path:
-    let
-      path' = builtins.storePath path;
-      res =
-        { type = "derivation";
-          name = builtins.unsafeDiscardStringContext (builtins.substring 33 (-1) (baseNameOf path'));
-          outPath = path';
-          outputs = [ "out" ];
-          out = res;
-          outputName = "out";
-        };
-    in res;
+    let path' = builtins.storePath path; in
+    { type = "derivation";
+      name = builtins.unsafeDiscardStringContext (builtins.substring 33 (-1) (baseNameOf path'));
+      outPath = path';
+      outputs = [ "out" ];
+    };
 
 
   /* If `cond' is true, return the attribute set `as',
@@ -344,7 +329,7 @@ rec {
       value = f name (catAttrs name sets);
     }) names);
 
-  /* Implementation note: Common names  appear multiple times in the list of
+  /* Implentation note: Common names  appear multiple times in the list of
      names, hopefully this does not affect the system because the maximal
      laziness avoid computing twice the same expression and listToAttrs does
      not care about duplicated attribute names.
@@ -363,7 +348,7 @@ rec {
   zipAttrs = zipAttrsWith (name: values: values);
 
   /* Does the same as the update operator '//' except that attributes are
-     merged until the given predicate is verified.  The predicate should
+     merged until the given pedicate is verified.  The predicate should
      accept 3 arguments which are the path to reach the attribute, a part of
      the first attribute set and a part of the second attribute set.  When
      the predicate is verified, the value of the first attribute set is
@@ -393,16 +378,15 @@ 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];
 
-  /* A recursive variant of the update operator ‘//’.  The recursion
+  /* A recursive variant of the update operator ‘//’.  The recusion
      stops when one of the attribute values is not an attribute set,
      in which case the right hand side value takes precedence over the
      left hand side value.
@@ -428,15 +412,18 @@ rec {
 
   /* Returns true if the pattern is contained in the set. False otherwise.
 
+     FIXME(zimbatm): this example doesn't work !!!
+
      Example:
-       matchAttrs { cpu = {}; } { cpu = { bits = 64; }; }
+       sys = mkSystem { }
+       matchAttrs { cpu = { bits = 64; }; } sys
        => true
    */
-  matchAttrs = pattern: attrs: assert isAttrs pattern;
-    fold and true (attrValues (zipAttrsWithNames (attrNames pattern) (n: values:
+  matchAttrs = pattern: attrs:
+    fold or false (attrValues (zipAttrsWithNames (attrNames pattern) (n: values:
       let pat = head values; val = head (tail values); in
       if length values == 1 then false
-      else if isAttrs pat then isAttrs val && matchAttrs pat val
+      else if isAttrs pat then isAttrs val && matchAttrs head values
       else pat == val
     ) [pattern attrs]));
 
@@ -444,15 +431,12 @@ rec {
     useful for deep-overriding.
 
     Example:
-      overrideExisting {} { a = 1; }
-      => {}
-      overrideExisting { b = 2; } { a = 1; }
-      => { b = 2; }
-      overrideExisting { a = 3; b = 2; } { a = 1; }
-      => { a = 1; b = 2; }
+      x = { a = { b = 4; c = 3; }; }
+      overrideExisting x { a = { b = 6; d = 2; }; }
+      => { a = { b = 6; d = 2; }; }
   */
   overrideExisting = old: new:
-    mapAttrs (name: value: new.${name} or value) old;
+    old // listToAttrs (map (attr: nameValuePair attr (attrByPath [attr] old.${attr} new)) (attrNames old));
 
   /* Get a package output.
      If no output is found, fallback to `.out` and then to the default.
@@ -470,11 +454,10 @@ rec {
   getLib = getOutput "lib";
   getDev = getOutput "dev";
 
-  /* Pick the outputs of packages to place in buildInputs */
-  chooseDevOutputs = drvs: builtins.map getDev drvs;
 
   /*** deprecated stuff ***/
 
+  deepSeqAttrs = throw "removed 2016-02-29 because unused and broken";
   zipWithNames = zipAttrsWithNames;
   zip = builtins.trace
     "lib.zip is deprecated, use lib.zipAttrsWith instead" zipAttrsWith;

lib/composable-derivation.nix

@@ -0,0 +1,113 @@
+{lib, pkgs} :
+let inherit (lib) nv nvs; in
+{
+
+  # composableDerivation basically mixes these features:
+  # - fix function
+  # - mergeAttrBy
+  # - provides shortcuts for "options" such as "--enable-foo" and adding
+  #   buildInputs, see php example
+  #
+  # It predates styles which are common today, such as
+  #  * the config attr
+  #  * mkDerivation.override feature
+  #  * overrideDerivation (lib/customization.nix)
+  #
+  # Some of the most more important usage examples (which could be rewritten if it was important):
+  # * php
+  # * postgis
+  # * vim_configurable
+  #
+  # A minimal example illustrating most features would look like this:
+  # let base = composableDerivation { (fixed : let inherit (fixed.fixed) name in {
+  #    src = fetchurl {
+  #    }
+  #    buildInputs = [A];
+  #    preConfigre = "echo ${name}";
+  #    # attention, "name" attr is missing, thus you cannot instantiate "base".
+  # }
+  # in {
+  #  # These all add name attribute, thus you can instantiate those:
+  #  v1 = base.merge   ({ name = "foo-add-B"; buildInputs = [B]; });       // B gets merged into buildInputs
+  #  v2 = base.merge   ({ name = "mix-in-pre-configure-lines" preConfigre = ""; });
+  #  v3 = base.replace ({ name = "foo-no-A-only-B;" buildInputs = [B]; });
+  # }
+  #
+  # So yes, you can think about it being something like nixos modules, and
+  # you'd be merging "features" in one at a time using .merge or .replace
+  # Thanks Shea for telling me that I rethink the documentation ..
+  #
+  # issues:
+  # * its complicated to understand
+  # * some "features" such as exact merge behaviour are burried in mergeAttrBy
+  #   and defaultOverridableDelayableArgs assuming the default behaviour does
+  #   the right thing in the common case
+  # * Eelco once said using such fix style functions are slow to evaluate
+  # * Too quick & dirty. Hard to understand for others. The benefit was that
+  #   you were able to create a kernel builder like base derivation and replace
+  #   / add patches the way you want without having to declare function arguments
+  #
+  # nice features:
+  # declaring "optional featuers" is modular. For instance:
+  #   flags.curl = {
+  #     configureFlags = ["--with-curl=${curl.dev}" "--with-curlwrappers"];
+  #     buildInputs = [curl openssl];
+  #   };
+  #   flags.other = { .. }
+  # (Example taken from PHP)
+  #
+  # alternative styles / related features:
+  #  * Eg see function supporting building the kernel
+  #  * versionedDerivation (discussion about this is still going on - or ended)
+  #  * composedArgsAndFun
+  #  * mkDerivation.override
+  #  * overrideDerivation
+  #  * using { .., *Support ? false }: like configurable options.
+  # To find those examples use grep
+  #
+  # To sum up: It exists for historical reasons - and for most commonly used
+  # tasks the alternatives should be used
+  #
+  # If you have questions about this code ping Marc Weber.
+  composableDerivation = {
+        mkDerivation ? pkgs.stdenv.mkDerivation,
+
+        # list of functions to be applied before defaultOverridableDelayableArgs removes removeAttrs names
+        # prepareDerivationArgs handles derivation configurations
+        applyPreTidy ? [ lib.prepareDerivationArgs ],
+
+        # consider adding addtional elements by derivation.merge { removeAttrs = ["elem"]; };
+        removeAttrs ? ["cfg" "flags"]
+
+      }: (lib.defaultOverridableDelayableArgs ( a: mkDerivation a) 
+         {
+           inherit applyPreTidy removeAttrs;
+         }).merge;
+
+  # some utility functions
+  # use this function to generate flag attrs for prepareDerivationArgs
+  # E nable  D isable F eature
+  edf = {name, feat ? name, enable ? {}, disable ? {} , value ? ""}:
+    nvs name {
+    set = {
+      configureFlags = ["--enable-${feat}${if value == "" then "" else "="}${value}"];
+    } // enable;
+    unset = {
+      configureFlags = ["--disable-${feat}"];
+    } // disable;
+  };
+
+  # same for --with and --without-
+  # W ith or W ithout F eature
+  wwf = {name, feat ? name, enable ? {}, disable ? {}, value ? ""}:
+    nvs name {
+    set = enable // {
+      configureFlags = ["--with-${feat}${if value == "" then "" else "="}${value}"]
+                       ++ lib.maybeAttr "configureFlags" [] enable;
+    };
+    unset = disable // {
+      configureFlags = ["--without-${feat}"]
+                       ++ lib.maybeAttr "configureFlags" [] disable;
+    };
+  };
+}

lib/customisation.nix

@@ -1,19 +1,24 @@
-{ lib }:
+let
+
+  lib = import ./default.nix;
+  inherit (builtins) attrNames isFunction;
+
+in
 
 rec {
 
 
   /* `overrideDerivation drv f' takes a derivation (i.e., the result
      of a call to the builtin function `derivation') and returns a new
-     derivation in which the attributes of the original are overridden
+     derivation in which the attributes of the original are overriden
      according to the function `f'.  The function `f' is called with
      the original derivation attributes.
 
      `overrideDerivation' allows certain "ad-hoc" customisation
-     scenarios (e.g. in ~/.config/nixpkgs/config.nix).  For instance,
-     if you want to "patch" the derivation returned by a package
-     function in Nixpkgs to build another version than what the
-     function itself provides, you can do something like this:
+     scenarios (e.g. in ~/.nixpkgs/config.nix).  For instance, if you
+     want to "patch" the derivation returned by a package function in
+     Nixpkgs to build another version than what the function itself
+     provides, you can do something like this:
 
        mySed = overrideDerivation pkgs.gnused (oldAttrs: {
          name = "sed-4.2.2-pre";
@@ -31,7 +36,7 @@ rec {
   overrideDerivation = drv: f:
     let
       newDrv = derivation (drv.drvAttrs // (f drv));
-    in lib.flip (extendDerivation true) newDrv (
+    in addPassthru newDrv (
       { meta = drv.meta or {};
         passthru = if drv ? passthru then drv.passthru else {};
       }
@@ -46,41 +51,21 @@ rec {
        else { }));
 
 
-  /* `makeOverridable` takes a function from attribute set to attribute set and
-     injects `override` attribute which can be used to override arguments of
-     the function.
-
-       nix-repl> x = {a, b}: { result = a + b; }
-
-       nix-repl> y = lib.makeOverridable x { a = 1; b = 2; }
-
-       nix-repl> y
-       { override = «lambda»; overrideDerivation = «lambda»; result = 3; }
-
-       nix-repl> y.override { a = 10; }
-       { override = «lambda»; overrideDerivation = «lambda»; result = 12; }
-
-     Please refer to "Nixpkgs Contributors Guide" section
-     "<pkg>.overrideDerivation" to learn about `overrideDerivation` and caveats
-     related to its use.
-  */
   makeOverridable = f: origArgs:
     let
       ff = f origArgs;
-      overrideWith = newArgs: origArgs // (if lib.isFunction newArgs then newArgs origArgs else newArgs);
+      overrideWith = newArgs: origArgs // (if builtins.isFunction newArgs then newArgs origArgs else newArgs);
     in
-      if builtins.isAttrs ff then (ff // {
-        override = newArgs: makeOverridable f (overrideWith newArgs);
-        overrideDerivation = fdrv:
-          makeOverridable (args: overrideDerivation (f args) fdrv) origArgs;
-        ${if ff ? overrideAttrs then "overrideAttrs" else null} = fdrv:
-          makeOverridable (args: (f args).overrideAttrs fdrv) origArgs;
-      })
-      else if lib.isFunction ff then {
-        override = newArgs: makeOverridable f (overrideWith newArgs);
-        __functor = self: ff;
-        overrideDerivation = throw "overrideDerivation not yet supported for functors";
-      }
+      if builtins.isAttrs ff then (ff //
+        { override = newArgs: makeOverridable f (overrideWith newArgs);
+          overrideDerivation = fdrv:
+            makeOverridable (args: overrideDerivation (f args) fdrv) origArgs;
+        })
+      else if builtins.isFunction ff then
+        { override = newArgs: makeOverridable f (overrideWith newArgs);
+          __functor = self: ff;
+          overrideDerivation = throw "overrideDerivation not yet supported for functors";
+        }
       else ff;
 
 
@@ -107,8 +92,8 @@ rec {
   */
   callPackageWith = autoArgs: fn: args:
     let
-      f = if lib.isFunction fn then fn else import fn;
-      auto = builtins.intersectAttrs (lib.functionArgs f) autoArgs;
+      f = if builtins.isFunction fn then fn else import fn;
+      auto = builtins.intersectAttrs (builtins.functionArgs f) autoArgs;
     in makeOverridable f (auto // args);
 
 
@@ -117,17 +102,19 @@ rec {
      individual attributes. */
   callPackagesWith = autoArgs: fn: args:
     let
-      f = if lib.isFunction fn then fn else import fn;
-      auto = builtins.intersectAttrs (lib.functionArgs f) autoArgs;
-      origArgs = auto // args;
-      pkgs = f origArgs;
-      mkAttrOverridable = name: _: makeOverridable (newArgs: (f newArgs).${name}) origArgs;
+      f = if builtins.isFunction fn then fn else import fn;
+      auto = builtins.intersectAttrs (builtins.functionArgs f) autoArgs;
+      finalArgs = auto // args;
+      pkgs = f finalArgs;
+      mkAttrOverridable = name: pkg: pkg // {
+        override = newArgs: mkAttrOverridable name (f (finalArgs // newArgs)).${name};
+      };
     in lib.mapAttrs mkAttrOverridable pkgs;
 
 
   /* Add attributes to each output of a derivation without changing
-     the derivation itself and check a given condition when evaluating. */
-  extendDerivation = condition: passthru: drv:
+     the derivation itself. */
+  addPassthru = drv: passthru:
     let
       outputs = drv.outputs or [ "out" ];
 
@@ -137,18 +124,13 @@ rec {
       outputToAttrListElement = outputName:
         { name = outputName;
           value = commonAttrs // {
-            inherit (drv.${outputName}) type outputName;
-            drvPath = assert condition; drv.${outputName}.drvPath;
-            outPath = assert condition; drv.${outputName}.outPath;
+            inherit (drv.${outputName}) outPath drvPath type outputName;
           };
         };
 
       outputsList = map outputToAttrListElement outputs;
-    in commonAttrs // {
-      outputUnspecified = true;
-      drvPath = assert condition; drv.drvPath;
-      outPath = assert condition; drv.outPath;
-    };
+  in commonAttrs // { outputUnspecified = true; };
+
 
   /* Strip a derivation of all non-essential attributes, returning
      only those needed by hydra-eval-jobs. Also strictly evaluate the
@@ -185,7 +167,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
+     `override' 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,11 +177,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: super: { … })` 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);
-          packages = f;
+          override = g: makeScope newScope (self_:
+            let super = f self_;
+            in super // g super self_);
         };
     in self;
 

lib/debug.nix

@@ -1,155 +1,62 @@
-/* Collection of functions useful for debugging
-   broken nix expressions.
+let lib = import ./default.nix;
+
+inherit (builtins) trace attrNamesToStr isAttrs isFunction isList isInt
+        isString isBool head substring attrNames;
+
+inherit (lib) all id mapAttrsFlatten elem;
 
-   * `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;
 in
 
 rec {
 
-  # -- TRACING --
+  inherit (builtins) addErrorContext;
 
-  /* Conditionally trace the supplied message, based on a predicate.
+  addErrorContextToAttrs = lib.mapAttrs (a: v: lib.addErrorContext "while evaluating ${a}" v);
 
-     Type: traceIf :: bool -> string -> a -> a
+  traceIf = p: msg: x: if p then trace msg x else x;
 
-     Example:
-       traceIf true "hello" 3
-       trace: hello
-       => 3
+  traceVal = x: trace x x;
+  traceXMLVal = x: trace (builtins.toXML x) x;
+  traceXMLValMarked = str: x: trace (str + builtins.toXML x) x;
+
+  # 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
+     result is a list of failed tests, each represented as {name,
+     expected, actual}, denoting the attribute name of the failing
+     test and its expected and actual results.  Used for regression
+     testing of the functions in lib; see tests.nix for an example.
+     Only tests having names starting with "test" are run.
+     Add attr { tests = ["testName"]; } to run these test only
   */
-  traceIf =
-    # Predicate to check
-    pred:
-    # Message that should be traced
-    msg:
-    # Value to return
-    x: if pred then trace msg x else x;
-
-  /* Trace the supplied value after applying a function to it, and
-     return the original value.
-
-     Type: traceValFn :: (a -> b) -> a -> a
-
-     Example:
-       traceValFn (v: "mystring ${v}") "foo"
-       trace: mystring foo
-       => "foo"
-  */
-  traceValFn =
-    # Function to apply
-    f:
-    # Value to trace and return
-    x: trace (f x) x;
-
-  /* Trace the supplied value and return it.
-
-     Type: traceVal :: a -> a
-
-     Example:
-       traceVal 42
-       # trace: 42
-       => 42
-  */
-  traceVal = traceValFn id;
-
-  /* `builtins.trace`, but the value is `builtins.deepSeq`ed first.
-
-     Type: traceSeq :: a -> b -> b
-
-     Example:
-       trace { a.b.c = 3; } null
-       trace: { a = <CODE>; }
-       => null
-       traceSeq { a.b.c = 3; } null
-       trace: { a = { b = { c = 3; }; }; }
-       => null
-  */
-  traceSeq =
-    # The value to trace
-    x:
-    # The value to return
-    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
-   */
-  traceSeqN = depth: x: y: with lib;
-    let snip = v: if      isList  v then noQuotes "[…]" v
-                  else if isAttrs v then noQuotes "{…}" v
-                  else v;
-        noQuotes = str: v: { __pretty = const str; val = v; };
-        modify = n: fn: v: if (n == 0) then fn v
-                      else if isList  v then map (modify (n - 1) fn) v
-                      else if isAttrs v then mapAttrs
-                        (const (modify (n - 1) fn)) v
-                      else v;
-    in trace (generators.toPretty { allowPrettyValues = true; }
-               (modify depth snip x)) y;
-
-  /* A combination of `traceVal` and `traceSeq` that applies a
-     provided function to the value to be traced after `deepSeq`ing
-     it.
-  */
-  traceValSeqFn =
-    # Function to apply
-    f:
-    # Value to trace
-    v: traceValFn f (builtins.deepSeq v v);
-
-  /* A combination of `traceVal` and `traceSeq`. */
-  traceValSeq = traceValSeqFn id;
-
-  /* A combination of `traceVal` and `traceSeqN` that applies a
-  provided function to the value to be traced. */
-  traceValSeqNFn =
-    # Function to apply
-    f:
-    depth:
-    # Value to trace
-    v: traceSeqN depth (f v) v;
-
-  /* A combination of `traceVal` and `traceSeqN`. */
-  traceValSeqN = traceValSeqNFn id;
-
-
-  # -- TESTING --
-
-  /* Evaluate a set of tests.  A test is an attribute set `{expr,
-     expected}`, denoting an expression and its expected result.  The
-     result is a list of failed tests, each represented as `{name,
-     expected, actual}`, denoting the attribute name of the failing
-     test and its expected and actual results.
-
-     Used for regression testing of the functions in lib; see
-     tests.nix for an example. Only tests having names starting with
-     "test" are run.
-
-     Add attr { tests = ["testName"]; } to run these tests only.
-  */
-  runTests =
-    # Tests to run
-    tests: lib.concatLists (lib.attrValues (lib.mapAttrs (name: test:
+  runTests = tests: lib.concatLists (lib.attrValues (lib.mapAttrs (name: test:
     let testsToRun = if tests ? tests then tests.tests else [];
     in if (substring 0 4 name == "test" ||  elem name testsToRun)
        && ((testsToRun == []) || elem name tests.tests)
@@ -158,75 +65,31 @@ rec {
       then [ { inherit name; expected = test.expected; result = test.expr; } ]
       else [] ) tests));
 
-  /* Create a test assuming that list elements are `true`.
+  # create a test assuming that list elements are true
+  # usage: { testX = allTrue [ true ]; }
+  testAllTrue = expr : { inherit expr; expected = map (x: true) expr; };
 
-     Example:
-       { 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);
+  # evaluate everything once so that errors will occur earlier
+  # hacky: traverse attrs by adding a dummy
+  # ignores functions (should this behavior change?) See strictf
+  #
+  # Note: This should be a primop! Something like seq of haskell would be nice to
+  # have as well. It's used fore debugging only anyway
+  strict = x :
+    let
+        traverse = x :
+          if isString x then true
+          else if isAttrs x then
+            if x ? outPath then true
+            else all id (mapAttrsFlatten (n: traverse) x)
+          else if isList x then
+            all id (map traverse x)
+          else if isBool x then true
+          else if isFunction x then true
+          else if isInt x then true
+          else if x == null then true
+          else true; # a (store) path?
+    in if traverse x then x else throw "else never reached";
 
   # example: (traceCallXml "myfun" id 3) will output something like
   # calling myfun arg 1: 3 result: 3
@@ -234,20 +97,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

@@ -1,138 +1,31 @@
-/* Library of low-level helper functions for nix expressions.
- *
- * Please implement (mostly) exhaustive unit tests
- * for new functions in `./tests.nix'.
- */
-let
+let 
 
-  inherit (import ./fixed-points.nix {}) makeExtensible;
+  trivial = import ./trivial.nix;
+  lists = import ./lists.nix;
+  strings = import ./strings.nix;
+  stringsWithDeps = import ./strings-with-deps.nix;
+  attrsets = import ./attrsets.nix;
+  sources = import ./sources.nix;
+  modules = import ./modules.nix;
+  options = import ./options.nix;
+  types = import ./types.nix;
+  meta = import ./meta.nix;
+  debug = import ./debug.nix;
+  misc = import ./deprecated.nix;
+  maintainers = import ./maintainers.nix;
+  platforms = import ./platforms.nix;
+  systems = import ./systems.nix;
+  customisation = import ./customisation.nix;
+  licenses = import ./licenses.nix;
+  sandbox = import ./sandbox.nix;
 
-  lib = makeExtensible (self: let
-    callLibs = file: import file { lib = self; };
-  in with self; {
-
-    # often used, or depending on very little
-    trivial = callLibs ./trivial.nix;
-    fixedPoints = callLibs ./fixed-points.nix;
-
-    # datatypes
-    attrsets = callLibs ./attrsets.nix;
-    lists = callLibs ./lists.nix;
-    strings = callLibs ./strings.nix;
-    stringsWithDeps = callLibs ./strings-with-deps.nix;
-
-    # packaging
-    customisation = callLibs ./customisation.nix;
-    maintainers = import ../maintainers/maintainer-list.nix;
-    meta = callLibs ./meta.nix;
-    sources = callLibs ./sources.nix;
-    versions = callLibs ./versions.nix;
-
-    # module system
-    modules = callLibs ./modules.nix;
-    options = callLibs ./options.nix;
-    types = callLibs ./types.nix;
-
-    # constants
-    licenses = callLibs ./licenses.nix;
-    systems = callLibs ./systems;
-
-    # misc
-    asserts = callLibs ./asserts.nix;
-    debug = callLibs ./debug.nix;
-    generators = callLibs ./generators.nix;
-    misc = callLibs ./deprecated.nix;
-
-    # domain-specific
-    fetchers = callLibs ./fetchers.nix;
-
-    # Eval-time filesystem handling
-    filesystem = callLibs ./filesystem.nix;
-
-    # back-compat aliases
-    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 showWarnings nixpkgsVersion version mod compare
-      splitByAndCompare functionArgs setFunctionArgs isFunction;
-    inherit (fixedPoints) fix fix' converge extends composeExtensions
-      makeExtensible makeExtensibleWithCustomName;
-    inherit (attrsets) attrByPath hasAttrByPath setAttrByPath
-      getAttrFromPath attrVals attrValues getAttrs catAttrs filterAttrs
-      filterAttrsRecursive foldAttrs collect nameValuePair mapAttrs
-      mapAttrs' mapAttrsToList mapAttrsRecursive mapAttrsRecursiveCond
-      genAttrs isDerivation toDerivation optionalAttrs
-      zipAttrsWithNames zipAttrsWith zipAttrs recursiveUpdateUntil
-      recursiveUpdate matchAttrs overrideExisting getOutput getBin
-      getLib getDev chooseDevOutputs zipWithNames zip;
-    inherit (lists) singleton forEach 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';
-    inherit (strings) concatStrings concatMapStrings concatImapStrings
-      intersperse concatStringsSep concatMapStringsSep
-      concatImapStringsSep makeSearchPath makeSearchPathOutput
-      makeLibraryPath makeBinPath optionalString
-      hasInfix 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
-      toInt readPathsFromFile fileContents;
-    inherit (stringsWithDeps) textClosureList textClosureMap
-      noDepEntry fullDepEntry packEntry stringAfter;
-    inherit (customisation) overrideDerivation makeOverridable
-      callPackageWith callPackagesWith extendDerivation hydraJob
-      makeScope;
-    inherit (meta) addMetaAttrs dontDistribute setName updateName
-      appendToName mapDerivationAttrset setPrio lowPrio lowPrioSet hiPrio
-      hiPrioSet;
-    inherit (sources) pathType pathIsDirectory cleanSourceFilter
-      cleanSource sourceByRegex sourceFilesBySuffices
-      commitIdFromGitRepo cleanSourceWith pathHasContext
-      canCleanSource;
-    inherit (modules) evalModules closeModules unifyModuleSyntax
-      applyIfFunction unpackSubmodule packSubmodule mergeModules
-      mergeModules' mergeOptionDecls evalOptionValue mergeDefinitions
-      pushDownProperties dischargeProperties filterOverrides
-      sortProperties fixupOptionType mkIf mkAssert mkMerge mkOverride
-      mkOptionDefault mkDefault mkForce mkVMOverride mkStrict
-      mkFixStrictness mkOrder mkBefore mkAfter mkAliasDefinitions
-      mkAliasAndWrapDefinitions fixMergeModules mkRemovedOptionModule
-      mkRenamedOptionModule mkMergedOptionModule mkChangedOptionModule
-      mkAliasOptionModule doRename filterModules;
-    inherit (options) isOption mkEnableOption mkSinkUndeclaredOptions
-      mergeDefaultOption mergeOneOption mergeEqualOption getValues
-      getFiles optionAttrSetToDocList optionAttrSetToDocList'
-      scrubOptionValue literalExample showOption showFiles
-      unknownModule mkOption;
-    inherit (types) isType setType defaultTypeMerge defaultFunctor
-      isOptionType mkOptionType;
-    inherit (asserts)
-      assertMsg assertOneOf;
-    inherit (debug) addErrorContextToAttrs traceIf traceVal traceValFn
-      traceXMLVal traceXMLValMarked traceSeq traceSeqN traceValSeq
-      traceValSeqFn traceValSeqN traceValSeqNFn traceShowVal
-      traceShowValMarked showVal traceCall traceCall2 traceCall3
-      traceValIfNot runTests testAllTrue traceCallXml attrNamesToStr;
-    inherit (misc) maybeEnv defaultMergeArg defaultMerge foldArgs
-      maybeAttrNullable maybeAttr ifEnable checkFlag getValue
-      checkReqs uniqList uniqListExt condConcat lazyGenericClosure
-      innerModifySumArgs modifySumArgs innerClosePropagation
-      closePropagation mapAttrsFlatten nvs setAttr setAttrMerge
-      mergeAttrsWithFunc mergeAttrsConcatenateValues
-      mergeAttrsNoOverride mergeAttrByFunc mergeAttrsByFuncDefaults
-      mergeAttrsByFuncDefaultsClean mergeAttrBy
-      fakeSha256 fakeSha512
-      nixType imap;
-  });
-in lib
+in
+  { inherit trivial lists strings stringsWithDeps attrsets sources options
+      modules types meta debug maintainers licenses platforms systems sandbox;
+  }
+  # !!! don't include everything at top-level; perhaps only the most
+  # commonly used functions.
+  // trivial // lists // strings // stringsWithDeps // attrsets // sources
+  // options // types // meta // debug // misc // modules
+  // systems
+  // customisation

lib/deprecated.nix

@@ -1,12 +1,11 @@
-{ lib }:
-let
-    inherit (builtins) head tail isList isAttrs isInt attrNames;
+let lib = import ./default.nix;
+    inherit (builtins) isFunction head tail isList isAttrs isInt attrNames;
 
 in
 
-with lib.lists;
-with lib.attrsets;
-with lib.strings;
+with import ./lists.nix;
+with import ./attrsets.nix;
+with import ./strings.nix;
 
 rec {
 
@@ -17,22 +16,90 @@ rec {
 
   defaultMergeArg = x : y: if builtins.isAttrs y then
     y
-  else
+  else 
     (y x);
   defaultMerge = x: y: x // (defaultMergeArg x y);
-  foldArgs = merger: f: init: x:
-    let arg = (merger init (defaultMergeArg init x));
-        # now add the function with composed args already applied to the final attrs
-        base = (setAttrMerge "passthru" {} (f arg)
-                        ( z: z // {
-                            function = foldArgs merger f arg;
-                            args = (lib.attrByPath ["passthru" "args"] {} z) // x;
+  foldArgs = merger: f: init: x: 
+    let arg=(merger init (defaultMergeArg init x));
+      # now add the function with composed args already applied to the final attrs
+        base = (setAttrMerge "passthru" {} (f arg) 
+                        ( z : z // rec { 
+                          function = foldArgs merger f arg; 
+			  args = (lib.attrByPath ["passthru" "args"] {} z) // x;
                           } ));
-        withStdOverrides = base // {
-          override = base.passthru.function;
-        };
+	withStdOverrides = base // {
+	   override = base.passthru.function;
+	   } ;
         in
-          withStdOverrides;
+	withStdOverrides;
+    
+
+  # predecessors: proposed replacement for applyAndFun (which has a bug cause it merges twice)
+  # the naming "overridableDelayableArgs" tries to express that you can
+  # - override attr values which have been supplied earlier
+  # - use attr values before they have been supplied by accessing the fix point
+  #   name "fixed"
+  # f: the (delayed overridden) arguments are applied to this
+  #
+  # initial: initial attrs arguments and settings. see defaultOverridableDelayableArgs
+  #
+  # returns: f applied to the arguments // special attributes attrs
+  #     a) merge: merge applied args with new args. Wether an argument is overridden depends on the merge settings
+  #     b) replace: this let's you replace and remove names no matter which merge function has been set
+  #
+  # examples: see test cases "res" below;
+  overridableDelayableArgs =
+          f :        # the function applied to the arguments
+          initial :  # you pass attrs, the functions below are passing a function taking the fix argument
+    let
+        takeFixed = if isFunction initial then initial else (fixed : initial); # transform initial to an expression always taking the fixed argument
+        tidy = args : 
+            let # apply all functions given in "applyPreTidy" in sequence
+                applyPreTidyFun = fold ( n : a : x : n ( a x ) ) lib.id (maybeAttr "applyPreTidy" [] args);
+            in removeAttrs (applyPreTidyFun args) ( ["applyPreTidy"] ++ (maybeAttr  "removeAttrs" [] args) ); # tidy up args before applying them
+        fun = n : x :
+             let newArgs = fixed :
+                     let args = takeFixed fixed; 
+                         mergeFun = args.${n};
+                     in if isAttrs x then (mergeFun args x)
+                        else assert isFunction x;
+                             mergeFun args (x ( args // { inherit fixed; }));
+             in overridableDelayableArgs f newArgs;
+    in
+    (f (tidy (lib.fix takeFixed))) // {
+      merge   = fun "mergeFun";
+      replace = fun "keepFun";
+    };
+  defaultOverridableDelayableArgs = f : 
+      let defaults = {
+            mergeFun = mergeAttrByFunc; # default merge function. merge strategie (concatenate lists, strings) is given by mergeAttrBy
+            keepFun = a : b : { inherit (a) removeAttrs mergeFun keepFun mergeAttrBy; } // b; # even when using replace preserve these values
+            applyPreTidy = []; # list of functions applied to args before args are tidied up (usage case : prepareDerivationArgs)
+            mergeAttrBy = mergeAttrBy // {
+              applyPreTidy = a : b : a ++ b;
+              removeAttrs = a : b: a ++ b;
+            };
+            removeAttrs = ["mergeFun" "keepFun" "mergeAttrBy" "removeAttrs" "fixed" ]; # before applying the arguments to the function make sure these names are gone
+          };
+      in (overridableDelayableArgs f defaults).merge;
+
+
+
+  # rec { # an example of how composedArgsAndFun can be used
+  #  a  = composedArgsAndFun (x : x) { a = ["2"]; meta = { d = "bar";}; };
+  #  # meta.d will be lost ! It's your task to preserve it (eg using a merge function)
+  #  b  = a.passthru.function { a = [ "3" ]; meta = { d2 = "bar2";}; };
+  #  # instead of passing/ overriding values you can use a merge function:
+  #  c  = b.passthru.function ( x: { a = x.a  ++ ["4"]; }); # consider using (maybeAttr "a" [] x)
+  # }
+  # result:
+  # {
+  #   a = { a = ["2"];     meta = { d = "bar"; }; passthru = { function = .. }; };
+  #   b = { a = ["3"];     meta = { d2 = "bar2"; }; passthru = { function = .. }; };
+  #   c = { a = ["3" "4"]; meta = { d2 = "bar2"; }; passthru = { function = .. }; };
+  #   # c2 is equal to c
+  # }
+  composedArgsAndFun = f: foldArgs defaultMerge f {};
 
 
   # shortcut for attrByPath ["name"] default attrs
@@ -52,7 +119,7 @@ rec {
     else if val == true || val == false then false
     else null;
 
-
+    
   # Return true only if there is an attribute and it is true.
   checkFlag = attrSet: name:
         if name == "true" then true else
@@ -67,29 +134,29 @@ rec {
   ( attrByPath [name] (if checkFlag attrSet name then true else
         if argList == [] then null else
         let x = builtins.head argList; in
-                if (head x) == name then
+                if (head x) == name then 
                         (head (tail x))
-                else (getValue attrSet
+                else (getValue attrSet 
                         (tail argList) name)) attrSet );
 
-
+                        
   # Input : attrSet, [[name default] ...], [ [flagname reqs..] ... ]
   # Output : are reqs satisfied? It's asserted.
-  checkReqs = attrSet: argList: condList:
+  checkReqs = attrSet : argList : condList :
   (
-    fold lib.and true
-      (map (x: let name = (head x); in
-
-        ((checkFlag attrSet name) ->
+    fold lib.and true 
+      (map (x: let name = (head x) ; in
+        
+        ((checkFlag attrSet name) -> 
         (fold lib.and true
         (map (y: let val=(getValue attrSet argList y); in
-                (val!=null) && (val!=false))
-        (tail x))))) condList));
-
+                (val!=null) && (val!=false)) 
+        (tail x))))) condList)) ;
+        
 
   # This function has O(n^2) performance.
-  uniqList = { inputList, acc ? [] }:
-    let go = xs: acc:
+  uniqList = {inputList, acc ? []} :
+    let go = xs : acc :
              if xs == []
              then []
              else let x = head xs;
@@ -97,26 +164,26 @@ rec {
                   in y ++ go (tail xs) (y ++ acc);
     in go inputList acc;
 
-  uniqListExt = { inputList,
-                  outputList ? [],
-                  getter ? (x: x),
-                  compare ? (x: y: x==y) }:
+  uniqListExt = {inputList, outputList ? [],
+    getter ? (x : x), compare ? (x: y: x==y)}:
         if inputList == [] then outputList else
-        let x = head inputList;
-            isX = y: (compare (getter y) (getter x));
-            newOutputList = outputList ++
-                (if any isX outputList then [] else [x]);
-        in uniqListExt { outputList = newOutputList;
-                         inputList = (tail inputList);
-                         inherit getter compare;
-                       };
+        let x=head inputList; 
+        isX = y: (compare (getter y) (getter x));
+        newOutputList = outputList ++
+         (if any isX outputList then [] else [x]);
+        in uniqListExt {outputList=newOutputList; 
+                inputList = (tail inputList);
+                inherit getter compare;
+                };
 
+
+                
   condConcat = name: list: checker:
         if list == [] then name else
-        if checker (head list) then
-                condConcat
-                        (name + (head (tail list)))
-                        (tail (tail list))
+        if checker (head list) then 
+                condConcat 
+                        (name + (head (tail list))) 
+                        (tail (tail list)) 
                         checker
         else condConcat
                 name (tail (tail list)) checker;
@@ -135,12 +202,12 @@ rec {
     in
       work startSet [] [];
 
-  innerModifySumArgs = f: x: a: b: if b == null then (f a b) // x else
+  innerModifySumArgs = f: x: a: b: if b == null then (f a b) // x else 
         innerModifySumArgs f x (a // b);
   modifySumArgs = f: x: innerModifySumArgs f x {};
 
 
-  innerClosePropagation = acc: xs:
+  innerClosePropagation = acc : xs :
     if xs == []
     then acc
     else let y  = head xs;
@@ -160,45 +227,45 @@ rec {
   closePropagation = list: (uniqList {inputList = (innerClosePropagation [] list);});
 
   # calls a function (f attr value ) for each record item. returns a list
-  mapAttrsFlatten = f: r: map (attr: f attr r.${attr}) (attrNames r);
+  mapAttrsFlatten = f : r : map (attr: f attr r.${attr}) (attrNames r);
 
   # attribute set containing one attribute
-  nvs = name: value: listToAttrs [ (nameValuePair name value) ];
+  nvs = name : value : listToAttrs [ (nameValuePair name value) ];
   # adds / replaces an attribute of an attribute set
-  setAttr = set: name: v: set // (nvs name v);
+  setAttr = set : name : v : set // (nvs name v);
 
   # setAttrMerge (similar to mergeAttrsWithFunc but only merges the values of a particular name)
-  # setAttrMerge "a" [] { a = [2];} (x: x ++ [3]) -> { a = [2 3]; }
-  # setAttrMerge "a" [] {         } (x: x ++ [3]) -> { a = [  3]; }
-  setAttrMerge = name: default: attrs: f:
+  # setAttrMerge "a" [] { a = [2];} (x : x ++ [3]) -> { a = [2 3]; } 
+  # setAttrMerge "a" [] {         } (x : x ++ [3]) -> { a = [  3]; }
+  setAttrMerge = name : default : attrs : f :
     setAttr attrs name (f (maybeAttr name default attrs));
 
-  # Using f = a: b = b the result is similar to //
+  # Using f = a : b = b the result is similar to //
   # merge attributes with custom function handling the case that the attribute
   # exists in both sets
-  mergeAttrsWithFunc = f: set1: set2:
-    fold (n: set: if set ? ${n}
+  mergeAttrsWithFunc = f : set1 : set2 :
+    fold (n: set : if set ? ${n}
                         then setAttr set n (f set.${n} set2.${n})
                         else set )
            (set2 // set1) (attrNames set2);
 
   # merging two attribute set concatenating the values of same attribute names
   # eg { a = 7; } {  a = [ 2 3 ]; } becomes { a = [ 7 2 3 ]; }
-  mergeAttrsConcatenateValues = mergeAttrsWithFunc ( a: b: (toList a) ++ (toList b) );
+  mergeAttrsConcatenateValues = mergeAttrsWithFunc ( a : b : (toList a) ++ (toList b) );
 
-  # merges attributes using //, if a name exists in both attributes
+  # merges attributes using //, if a name exisits in both attributes
   # an error will be triggered unless its listed in mergeLists
   # so you can mergeAttrsNoOverride { buildInputs = [a]; } { buildInputs = [a]; } {} to get
   # { buildInputs = [a b]; }
-  # merging buildPhase doesn't really make sense. The cases will be rare where appending /prefixing will fit your needs?
+  # merging buildPhase does'nt really make sense. The cases will be rare where appending /prefixing will fit your needs?
   # in these cases the first buildPhase will override the second one
   # ! deprecated, use mergeAttrByFunc instead
   mergeAttrsNoOverride = { mergeLists ? ["buildInputs" "propagatedBuildInputs"],
                            overrideSnd ? [ "buildPhase" ]
-                         }: attrs1: attrs2:
-    fold (n: set:
+                         } : attrs1 : attrs2 :
+    fold (n: set : 
         setAttr set n ( if set ? ${n}
-            then # merge
+            then # merge 
               if elem n mergeLists # attribute contains list, merge them by concatenating
                 then attrs2.${n} ++ attrs1.${n}
               else if elem n overrideSnd
@@ -217,16 +284,16 @@ rec {
   # };
   # will result in
   # { mergeAttrsBy = [...]; buildInputs = [ a b c d ]; }
-  # is used by defaultOverridableDelayableArgs and can be used when composing using
+  # is used by prepareDerivationArgs, defaultOverridableDelayableArgs and can be used when composing using
   # foldArgs, composedArgsAndFun or applyAndFun. Example: composableDerivation in all-packages.nix
-  mergeAttrByFunc = x: y:
+  mergeAttrByFunc = x : y :
     let
-          mergeAttrBy2 = { mergeAttrBy = lib.mergeAttrs; }
+          mergeAttrBy2 = { mergeAttrBy=lib.mergeAttrs; }
                       // (maybeAttr "mergeAttrBy" {} x)
                       // (maybeAttr "mergeAttrBy" {} y); in
     fold lib.mergeAttrs {} [
       x y
-      (mapAttrs ( a: v: # merge special names using given functions
+      (mapAttrs ( a : v : # merge special names using given functions
           if x ? ${a}
              then if y ? ${a}
                then v x.${a} y.${a} # both have attr, use merge func
@@ -242,19 +309,110 @@ rec {
   mergeAttrsByFuncDefaults = foldl mergeAttrByFunc { inherit mergeAttrBy; };
   mergeAttrsByFuncDefaultsClean = list: removeAttrs (mergeAttrsByFuncDefaults list) ["mergeAttrBy"];
 
+  # merge attrs based on version key into mkDerivation args, see mergeAttrBy to learn about smart merge defaults
+  #
+  # This function is best explained by an example:
+  #
+  #     {version ? "2.x"} :
+  #
+  #     mkDerivation (mergeAttrsByVersion "package-name" version 
+  #       { # version specific settings
+  #         "git" = { src = ..; preConfigre = "autogen.sh"; buildInputs = [automake autoconf libtool];  };
+  #         "2.x" = { src = ..; };
+  #       }
+  #       {  // shared settings
+  #          buildInputs = [ common build inputs ];
+  #          meta = { .. }
+  #       }
+  #     )
+  #
+  # Please note that e.g. Eelco Dolstra usually prefers having one file for
+  # each version. On the other hand there are valuable additional design goals
+  #  - readability
+  #  - do it once only
+  #  - try to avoid duplication
+  #
+  # Marc Weber and Michael Raskin sometimes prefer keeping older
+  # versions around for testing and regression tests - as long as its cheap to
+  # do so.
+  #
+  # Very often it just happens that the "shared" code is the bigger part.
+  # Then using this function might be appropriate.
+  #
+  # Be aware that its easy to cause recompilations in all versions when using
+  # this function - also if derivations get too complex splitting into multiple
+  # files is the way to go.
+  #
+  # See misc.nix -> versionedDerivation
+  # discussion: nixpkgs: pull/310
+  mergeAttrsByVersion = name: version: attrsByVersion: base:
+    mergeAttrsByFuncDefaultsClean [ { name = "${name}-${version}"; } base (maybeAttr version (throw "bad version ${version} for ${name}") attrsByVersion)];
+
   # sane defaults (same name as attr name so that inherit can be used)
   mergeAttrBy = # { buildInputs = concatList; [...]; passthru = mergeAttr; [..]; }
-    listToAttrs (map (n: nameValuePair n lib.concat)
+    listToAttrs (map (n : nameValuePair n lib.concat)
       [ "nativeBuildInputs" "buildInputs" "propagatedBuildInputs" "configureFlags" "prePhases" "postAll" "patches" ])
-    // listToAttrs (map (n: nameValuePair n lib.mergeAttrs) [ "passthru" "meta" "cfg" "flags" ])
-    // listToAttrs (map (n: nameValuePair n (a: b: "${a}\n${b}") ) [ "preConfigure" "postInstall" ])
+    // listToAttrs (map (n : nameValuePair n lib.mergeAttrs) [ "passthru" "meta" "cfg" "flags" ])
+    // listToAttrs (map (n : nameValuePair n (a: b: "${a}\n${b}") ) [ "preConfigure" "postInstall" ])
   ;
 
+  # prepareDerivationArgs tries to make writing configurable derivations easier
+  # example:
+  #  prepareDerivationArgs {
+  #    mergeAttrBy = {
+  #       myScript = x : y : x ++ "\n" ++ y;
+  #    };
+  #    cfg = {
+  #      readlineSupport = true;
+  #    };
+  #    flags = {
+  #      readline = {
+  #        set = {
+  #           configureFlags = [ "--with-compiler=${compiler}" ];
+  #           buildInputs = [ compiler ];
+  #           pass = { inherit compiler; READLINE=1; };
+  #           assertion = compiler.dllSupport;
+  #           myScript = "foo";
+  #        };
+  #        unset = { configureFlags = ["--without-compiler"]; };
+  #      };
+  #    };
+  #    src = ...
+  #    buildPhase = '' ... '';
+  #    name = ...
+  #    myScript = "bar";
+  #  };
+  # if you don't have need for unset you can omit the surrounding set = { .. } attr
+  # all attrs except flags cfg and mergeAttrBy will be merged with the
+  # additional data from flags depending on config settings
+  # It's used in composableDerivation in all-packages.nix. It's also used
+  # heavily in the new python and libs implementation
+  #
+  # should we check for misspelled cfg options?
+  # TODO use args.mergeFun here as well?
+  prepareDerivationArgs = args:
+    let args2 = { cfg = {}; flags = {}; } // args;
+        flagName = name : "${name}Support";
+        cfgWithDefaults = (listToAttrs (map (n : nameValuePair (flagName n) false) (attrNames args2.flags)))
+                          // args2.cfg;
+        opts = attrValues (mapAttrs (a : v :
+                let v2 = if v ? set || v ? unset then v else { set = v; };
+                    n = if cfgWithDefaults.${flagName a} then "set" else "unset";
+                    attr = maybeAttr n {} v2; in
+                if (maybeAttr "assertion" true attr)
+                  then attr
+                  else throw "assertion of flag ${a} of derivation ${args.name} failed"
+               ) args2.flags );
+    in removeAttrs
+      (mergeAttrsByFuncDefaults ([args] ++ opts ++ [{ passthru = cfgWithDefaults; }]))
+      ["flags" "cfg" "mergeAttrBy" ];
+
+
   nixType = x:
       if isAttrs x then
           if x ? outPath then "derivation"
           else "attrs"
-      else if lib.isFunction x then "function"
+      else if isFunction x then "function"
       else if isList x then "list"
       else if x == true then "bool"
       else if x == false then "bool"
@@ -262,16 +420,4 @@ rec {
       else if isInt x then "int"
       else "string";
 
-  /* deprecated:
-
-     For historical reasons, imap has an index starting at 1.
-
-     But for consistency with the rest of the library we want an index
-     starting at zero.
-  */
-  imap = imap1;
-
-  # Fake hashes. Can be used as hash placeholders, when computing hash ahead isn't trivial
-  fakeSha256 = "0000000000000000000000000000000000000000000000000000000000000000";
-  fakeSha512 = "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000";
 }

lib/fetchers.nix

@@ -1,13 +0,0 @@
-# snippets that can be shared by multiple fetchers (pkgs/build-support)
-{ lib }:
-{
-
-  proxyImpureEnvVars = [
-    # We borrow these environment variables from the caller to allow
-    # easy proxy configuration.  This is impure, but a fixed-output
-    # derivation like fetchurl is allowed to do so since its result is
-    # by definition pure.
-    "http_proxy" "https_proxy" "ftp_proxy" "all_proxy" "no_proxy"
-  ];
-
-}

lib/filesystem.nix

@@ -1,45 +0,0 @@
-{ lib }:
-{ # haskellPathsInDir : Path -> Map String Path
-  # A map of all haskell packages defined in the given path,
-  # identified by having a cabal file with the same name as the
-  # directory itself.
-  haskellPathsInDir = root:
-    let # Files in the root
-        root-files = builtins.attrNames (builtins.readDir root);
-        # Files with their full paths
-        root-files-with-paths =
-          map (file:
-            { name = file; value = root + "/${file}"; }
-          ) root-files;
-        # Subdirectories of the root with a cabal file.
-        cabal-subdirs =
-          builtins.filter ({ name, value }:
-            builtins.pathExists (value + "/${name}.cabal")
-          ) root-files-with-paths;
-    in builtins.listToAttrs cabal-subdirs;
-  # locateDominatingFile :  RegExp
-  #                      -> Path
-  #                      -> Nullable { path : Path;
-  #                                    matches : [ MatchResults ];
-  #                                  }
-  # Find the first directory containing a file matching 'pattern'
-  # upward from a given 'file'.
-  # Returns 'null' if no directories contain a file matching 'pattern'.
-  locateDominatingFile = pattern: file:
-    let go = path:
-          let files = builtins.attrNames (builtins.readDir path);
-              matches = builtins.filter (match: match != null)
-                          (map (builtins.match pattern) files);
-          in
-            if builtins.length matches != 0
-              then { inherit path matches; }
-              else if path == /.
-                then null
-                else go (dirOf path);
-        parent = dirOf file;
-        isDir =
-          let base = baseNameOf file;
-              type = (builtins.readDir parent).${base} or null;
-          in file == /. || type == "directory";
-    in go (if isDir then file else parent);
-}