pyrox.dev / nixpkgs
lol
fork atom

Manual: Add a warning that overrideDerivation should not be used

Eelco Dolstra f7c25bf9 e0bacc0b

+7
unified split
+7
doc/functions.xml
··· 88 <section xml:id="sec-pkg-overrideDerivation"> 89 <title>&lt;pkg&gt;.overrideDerivation</title> 90 91 <para> 92 The function <varname>overrideDerivation</varname> is usually available for all the 93 derivations in the nixpkgs expression (<varname>pkgs</varname>).
··· 88 <section xml:id="sec-pkg-overrideDerivation"> 89 <title>&lt;pkg&gt;.overrideDerivation</title> 90 91 + <warning> 92 + <para>Do not use this function in Nixpkgs. Because it breaks 93 + package abstraction and doesn’t provide error checking for 94 + function arguments, it is only intended for ad-hoc customisation 95 + (such as in <filename>~/.nixpkgs/config.nix</filename>).</para> 96 + </warning> 97 + 98 <para> 99 The function <varname>overrideDerivation</varname> is usually available for all the 100 derivations in the nixpkgs expression (<varname>pkgs</varname>).