aboutsummaryrefslogtreecommitdiff
path: root/doc/functions
diff options
context:
space:
mode:
authorJohn Ericson <git@JohnEricson.me>2018-10-23 20:21:48 -0400
committerGitHub <noreply@github.com>2018-10-23 20:21:48 -0400
commitb71389aefbd9119ee9aaa454d2c8eae0f870b9f9 (patch)
tree0c913c902e431529b81b5d0cd133c979ec61f143 /doc/functions
parentb41f8936b9326c10178e48ddc8f94c3c17af22a2 (diff)
parenta5c4642ddf03f792c29764c53725f9b04e06decd (diff)
Merge pull request #47430 from roberth/nixpkgs-extend
pkgs.extend for adding overlays
Diffstat (limited to 'doc/functions')
-rw-r--r--doc/functions/overrides.xml13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/functions/overrides.xml b/doc/functions/overrides.xml
index 021c4b41c36..1bd90d2a0c7 100644
--- a/doc/functions/overrides.xml
+++ b/doc/functions/overrides.xml
@@ -6,8 +6,14 @@
<para>
Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g.
- derivation attributes, the results of derivations or even the whole package
- set.
+ 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">
@@ -25,6 +31,9 @@
<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 ; };