diff options
author | Ludovic Courtès <ludo@gnu.org> | 2020-08-28 10:01:44 +0200 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2020-08-28 23:27:53 +0200 |
commit | b6308409206af78356ea7d1b2c4613ca1ee4315c (patch) | |
tree | 9456f9a1243167ed6dbdb9ffd896b83abbdb0e11 /doc | |
parent | be1c00ae3c3dc7086ada05f34c36e85adb839038 (diff) | |
download | guix-b6308409206af78356ea7d1b2c4613ca1ee4315c.tar.gz |
doc: Document the 'description' and 'default-value' of <service-type>.
* doc/guix.texi (Service Reference): Document the 'description' and 'default-value' fields of <service-type>.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guix.texi | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 0b79a49814..6206a93857 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -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. |