futurile/guix-play
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Document the 'description' and 'default-value' of <service-type>.

Browse Source 
* doc/guix.texi (Service Reference): Document the 'description' and
'default-value' fields of <service-type>.
This commit is contained in:
Ludovic Courtès 2020-08-28 10:01:44 +02:00
parent be1c00ae3c
commit b630840920
No known key found for this signature in database
GPG Key ID: 090B11993D9AEBB5
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/guix.texi
View File

@ -29770,6 +29770,23 @@ calls it, passing it the initial value of the service as the first
argument and the result of applying @code{compose} to the extension
values as the second argument. It must return a value that is a valid
parameter value for the service instance.
@item @code{description}
This is a string, possibly using Texinfo markup, describing in a couple
of sentences what the service is about. This string allows users to
find about the service through @command{guix system search}
(@pxref{Invoking guix system}).
@item @code{default-value} (default: @code{&no-default-value})
The default value associated for instances of this service type. This
allows users to use the @code{service} form without its second argument:
@lisp
(service @var{type})
@end lisp
The returned service in this case has the default value specified by
@var{type}.
@end table
@xref{Service Types and Services}, for examples.