01/06: services: avahi: Deprecate the 'avahi-service' procedure.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit 2e04ab7147948b51d4e437ca9ba910530ac2a788
Author: Ludovic Courtès <address@hidden>
Date:   Wed Jan 16 11:18:34 2019 +0100

    services: avahi: Deprecate the 'avahi-service' procedure.
    
    * gnu/services/avahi.scm (<avahi-configuration>): Export getters.  Add
    default values.
    (avahi-service-type)[default-value]: New field.
    (avahi-service): Mark as deprecated.
    * gnu/services/desktop.scm (%desktop-services): Use the 'service' form
    instead of calling 'avahi-service'.
    * gnu/tests/base.scm (%avahi-os): Likewise.
    * doc/guix.texi (Base Services): Adjust example accordingly.
    (Networking Services): Update accordingly.
---
 doc/guix.texi            | 71 ++++++++++++++++++++++++++++++++----------------
 gnu/services/avahi.scm   | 52 ++++++++++++++++++++++++-----------
 gnu/services/desktop.scm |  4 +--
 gnu/tests/base.scm       |  3 +-
 4 files changed, 88 insertions(+), 42 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 2039ff6..1cdf99d 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10848,7 +10848,9 @@ system, you will want to append services to 
@var{%base-services}, like
 this:
 
 @example
-(cons* (avahi-service) (lsh-service) %base-services)
+(cons* (service avahi-service-type)
+       (service openssh-service-type)
+       %base-services)
 @end example
 @end defvr
 
@@ -12709,31 +12711,54 @@ browsers, from accessing Facebook.
 
 The @code{(gnu services avahi)} provides the following definition.
 
