branch master updated: doc: Document the dummy $HOME in the build chroot.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

lfam pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new 72f3334308 doc: Document the dummy $HOME in the build chroot.
72f3334308 is described below

commit 72f33343080d393f068cf3afbfeae56af6895c23
Author: Leo Famulari <leo@famulari.name>
AuthorDate: Sun Jan 16 13:14:02 2022 -0500

    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'.
---
 doc/guix.texi | 5 +++++
 1 file changed, 5 insertions(+)

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},