branch master updated: doc: Explain ‘--’ syntax of ‘guix shell’ before giving examples.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

pelzflorian pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new d6b8679784 doc: Explain ‘--’ syntax of ‘guix shell’ before giving 
examples.
d6b8679784 is described below

commit d6b8679784f57c6a71ef7d6ccab19d87f4c38721
Author: Florian Pelz <pelzflorian@pelzflorian.de>
AuthorDate: Mon Nov 18 15:20:26 2024 +0100

    doc: Explain ‘--’ syntax of ‘guix shell’ before giving examples.
    
    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(+)

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 @@ The general syntax is:
 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: