From unknown Tue Jun 17 01:36:15 2025 X-Loop: help-debbugs@gnu.org Subject: [bug#39533] [PATCH] doc: Clarify documentation of guix environment --expose vs. Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 09 Feb 2020 20:12:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 39533 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 39533@debbugs.gnu.org X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.158127911215465 (code B ref -1); Sun, 09 Feb 2020 20:12:01 +0000 Received: (at submit) by debbugs.gnu.org; 9 Feb 2020 20:11:52 +0000 Received: from localhost ([127.0.0.1]:53247 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j0svo-00041M-Go for submit@debbugs.gnu.org; Sun, 09 Feb 2020 15:11:52 -0500 Received: from lists.gnu.org ([209.51.188.17]:36456) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j0svm-00041F-Lp for submit@debbugs.gnu.org; Sun, 09 Feb 2020 15:11:50 -0500 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 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,URIBL_BLOCKED autolearn=disabled version=3.3.2 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) X-Virus-Scanned: amavisd-new at choca.pics 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="=-=-=" X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 80.67.172.235 X-Spam-Score: 0.2 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.8 (/) --=-=-= 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 --=-=-=-- From unknown Tue Jun 17 01:36:15 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: Damien Cassou Subject: bug#39533: closed (Re: [PATCH] doc: Clarify documentation of guix environment --expose vs.) Message-ID: References: <20200214220003.azinipkwzd5hrtnf@gravity> <87k14v34hr.fsf@cassou.me> X-Gnu-PR-Message: they-closed 39533 X-Gnu-PR-Package: guix-patches X-Gnu-PR-Keywords: patch Reply-To: 39533@debbugs.gnu.org Date: Fri, 14 Feb 2020 22:00:03 +0000 Content-Type: multipart/mixed; boundary="----------=_1581717603-30546-1" This is a multi-part message in MIME format... ------------=_1581717603-30546-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #39533: [PATCH] doc: Clarify documentation of guix environment --expose vs. which was filed against the guix-patches package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 39533@debbugs.gnu.org. --=20 39533: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D39533 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1581717603-30546-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 39533-done) by debbugs.gnu.org; 14 Feb 2020 21:59:31 +0000 Received: from localhost ([127.0.0.1]:34831 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j2izj-0007uw-6X for submit@debbugs.gnu.org; Fri, 14 Feb 2020 16:59:31 -0500 Received: from pat.zlotemysli.pl ([37.59.186.212]:51132) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j2izh-0007uk-B2 for 39533-done@debbugs.gnu.org; Fri, 14 Feb 2020 16:59:29 -0500 Received: (qmail 11019 invoked by uid 1009); 14 Feb 2020 22:59:27 +0100 Received: from 188.123.215.55 (kuba@kadziolka.net@188.123.215.55) by pat (envelope-from , uid 1002) with qmail-scanner-2.08st (clamdscan: 0.98.6/25722. spamassassin: 3.4.0. perlscan: 2.08st. Clear:RC:1(188.123.215.55):. Processed in 0.022031 secs); 14 Feb 2020 21:59:27 -0000 Received: from unknown (HELO gravity) (kuba@kadziolka.net@188.123.215.55) by pat.zlotemysli.pl with SMTP; 14 Feb 2020 22:59:27 +0100 Date: Fri, 14 Feb 2020 23:00:03 +0100 From: Jakub =?utf-8?B?S8SFZHppb8WCa2E=?= To: Damien Cassou Subject: Re: [PATCH] doc: Clarify documentation of guix environment --expose vs. Message-ID: <20200214220003.azinipkwzd5hrtnf@gravity> References: <87k14v34hr.fsf@cassou.me> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="52rjheopj4bxjykl" Content-Disposition: inline In-Reply-To: <87k14v34hr.fsf@cassou.me> X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 39533-done Cc: 39533-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --52rjheopj4bxjykl Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sun, Feb 09, 2020 at 09:11:44PM +0100, Damien Cassou wrote: > The documentation for --expose and --share parameters are so similar > that the reader has to read both descriptions in parallel to find the > difference. >=20 > * doc/guix.texi (Invoking guix environment): Merge the two descriptions > into one, making it much easier to see the difference. Thanks for the patch! I agree that the options are so similar that they are best described together. I've edited the commit message slightly and pushed your patch as 459e0967705945bf6b5861598202aefef27451cd. --52rjheopj4bxjykl Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEE5Xa/ss9usT31cTO54xWnWEYTFWQFAl5HGGMACgkQ4xWnWEYT FWQkzA/9HGqmnBgL6khNUaMFbktyz4TqG/uXEg1E98RdmWFpqLRwONkIAjKv3dsE tBNpkqG8G3I6nEnfqGSaCnilr3yd2n/koCmyzC+WzjAEPHTQAnHxR/rDlYr9WICA t0zer9QrlQfJP3nfSulhMcpVtgt4YlYWbcDKCt1oAJEHXJSLD4j87d12bKf5Nlm3 Wb4JiI0+sM/pRN0e6TS1DxKgMANNAtW8IFV54J/KCzh2GFUMXYEzmwLf8h1q7tmv cQlCJP2kM+lht+rsxzplyJ/DUPRP5x/McgRKeRYIBbuDe+TqY/JtbQD64uU6pnjB SVQnJxYHLypBtAHzUT8ynfrlStW+XTJlSas4UjTR1HLMxWYXX9BP6uieglUSczRO aN2CTNPzy3VAnCMPvMwcYkWK+ZPum6BWA1ziQtVf3jXHjuG9SHB5MWdC8Bf6+iN3 xaqkwSzL3nTRcEr0ptlcMFga9q+h0kB0Iw6C1QNV8cSbJfNfQeeTMDQ52ATilPHF wyp76ELt1fI2VmKYm1Psb8KPK+G8R/Q9AnieEBsu7vRAKgWQXICpud4nIRswf7aV TT2JIPOwcJLXFIvEEQw2UwgFTGvOzTmh2hXMyqppmO84eH9UXWMmF74ChM9MD3kC kXf3+0cj5Zob0ECM5C9mRMv/P0UFQODG85MpTXUha8t3PiaDPZc= =wEcN -----END PGP SIGNATURE----- --52rjheopj4bxjykl-- ------------=_1581717603-30546-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 9 Feb 2020 20:11:52 +0000 Received: from localhost ([127.0.0.1]:53247 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j0svo-00041M-Go for submit@debbugs.gnu.org; Sun, 09 Feb 2020 15:11:52 -0500 Received: from lists.gnu.org ([209.51.188.17]:36456) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j0svm-00041F-Lp for submit@debbugs.gnu.org; Sun, 09 Feb 2020 15:11:50 -0500 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 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,URIBL_BLOCKED autolearn=disabled version=3.3.2 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) X-Virus-Scanned: amavisd-new at choca.pics 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 To: guix-patches@gnu.org Subject: [PATCH] doc: Clarify documentation of guix environment --expose vs. Date: Sun, 09 Feb 2020 21:11:44 +0100 Message-ID: <87k14v34hr.fsf@cassou.me> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 80.67.172.235 X-Spam-Score: 0.2 (/) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.8 (/) --=-=-= 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 --=-=-=-- ------------=_1581717603-30546-1--