[PATCH] doc: Explain ‘--’ syntax of ‘guix shell’ before giving examples.

  • Done
  • quality assurance status badge
Details
3 participants
  • Ludovic Courtès
  • Noé Lopez
  • Florian Pelz
Owner
unassigned
Submitted by
Florian Pelz
Severity
normal

Debbugs page

Florian Pelz wrote 4 months ago
[PATCH] doc: Explain ‘--’ syntax of ‘guix shell’ before giving exam ples.
(address . guix-patches@gnu.org)(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)
24a645c2c44f8b98d6351c8d8c4839feb46b012e.1731940595.git.pelzflorian@pelzflorian.de
This paragraph is present in the ‘guix environment’ docs. I presume
it clarifies ‘guix shell’ for newcomers as well.

* doc/guix.texi (Invoking guix shell): Take over an introductory
paragraph from ‘guix environment’ and use it for ‘guix shell’.

Change-Id: I06280516ad3436260114b074c5f325e6984e9c76
---
doc/guix.texi | 4 ++++
1 file changed, 4 insertions(+)

Toggle diff (19 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index ba4bd2cc79..f71f0b6561 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -5933,6 +5933,10 @@ Invoking guix shell
guix shell [@var{options}] [@var{package}@dots{}]
@end example
+Sometimes an interactive shell session is not desired. An arbitrary
+command may be invoked by placing the @code{--} token to separate the
+command from the rest of the arguments.
+
The following example creates an environment containing Python and NumPy,
building or downloading any missing package, and runs the
@command{python3} command in that environment:

base-commit: 23cbbe6860782c5d4a0ba599ea1cda0642e91661
--
2.46.0
Ludovic Courtès wrote 4 months ago
Re: [bug#74418] [PATCH] doc: Explain ‘--’ syntax of ‘guix shell’ before giving examples.
(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)
87bjycegdh.fsf@gnu.org
Florian Pelz <pelzflorian@pelzflorian.de> skribis:

Toggle quote (8 lines)
> This paragraph is present in the ‘guix environment’ docs. I presume
> it clarifies ‘guix shell’ for newcomers as well.
>
> * doc/guix.texi (Invoking guix shell): Take over an introductory
> paragraph from ‘guix environment’ and use it for ‘guix shell’.
>
> Change-Id: I06280516ad3436260114b074c5f325e6984e9c76

LGTM!
Noé Lopez wrote 4 months ago
Re: [PATCH] doc: Explain ‘--’ syntax of ‘guix shell’ before giving examples.
(address . 74418@debbugs.gnu.org)(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)
87wmh0dvgp.fsf@xn--no-cja.eu
Looks good to me too, the explanation is clear.
pelzflorian (Florian Pelz) wrote 4 months ago
(address . 74418-done@debbugs.gnu.org)
87bjybwjyx.fsf@pelzflorian.de
Pushed as d6b8679784f57c6a71ef7d6ccab19d87f4c38721.

Thank you Ludo, Noé for reviewing.

Regards,
Florian
Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 74418@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 74418
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help