services: Add a description and location for each service type.

* gnu/services.scm (<service-type>)[description, location]: New field.
* doc/guix.texi (Service Types and Services): Document 'description'.
master
Ludovic Courtès 2017-09-13 16:01:36 +02:00
parent c7ae219e39
commit b714395a39
No known key found for this signature in database
GPG Key ID: 090B11993D9AEBB5
2 changed files with 16 additions and 1 deletions

View File

@ -18020,6 +18020,10 @@ Udev extensions are composed into a list of rules, but the udev service
value is itself a @code{<udev-configuration>} record. So here, we
extend that record by appending the list of rules it contains to the
list of contributed rules.
@item description
This is a string giving an overview of the service type. The string can
contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}).
@end table
There can be only one instance of an extensible service type such as

View File

@ -49,6 +49,9 @@
service-type-compose
service-type-extend
service-type-default-value
service-type-description
service-type-location
service
service?
@ -145,7 +148,15 @@
;; Optional default value for instances of this type.
(default-value service-type-default-value ;Any
(default &no-default-value)))
(default &no-default-value))
;; Meta-data.
(description service-type-description ;string
(default #f))
(location service-type-location ;<location>
(default (and=> (current-source-location)
source-properties->location))
(innate)))
(define (write-service-type type port)
(format port "#<service-type ~a ~a>"