summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2013-11-07 21:57:53 +0100
committerLudovic Courtès <ludo@gnu.org>2013-11-07 22:17:15 +0100
commitb5385b528cd4b2674e0c656ea99d7ecd81ffe41d (patch)
tree058667321370d224b2ce70bc7837ad3e7fd5755d /doc
parentda95c8170aaa24a91cf0db35ff4db7ac7c2136f6 (diff)
downloadgnu-guix-b5385b528cd4b2674e0c656ea99d7ecd81ffe41d.tar
gnu-guix-b5385b528cd4b2674e0c656ea99d7ecd81ffe41d.tar.gz
doc: Improve documentation of '--no-substitutes'.
Suggested by Mark H. Weaver <mhw@netris.org>. * doc/guix.texi (Invoking guix package): Spell out the --no-substitutes documentation. (Invoking guix build): Use the more complete --no-substitutes documentation. (Invoking guix-daemon): Explain the interaction with what clients ask for.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi17
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 79aa71a993..64b18b4416 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -288,9 +288,18 @@ Take users from @var{group} to run build processes (@pxref{Setting Up
the Daemon, build users}).
@item --no-substitutes
+@cindex substitutes
Do not use substitutes for build products. That is, always build things
locally instead of allowing downloads of pre-built binaries.
+By default substitutes are used, unless the client---such as the
+@command{guix package} command---is explicitly invoked with
+@code{--no-substitutes}.
+
+When the daemon runs with @code{--no-substitutes}, clients can still
+explicitly enable substitution @i{via} the @code{set-build-options}
+remote procedure call (@pxref{The Store}).
+
@item --cache-failures
Cache build failures. By default, only successful builds are cached.
@@ -598,7 +607,10 @@ When substituting a pre-built binary fails, fall back to building
packages locally.
@item --no-substitutes
-@itemx --max-silent-time=@var{seconds}
+Do not use substitutes for build products. That is, always build things
+locally instead of allowing downloads of pre-built binaries.
+
+@item --max-silent-time=@var{seconds}
Same as for @command{guix build} (@pxref{Invoking guix build}).
@item --verbose
@@ -1495,7 +1507,8 @@ When substituting a pre-built binary fails, fall back to building
packages locally.
@item --no-substitutes
-Build instead of resorting to pre-built substitutes.
+Do not use substitutes for build products. That is, always build things
+locally instead of allowing downloads of pre-built binaries.
@item --max-silent-time=@var{seconds}
When the build or substitution process remains silent for more than