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

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

[Liliana Marie Prikler]

---
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

[bug#55317] [PATCH v2] doc: Clarify guix shell's DWIM behaviour.

[Liliana Marie Prikler]

* doc/guix.texi ("Invoking guix shell"): Document the exact behaviour, that is
which flags go together with which file names.
---
 doc/guix.texi | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

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.
 
-- 
2.36.0

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

[Ryan Prior via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 415 bytes --]

-------- Original Message --------
On May 8, 2022, 10:29 AM, Liliana Marie Prikler < liliana.prikler@gmail.com> wrote:
---
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.

Thank you Liliana, this is a helpful change!

[-- Attachment #2: Type: text/html, Size: 530 bytes --]

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

[Ludovic Courtès]

Hi,

Liliana Marie Prikler <liliana.prikler@gmail.com> skribis:

> +++ 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.

It’s clearer like this, so go for it!  Maybe you can keep the @example
bit as that makes an easily visible anchor in the text.

Thank you,
Ludo’.

[bug#55317] [PATCH v2] doc: Clarify guix shell's DWIM behaviour.

[Ludovic Courtès]

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’.

bug#55317: [PATCH v2] doc: Clarify guix shell's DWIM behaviour.

[Liliana Marie Prikler]

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