me
/
guix
Archived
1
0
Fork 0
Code

doc: Clarify guix shell's DWIM behaviour. 

* doc/guix.texi ("Invoking guix shell"): Document the exact behaviour, that is
which flags go together with which file names.
Liliana Marie Prikler 2022-05-08 17:29:06 +02:00
parent 5f77ece508
commit 131acaa28d
No known key found for this signature in database
GPG Key ID: 442A84B8C70E2F87
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/guix.texi
View File

@ -5670,17 +5670,22 @@ before @command{guix shell} was invoked. The next garbage collection
(@pxref{Invoking guix gc}) may clean up packages that were installed in (@pxref{Invoking guix gc}) may clean up packages that were installed in
the environment and that are no longer used outside of it. the environment and that are no longer used outside of it.
As an added convenience, when running from a directory that contains a As an added convenience, @command{guix shell} will try to do what you
@file{manifest.scm} or a @file{guix.scm} file (in this order), possibly mean when it is invoked interactively without any other arguments
in a parent directory, @command{guix shell} automatically loads the as in:
file---provided the directory is listed in
@file{~/.config/guix/shell-authorized-directories}, and only for
interactive use:
@example @example
guix shell guix shell
@end example @end example
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 This provides an easy way to define, share, and enter development
environments. environments.