me/guix
Archived
1
0
Fork 0
Code Activity

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

Browse source 
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>
This commit is contained in:
Damien Cassou 2020-02-09 21:07:04 +01:00 • committed by Jakub Kądziołka
parent cc0cc9651a
commit 459e096770
No known key found for this signature in database
GPG key ID: E315A75846131564
1 changed files with 4 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/guix.texi
View file

@ -4964,8 +4964,10 @@ shared and will change to the user's home directory within the container
instead. See also @code{--user}. instead. See also @code{--user}.
@item --expose=@var{source}[=@var{target}] @item --expose=@var{source}[=@var{target}]
For containers, expose the file system @var{source} from the host system @item --share=@var{source}[=@var{target}]
as the read-only file system @var{target} within the container. If 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 @var{target} is not specified, @var{source} is used as the target mount
point in the container. point in the container.
@ -4977,19 +4979,6 @@ directory:
guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile
@end example @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 @end table
@command{guix environment} @command{guix environment}