aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/nix-build.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/nix-build.xml')
-rw-r--r--doc/manual/nix-build.xml30
1 files changed, 14 insertions, 16 deletions
diff --git a/doc/manual/nix-build.xml b/doc/manual/nix-build.xml
index 23c0b2304..465635f67 100644
--- a/doc/manual/nix-build.xml
+++ b/doc/manual/nix-build.xml
@@ -28,8 +28,8 @@
</group>
<replaceable>attrPath</replaceable>
</arg>
- <arg><option>--add-drv-link</option></arg>
<arg><option>--drv-link </option><replaceable>drvlink</replaceable></arg>
+ <arg><option>--add-drv-link</option></arg>
<arg><option>--no-out-link</option></arg>
<arg>
<group choice='req'>
@@ -83,24 +83,23 @@ except for <option>--arg</option> and <option>--attr</option> /
<variablelist>
- <varlistentry><term><option>--add-drv-link</option></term>
+ <varlistentry><term><option>--drv-link</option> <replaceable>drvlink</replaceable></term>
- <listitem><para>Add a symlink in the current directory to the
- store derivation produced by <command>nix-instantiate</command>.
- The symlink is called <filename>derivation</filename> (which is
- numbered in the case of multiple derivations). The derivation is
+ <listitem><para>Add a symlink named
+ <replaceable>drvlink</replaceable> to the store derivation
+ produced by <command>nix-instantiate</command>. The derivation is
a root of the garbage collector until the symlink is deleted or
- renamed.</para></listitem>
-
+ renamed. If there are multiple derivations, numbers are suffixed
+ to <replaceable>drvlink</replaceable> to distinguish between
+ them.</para></listitem>
+
</varlistentry>
- <varlistentry><term><option>--drv-link</option> <replaceable>drvlink</replaceable></term>
+ <varlistentry><term><option>--add-drv-link</option></term>
- <listitem><para>Change the name of the symlink to the derivation
- created when <option>--add-drv-link</option> is used from
- <filename>derivation</filename> to
- <replaceable>drvlink</replaceable>.</para></listitem>
-
+ <listitem><para>Shorthand for <option>--drv-link</option>
+ <filename>./derivation</filename>.</para></listitem>
+
</varlistentry>
<varlistentry><term><option>--no-out-link</option></term>
@@ -116,8 +115,7 @@ except for <option>--arg</option> and <option>--attr</option> /
<option>-o</option> <replaceable>outlink</replaceable></term>
<listitem><para>Change the name of the symlink to the output path
- created unless <option>--no-out-link</option> is used from
- <filename>result</filename> to
+ created from <filename>result</filename> to
<replaceable>outlink</replaceable>.</para></listitem>
</varlistentry>