aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2014-10-10 09:34:38 +0200
committerLudovic Courtès <ludo@gnu.org>2014-10-10 14:08:59 +0200
commitc678a4eef668b0e64f4700ce3efb59ef62c8d644 (patch)
tree61064d61ee4c6f74f3851b1f9f37200141169233
parent7239828d29613aafb31295c4836d3cf363b3458c (diff)
downloadpatches-c678a4eef668b0e64f4700ce3efb59ef62c8d644.tar
patches-c678a4eef668b0e64f4700ce3efb59ef62c8d644.tar.gz
doc: Use @deftp for 'build-machine'.
* doc/guix.texi (Daemon Offload Setup): Use @deftp for 'build-machine'.
-rw-r--r--doc/guix.texi11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 5881adb221..c9aae24249 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -335,9 +335,12 @@ must be a list of @code{build-machine} objects. While this example
shows a fixed list of build machines, one could imagine, say, using
DNS-SD to return a list of potential build machines discovered in the
local network (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using
-Avahi in Guile Scheme Programs}).
+Avahi in Guile Scheme Programs}). The @code{build-machine} data type is
+detailed below.
-The compulsory fields for a @code{build-machine} declaration are:
+@deftp {Data Type} build-machine
+This data type represents build machines the daemon may offload builds
+to. The important fields are:
@table @code
@@ -345,7 +348,7 @@ The compulsory fields for a @code{build-machine} declaration are:
The remote machine's host name.
@item system
-The remote machine's system type.
+The remote machine's system type---e.g., @code{"x86_64-linux"}.
@item user
The user account to use when connecting to the remote machine over SSH.
@@ -354,7 +357,6 @@ allow non-interactive logins.
@end table
-@noindent
A number of optional fields may be specified:
@table @code
@@ -380,6 +382,7 @@ and corresponding hardware support. Derivations can request features by
name, and they will be scheduled on matching build machines.
@end table
+@end deftp
The @code{guix} command must be in the search path on the build
machines, since offloading works by invoking the @code{guix archive} and