summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLee <inbox@leefallat.ca>2021-02-12 16:44:56 -0500
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2021-02-15 12:06:13 +0100
commit2b529a376a7fd839c00fc6b9053df685d4f644d2 (patch)
treeae56281c3cab052474ebe1bced3ff9ba1796d058 /doc
parentadae5d75b6029b5d034030cff24e1ba4d8b3144a (diff)
downloadguix-2b529a376a7fd839c00fc6b9053df685d4f644d2.tar.gz
doc: Explain how to exit and clean up a Guix environment.
* doc/guix.texi (Invoking guix environment): Explain how to exit and clean up
a Guix environment.

The current documentation doesn't explain how to exit an environment or how to
remove the packages after exiting.

Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 68abb968b0..d1c6acddcf 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -5558,6 +5558,12 @@ 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.}.
 
+Exiting from a Guix environment is the same as exiting from the shell,
+and will place the user back in the old environment before @command{guix
+environment} was invoked.  The next garbage collection (@pxref{Invoking
+guix gc}) will clean up packages that were installed from within the
+environment and are no longer used outside of it.
+
 @vindex GUIX_ENVIRONMENT
 @command{guix environment} defines the @env{GUIX_ENVIRONMENT}
 variable in the shell it spawns; its value is the file name of the