summary refs log tree commit diff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2015-07-01 14:01:02 +0200
committerLudovic Courtès <ludo@gnu.org>2015-07-01 23:29:49 +0200
commit50500f7cf0786cccb8211ddac75a56c3c82859f6 (patch)
treea613530a43f2eeb8ecc40d20e1e6ee97d7c6b31b
parentd70389c423101d9ee26937e5d63945ac228fe6ee (diff)
downloadguix-50500f7cf0786cccb8211ddac75a56c3c82859f6.tar.gz
doc: Mention .bashrc vs. .bash_profile for 'guix environment'.
* doc/guix.texi (Invoking guix environment): Add footnote about .bashrc
  vs. .bash_profile.
-rw-r--r--doc/guix.texi10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 119c2d9c98..a35ea2fd9d 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4136,7 +4136,15 @@ version of the environment that @command{guix environment} was run in.
 It contains the necessary search paths for building the given package
 added to the existing environment variables.  To create a ``pure''
 environment in which the original environment variables have been unset,
-use the @code{--pure} option.
+use the @code{--pure} option@footnote{Users sometimes wrongfully augment
+environment variables such as @code{PATH} in their @file{~/.bashrc}
+file.  As a consequence, when @code{guix environment} launches it, Bash
+may read @file{~/.bashrc}, thereby introducing ``impurities'' in these
+environment variables.  It is an error to define such environment
+variables in @file{.bashrc}; instead, they should be defined in
+@file{.bash_profile}, which is sourced only by log-in shells.
+@xref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}, for
+details on Bash start-up files.}.
 
 Additionally, more than one package may be specified, in which case the
 union of the inputs for the given packages are used.  For example, the