* Manual updates.

This commit is contained in:
Eelco Dolstra 2005-04-05 15:28:30 +00:00
parent 229252941a
commit 128c174295
5 changed files with 129 additions and 77 deletions

View file

@ -3,10 +3,16 @@
<glosslist> <glosslist>
<glossentry><glossterm>derivation</glossterm> <glossentry id="gloss-derivation"><glossterm>derivation</glossterm>
<glossdef><para>A description of a build action. The result of a <glossdef><para>A description of a build action. The result of a
derivation is a store object.</para></glossdef> derivation is a store object. Derivations are typically specified
in Nix expressions using the <link
linkend="ssec-derivation"><function>derivation</function>
primitive</link>. These are translated into low-level
<emphasis>store derivations</emphasis> (implicitly by
<command>nix-env</command> and <command>nix-build</command>, or
explicitly by <command>nix-instantiate</command>).</para></glossdef>
</glossentry> </glossentry>
@ -73,6 +79,21 @@
</glossentry> </glossentry>
<glossentry><glossterm>closure</glossterm>
<glossdef><para>The closure of a store path is the set of store
paths that are directly or indirectly “reachable” from that store
path. For instance, if the store object at path
<varname>P</varname> contains a reference to path
<varname>Q</varname>, then <varname>Q</varname> is in the closure of
<varname>P</varname>. For correct deployment it is necessary to
deploy whole closures, since otherwise at runtime files could be
missing. The command <command>nix-store -qR</command> prints out
closures of store paths.</para></glossdef>
</glossentry>
</glosslist> </glosslist>

View file

@ -1,89 +1,97 @@
<refentry> <refentry>
<refnamediv>
<refname>nix-instantiate</refname>
<refpurpose>instantiate store expressions from Nix expressions</refpurpose>
</refnamediv>
<refsynopsisdiv> <refnamediv>
<refname>nix-instantiate</refname>
<refpurpose>instantiate store derivations from Nix expressions</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>nix-instantiate</command> <command>nix-instantiate</command>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common-syn.xml#xpointer(/nop/*)" /> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common-syn.xml#xpointer(/nop/*)" />
<arg><option>--add-root</option> <replaceable>path</replaceable></arg>
<arg><option>--indirect</option></arg>
<group choice='opt'> <group choice='opt'>
<arg choice='plain'><option>--parse-only</option></arg> <arg choice='plain'><option>--parse-only</option></arg>
<arg choice='plain'><option>--eval-only</option></arg> <arg choice='plain'><option>--eval-only</option></arg>
</group> </group>
<arg choice='plain' rep='repeat'><replaceable>files</replaceable></arg> <arg choice='plain' rep='repeat'><replaceable>files</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsection>
<title>Description</title>
<para> <refsection><title>Description</title>
The command <command>nix-instantiate</command> generates
(low-level) store expressions from (high-level) Nix expressions.
It loads and evaluates the Nix expressions in each of
<replaceable>files</replaceable>. Each top-level expression
should evaluate to a derivation, a list of derivations, or a set
of derivations. The paths of the resulting store expressions
are printed on standard output.
</para>
<para> <para>The command <command>nix-instantiate</command> generates <link
This command is generally used for testing Nix expression before linkend="gloss-derivation">store derivations</link> from (high-level)
they are used with <command>nix-env</command>. See also <xref Nix expressions. It loads and evaluates the Nix expressions in each
linkend="sec-common-options" />. of <replaceable>files</replaceable>. Each top-level expression should
</para> evaluate to a derivation, a list of derivations, or a set of
derivations. The paths of the resulting store derivations are printed
on standard output.</para>
</refsection> <para>Most users and developers dont need to use this command
(<command>nix-env</command> and <command>nix-build</command> perform
store derivation instantiation from Nix expressions automatically).
It is most commonly used for implementing new deployment
policies.</para>
<refsection> <para>See also <xref linkend="sec-common-options" /> for a list of
<title>Options</title> common options.</para>
<variablelist> </refsection>
<refsection><title>Options</title>
<variablelist>
<varlistentry> <varlistentry>
<term><option>--parse-only</option></term> <term><option>--add-root</option> <replaceable>path</replaceable></term>
<listitem> <term><option>--indirect</option></term>
<para>
Just parse the input files, and print their abstract <listitem><para>See the <link linkend="opt-add-root">corresponding
syntax trees on standard output in ATerm format. options</link> in <command>nix-store</command>.</para></listitem>
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--eval-only</option></term> <varlistentry><term><option>--parse-only</option></term>
<listitem>
<para> <listitem><para>Just parse the input files, and print their
Just parse and evaluate the input files, and print the abstract syntax trees on standard output in ATerm
resulting values on standard output. No instantiation of format.</para></listitem>
store expressions takes place.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> <varlistentry><term><option>--eval-only</option></term>
</refsection> <listitem><para>Just parse and evaluate the input files, and print
the resulting values on standard output. No instantiation of
store derivations takes place.</para></listitem>
<refsection> </varlistentry>
<title>Examples</title>
<screen> </variablelist>
$ nix-instantiate gcc.nix <lineannotation>(instantiate)</lineannotation>
/nix/store/468abdcb93aa22bb721142615b97698b-d-gcc-3.3.2.store
$ nix-store -r $(nix-instantiate gcc.nix) <lineannotation>(build)</lineannotation> </refsection>
$ nix-store -r $(nix-instantiate gcc.nix) <lineannotation>(print output path)</lineannotation>
/nix/store/9afa718cddfdfe94b5b9303d0430ceb1-gcc-3.3.2
$ ls -l /nix/store/9afa718cddfdfe94b5b9303d0430ceb1-gcc-3.3.2 <refsection><title>Examples</title>
dr-xr-xr-x 2 eelco users 360 2003-12-01 16:12 bin
dr-xr-xr-x 3 eelco users 72 2003-12-01 16:12 include <screen>
$ nix-instantiate test.nix <lineannotation>(instantiate)</lineannotation>
/nix/store/cigxbmvy6dzix98dxxh9b6shg7ar5bvs-perl-BerkeleyDB-0.26.drv
$ nix-store -r $(nix-instantiate test.nix) <lineannotation>(build)</lineannotation>
<replaceable>...</replaceable>
/nix/store/qhqk4n8ci095g3sdp93x7rgwyh9rdvgk-perl-BerkeleyDB-0.26 <lineannotation>(output path)</lineannotation>
$ ls -l /nix/store/qhqk4n8ci095g3sdp93x7rgwyh9rdvgk-perl-BerkeleyDB-0.26
dr-xr-xr-x 2 eelco users 4096 1970-01-01 01:00 lib
...</screen> ...</screen>
</refsection> </refsection>
</refentry> </refentry>

