diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/functions.xml | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/functions.xml b/doc/functions.xml index 16f4f262a25f..89f2fda0ad4b 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -54,4 +54,35 @@ in ...</programlisting> </section> +<section xml:id="sec-pkg-override"> + <title><pkg>.override</title> + + <para> + The function <varname>override</varname> is usually available for all the + derivations in the nixpkgs expression (<varname>pkgs</varname>). + </para> + <para> + It is used to override the arguments passed to a function. + </para> + <para> + Example usages: + + <programlisting>pkgs.foo.override { arg1 = val1; arg2 = val2; ... }</programlisting> + <programlisting>pkgs.overridePackages (self: super: { + foo = super.foo.override { barSupport = true ; }; +})</programlisting> + <programlisting>mypkg = pkgs.callPackage ./mypkg.nix { + mydep = pkgs.mydep.override { ... }; +})</programlisting> + </para> + + <para> + In the first example, <varname>pkgs.foo</varname> is the result of a function call + with some default arguments, usually a derivation. + Using <varname>pkgs.foo.override</varname> will call the same function with + the given new arguments. + </para> + +</section> + </chapter> |