summaryrefslogtreecommitdiff
path: root/doc/guix.texi
diff options
context:
space:
mode:
authorDamien Cassou <damien@cassou.me>2020-02-09 21:07:04 +0100
committerJakub Kądziołka <kuba@kadziolka.net>2020-02-14 22:55:52 +0100
commit459e0967705945bf6b5861598202aefef27451cd (patch)
tree8dbc3ced07f8ca3ec9f401f7d5f2cf3d0cbc8657 /doc/guix.texi
parentcc0cc9651a398822931e0b34714f64da6e04d0fa (diff)
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 <kuba@kadziolka.net>
Diffstat (limited to 'doc/guix.texi')
-rw-r--r--doc/guix.texi19
1 files changed, 4 insertions, 15 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 25b50bad9e..3c310c0912 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}