[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
113/376: Update manual
From: |
Ludovic Courtès |
Subject: |
113/376: Update manual |
Date: |
Wed, 28 Jan 2015 22:04:24 +0000 |
civodul pushed a commit to tag 1.8
in repository guix.
commit 70188305090331537e8ae47bcca0a76584884ea3
Author: Eelco Dolstra <address@hidden>
Date: Mon Aug 4 18:00:33 2014 +0200
Update manual
---
doc/manual/conf-file.xml | 58 ++++++++++++++++++++++++++-------------------
1 files changed, 33 insertions(+), 25 deletions(-)
diff --git a/doc/manual/conf-file.xml b/doc/manual/conf-file.xml
index 6af4c77..e420d1e 100644
--- a/doc/manual/conf-file.xml
+++ b/doc/manual/conf-file.xml
@@ -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
performed in a <emphasis>chroot environment</emphasis>, i.e., the
build will be isolated from the normal file system hierarchy and
- will only see the Nix store, the temporary build directory, and
- the directories configured with the <link
- linkend='conf-build-chroot-dirs'><literal>build-chroot-dirs</literal>
- option</link> (such as <filename>/proc</filename> and
- <filename>/dev</filename>). This is useful to prevent undeclared
- dependencies on files in directories such as
+ will only see its dependencies in the Nix store, the temporary
+ build directory, private versions of <filename>/proc</filename>,
+ <filename>/dev</filename>, <filename>/dev/shm</filename> and
+ <filename>/dev/pts</filename>, and the paths configured with the
+ <link linkend='conf-build-chroot-dirs'><literal>build-chroot-dirs</literal>
+ option</link>. This is useful to prevent undeclared dependencies
+ on files in directories such as
<filename>/usr/bin</filename>.</para>
- <para>The use of a chroot requires that Nix is run as root (but
- you can still use the <link
- linkend='conf-build-users-group'>“build users†feature</link> to
- perform builds under different users than root). Currently,
- chroot builds only work on Linux because Nix uses “bind mounts†to
- make the Nix store and other directories available inside the
- chroot.</para>
+ <para>The use of a chroot requires that Nix is run as root (so you
+ should use the <link linkend='conf-build-users-group'>“build
+ users†feature</link> to perform the actual builds under different
+ users than root). Currently, chroot builds only work on Linux
+ because Nix uses “bind mounts†to make the Nix store and other
+ directories available inside the chroot.</para>
</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>
- <listitem><para>When builds are performed in a chroot environment,
- Nix will mount some directories from the normal file system
- hierarchy inside the chroot. These are the Nix store, the
- temporary build directory (usually
-
<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
+ <listitem><para>A list of paths bind-mounted into Nix chroot
+ environments. Contrary to what the name suggests, the specified
+ paths do not have to be directories; you can bind-mount other
+ types of files as well. You can use the syntax
<literal><replaceable>target</replaceable>=<replaceable>source</replaceable></literal>
to mount a path in a different location in the chroot; for
- instance, <literal>/bin=/nix-bin</literal> will mount the
- directory <literal>/nix-bin</literal> as <literal>/bin</literal>
- inside the chroot.</para></listitem>
+ instance, <literal>/bin=/nix-bin</literal> will mount the path
+ <literal>/nix-bin</literal> as <literal>/bin</literal> inside the
+ 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>
- 119/376: Add support for order-only dependencies, (continued)
- 119/376: Add support for order-only dependencies, Ludovic Courtès, 2015/01/28
- 118/376: install-nix-from-closure.sh: Use https channel if possible, Ludovic Courtès, 2015/01/28
- 114/376: Refactor, Ludovic Courtès, 2015/01/28
- 117/376: Remove unnecessary call to addTempRoot(), Ludovic Courtès, 2015/01/28
- 115/376: Move some options out of globals, Ludovic Courtès, 2015/01/28
- 116/376: Doh, Ludovic Courtès, 2015/01/28
- 112/376: Add option ‘build-extra-chroot-dirs’, Ludovic Courtès, 2015/01/28
- 111/376: Get rid of "killing <pid>" message for unused build hooks, Ludovic Courtès, 2015/01/28
- 129/376: Remove log2html.xsl and friends, Ludovic Courtès, 2015/01/28
- 122/376: Warn about untrusted binary caches in extra-binary-caches, Ludovic Courtès, 2015/01/28
- 113/376: Update manual,
Ludovic Courtès <=
- 126/376: Handle compound single dash options properly, Ludovic Courtès, 2015/01/28
- 124/376: Fix warning about non-existant -I directories, Ludovic Courtès, 2015/01/28
- 127/376: Use regular file GC roots if possible, Ludovic Courtès, 2015/01/28
- 128/376: nix-log2xml: Handle UTF-8 characters, Ludovic Courtès, 2015/01/28
- 132/376: nix-shell: Use $XDG_RUNTIME_DIR, Ludovic Courtès, 2015/01/28
- 120/376: download-from-binary-cache.pl: Respect $SSL_CERT_FILE, Ludovic Courtès, 2015/01/28
- 123/376: Remove pointless NIX_LOG_TYPE environment variable, Ludovic Courtès, 2015/01/28
- 136/376: Propagate remote timeouts properly, Ludovic Courtès, 2015/01/28
- 131/376: Use $XDG_RUNTIME_DIR for temporary files, Ludovic Courtès, 2015/01/28
- 137/376: Reduce verbosity, Ludovic Courtès, 2015/01/28