summary refs log tree commit diff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2015-02-07 18:32:04 +0100
committerLudovic Courtès <ludo@gnu.org>2015-02-07 23:16:55 +0100
commitcbc538fe69577068d5676428c77287d82123a704 (patch)
treef7c7965d3a79f1563917bb4ebf1d2751a20c93dd
parent4320c094f3cfd736f37b4461f11da320e073e292 (diff)
downloadguix-cbc538fe69577068d5676428c77287d82123a704.tar.gz
doc: Document the location of the build directory.
Fixes <http://bugs.gnu.org/19771>.
Reported by Andrei Osipov <andrspv@gmail.com>.

* doc/guix.texi (Invoking guix-daemon): Document the build directory
  location.
-rw-r--r--doc/guix.texi13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 3930b96836..510acddb46 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -557,6 +557,19 @@ system directories.  By default, the latter contains @file{/dev} and
 a separate mount name space, its own PID name space, network name space,
 etc.  This helps achieve reproducible builds (@pxref{Features}).
 
+When the daemon performs a build on behalf of the user, it creates a
+build directory under @file{/tmp} or under the directory specified by
+its @code{TMPDIR} environment variable; this directory is shared with
+the container for the duration of the build.  Be aware that using a
+directory other than @file{/tmp} can affect build results---for example,
+with a longer directory name, a build process that uses Unix-domain
+sockets might hit the name length limitation for @code{sun_path}, which
+it would otherwise not hit.
+
+The build directory is automatically deleted upon completion, unless the
+build failed and the client specified @option{--keep-failed}
+(@pxref{Invoking guix build, @option{--keep-failed}}).
+
 The following command-line options are supported:
 
 @table @code