1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-19 04:02:10 +00:00
nixpkgs/doc
Nicolas B. Pierron f5dfe78a1e 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.
2017-01-16 01:17:33 +01:00
..
languages-frameworks Add overlays mechanism to Nixpkgs. 2017-01-16 01:17:33 +01:00
old Fix #4210: Remove builderDefs 2016-08-31 11:34:46 +02:00
coding-conventions.xml nixpkgs-doc: add patches to coding conventions 2016-08-06 09:05:23 +09:00
configuration.xml nixpkgs manual: more extensible example (#15557) 2016-05-23 11:02:46 +01:00
contributing.xml doc: make it clear the Contributing section is for the docs 2015-06-30 12:25:55 +02:00
default.nix Nixpkgs manual: Fix epub generation 2016-10-03 20:33:01 +02:00
functions.xml Add overlays mechanism to Nixpkgs. 2017-01-16 01:17:33 +01:00
introduction.md nixpkgs manual introduction: improve 2016-04-05 10:06:10 +02:00
manual.xml Add overlays mechanism to Nixpkgs. 2017-01-16 01:17:33 +01:00
meta.xml nixpkgs manual: Fix license strings docs 2016-02-24 01:48:02 +01:00
multiple-output.xml outputDocdev -> outputDevdoc 2016-09-20 17:44:48 +02:00
overlays.xml Add overlays mechanism to Nixpkgs. 2017-01-16 01:17:33 +01:00
package-notes.xml steam: removed unuseful section from documentation 2016-12-11 16:57:28 +01:00
quick-start.xml hello/ex-2 -> hello 2015-09-22 20:23:23 +02:00
release-notes.xml
reviewing-contributions.xml manual: reviewing contributions nixos -> nixpkgs (#20626) 2016-11-22 15:15:02 +01:00
stdenv.xml stdenv/stripHash: print to stdout, not to variable 2016-10-11 18:34:36 +02:00
style.css
submitting-changes.xml nixpkgs manual: more strict commit policy (close #11609) 2015-12-18 15:00:33 +01:00