Add some hyperlinks between NIXPATH and -I

This commit is contained in:
Eelco Dolstra 2014-09-16 11:20:09 +02:00
parent d2d5543625
commit 67e5dd3ce9
3 changed files with 27 additions and 25 deletions

View file

@ -9,8 +9,8 @@
<variablelist xml:id="env-common"> <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> <listitem>
@ -26,7 +26,7 @@
<filename>/home/eelco/Dev</filename> and <filename>/home/eelco/Dev</filename> and
<filename>/etc/nixos</filename>, in that order. It is also <filename>/etc/nixos</filename>, in that order. It is also
possible to match paths against a prefix. For example, the value possible to match paths against a prefix. For example, the value
<screen> <screen>
nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen> nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen>
@ -37,12 +37,12 @@ nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen>
<filename>/etc/nixos/nixpkgs/<replaceable>path</replaceable></filename>. <filename>/etc/nixos/nixpkgs/<replaceable>path</replaceable></filename>.
</para> </para>
<para>The search path can be extended using the <para>The search path can be extended using the <option
<option>-I</option> option, which takes precedence over linkend="opt-I">-I</option> option, which takes precedence over
<envar>NIX_PATH</envar>.</para></listitem> <envar>NIX_PATH</envar>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry><term><envar>NIX_IGNORE_SYMLINK_STORE</envar></term> <varlistentry><term><envar>NIX_IGNORE_SYMLINK_STORE</envar></term>
@ -65,7 +65,7 @@ nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen>
youre better off using <literal>bind</literal> mount points, e.g., youre better off using <literal>bind</literal> mount points, e.g.,
<screen> <screen>
$ mkdir /nix $ mkdir /nix
$ mount -o bind /mnt/otherdisk/nix /nix</screen> $ mount -o bind /mnt/otherdisk/nix /nix</screen>
Consult the <citerefentry><refentrytitle>mount</refentrytitle> Consult the <citerefentry><refentrytitle>mount</refentrytitle>
@ -80,7 +80,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the Nix store (default <listitem><para>Overrides the location of the Nix store (default
<filename><replaceable>prefix</replaceable>/store</filename>).</para></listitem> <filename><replaceable>prefix</replaceable>/store</filename>).</para></listitem>
</varlistentry> </varlistentry>
@ -89,7 +89,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the Nix static data <listitem><para>Overrides the location of the Nix static data
directory (default directory (default
<filename><replaceable>prefix</replaceable>/share</filename>).</para></listitem> <filename><replaceable>prefix</replaceable>/share</filename>).</para></listitem>
</varlistentry> </varlistentry>
@ -97,7 +97,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the Nix log directory <listitem><para>Overrides the location of the Nix log directory
(default <filename><replaceable>prefix</replaceable>/log/nix</filename>).</para></listitem> (default <filename><replaceable>prefix</replaceable>/log/nix</filename>).</para></listitem>
</varlistentry> </varlistentry>
@ -105,7 +105,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the Nix state directory <listitem><para>Overrides the location of the Nix state directory
(default <filename><replaceable>prefix</replaceable>/var/nix</filename>).</para></listitem> (default <filename><replaceable>prefix</replaceable>/var/nix</filename>).</para></listitem>
</varlistentry> </varlistentry>
@ -114,7 +114,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the Nix database (default <listitem><para>Overrides the location of the Nix database (default
<filename><replaceable>$NIX_STATE_DIR</replaceable>/db</filename>, i.e., <filename><replaceable>$NIX_STATE_DIR</replaceable>/db</filename>, i.e.,
<filename><replaceable>prefix</replaceable>/var/nix/db</filename>).</para></listitem> <filename><replaceable>prefix</replaceable>/var/nix/db</filename>).</para></listitem>
</varlistentry> </varlistentry>
@ -123,7 +123,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the Nix configuration <listitem><para>Overrides the location of the Nix configuration
directory (default directory (default
<filename><replaceable>prefix</replaceable>/etc/nix</filename>).</para></listitem> <filename><replaceable>prefix</replaceable>/etc/nix</filename>).</para></listitem>
</varlistentry> </varlistentry>
@ -133,7 +133,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
files. In particular, this includes temporary build directories; files. In particular, this includes temporary build directories;
these can take up substantial amounts of disk space. The default is these can take up substantial amounts of disk space. The default is
<filename>/tmp</filename>.</para></listitem> <filename>/tmp</filename>.</para></listitem>
</varlistentry> </varlistentry>
@ -231,7 +231,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
store derivation itself).</para></listitem> store derivation itself).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry><term><filename>outputs</filename></term> <varlistentry><term><filename>outputs</filename></term>
<listitem><para>The set of store paths that are outputs of the <listitem><para>The set of store paths that are outputs of the
@ -280,7 +280,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
</varlistentry> </varlistentry>
<varlistentry xml:id="envar-other-stores"><term><envar>NIX_OTHER_STORES</envar></term> <varlistentry xml:id="envar-other-stores"><term><envar>NIX_OTHER_STORES</envar></term>
<listitem><para>This variable contains the paths of remote Nix <listitem><para>This variable contains the paths of remote Nix
@ -331,7 +331,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
</varlistentry> </varlistentry>
</variablelist> </variablelist>

View file

@ -103,9 +103,10 @@ input.</para>
<varlistentry><term><option>--find-file</option></term> <varlistentry><term><option>--find-file</option></term>
<listitem><para>Look up the given files in Nixs search path (as <listitem><para>Look up the given files in Nixs search path (as
specified by the <envar>NIX_PATH</envar> environment variable). specified by the <envar linkend="env-NIX_PATH">NIX_PATH</envar>
If found, print the corresponding absolute paths on standard environment variable). If found, print the corresponding absolute
output. For instance, if <envar>NIX_PATH</envar> is paths on standard output. For instance, if
<envar>NIX_PATH</envar> is
<literal>nixpkgs=/home/alice/nixpkgs</literal>, then <literal>nixpkgs=/home/alice/nixpkgs</literal>, then
<literal>nix-instantiate --find-file nixpkgs/default.nix</literal> <literal>nix-instantiate --find-file nixpkgs/default.nix</literal>
will print will print

View file

@ -351,13 +351,14 @@
</varlistentry> </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 <listitem><para>Add a path to the Nix expression search path. This
option may be given multiple times. See the <envar>NIX_PATH</envar> option may be given multiple times. See the <envar
environment variable for information on the semantics of the Nix linkend="env-NIX_PATH">NIX_PATH</envar> environment variable for
search path. Paths added through <option>-I</option> take information on the semantics of the Nix search path. Paths added
precedence over <envar>NIX_PATH</envar>.</para></listitem> through <option>-I</option> take precedence over
<envar>NIX_PATH</envar>.</para></listitem>
</varlistentry> </varlistentry>