GNU bug report logs - #39418
[PATCH] doc: Improve documentation on Substitute Server Authorization

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 39418 in the body.
You can then email your comments to 39418 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: guix-patches <at> gnu.org
Subject: [PATCH] doc: Improve documentation on Substitute Server Authorization
Date: Tue, 04 Feb 2020 15:18:03 +0100

[Message part 1 (text/plain, inline)]

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0001-doc-Improve-documentation-on-Substitute-Server-Autho.patch (text/x-patch, attachment)]

Message #8 received at 39418 <at> debbugs.gnu.org (full text, mbox):

From: Leo Famulari <leo <at> famulari.name>
To: Damien Cassou <damien <at> cassou.me>
Cc: 39418 <at> debbugs.gnu.org
Subject: Re: [bug#39418] [PATCH] doc: Improve documentation on Substitute
 Server Authorization
Date: Tue, 4 Feb 2020 19:42:42 -0500

On Tue, Feb 04, 2020 at 03:18:03PM +0100, Damien Cassou wrote:
> * 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 are
working.

It's in contrast to the text from the previous example "The following
derivations would be built".

Message #11 received at 39418 <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Leo Famulari <leo <at> famulari.name>
Cc: 39418 <at> debbugs.gnu.org
Subject: Re: [bug#39418] [PATCH] doc: Improve documentation on Substitute
 Server Authorization
Date: Wed, 05 Feb 2020 11:31:07 +0100

[Message part 1 (text/plain, inline)]

Leo Famulari <leo <at> famulari.name> writes:
> 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. I
still think making it explicit would improve understanding. Here is a
modified patch. You may close the issue if you think no change is
necessary.

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0001-doc-Improve-documentation-on-Substitute-Server-Autho.patch (text/x-patch, attachment)]

Message #16 received at 39418-done <at> debbugs.gnu.org (full text, mbox):

From: Leo Famulari <leo <at> famulari.name>
To: Damien Cassou <damien <at> cassou.me>
Cc: 39418-done <at> debbugs.gnu.org
Subject: Re: [bug#39418] [PATCH] doc: Improve documentation on Substitute
 Server Authorization
Date: Wed, 5 Feb 2020 15:14:37 -0500

On Wed, Feb 05, 2020 at 11:31:07AM +0100, Damien Cassou wrote:
> -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 as
ea9cc4ef219e62de569945816a5e666775e7fa41

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.