diff mbox series

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

Message ID 87y2tibfms.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. 4, 2020, 2:18 p.m. UTC

Comments

Leo Famulari Feb. 5, 2020, 12:42 a.m. UTC | #1
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".
diff mbox series

Patch

From 5055c85f9accf11284223f824f9fd7d4456da308 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 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

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