View file

@ -39,11 +39,11 @@ be performed. These are documented below.</para>
<para>This section lists the options that are common to all <para>This section lists the options that are common to all
operations. These options are allowed for every subcommand, though operations. These options are allowed for every subcommand, though
they may not always have an effect. See also <xref they may not always have an effect. See also <xref
linkend="sec-common-options" />.</para> linkend="sec-common-options" /> for a list of common options.</para>
<variablelist> <variablelist>
<varlistentry><term><option>--add-root</option> <replaceable>path</replaceable></term> <varlistentry id="opt-add-root"><term><option>--add-root</option> <replaceable>path</replaceable></term>
<listitem><para>Causes the result of a build action <listitem><para>Causes the result of a build action
(<option>--realise</option> and <option>--force-realise</option>) (<option>--realise</option> and <option>--force-realise</option>)

View file

@ -1,8 +1,31 @@
<appendix> <appendix>
<title>Troubleshooting</title> <title>Troubleshooting</title>
<para> <para>This section provides solutions for some common problems.</para>
(Nothing.)
<sect1><title>Berkeley DB: <quote>Cannot allocate memory</quote></title>
<para>Symptom: Nix operations (in particular the
<command>nix-store</command> operations <option>--gc</option>,
<option>--verify</option>, and <option>--clear-substitutes</option>
— the latter being called by <command>nix-channel
--update</command>) failing:
<screen>
$ nix-store --verify
error: Db::del: Cannot allocate memory</screen>
Possible solution: make sure that no Nix processes are running,
then do:
<screen>
$ cd /nix/var/nix/db
$ rm __db.00*</screen>
</para> </para>
</sect1>
</appendix> </appendix>

View file

@ -1103,7 +1103,7 @@ weakest binding).</para>
</simplesect> </simplesect>
<simplesect><title>Derivations</title> <simplesect id="ssec-derivation"><title>Derivations</title>
<para>The most important built-in function is <para>The most important built-in function is
<function>derivation</function>, which is used to describe a <function>derivation</function>, which is used to describe a