soenkehahn/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

Update manual

Browse source
This commit is contained in:
Eelco Dolstra 2014-08-04 18:00:33 +02:00
parent d5a076c36f
commit 7018830509
1 changed files with 33 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
doc/manual/conf-file.xml
View file

@ -229,21 +229,21 @@ flag, e.g. <literal>--option gc-keep-outputs false</literal>.</para>
<listitem><para>If set to <literal>true</literal>, builds will be <listitem><para>If set to <literal>true</literal>, builds will be
performed in a <emphasis>chroot environment</emphasis>, i.e., the performed in a <emphasis>chroot environment</emphasis>, i.e., the
build will be isolated from the normal file system hierarchy and build will be isolated from the normal file system hierarchy and
will only see the Nix store, the temporary build directory, and will only see its dependencies in the Nix store, the temporary
the directories configured with the <link build directory, private versions of <filename>/proc</filename>,
linkend='conf-build-chroot-dirs'><literal>build-chroot-dirs</literal> <filename>/dev</filename>, <filename>/dev/shm</filename> and
option</link> (such as <filename>/proc</filename> and <filename>/dev/pts</filename>, and the paths configured with the
<filename>/dev</filename>). This is useful to prevent undeclared <link linkend='conf-build-chroot-dirs'><literal>build-chroot-dirs</literal>
dependencies on files in directories such as option</link>. This is useful to prevent undeclared dependencies
on files in directories such as
<filename>/usr/bin</filename>.</para> <filename>/usr/bin</filename>.</para>
<para>The use of a chroot requires that Nix is run as root (but <para>The use of a chroot requires that Nix is run as root (so you
you can still use the <link should use the <link linkend='conf-build-users-group'>“build
linkend='conf-build-users-group'>“build users” feature</link> to users” feature</link> to perform the actual builds under different
perform builds under different users than root). Currently, users than root). Currently, chroot builds only work on Linux
chroot builds only work on Linux because Nix uses “bind mounts” to because Nix uses “bind mounts” to make the Nix store and other
make the Nix store and other directories available inside the directories available inside the chroot.</para>
chroot.</para>
</listitem> </listitem>
@ -252,20 +252,28 @@ flag, e.g. <literal>--option gc-keep-outputs false</literal>.</para>
<varlistentry xml:id="conf-build-chroot-dirs"><term><literal>build-chroot-dirs</literal></term> <varlistentry xml:id="conf-build-chroot-dirs"><term><literal>build-chroot-dirs</literal></term>
<listitem><para>When builds are performed in a chroot environment, <listitem><para>A list of paths bind-mounted into Nix chroot
Nix will mount some directories from the normal file system environments. Contrary to what the name suggests, the specified
hierarchy inside the chroot. These are the Nix store, the paths do not have to be directories; you can bind-mount other
temporary build directory (usually types of files as well. You can use the syntax
<filename>/tmp/nix-build-<replaceable>drvname</replaceable>-<replaceable>number</replaceable></filename>),
the <literal>/proc</literal> filesystem, and the directories
listed here. The default is <literal>/dev /dev/pts</literal>,
since these contain files needed by many builds (such as
<filename>/dev/null</filename>). You can use the syntax
<literal><replaceable>target</replaceable>=<replaceable>source</replaceable></literal> <literal><replaceable>target</replaceable>=<replaceable>source</replaceable></literal>
to mount a path in a different location in the chroot; for to mount a path in a different location in the chroot; for
instance, <literal>/bin=/nix-bin</literal> will mount the instance, <literal>/bin=/nix-bin</literal> will mount the path
directory <literal>/nix-bin</literal> as <literal>/bin</literal> <literal>/nix-bin</literal> as <literal>/bin</literal> inside the
inside the chroot.</para></listitem> chroot.</para>
<para>Depending on how Nix was built, the default value for this option
may be empty or provide <filename>/bin/sh</filename> as a
bind-mount of <command>bash</command>.</para></listitem>
</varlistentry>
<varlistentry xml:id="conf-build-extra-chroot-dirs"><term><literal>build-extra-chroot-dirs</literal></term>
<listitem><para>A list of additional paths appended to
<option>build-chroot-dirs</option>. Useful if you want to extend
its default value.</para></listitem>
</varlistentry> </varlistentry>