diff mbox series

[bug#39418] doc: Improve documentation on Substitute Server Authorization

Message ID 87a75xgwb8.fsf@cassou.me
State Accepted
Headers show
Series [bug#39418] doc: Improve documentation on Substitute Server Authorization | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch fail View Laminar job

Commit Message

Damien Cassou Feb. 5, 2020, 10:31 a.m. UTC 
Leo Famulari <leo@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.

Comments

Leo Famulari Feb. 5, 2020, 8:14 p.m. UTC | #1 
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
diff mbox series

Patch

From 8642c07f2a31c77cc84c70fd31b20f78515bf934 Mon Sep 17 00:00:00 2001
From: Damien Cassou <damien@cassou.me>
Date: Tue, 4 Feb 2020 15:13:06 +0100
Subject: [PATCH] doc: Improve documentation on Substitute Server Authorization

* doc/guix.texi (Substitute Server Authorization): Explain that this is the
absence of the .drv file extension that indicates a proper setup.
---
 doc/guix.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 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