From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:470:142:3::10]:34365) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j0svz-0002U1-Cu for guix-patches@gnu.org; Sun, 09 Feb 2020 15:12:04 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j0svy-0004T1-BK for guix-patches@gnu.org; Sun, 09 Feb 2020 15:12:03 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:47274) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j0svy-0004So-7t for guix-patches@gnu.org; Sun, 09 Feb 2020 15:12:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1j0svy-00041m-4K for guix-patches@gnu.org; Sun, 09 Feb 2020 15:12:02 -0500 Subject: [bug#39533] [PATCH] doc: Clarify documentation of guix environment --expose vs. Resent-Message-ID: Received: from eggs.gnu.org ([2001:470:142:3::10]:34325) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j0svl-0002Tr-EH for guix-patches@gnu.org; Sun, 09 Feb 2020 15:11:50 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j0svk-0004DI-Bd for guix-patches@gnu.org; Sun, 09 Feb 2020 15:11:49 -0500 Received: from mail.choca.pics ([80.67.172.235]:54036) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1j0svk-0004CA-0Q for guix-patches@gnu.org; Sun, 09 Feb 2020 15:11:48 -0500 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id EB494181929EE for ; Sun, 9 Feb 2020 21:11:45 +0100 (CET) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id C_9BsYD8Hxy5 for ; Sun, 9 Feb 2020 21:11:45 +0100 (CET) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 716E4181929E0 for ; Sun, 9 Feb 2020 21:11:45 +0100 (CET) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id 1_uefho8Qr_Z for ; Sun, 9 Feb 2020 21:11:45 +0100 (CET) Received: from luz4 (57.139.120.78.rev.sfr.net [78.120.139.57]) by mail.choca.pics (Postfix) with ESMTPSA id 3874118192B26 for ; Sun, 9 Feb 2020 21:11:45 +0100 (CET) From: Damien Cassou Date: Sun, 09 Feb 2020 21:11:44 +0100 Message-ID: <87k14v34hr.fsf@cassou.me> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" To: 39533@debbugs.gnu.org --=-=-= Content-Type: text/plain 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): Merge the two descriptions into one, making it much easier to see the difference. -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-doc-Clarify-documentation-of-guix-environment-expose.patch >From a790162f26a2349039955c70f264822dc00986b3 Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Sun, 9 Feb 2020 21:07:04 +0100 Subject: [PATCH] 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): Merge the two descriptions into one, making it much easier to see the difference. --- doc/guix.texi | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 56cc333fe4..baa128f6f0 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -4958,8 +4958,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. @@ -4971,19 +4973,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} -- 2.24.1 --=-=-=--