summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLeo Famulari <leo@famulari.name>2022-01-16 13:14:02 -0500
committerLeo Famulari <leo@famulari.name>2022-01-16 13:17:22 -0500
commit72f33343080d393f068cf3afbfeae56af6895c23 (patch)
tree840dff95fcec232f13b5929352830edaf8bff5a7 /doc
parent8cdecad237343f5c955d17df3a78e41fa1f2d56c (diff)
downloadguix-72f33343080d393f068cf3afbfeae56af6895c23.tar.gz
doc: Document the dummy $HOME in the build chroot.
This missing documentation reported by Matt <matt@excalamus.com>.

* doc/guix.texi (Build Environment Setup): Document '/homeless-shelter'.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 42691570ff..300518e861 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -1178,6 +1178,11 @@ user @file{nobody};
 a writable @file{/tmp} directory.
 @end itemize
 
+The chroot does contain a @file{/home} directory, and the @env{HOME}
+environment variable is set to the non-existent
+@file{/homeless-shelter}.  This helps to highlight inappropriate uses of
+@env{HOME} in the build scripts of packages.
+
 You can influence the directory where the daemon stores build trees
 @i{via} the @env{TMPDIR} environment variable.  However, the build tree
 within the chroot is always called @file{/tmp/guix-build-@var{name}.drv-0},