me/guix
Archived
1
0
Fork 0
Code Activity

doc: Use @deftp for 'build-machine'.

Browse source 
* doc/guix.texi (Daemon Offload Setup): Use @deftp for 'build-machine'.
This commit is contained in:
Ludovic Courtès 2014-10-10 09:34:38 +02:00
parent 7239828d29
commit c678a4eef6
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/guix.texi
View file

@ -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 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 DNS-SD to return a list of potential build machines discovered in the
local network (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using 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 @table @code
@ -345,7 +348,7 @@ The compulsory fields for a @code{build-machine} declaration are:
The remote machine's host name. The remote machine's host name.
@item system @item system
The remote machine's system type. The remote machine's system type---e.g., @code{"x86_64-linux"}.
@item user @item user
The user account to use when connecting to the remote machine over SSH. The user account to use when connecting to the remote machine over SSH.
@ -354,7 +357,6 @@ allow non-interactive logins.
@end table @end table
@noindent
A number of optional fields may be specified: A number of optional fields may be specified:
@table @code @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. name, and they will be scheduled on matching build machines.
@end table @end table
@end deftp
The @code{guix} command must be in the search path on the build The @code{guix} command must be in the search path on the build
machines, since offloading works by invoking the @code{guix archive} and machines, since offloading works by invoking the @code{guix archive} and