diff options
author | Luca Bruno <lethalman88@gmail.com> | 2015-07-30 17:56:16 +0200 |
---|---|---|
committer | Luca Bruno <lethalman88@gmail.com> | 2015-07-30 17:56:39 +0200 |
commit | 5dfb469faf199838b8c09e82b8778925e7fe307e (patch) | |
tree | 9273705239a7492018e99f4e8e02c16493a4fa33 | |
parent | 97dd0dae7489cda16d8897aa289c3a9cd4f7ac56 (diff) |
doc: document .overrideDerivation
-rw-r--r-- | doc/functions.xml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/functions.xml b/doc/functions.xml index 2aae3cfb2aec5..aec8a57c21a98 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -85,6 +85,44 @@ in ...</programlisting> </section> +<section xml:id="sec-pkg-overrideDerivation"> + <title><pkg>.overrideDerivation</title> + + <para> + The function <varname>overrideDerivation</varname> is usually available for all the + derivations in the nixpkgs expression (<varname>pkgs</varname>). + </para> + <para> + It is used to create a new derivation by overriding the attributes of + the original derivation according to the given function. + </para> + + <para> + Example usage: + + <programlisting>mySed = pkgs.gnused.overrideDerivation (oldAttrs: { + name = "sed-4.2.2-pre"; + src = fetchurl { + url = ftp://alpha.gnu.org/gnu/sed/sed-4.2.2-pre.tar.bz2; + sha256 = "11nq06d131y4wmf3drm0yk502d2xc6n5qy82cg88rb9nqd2lj41k"; + }; + patches = []; +});</programlisting> + </para> + + <para> + In the above example, the name, src and patches of the derivation + will be overridden, while all other attributes will be retained from the + original derivation. + </para> + + <para> + The argument <varname>oldAttrs</varname> is used to refer to the attribute set of + the original derivation. + </para> + +</section> + <section xml:id="sec-lib-makeOverridable"> <title>lib.makeOverridable</title> |