diff options
author | Nicolas B. Pierron <nicolas.b.pierron@nbp.name> | 2016-12-17 18:05:21 +0000 |
---|---|---|
committer | Nicolas B. Pierron <nicolas.b.pierron@gmail.com> | 2017-01-16 01:17:33 +0100 |
commit | f5dfe78a1eb5ff8dfcc7ab37cfc132c5f31d3cef (patch) | |
tree | d7422aa64c2735316fb2bdd2022f90d7a15a453c /nixos/doc | |
parent | 7c8d3aa21d420f5e1546d0021c2e950ac1ebf4c6 (diff) |
Add overlays mechanism to Nixpkgs.
This patch add a new argument to Nixpkgs default expression named "overlays".
By default, the value of the argument is either taken from the environment variable `NIXPKGS_OVERLAYS`,
or from the directory `~/.nixpkgs/overlays/`. If the environment variable does not name a valid directory
then this mechanism would fallback on the home directory. If the home directory does not exists it will
fallback on an empty list of overlays.
The overlays directory should contain the list of extra Nixpkgs stages which would be used to extend the
content of Nixpkgs, with additional set of packages. The overlays, i-e directory, files, symbolic links
are used in alphabetical order.
The simplest overlay which extends Nixpkgs with nothing looks like:
```nix
self: super: {
}
```
More refined overlays can use `super` as the basis for building new packages, and `self` as a way to query
the final result of the fix-point.
An example of overlay which extends Nixpkgs with a small set of packages can be found at:
https://github.com/nbp/nixpkgs-mozilla/blob/nixpkgs-overlay/moz-overlay.nix
To use this file, checkout the repository and add a symbolic link to
the `moz-overlay.nix` file in `~/.nixpkgs/overlays` directory.
Diffstat (limited to 'nixos/doc')
-rw-r--r-- | nixos/doc/manual/release-notes/rl-1703.xml | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/nixos/doc/manual/release-notes/rl-1703.xml b/nixos/doc/manual/release-notes/rl-1703.xml index 6997155d94d0..bbb9c53eaa36 100644 --- a/nixos/doc/manual/release-notes/rl-1703.xml +++ b/nixos/doc/manual/release-notes/rl-1703.xml @@ -11,7 +11,9 @@ has the following highlights: </para> <itemizedlist> <listitem> - <para></para> + <para>Nixpkgs is now extensible through <link + xlink:href="https://github.com/NixOS/nixpkgs/pull/21243">overlays</link>. + See the Nixpkgs manual for more information.</para> </listitem> </itemizedlist> @@ -96,6 +98,11 @@ following incompatible changes:</para> <literal>networking.timeServers</literal>. </para> </listitem> + + <listitem> + <para><literal>pkgs.overridePackages</literal> function no longer exists. Instead import Nixpkgs a second time using <literal>import pkgs.path { + overlays = [ <replaceable>...</replaceable> ]; }</literal>.</para> + </listitem> </itemizedlist> |