diff mbox series

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

Message ID 24a645c2c44f8b98d6351c8d8c4839feb46b012e.1731940595.git.pelzflorian@pelzflorian.de
State New
Headers show
Series [bug#74418] doc: Explain ‘--’ syntax of ‘guix shell’ before giving examples. | expand

Commit Message

pelzflorian (Florian Pelz) Nov. 18, 2024, 2:38 p.m. UTC 
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(+)


base-commit: 23cbbe6860782c5d4a0ba599ea1cda0642e91661

Comments

Ludovic Courtès Nov. 18, 2024, 3 p.m. UTC | #1 
Florian Pelz <pelzflorian@pelzflorian.de> skribis:

> 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 Nov. 18, 2024, 10:32 p.m. UTC | #2 
Looks good to me too, the explanation is clear.
pelzflorian (Florian Pelz) Nov. 19, 2024, 11:17 a.m. UTC | #3 
Pushed as d6b8679784f57c6a71ef7d6ccab19d87f4c38721.

Thank you Ludo, Noé for reviewing.

Regards,
Florian
diff mbox series

Patch

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: