GNU bug report logs - #55317
[PATCH] doc: Clarify guix shell's DWIM behaviour.

Previous Next

Full log

View this message in rfc822 format

From: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
To: 55317 <at> debbugs.gnu.org
Cc: Ryan Prior <rprior <at> protonmail.com>
Subject: [bug#55317] [PATCH] doc: Clarify guix shell's DWIM behaviour.
Date: Sun, 8 May 2022 17:29:06 +0200

---
Bonjour Guix,

as can be seen from <http://logs.guix.gnu.org/guix/2022-05-08.log#164019>,
the way in which guix shell interactively does what you mean is open to
interpretation and different folks may mean different things when
specifying nothing.  Therefore, document guix' assumptions more clearly.

Cheers

 doc/guix.texi | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 5399584cb0..249c5956e2 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -5693,17 +5693,16 @@ before @command{guix shell} was invoked.  The next garbage collection
 (@pxref{Invoking guix gc}) may clean up packages that were installed in
 the environment and that are no longer used outside of it.
 
-As an added convenience, when running from a directory that contains a
-@file{manifest.scm} or a @file{guix.scm} file (in this order), possibly
-in a parent directory, @command{guix shell} automatically loads the
-file---provided the directory is listed in
-@file{~/.config/guix/shell-authorized-directories}, and only for
-interactive use:
-
-@example
-guix shell
-@end example
-
+As an added convenience, @command{guix shell} when invoked interactively
+without any other arguments will try to do what you mean based on the
+files it locates in the current directory or parent directories.
+If it finds a @file{manifest.scm}, it uses this manifest as though
+it was given via @code{--manifest}.
+If it finds a @file{guix.scm}, it uses this package file as though
+it was given via @code{--development --file}.
+In either case, the file will only be loaded if the directory it
+resides in is listed in
+@file{~/.config/guix/shell-authorized-directories}.
 This provides an easy way to define, share, and enter development
 environments.
 
-- 
2.36.0

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.