Message ID | 3eccfbb0aa34517d4ff44822c7634872f4528e19.camel@gmail.com |
---|---|
State | Accepted |
Headers | show |
Series | [bug#55317,v2] doc: Clarify guix shell's DWIM behaviour. | expand |
Context | Check | Description |
---|---|---|
cbaines/comparison | success | View comparision |
cbaines/git branch | success | View Git branch |
cbaines/applying patch | success | View Laminar job |
cbaines/issue | success | View issue |
Hi! Liliana Marie Prikler <liliana.prikler@gmail.com> skribis: > * doc/guix.texi ("Invoking guix shell"): Document the exact behaviour, that is > which flags go together with which file names. [...] > +As an added convenience, @command{guix shell} will try to do what you > +mean when it is invoked interactively as in > @example I’d add a colon after “in” followed by a newline. Otherwise LGTM, thank you! Ludo’.
Am Dienstag, dem 17.05.2022 um 14:46 +0200 schrieb Ludovic Courtès: > > > +As an added convenience, @command{guix shell} will try to do what > > you > > +mean when it is invoked interactively as in > > @example > > I’d add a colon after “in” followed by a newline. I pushed this in 131acaa28ded1455de291a83a8cdecab77b74a87 some while ago (with the added colon), so I'm closing this now. Cheers
diff --git a/doc/guix.texi b/doc/guix.texi index e1fb50a634..34908462e2 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -5670,17 +5670,20 @@ 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: - +As an added convenience, @command{guix shell} will try to do what you +mean when it is invoked interactively as in @example guix shell @end example - +without any other arguments. If it finds a @file{manifest.scm} in the +current working directory or any of its parents, it uses this manifest +as though it was given via @code{--manifest}. Likewise, if it finds +a @file{guix.scm} in the same directories, it uses it to build a +development profile as though both @code{--development} and @code{--file} +were present. +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.