branch master updated: doc: Clarify documentation of guix environment --expose vs. --share

[guix-commits]

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

niedzejkob pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new 459e096  doc: Clarify documentation of guix environment --expose vs. 
--share
459e096 is described below

commit 459e0967705945bf6b5861598202aefef27451cd
Author: Damien Cassou <address@hidden>
AuthorDate: Sun Feb 9 21:07:04 2020 +0100

    doc: Clarify documentation of guix environment --expose vs. --share
    
    The documentation for --expose and --share parameters are so similar that 
the
    reader has to read both descriptions in parallel to find the difference.
    
    * doc/guix.texi (Invoking guix environment)[--expose, --share]: Merge the 
two
      descriptions into one.
    
    Signed-off-by: Jakub Kądziołka <address@hidden>
---
 doc/guix.texi | 19 ++++---------------
 1 file changed, 4 insertions(+), 15 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 25b50ba..3c310c0 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4964,8 +4964,10 @@ shared and will change to the user's home directory 
within the container
 instead.  See also @code{--user}.
 
 @item --expose=@var{source}[=@var{target}]
-For containers, expose the file system @var{source} from the host system
-as the read-only file system @var{target} within the container.  If
+@item --share=@var{source}[=@var{target}]
+For containers, @code{--expose} (resp. @code{--share}) exposes the file
+system @var{source} from the host system as the read-only
+(resp. writable) file system @var{target} within the container.  If
 @var{target} is not specified, @var{source} is used as the target mount
 point in the container.
 
@@ -4977,19 +4979,6 @@ directory:
 guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile
 @end example
 
-@item --share=@var{source}[=@var{target}]
-For containers, share the file system @var{source} from the host system
-as the writable file system @var{target} within the container.  If
-@var{target} is not specified, @var{source} is used as the target mount
-point in the container.
-
-The example below spawns a Guile REPL in a container in which the user's
-home directory is accessible for both reading and writing via the
-@file{/exchange} directory:
-
-@example
-guix environment --container --share=$HOME=/exchange --ad-hoc guile -- guile
-@end example
 @end table
 
 @command{guix environment}