[PATCH] doc: Improve documentation on Substitute Server Authorization

DoneSubmitted by Damien Cassou.
Details
2 participants
  • Damien Cassou
  • Leo Famulari
Owner
unassigned
Severity
normal
D
D
Damien Cassou wrote on 4 Feb 2020 15:18
(address . guix-patches@gnu.org)
87y2tibfms.fsf@cassou.me
-- Damien Cassou
"Success is the ability to go from one failure to another withoutlosing enthusiasm." --Winston Churchill
From 5055c85f9accf11284223f824f9fd7d4456da308 Mon Sep 17 00:00:00 2001From: Damien Cassou <damien@cassou.me>Date: Tue, 4 Feb 2020 15:13:06 +0100Subject: [PATCH] doc: Improve documentation on Substitute Server Authorization
* doc/guix.texi (Substitute Server Authorization): Explain that this is theabsence of the .drv file extension that indicates a proper setup.--- doc/guix.texi | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Toggle diff (18 lines)diff --git a/doc/guix.texi b/doc/guix.texiindex 956c25ba9e..36c2437d96 100644--- a/doc/guix.texi+++ b/doc/guix.texi@@ -3292,8 +3292,9 @@ $ guix build emacs --dry-run @end example @noindent-This indicates that substitutes from @code{@value{SUBSTITUTE-SERVER}} are usable and-will be downloaded, when possible, for future builds.+The absence of the @file{.drv} file extension indicates that substitutes+from @code{@value{SUBSTITUTE-SERVER}} are usable and will be downloaded,+when possible, for future builds. @cindex substitutes, how to disable The substitute mechanism can be disabled globally by running-- 2.24.1
L
L
Leo Famulari wrote on 5 Feb 2020 01:42
(name . Damien Cassou)(address . damien@cassou.me)(address . 39418@debbugs.gnu.org)
20200205004242.GD30681@jasmine.lan
On Tue, Feb 04, 2020 at 03:18:03PM +0100, Damien Cassou wrote:
Toggle quote (9 lines)> * doc/guix.texi (Substitute Server Authorization): Explain that this is the> absence of the .drv file extension that indicates a proper setup.
> -This indicates that substitutes from @code{@value{SUBSTITUTE-SERVER}} are usable and> -will be downloaded, when possible, for future builds.> +The absence of the @file{.drv} file extension indicates that substitutes> +from @code{@value{SUBSTITUTE-SERVER}} are usable and will be downloaded,> +when possible, for future builds.
The text "would be downloaded" is what indicates that substitutes areworking.
It's in contrast to the text from the previous example "The followingderivations would be built".
D
D
Damien Cassou wrote on 5 Feb 2020 11:31
(name . Leo Famulari)(address . leo@famulari.name)(address . 39418@debbugs.gnu.org)
87a75xgwb8.fsf@cassou.me
Leo Famulari <leo@famulari.name> writes:
Toggle quote (4 lines)> On Tue, Feb 04, 2020 at 03:18:03PM +0100, Damien Cassou wrote:> The text "would be downloaded" is what indicates that substitutes are> working.
I didn't notice this difference :-). It seems pretty obvious now. Istill think making it explicit would improve understanding. Here is amodified patch. You may close the issue if you think no change isnecessary.
-- Damien Cassou
"Success is the ability to go from one failure to another withoutlosing enthusiasm." --Winston Churchill
From 8642c07f2a31c77cc84c70fd31b20f78515bf934 Mon Sep 17 00:00:00 2001From: Damien Cassou <damien@cassou.me>Date: Tue, 4 Feb 2020 15:13:06 +0100Subject: [PATCH] doc: Improve documentation on Substitute Server Authorization
* doc/guix.texi (Substitute Server Authorization): Explain that this is theabsence of the .drv file extension that indicates a proper setup.--- doc/guix.texi | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
Toggle diff (19 lines)diff --git a/doc/guix.texi b/doc/guix.texiindex 956c25ba9e..5b325642db 100644--- a/doc/guix.texi+++ b/doc/guix.texi@@ -3292,8 +3292,10 @@ $ guix build emacs --dry-run @end example @noindent-This indicates that substitutes from @code{@value{SUBSTITUTE-SERVER}} are usable and-will be downloaded, when possible, for future builds.+Please note that the introductory text changed from ``The following+derivations would be built'' to ``112.3 MB would be downloaded''. This+indicates that substitutes from @code{@value{SUBSTITUTE-SERVER}} are+usable and will be downloaded, when possible, for future builds. @cindex substitutes, how to disable The substitute mechanism can be disabled globally by running-- 2.24.1
L
L
Leo Famulari wrote on 5 Feb 2020 21:14
(name . Damien Cassou)(address . damien@cassou.me)(address . 39418-done@debbugs.gnu.org)
20200205201437.GA6380@jasmine.lan
On Wed, Feb 05, 2020 at 11:31:07AM +0100, Damien Cassou wrote:
Toggle quote (7 lines)> -This indicates that substitutes from @code{@value{SUBSTITUTE-SERVER}} are usable and> -will be downloaded, when possible, for future builds.> +Please note that the introductory text changed from ``The following> +derivations would be built'' to ``112.3 MB would be downloaded''. This> +indicates that substitutes from @code{@value{SUBSTITUTE-SERVER}} are> +usable and will be downloaded, when possible, for future builds.
Thanks! I simplified the text a bit and pushed asea9cc4ef219e62de569945816a5e666775e7fa41
Closed
?
Your comment

This issue is archived.

To comment on this conversation send email to 39418@debbugs.gnu.org