diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/command-ref/env-common.xml | 34 | ||||
| -rw-r--r-- | doc/manual/command-ref/nix-instantiate.xml | 7 | ||||
| -rw-r--r-- | doc/manual/command-ref/opt-common.xml | 11 | ||||
| -rw-r--r-- | doc/manual/expressions/advanced-attributes.xml | 21 | ||||
| -rw-r--r-- | doc/manual/release-notes/rl-18.xml | 14 |
5 files changed, 59 insertions, 28 deletions
diff --git a/doc/manual/command-ref/env-common.xml b/doc/manual/command-ref/env-common.xml index c501d1c011c0..b52e450309f4 100644 --- a/doc/manual/command-ref/env-common.xml +++ b/doc/manual/command-ref/env-common.xml @@ -11,8 +11,8 @@ <variablelist xml:id="env-common"> - -<varlistentry><term><envar>NIX_PATH</envar></term> + +<varlistentry xml:id="env-NIX_PATH"><term><envar>NIX_PATH</envar></term> <listitem> @@ -28,7 +28,7 @@ <filename>/home/eelco/Dev</filename> and <filename>/etc/nixos</filename>, in that order. It is also possible to match paths against a prefix. For example, the value - + <screen> nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen> @@ -39,12 +39,12 @@ nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen> <filename>/etc/nixos/nixpkgs/<replaceable>path</replaceable></filename>. </para> - <para>The search path can be extended using the - <option>-I</option> option, which takes precedence over + <para>The search path can be extended using the <option + linkend="opt-I">-I</option> option, which takes precedence over <envar>NIX_PATH</envar>.</para></listitem> </varlistentry> - + <varlistentry><term><envar>NIX_IGNORE_SYMLINK_STORE</envar></term> @@ -67,7 +67,7 @@ nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen> you’re better off using <literal>bind</literal> mount points, e.g., <screen> -$ mkdir /nix +$ mkdir /nix $ mount -o bind /mnt/otherdisk/nix /nix</screen> Consult the <citerefentry><refentrytitle>mount</refentrytitle> @@ -82,7 +82,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> <listitem><para>Overrides the location of the Nix store (default <filename><replaceable>prefix</replaceable>/store</filename>).</para></listitem> - + </varlistentry> @@ -91,7 +91,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> <listitem><para>Overrides the location of the Nix static data directory (default <filename><replaceable>prefix</replaceable>/share</filename>).</para></listitem> - + </varlistentry> @@ -99,7 +99,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> <listitem><para>Overrides the location of the Nix log directory (default <filename><replaceable>prefix</replaceable>/log/nix</filename>).</para></listitem> - + </varlistentry> @@ -107,7 +107,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> <listitem><para>Overrides the location of the Nix state directory (default <filename><replaceable>prefix</replaceable>/var/nix</filename>).</para></listitem> - + </varlistentry> @@ -116,7 +116,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> <listitem><para>Overrides the location of the Nix database (default <filename><replaceable>$NIX_STATE_DIR</replaceable>/db</filename>, i.e., <filename><replaceable>prefix</replaceable>/var/nix/db</filename>).</para></listitem> - + </varlistentry> @@ -125,7 +125,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> <listitem><para>Overrides the location of the Nix configuration directory (default <filename><replaceable>prefix</replaceable>/etc/nix</filename>).</para></listitem> - + </varlistentry> @@ -135,7 +135,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> files. In particular, this includes temporary build directories; these can take up substantial amounts of disk space. The default is <filename>/tmp</filename>.</para></listitem> - + </varlistentry> @@ -233,7 +233,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> store derivation itself).</para></listitem> </varlistentry> - + <varlistentry><term><filename>outputs</filename></term> <listitem><para>The set of store paths that are outputs of the @@ -282,7 +282,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> </varlistentry> - + <varlistentry xml:id="envar-other-stores"><term><envar>NIX_OTHER_STORES</envar></term> <listitem><para>This variable contains the paths of remote Nix @@ -333,7 +333,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen> </varlistentry> - + </variablelist> diff --git a/doc/manual/command-ref/nix-instantiate.xml b/doc/manual/command-ref/nix-instantiate.xml index a4e45cf97af4..8649cd58cc60 100644 --- a/doc/manual/command-ref/nix-instantiate.xml +++ b/doc/manual/command-ref/nix-instantiate.xml @@ -104,9 +104,10 @@ input.</para> <varlistentry><term><option>--find-file</option></term> <listitem><para>Look up the given files in Nix’s search path (as - specified by the <envar>NIX_PATH</envar> environment variable). - If found, print the corresponding absolute paths on standard - output. For instance, if <envar>NIX_PATH</envar> is + specified by the <envar linkend="env-NIX_PATH">NIX_PATH</envar> + environment variable). If found, print the corresponding absolute + paths on standard output. For instance, if + <envar>NIX_PATH</envar> is <literal>nixpkgs=/home/alice/nixpkgs</literal>, then <literal>nix-instantiate --find-file nixpkgs/default.nix</literal> will print diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml index 3486c7e7d852..c7e8ae1ed05f 100644 --- a/doc/manual/command-ref/opt-common.xml +++ b/doc/manual/command-ref/opt-common.xml @@ -351,13 +351,14 @@ </varlistentry> -<varlistentry><term><option>-I</option> <replaceable>path</replaceable></term> +<varlistentry xml:id="opt-I"><term><option>-I</option> <replaceable>path</replaceable></term> <listitem><para>Add a path to the Nix expression search path. This - option may be given multiple times. See the <envar>NIX_PATH</envar> - environment variable for information on the semantics of the Nix - search path. Paths added through <option>-I</option> take - precedence over <envar>NIX_PATH</envar>.</para></listitem> + option may be given multiple times. See the <envar + linkend="env-NIX_PATH">NIX_PATH</envar> environment variable for + information on the semantics of the Nix search path. Paths added + through <option>-I</option> take precedence over + <envar>NIX_PATH</envar>.</para></listitem> </varlistentry> diff --git a/doc/manual/expressions/advanced-attributes.xml b/doc/manual/expressions/advanced-attributes.xml index 40a5a80acdb6..f8b84b98cb82 100644 --- a/doc/manual/expressions/advanced-attributes.xml +++ b/doc/manual/expressions/advanced-attributes.xml @@ -32,6 +32,25 @@ allowedReferences = []; </varlistentry> + <varlistentry><term><varname>allowedRequisites</varname></term> + + <listitem><para>This attribute is similar to + <varname>allowedReferences</varname>, but it specifies the legal + requisites of the whole closure, so all the dependencies + recursively. For example, + +<programlisting> +allowedReferences = [ foobar ]; +</programlisting> + + enforces that the output of a derivation cannot have any other + runtime dependency than <varname>foobar</varname>, and in addition + it enforces that <varname>foobar</varname> itself doesn't + introduce any other dependency itself.</para></listitem> + + </varlistentry> + + <varlistentry><term><varname>exportReferencesGraph</varname></term> <listitem><para>This attribute allows builders access to the @@ -240,4 +259,4 @@ impureEnvVars = [ "http_proxy" "https_proxy" <replaceable>...</replaceable> ]; </variablelist> -</section> \ No newline at end of file +</section> diff --git a/doc/manual/release-notes/rl-18.xml b/doc/manual/release-notes/rl-18.xml index 0fe3c2de761e..aace95210ff7 100644 --- a/doc/manual/release-notes/rl-18.xml +++ b/doc/manual/release-notes/rl-18.xml @@ -6,6 +6,16 @@ <title>Release 1.8 (TBA)</title> -<para>TODO</para> +<itemizedlist> -</chapter> \ No newline at end of file + <listitem><para>Derivations can specify the new special attribute + <varname>allowedRequisites</varname>, which has a similar meaning to + <varname>allowedReferences</varname>. But instead of only enforcing + to explicitly specify the immediate references, it requires the + derivation to specify all the dependencies recursively (hence the + name, requisites) that are used by the resulting + output.</para></listitem> + +</itemizedlist> + +</chapter> |