summary refs log tree commit diff
path: root/doc/functions.xml
diff options
context:
space:
mode:
authorJohn Ericson <jericson@galois.com>2016-10-12 15:14:49 -0400
committerJohn Ericson <jericson@galois.com>2016-10-13 11:14:11 -0400
commite4cd45a30c92a19a240df835cdaf6da5f76ea9fc (patch)
treefc234aeb6b3b5714be3c6db9e1c0607496d258d1 /doc/functions.xml
parentda36847d925058fd86f027b64cc712c57be11ad8 (diff)
downloadnixlib-e4cd45a30c92a19a240df835cdaf6da5f76ea9fc.tar
nixlib-e4cd45a30c92a19a240df835cdaf6da5f76ea9fc.tar.gz
nixlib-e4cd45a30c92a19a240df835cdaf6da5f76ea9fc.tar.bz2
nixlib-e4cd45a30c92a19a240df835cdaf6da5f76ea9fc.tar.lz
nixlib-e4cd45a30c92a19a240df835cdaf6da5f76ea9fc.tar.xz
nixlib-e4cd45a30c92a19a240df835cdaf6da5f76ea9fc.tar.zst
nixlib-e4cd45a30c92a19a240df835cdaf6da5f76ea9fc.zip
top-level: Make `overridePackages` extend rather than replace existing overrides
Diffstat (limited to 'doc/functions.xml')
-rw-r--r--doc/functions.xml14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/functions.xml b/doc/functions.xml
index 908e9571ed69..e767d01d8431 100644
--- a/doc/functions.xml
+++ b/doc/functions.xml
@@ -52,6 +52,20 @@ in ...</programlisting>
     It's equivalent to <varname>pkgs</varname> in the above example.
   </para>
 
+  <para>
+    Note that in previous versions of nixpkgs, this method replaced any changes from <link 
+    linkend="sec-modify-via-packageOverrides">config.packageOverrides</link>,
+    along with that from previous calls if this function was called repeatedly.
+    Now those previous changes will be preserved so this function can be "chained" meaningfully.
+    To recover the old behavior, make sure <varname>config.packageOverrides<varname> is unset,
+    and call this only once off a "freshly" imported nixpkgs:
+
+    <programlisting>let
+  pkgs = import &lt;nixpkgs&gt; { config: {}; };
+  newpkgs = pkgs.overridePackages ...;
+in ...</programlisting>
+  </para>
+
 </section>
 
 <section xml:id="sec-pkg-override">