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

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit b6308409206af78356ea7d1b2c4613ca1ee4315c
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Fri Aug 28 10:01:44 2020 +0200

    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>.
---
 doc/guix.texi | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index 0b79a49..6206a93 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.