address@hidden {Scheme Procedure} avahi-service [#:avahi @var{avahi}] @
-          [#:host-name #f] [#:publish? #t] [#:ipv4? #t] @
-          [#:ipv6? #t] [#:wide-area? #f] @
-          [#:domains-to-browse '()] [#:debug? #f]
-Return a service that runs @command{avahi-daemon}, a system-wide
address@hidden {Scheme Variable} avahi-service-type
+This is the service that runs @command{avahi-daemon}, a system-wide
 mDNS/DNS-SD responder that allows for service discovery and
-"zero-configuration" host name lookups (see @uref{http://avahi.org/}), and
-extends the name service cache daemon (nscd) so that it can resolve
address@hidden host names using
address@hidden://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}.  
Additionally,
-add the @var{avahi} package to the system profile so that commands such as
address@hidden are directly usable.
-
-If @var{host-name} is different from @code{#f}, use that as the host name to
+``zero-configuration'' host name lookups (see @uref{http://avahi.org/}).
+Its value must be a @code{zero-configuration} record---see below.
+
+This service extends the name service cache daemon (nscd) so that it can
+resolve @code{.local} host names using
address@hidden://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}.  @xref{Name
+Service Switch}, for information on host name resolution.
+
+Additionally, add the @var{avahi} package to the system profile so that
+commands such as @command{avahi-browse} are directly usable.
address@hidden defvr
+
address@hidden {Data Type} avahi-configuration
+Data type representation the configuration for Avahi.
+
address@hidden @asis
+
address@hidden @code{host-name} (default: @code{#f})
+If different from @code{#f}, use that as the host name to
 publish for this machine; otherwise, use the machine's actual host name.
 
-When @var{publish?} is true, publishing of host names and services is allowed;
-in particular, avahi-daemon will publish the machine's host name and IP
-address via mDNS on the local network.
address@hidden @code{publish?} (default: @code{#t})
+When true, allow host names and services to be published (broadcast) over the
+network.
 
-When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled.
address@hidden @code{publish-workstation?} (default: @code{#t})
+When true, @command{avahi-daemon} publishes the machine's host name and IP
+address via mDNS on the local network.  To view the host names published on
+your local network, you can run:
 
-Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use IPv4/IPv6
-sockets.
address@hidden deffn
address@hidden
+avahi-browse _workstation._tcp
address@hidden example
+
address@hidden @code{wide-area?} (default: @code{#f})
+When true, DNS-SD over unicast DNS is enabled.
+
address@hidden @code{ipv4?} (default: @code{#t})
address@hidden @code{ipv6?} (default: @code{#t})
+These fields determine whether to use IPv4/IPv6 sockets.
+
address@hidden @code{domains-to-browse} (default: @code{'()})
+This is a list of domains to browse.
address@hidden table
address@hidden deftp
 
 @deffn {Scheme Variable} openvswitch-service-type
 This is the type of the @uref{http://www.openvswitch.org, Open vSwitch}
@@ -22303,8 +22328,8 @@ want is to have @code{.local} host lookup working.
 
 Note that, in this case, in addition to setting the
 @code{name-service-switch} of the @code{operating-system} declaration,
-you also need to use @code{avahi-service} (@pxref{Networking Services,
address@hidden), or @var{%desktop-services}, which includes it
+you also need to use @code{avahi-service-type} (@pxref{Networking Services,
address@hidden), or @var{%desktop-services}, which includes it
 (@pxref{Desktop Services}).  Doing this makes @code{nss-mdns} accessible
 to the name service cache daemon (@pxref{Base Services,
 @code{nscd-service}}).
diff --git a/gnu/services/avahi.scm b/gnu/services/avahi.scm
index 5de30ff..547d826 100644
--- a/gnu/services/avahi.scm
+++ b/gnu/services/avahi.scm
@@ -1,5 +1,5 @@
 ;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014, 2015, 2016, 2017, 2018 Ludovic Courtès <address@hidden>
+;;; Copyright © 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès 
<address@hidden>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -24,9 +24,22 @@
   #:use-module (gnu system shadow)
   #:use-module (gnu packages avahi)
   #:use-module (gnu packages admin)
+  #:use-module (guix deprecation)
   #:use-module (guix records)
   #:use-module (guix gexp)
   #:export (avahi-configuration
+            avahi-configuration?
+
+            avahi-configuration-avahi
+            avahi-configuration-debug?
+            avahi-configuration-host-name
+            avahi-configuration-publish?
+            avahi-configuration-publish-workstation?
+            avahi-configuration-ipv4?
+            avahi-configuration-ipv6?
+            avahi-configuration-wide-area?
+            avahi-configuration-domains-to-browse
+
             avahi-service
             avahi-service-type))
 
@@ -37,7 +50,6 @@
 ;;;
 ;;; Code:
 
-  ;; TODO: Export.
 (define-record-type* <avahi-configuration>
   avahi-configuration make-avahi-configuration
   avahi-configuration?
@@ -45,18 +57,24 @@
                      (default avahi))
   (debug?            avahi-configuration-debug?   ;Boolean
                      (default #f))
-  (host-name         avahi-configuration-host-name) ;string
-  (publish?          avahi-configuration-publish?)  ;Boolean
+  (host-name         avahi-configuration-host-name ;string | #f
+                     (default #f))
+  (publish?          avahi-configuration-publish? ;boolean
+                     (default #t))
 
   ;; The default for this was #t in Avahi 0.6.31 and became #f in 0.7.  For
   ;; now we stick to the old default.
   (publish-workstation? avahi-configuration-publish-workstation? ;Boolean
                         (default #t))
 
-  (ipv4?             avahi-configuration-ipv4?)     ;Boolean
-  (ipv6?             avahi-configuration-ipv6?)     ;Boolean
-  (wide-area?        avahi-configuration-wide-area?) ;Boolean
-  (domains-to-browse avahi-configuration-domains-to-browse)) ;list of strings
+  (ipv4?             avahi-configuration-ipv4?    ;Boolean
+                     (default #t))
+  (ipv6?             avahi-configuration-ipv6?    ;Boolean
+                     (default #t))
+  (wide-area?        avahi-configuration-wide-area? ;Boolean
+                     (default #f))
+  (domains-to-browse avahi-configuration-domains-to-browse ;list of strings
+                     (default '())))
 
 (define* (configuration-file config)
   "Return an avahi-daemon configuration file based on CONFIG, an
@@ -145,14 +163,16 @@ service switch (NSS) with support for @code{.local} host 
name resolution.")
                          ;; Provide 'avahi-browse', 'avahi-resolve', etc. in
                          ;; the system profile.
                          (service-extension profile-service-type
-                                            avahi-package))))))
-
-(define* (avahi-service #:key (avahi avahi) debug?
-                        host-name
-                        (publish? #t)
-                        (ipv4? #t) (ipv6? #t)
-                        wide-area?
-                        (domains-to-browse '()))
+                                            avahi-package)))
+                  (default-value (avahi-configuration)))))
+
+(define-deprecated (avahi-service #:key (avahi avahi) debug?
+                                  host-name
+                                  (publish? #t)
+                                  (ipv4? #t) (ipv6? #t)
+                                  wide-area?
+                                  (domains-to-browse '()))
+  avahi-service-type
   "Return a service that runs @command{avahi-daemon}, a system-wide
 mDNS/DNS-SD responder that allows for service discovery and
 \"zero-configuration\" host name lookups (see @uref{http://avahi.org/}), and
diff --git a/gnu/services/desktop.scm b/gnu/services/desktop.scm
index 47d1096..2d5e900 100644
--- a/gnu/services/desktop.scm
+++ b/gnu/services/desktop.scm
@@ -1,5 +1,5 @@
 ;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014, 2015, 2016, 2017, 2018 Ludovic Courtès <address@hidden>
+;;; Copyright © 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès 
<address@hidden>
 ;;; Copyright © 2015 Andy Wingo <address@hidden>
 ;;; Copyright © 2015 Mark H Weaver <address@hidden>
 ;;; Copyright © 2016 Sou Bunnbu <address@hidden>
@@ -986,7 +986,7 @@ as expected.")))
          ;; The D-Bus clique.
          (service network-manager-service-type)
          (service wpa-supplicant-service-type)    ;needed by NetworkManager
-         (avahi-service)
+         (service avahi-service-type)
          (udisks-service)
          (upower-service)
          (accountsservice-service)
diff --git a/gnu/tests/base.scm b/gnu/tests/base.scm
index 2b20aac..0f8fb7f 100644
--- a/gnu/tests/base.scm
+++ b/gnu/tests/base.scm
@@ -706,7 +706,8 @@ non-ASCII names from /tmp.")
   (operating-system
     (inherit %simple-os)
     (name-service-switch %mdns-host-lookup-nss)
-    (services (cons* (avahi-service #:debug? #t)
+    (services (cons* (service avahi-service-type
+                              (avahi-configuration (debug? #t)))
                      (dbus-service)
                      (service dhcp-client-service-type) ;needed for multicast