[no subject]

[Ludovic Courtès]

branch: master
commit d2ba893a3976b43a7c8ecc15164fd9d1ba8aaf3b
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Mon Jun 26 23:15:50 2023 +0200

    doc: Document '--build-remote'.
    
    * doc/cuirass.texi (Invoking cuirass register): Document
    '--build-remote'.
    (Invoking cuirass remote-server): Mention it.
---
 doc/cuirass.texi | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/doc/cuirass.texi b/doc/cuirass.texi
index 1949ee4..6b34049 100644
--- a/doc/cuirass.texi
+++ b/doc/cuirass.texi
@@ -518,6 +518,17 @@ build results. Since Cuirass uses PostgreSQL as a database 
engine,
 host=localhost"}.  By default, Cuirass uses the following connection
 string: @code{dbname=cuirass host=/var/run/postgresql"}.
 
+@cindex remote builds
+@cindex build offloading
+@item --build-remote
+Use the @dfn{remote build mechanism}, whereby build distribution is
+handled by a separate @command{cuirass remote-server} process (see
+below).  This option can increase throughput and resilience when
+distributing builds to a large number of build machines.
+
+When this option is omitted, builds are started using the ``normal''
+Guix way, by asking @command{guix-daemon} to build them.
+
 @item --parameters=@var{parameters-file}
 @itemx -P @var{parameters-file}
 Read parameters from the given @var{parameters-file}.  The supported
@@ -603,10 +614,13 @@ Display an help message that summarize all the options 
provided.
 @section Invoking cuirass remote-server
 @cindex remote-server
 
+@cindex build offloading
+@cindex remote builds
 The @code{remote-server} command starts a daemon that is able to
-communicate with @code{remote-worker} processes.  Its role is to
-answer build requests from the workers, by sending back derivations
-that must be built.
+communicate with @code{remote-worker} processes; it is used in
+conjunction with @command{cuirass register --build-remote} (see above).
+Its role is to answer build requests from the workers, by sending back
+derivations that must be built.
 
 On build completion it updates the database accordingly and possibly
 fetches build substitutes.  The @code{remote-server} and