diff options
| author | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2015-12-02 13:54:24 +0100 |
|---|---|---|
| committer | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2015-12-02 13:54:24 +0100 |
| commit | f7c25bf9c2b48027bd13bb92365bebbf8fa97060 (patch) | |
| tree | 18b8e98f7a2dfefea928f9cdaa99cf8e7aae79df /doc/functions.xml | |
| parent | e0bacc0b39a48912473eb1ce9a3bde71d34faec4 (diff) | |
| download | nixpkgs-f7c25bf9c2b48027bd13bb92365bebbf8fa97060.tar nixpkgs-f7c25bf9c2b48027bd13bb92365bebbf8fa97060.tar.gz nixpkgs-f7c25bf9c2b48027bd13bb92365bebbf8fa97060.tar.bz2 nixpkgs-f7c25bf9c2b48027bd13bb92365bebbf8fa97060.tar.lz nixpkgs-f7c25bf9c2b48027bd13bb92365bebbf8fa97060.tar.xz nixpkgs-f7c25bf9c2b48027bd13bb92365bebbf8fa97060.tar.zst nixpkgs-f7c25bf9c2b48027bd13bb92365bebbf8fa97060.zip | |
Manual: Add a warning that overrideDerivation should not be used
Diffstat (limited to 'doc/functions.xml')
| -rw-r--r-- | doc/functions.xml | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/functions.xml b/doc/functions.xml index 39010f8ab14..e2bc751e140 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -88,6 +88,13 @@ in ...</programlisting> <section xml:id="sec-pkg-overrideDerivation"> <title><pkg>.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> + </warning> + <para> The function <varname>overrideDerivation</varname> is usually available for all the derivations in the nixpkgs expression (<varname>pkgs</varname>). |