GNU bug report logs - #54674
[PATCH] services: configuration: Use *unspecified* instead of 'disabled.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 54674 in the body.
You can then email your comments to 54674 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: guix-patches <at> gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH] services: configuration: Use *unspecified* instead of
 'disabled.
Date: Fri,  1 Apr 2022 21:19:58 +0200

...as a marker for field values that have not been set. Rationale: 'disabled
may easily clash with user values for boolean fields, is confusing (i.e. its
meaning is *not* boolean false, bug unspecified) and it also passes through
silently the symbol? predicate of a field of type symbol.

Relax the syntax to accept (field1 (maybe-string) "") forms, in which case it
uses *unspecified* as default value.

Possible future improvement: also accept (field1 maybe-string "") forms,
i.e. without the extra parens around maybe types without defaults.

* gnu/services/configuration.scm (configuration-missing-default-value):
Renamed from configuration-no-default-value.
* gnu/services/configuration.scm (define-maybe-helper): Use *unspecified*
instead of 'disabled, and make the default value optional.
---

i could not test every service that uses define-configuration, but i did
reconfigure my server with this commit, and i have adapted and tested my
swarm service code with it, too.

take it as a request for comments, but it may very well be of good
enough quality for inclusion.

the reason i didn't do the (field1 maybe-string "") syntax *i.e. no
parens around maybe-string), is that i couldn't convince the hygienic
macro system about it.

 gnu/home/services/desktop.scm    | 12 ++---
 gnu/services/authentication.scm  | 82 ++++++++++++++++----------------
 gnu/services/cgit.scm            | 12 ++---
 gnu/services/configuration.scm   | 16 +++----
 gnu/services/file-sharing.scm    | 24 +++++-----
 gnu/services/messaging.scm       | 37 +++++++-------
 gnu/services/networking.scm      | 12 ++---
 gnu/services/pm.scm              | 54 ++++++++++-----------
 gnu/services/telephony.scm       | 14 +++---
 gnu/services/vpn.scm             |  2 +-
 tests/services/configuration.scm | 12 +++++
 11 files changed, 143 insertions(+), 134 deletions(-)

diff --git a/gnu/home/services/desktop.scm b/gnu/home/services/desktop.scm
index cbb9cf76da..a54ad0d115 100644
--- a/gnu/home/services/desktop.scm
+++ b/gnu/home/services/desktop.scm
@@ -91,26 +91,26 @@ (define-configuration home-redshift-configuration
    "Nighttime color temperature (kelvins).")
 
   (daytime-brightness
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Daytime screen brightness, between 0.1 and 1.0.")
   (nighttime-brightness
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Nighttime screen brightness, between 0.1 and 1.0.")
 
   (latitude
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Latitude, when @code{location-provider} is @code{'manual}.")
   (longitude
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Longitude, when @code{location-provider} is @code{'manual}.")
 
   (dawn-time
-   (maybe-string 'disabled)
+   (maybe-string)
    "Custom time for the transition from night to day in the
 morning---@code{\"HH:MM\"} format.  When specified, solar elevation is not
 used to determine the daytime/nighttime period.")
   (dusk-time
-   (maybe-string 'disabled)
+   (maybe-string)
    "Likewise, custom time for the transition from day to night in the
 evening.")
 
diff --git a/gnu/services/authentication.scm b/gnu/services/authentication.scm
index cb0ef6d85a..1c4800bfbd 100644
--- a/gnu/services/authentication.scm
+++ b/gnu/services/authentication.scm
@@ -218,7 +218,7 @@ (define-configuration nslcd-configuration
 
   ;; Runtime options
   (threads
-   (maybe-number 'disabled)
+   (maybe-number)
    "The number of threads to start that can handle requests and perform LDAP
 queries.  Each thread opens a separate connection to the LDAP server.  The
 default is to start 5 threads.")
@@ -243,45 +243,45 @@ (define-configuration nslcd-configuration
    "The list of LDAP server URIs.  Normally, only the first server will be
 used with the following servers as fall-back.")
   (ldap-version
-   (maybe-string 'disabled)
+   (maybe-string)
    "The version of the LDAP protocol to use.  The default is to use the
 maximum version supported by the LDAP library.")
   (binddn
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the distinguished name with which to bind to the directory
 server for lookups.  The default is to bind anonymously.")
   (bindpw
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the credentials with which to bind.  This option is only
 applicable when used with binddn.")
   (rootpwmoddn
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the distinguished name to use when the root user tries to modify
 a user's password using the PAM module.")
   (rootpwmodpw
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the credentials with which to bind if the root user tries to
 change a user's password.  This option is only applicable when used with
 rootpwmoddn")
 
   ;; SASL authentication options
   (sasl-mech
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the SASL mechanism to be used when performing SASL
 authentication.")
   (sasl-realm
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the SASL realm to be used when performing SASL authentication.")
   (sasl-authcid
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the authentication identity to be used when performing SASL
 authentication.")
   (sasl-authzid
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the authorization identity to be used when performing SASL
 authentication.")
   (sasl-canonicalize?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Determines whether the LDAP server host name should be canonicalised.  If
 this is enabled the LDAP library will do a reverse host name lookup.  By
 default, it is left up to the LDAP library whether this check is performed or
@@ -289,7 +289,7 @@ (define-configuration nslcd-configuration
 
   ;; Kerberos authentication options
   (krb5-ccname
-   (maybe-string 'disabled)
+   (maybe-string)
    "Set the name for the GSS-API Kerberos credentials cache.")
 
   ;; Search / mapping options
@@ -302,11 +302,11 @@ (define-configuration nslcd-configuration
 default scope is subtree; base scope is almost never useful for name service
 lookups; children scope is not supported on all servers.")
   (deref
-   (maybe-deref-option 'disabled)
+   (maybe-deref-option)
    "Specifies the policy for dereferencing aliases.  The default policy is to
 never dereference aliases.")
   (referrals
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Specifies whether automatic referral chasing should be enabled.  The
 default behaviour is to chase referrals.")
   (maps
@@ -322,132 +322,132 @@ (define-configuration nslcd-configuration
 
   ;; Timing / reconnect options
   (bind-timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time limit in seconds to use when connecting to the
 directory server.  The default value is 10 seconds.")
   (timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time limit (in seconds) to wait for a response from the LDAP
 server.  A value of zero, which is the default, is to wait indefinitely for
 searches to be completed.")
   (idle-timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the period if inactivity (in seconds) after which the con‐
 nection to the LDAP server will be closed.  The default is not to time out
 connections.")
   (reconnect-sleeptime
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the number of seconds to sleep when connecting to all LDAP
 servers fails.  By default one second is waited between the first failure and
 the first retry.")
   (reconnect-retrytime
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time after which the LDAP server is considered to be
 permanently unavailable.  Once this time is reached retries will be done only
 once per this time period.  The default value is 10 seconds.")
 
   ;; TLS options
   (ssl
-   (maybe-ssl-option 'disabled)
+   (maybe-ssl-option)
    "Specifies whether to use SSL/TLS or not (the default is not to).  If
 'start-tls is specified then StartTLS is used rather than raw LDAP over SSL.")
   (tls-reqcert
-   (maybe-tls-reqcert-option 'disabled)
+   (maybe-tls-reqcert-option)
    "Specifies what checks to perform on a server-supplied certificate.
 The meaning of the values is described in the ldap.conf(5) manual page.")
   (tls-cacertdir
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the directory containing X.509 certificates for peer authen‐
 tication.  This parameter is ignored when using GnuTLS.")
   (tls-cacertfile
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the X.509 certificate for peer authentication.")
   (tls-randfile
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to an entropy source.  This parameter is ignored when
 using GnuTLS.")
   (tls-ciphers
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the ciphers to use for TLS as a string.")
   (tls-cert
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the file containing the local certificate for client
 TLS authentication.")
   (tls-key
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the file containing the private key for client TLS
 authentication.")
 
   ;; Other options
   (pagesize
-   (maybe-number 'disabled)
+   (maybe-number)
    "Set this to a number greater than 0 to request paged results from the LDAP
 server in accordance with RFC2696.  The default (0) is to not request paged
 results.")
   (nss-initgroups-ignoreusers
-   (maybe-ignore-users-option 'disabled)
+   (maybe-ignore-users-option)
    "This option prevents group membership lookups through LDAP for the
 specified users.  Alternatively, the value 'all-local may be used.  With that
 value nslcd builds a full list of non-LDAP users on startup.")
   (nss-min-uid
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option ensures that LDAP users with a numeric user id lower than the
 specified value are ignored.")
   (nss-uid-offset
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option specifies an offset that is added to all LDAP numeric user
 ids.  This can be used to avoid user id collisions with local users.")
   (nss-gid-offset
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option specifies an offset that is added to all LDAP numeric group
 ids.  This can be used to avoid user id collisions with local groups.")
   (nss-nested-groups
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, the member attribute of a group may point to
 another group.  Members of nested groups are also returned in the higher level
 group and parent groups are returned when finding groups for a specific user.
 The default is not to perform extra searches for nested groups.")
   (nss-getgrent-skipmembers
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, the group member list is not retrieved when looking
 up groups.  Lookups for finding which groups a user belongs to will remain
 functional so the user will likely still get the correct groups assigned on
 login.")
   (nss-disable-enumeration
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, functions which cause all user/group entries to be
 loaded from the directory will not succeed in doing so.  This can dramatically
 reduce LDAP server load in situations where there are a great number of users
 and/or groups.  This option is not recommended for most configurations.")
   (validnames
-   (maybe-string 'disabled)
+   (maybe-string)
    "This option can be used to specify how user and group names are verified
 within the system.  This pattern is used to check all user and group names
 that are requested and returned from LDAP.")
   (ignorecase
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "This specifies whether or not to perform searches using case-insensitive
 matching.  Enabling this could open up the system to authorization bypass
 vulnerabilities and introduce nscd cache poisoning vulnerabilities which allow
 denial of service.")
   (pam-authc-ppolicy
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "This option specifies whether password policy controls are requested and
 handled from the LDAP server when performing user authentication.")
   (pam-authc-search
-   (maybe-string 'disabled)
+   (maybe-string)
    "By default nslcd performs an LDAP search with the user's credentials after
 BIND (authentication) to ensure that the BIND operation was successful.  The
 default search is a simple check to see if the user's DN exists.  A search
 filter can be specified that will be used instead.  It should return at least
 one entry.")
   (pam-authz-search
-   (maybe-string 'disabled)
+   (maybe-string)
    "This option allows flexible fine tuning of the authorisation check that
 should be performed.  The search filter specified is executed and if any
 entries match, access is granted, otherwise access is denied.")
   (pam-password-prohibit-message
-   (maybe-string 'disabled)
+   (maybe-string)
    "If this option is set password modification using pam_ldap will be denied
 and the specified message will be presented to the user instead.  The message
 can be used to direct the user to an alternative means of changing their
diff --git a/gnu/services/cgit.scm b/gnu/services/cgit.scm
index bfc89a40a4..bcb3e1a796 100644
--- a/gnu/services/cgit.scm
+++ b/gnu/services/cgit.scm
@@ -241,27 +241,27 @@ (define-configuration repository-cgit-configuration
    (repo-file-object "")
    "Override the default @code{email-filter}.")
   (enable-commit-graph?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-commit-graph?}.")
   (enable-log-filecount?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-log-filecount?}.")
   (enable-log-linecount?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-log-linecount?}.")
   (enable-remote-branches?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "Flag which, when set to @code{#t}, will make cgit display remote
 branches in the summary and refs views.")
   (enable-subject-links?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to override the global setting
 @code{enable-subject-links?}.")
   (enable-html-serving?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to override the global setting
 @code{enable-html-serving?}.")
   (hide?
diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index 0de350a4df..325ef6e0ac 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -92,7 +92,7 @@ (define (configuration-field-error field val)
 (define (configuration-missing-field kind field)
   (configuration-error
    (format #f "~a configuration missing required field ~a" kind field)))
-(define (configuration-no-default-value kind field)
+(define (configuration-missing-default-value kind field)
   (configuration-error
    (format #f "The field `~a' of the `~a' configuration record \
 does not have a default value" field kind)))
@@ -141,7 +141,8 @@ (define (define-maybe-helper serialize? prefix syn)
                                     (id #'stem #'serialize-maybe- #'stem))))
        #`(begin
            (define (maybe-stem? val)
-             (or (eq? val 'disabled) (stem? val)))
+             (or (unspecified? val)
+                 (stem? val)))
            #,@(if serialize?
                   (list #'(define (serialize-maybe-stem field-name val)
                             (if (stem? val)
@@ -178,9 +179,7 @@ (define (define-configuration-helper serialize? serializer-prefix syn)
     			   ((field-type default-value)
                             default-value)
     			   ((field-type)
-                            ;; Quote `undefined' to prevent a possibly
-                            ;; unbound warning.
-                            (syntax 'undefined)))
+                            (syntax *unspecified*)))
     			 #'((field-type def ...) ...)))
                    ((field-serializer ...)
                     (map (lambda (type custom-serializer)
@@ -206,7 +205,7 @@ (define-record-type* #,(id #'stem #'< #'stem #'>)
     					source-properties->location))
     			(innate))
     	     #,@(map (lambda (name getter def)
-    		       (if (eq? (syntax->datum def) (quote 'undefined))
+    		       (if (unspecified? (syntax->datum def))
     			   #`(#,name #,getter)
     			   #`(#,name #,getter (default #,def))))
     		     #'(field ...)
@@ -222,9 +221,8 @@ (define #,(id #'stem #'stem #'-fields)
     		    (default-value-thunk
     		      (lambda ()
     			(display '#,(id #'stem #'% #'stem))
-    			(if (eq? (syntax->datum field-default)
-    				 'undefined)
-    			    (configuration-no-default-value
+    			(if (unspecified? (syntax->datum field-default))
+    			    (configuration-missing-default-value
     			     '#,(id #'stem #'% #'stem) 'field)
     			    field-default)))
     		    (documentation doc))
diff --git a/gnu/services/file-sharing.scm b/gnu/services/file-sharing.scm
index e3d681b08f..6e71fa9154 100644
--- a/gnu/services/file-sharing.scm
+++ b/gnu/services/file-sharing.scm
@@ -115,8 +115,7 @@ (define-maybe string)
 (set! serialize-maybe-string
   (lambda (field-name val)
     (serialize-string field-name
-                      (if (and (symbol? val)
-                               (eq? val 'disabled))
+                      (if (unspecified? val)
                           ""
                           val))))
 
@@ -181,8 +180,7 @@ (define (serialize-file-object field-name val)
 (define-maybe file-object)
 (set! serialize-maybe-file-object
   (lambda (field-name val)
-    (if (and (symbol? val)
-             (eq? val 'disabled))
+    (if (unspecified? val)
         (serialize-string field-name "")
         (serialize-file-object field-name val))))
 
@@ -281,7 +279,7 @@ (define-configuration transmission-daemon-configuration
 torrent is complete.  Otherwise, files for all torrents (including those still
 being downloaded) will be placed in @code{download-dir}.")
   (incomplete-dir
-   (maybe-string 'disabled)
+   (maybe-string)
    "The directory in which files from incompletely downloaded torrents will be
 held when @code{incomplete-dir-enabled?} is @code{#t}.")
   (umask
@@ -305,7 +303,7 @@ (define-configuration transmission-daemon-configuration
 automatically (and the original files removed, if
 @code{trash-original-torrent-files?} is @code{#t}).")
   (watch-dir
-   (maybe-string 'disabled)
+   (maybe-string)
    "The directory to be watched for @file{.torrent} files indicating new
 torrents to be added, when @code{watch-dir-enabled} is @code{#t}.")
   (trash-original-torrent-files?
@@ -401,11 +399,11 @@ (define-configuration transmission-daemon-configuration
 @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or
 @code{require-encrypted-connections}.")
   (peer-congestion-algorithm
-   (maybe-string 'disabled)
+   (maybe-string)
    "The TCP congestion-control algorithm to use for peer connections,
 specified using a string recognized by the operating system in calls to
-@code{setsockopt} (or set to @code{disabled}, in which case the
-operating-system default is used).
+@code{setsockopt} (or leave it unset, in which case the operating-system
+default is used).
 
 Note that on GNU/Linux systems, the kernel must be configured to allow
 processes to use a congestion-control algorithm not in the default set;
@@ -465,7 +463,7 @@ (define-configuration transmission-daemon-configuration
    "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it
 has most recently downloaded from @code{blocklist-url}.")
   (blocklist-url
-   (maybe-string 'disabled)
+   (maybe-string)
    "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule
 @file{.dat} format) to be periodically downloaded and applied when
 @code{blocklist-enabled?} is @code{#t}.")
@@ -564,11 +562,11 @@ (define-configuration transmission-daemon-configuration
 the side effect of disabling host-name whitelisting (see
 @code{rpc-host-whitelist-enabled?}.")
   (rpc-username
-   (maybe-string 'disabled)
+   (maybe-string)
    "The username required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.")
   (rpc-password
-   (maybe-transmission-password-hash 'disabled)
+   (maybe-transmission-password-hash)
    "The password required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.  This must be specified
 using a password hash in the format recognized by Transmission clients, either
@@ -613,7 +611,7 @@ (define-configuration transmission-daemon-configuration
 @code{script-torrent-done-filename} will be invoked each time a torrent
 completes.")
   (script-torrent-done-filename
-   (maybe-file-object 'disabled)
+   (maybe-file-object)
    "A file name or file-like object specifying a script to run each time a
 torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}.")
   (scrape-paused-torrents-enabled?
diff --git a/gnu/services/messaging.scm b/gnu/services/messaging.scm
index 4bceb1d37a..5f20d768ef 100644
--- a/gnu/services/messaging.scm
+++ b/gnu/services/messaging.scm
@@ -72,6 +72,7 @@ (define (make-pred arg)
       (lambda (field target)
         (and (memq (syntax->datum target) `(common ,arg)) field)))
     (syntax-case stx ()
+      ;; TODO Also handle (field-type) form, without a default.
       ((_ stem (field (field-type def) doc target) ...)
        (with-syntax (((new-field-type ...)
                       (map (lambda (field-type target)
@@ -85,7 +86,7 @@ (define (make-pred arg)
                      ((new-def ...)
                       (map (lambda (def target)
                              (if (eq? 'common (syntax->datum target))
-                                 #''disabled def))
+                                 #'*unspecified* def))
                            #'(def ...) #'(target ...)))
                      ((new-doc ...)
                       (map (lambda (doc target)
@@ -195,7 +196,7 @@ (define (serialize-file-object-list field-name val)
 (define-maybe file-object-list)
 
 (define (raw-content? val)
-  (not (eq? val 'disabled)))
+  (not (unspecified? val)))
 (define (serialize-raw-content field-name val)
   val)
 (define-maybe raw-content)
@@ -223,15 +224,15 @@ (define-maybe mod-muc-configuration)
 
 (define-configuration ssl-configuration
   (protocol
-   (maybe-string 'disabled)
+   (maybe-string)
    "This determines what handshake to use.")
 
   (key
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "Path to your private key file.")
 
   (certificate
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "Path to your certificate file.")
 
   (capath
@@ -240,48 +241,48 @@ (define-configuration ssl-configuration
 trust when verifying the certificates of remote servers.")
 
   (cafile
-   (maybe-file-object 'disabled)
+   (maybe-file-object)
    "Path to a file containing root certificates that you wish Prosody to trust.
 Similar to @code{capath} but with all certificates concatenated together.")
 
   (verify
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of verification options (these mostly map to OpenSSL's
 @code{set_verify()} flags).")
 
   (options
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of general options relating to SSL/TLS.  These map to OpenSSL's
 @code{set_options()}.  For a full list of options available in LuaSec, see the
 LuaSec source.")
 
   (depth
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "How long a chain of certificate authorities to check when looking for a
 trusted root certificate.")
 
   (ciphers
-   (maybe-string 'disabled)
+   (maybe-string)
    "An OpenSSL cipher string.  This selects what ciphers Prosody will offer to
 clients, and in what order.")
 
   (dhparam
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "A path to a file containing parameters for Diffie-Hellman key exchange.  You
 can create such a file with:
 @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}")
 
   (curve
-   (maybe-string 'disabled)
+   (maybe-string)
    "Curve for Elliptic curve Diffie-Hellman. Prosody's default is
 @samp{\"secp384r1\"}.")
 
   (verifyext
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of \"extra\" verification options.")
 
   (password
-   (maybe-string 'disabled)
+   (maybe-string)
    "Password for encrypted private keys."))
 (define (serialize-ssl-configuration field-name val)
   #~(format #f "ssl = {\n~a};\n"
@@ -469,12 +470,12 @@ (define-all-configurations prosody-configuration
      global)
 
     (http-max-content-size
-     (maybe-non-negative-integer 'disabled)
+     (maybe-non-negative-integer *unspecified*)
      "Maximum allowed size of the HTTP body (in bytes)."
      common)
 
     (http-external-url
-     (maybe-string 'disabled)
+     (maybe-string *unspecified*)
      "Some modules expose their own URL in various ways.  This URL is built
 from the protocol, host and port used.  If Prosody sits behind a proxy, the
 public URL will be @code{http-external-url} instead.  See
@@ -551,7 +552,7 @@ (define-all-configurations prosody-configuration
      int-component)
 
     (mod-muc
-     (maybe-mod-muc-configuration 'disabled)
+     (maybe-mod-muc-configuration *unspecified*)
      "Multi-user chat (MUC) is Prosody's module for allowing you to create
 hosted chatrooms/conferences for XMPP users.
 
@@ -568,7 +569,7 @@ (define-all-configurations prosody-configuration
      ext-component)
 
     (raw-content
-     (maybe-raw-content 'disabled)
+     (maybe-raw-content *unspecified*)
      "Raw content that will be added to the configuration file."
      common)))
 
diff --git a/gnu/services/networking.scm b/gnu/services/networking.scm
index 5bb8638930..b5c46218e7 100644
--- a/gnu/services/networking.scm
+++ b/gnu/services/networking.scm
@@ -763,17 +763,17 @@ (define-configuration/no-serialization opendht-configuration
    "The node host name that is used to make the first connection to the
 network.  A specific port value can be provided by appending the @code{:PORT}
 suffix.  By default, it uses the Jami bootstrap nodes, but any host can be
-specified here.  It's also possible to disable bootstrapping by setting this
-to the @code{'disabled} symbol.")
+specified here.  It's also possible to disable bootstrapping by explicitly
+setting this field to the @code{*unspecified*} value.")
   (port
    (maybe-number 4222)
-   "The UDP port to bind to.  When set to @code{'disabled}, an available port
-is automatically selected.")
+   "The UDP port to bind to.  When set to @code{*unspecified*}, an available
+port is automatically selected.")
   (proxy-server-port
-   (maybe-number 'disabled)
+   (maybe-number)
    "Spawn a proxy server listening on the specified port.")
   (proxy-server-port-tls
-   (maybe-number 'disabled)
+   (maybe-number)
    "Spawn a proxy server listening to TLS connections on the specified
 port."))
 
diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index e48236dbca..d1250ab488 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -114,55 +114,55 @@ (define-configuration tlp-configuration
    "Same as @code{max-lost-work-secs-on-ac} but on BAT mode.")
 
   (cpu-scaling-governor-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "CPU frequency scaling governor on AC mode.  With intel_pstate
 driver, alternatives are powersave and performance.  With acpi-cpufreq driver,
 alternatives are ondemand, powersave, performance and conservative.")
 
   (cpu-scaling-governor-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode.")
 
   (cpu-scaling-min-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the min available frequency for the scaling governor on AC.")
 
   (cpu-scaling-max-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the max available frequency for the scaling governor on AC.")
 
   (cpu-scaling-min-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the min available frequency for the scaling governor on BAT.")
 
   (cpu-scaling-max-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the max available frequency for the scaling governor on BAT.")
 
   (cpu-min-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Limit the min P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-max-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Limit the max P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-min-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Same as @code{cpu-min-perf-on-ac} on BAT mode.")
 
   (cpu-max-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Same as @code{cpu-max-perf-on-ac} on BAT mode.")
 
   (cpu-boost-on-ac?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Enable CPU turbo boost feature on AC mode.")
 
   (cpu-boost-on-bat?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Same as @code{cpu-boost-on-ac?} on BAT mode.")
 
   (sched-powersave-on-ac?
@@ -179,7 +179,7 @@ (define-configuration tlp-configuration
    "Enable Linux kernel NMI watchdog.")
 
   (phc-controls
-   (maybe-string 'disabled)
+   (maybe-string)
    "For Linux kernels with PHC patch applied, change CPU voltages.
 An example value would be @samp{\"F:V F:V F:V F:V\"}.")
 
@@ -205,16 +205,16 @@ (define-configuration tlp-configuration
    "Same as @code{disk-apm-bat} but on BAT mode.")
 
   (disk-spindown-timeout-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Hard disk spin down timeout.  One value has to be specified for
 each declared hard disk.")
 
   (disk-spindown-timeout-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode.")
 
   (disk-iosched
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Select IO scheduler for disk devices.  One value has to be specified
 for each declared hard disk.  Example alternatives are cfq, deadline and noop.")
 
@@ -228,16 +228,16 @@ (define-configuration tlp-configuration
    "Same as @code{sata-linkpwr-ac} but on BAT mode.")
 
   (sata-linkpwr-blacklist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Exclude specified SATA host devices for link power management.")
 
   (ahci-runtime-pm-on-ac?
-   (maybe-on-off-boolean 'disabled)
+   (maybe-on-off-boolean)
    "Enable Runtime Power Management for AHCI controller and disks
 on AC mode.")
 
   (ahci-runtime-pm-on-bat?
-   (maybe-on-off-boolean 'disabled)
+   (maybe-on-off-boolean)
    "Same as @code{ahci-runtime-pm-on-ac} on BAT mode.")
 
   (ahci-runtime-pm-timeout
@@ -254,19 +254,19 @@ (define-configuration tlp-configuration
    "Same as @code{pcie-aspm-ac} but on BAT mode.")
 
   (start-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 0 should begin charging.")
 
   (stop-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 0 should stop charging.")
 
   (start-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 1 should begin charging.")
 
   (stop-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 1 should stop charging.")
 
   (radeon-power-profile-on-ac
@@ -346,7 +346,7 @@ (define-configuration tlp-configuration
 blacklisted ones.")
 
   (runtime-pm-blacklist
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Exclude specified PCI(e) device addresses from Runtime Power Management.")
 
   (runtime-pm-driver-blacklist
@@ -359,7 +359,7 @@ (define-configuration tlp-configuration
    "Enable USB autosuspend feature.")
 
   (usb-blacklist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Exclude specified devices from USB autosuspend.")
 
   (usb-blacklist-wwan?
@@ -367,12 +367,12 @@ (define-configuration tlp-configuration
    "Exclude WWAN devices from USB autosuspend.")
 
   (usb-whitelist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Include specified devices into USB autosuspend, even if they are
 already excluded by the driver or via @code{usb-blacklist-wwan?}.")
 
   (usb-autosuspend-disable-on-shutdown?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Enable USB autosuspend before shutdown.")
 
   (restore-device-state-on-startup?
diff --git a/gnu/services/telephony.scm b/gnu/services/telephony.scm
index 157d96abd6..c153cb37c3 100644
--- a/gnu/services/telephony.scm
+++ b/gnu/services/telephony.scm
@@ -155,7 +155,7 @@ (define-configuration jami-account
 secret key material of the Jami account it contains."
    empty-serializer)
   (allowed-contacts
-   (maybe-account-fingerprint-list 'disabled)
+   (maybe-account-fingerprint-list)
    "The list of allowed contacts for the account, entered as their 40
 characters long fingerprint.  Messages or calls from accounts not in that list
 will be rejected.  When unspecified, the configuration of the account archive
@@ -164,7 +164,7 @@ (define-configuration jami-account
 the account."
    empty-serializer)
   (moderators
-   (maybe-account-fingerprint-list 'disabled)
+   (maybe-account-fingerprint-list)
    "The list of contacts that should have moderation privileges (to ban, mute,
 etc. other users) in rendezvous conferences, entered as their 40 characters
 long fingerprint.  When unspecified, the configuration of the account archive
@@ -173,24 +173,24 @@ (define-configuration jami-account
    empty-serializer)
   ;; The serializable fields below are to be set with set-account-details.
   (rendezvous-point?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Whether the account should operate in the rendezvous mode.  In this mode,
 all the incoming audio/video calls are mixed into a conference.  When left
 unspecified, the value from the account archive prevails.")
   (peer-discovery?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Whether peer discovery should be enabled.  Peer discovery is used to
 discover other OpenDHT nodes on the local network, which can be useful to
 maintain communication between devices on such network even when the
 connection to the the Internet has been lost.  When left unspecified, the
 value from the account archive prevails.")
   (bootstrap-hostnames
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of hostnames or IPs pointing to OpenDHT nodes, that should be used
 to initially join the OpenDHT network.  When left unspecified, the value from
 the account archive prevails.")
   (name-server-uri
-   (maybe-string 'disabled)
+   (maybe-string)
    "The URI of the name server to use, that can be used to retrieve the
 account fingerprint for a registered username."))
 
@@ -245,7 +245,7 @@ (define-configuration/no-serialization jami-configuration
    (boolean #f)
    "Whether to force automatic answer to incoming calls.")
   (accounts
-   (maybe-jami-account-list 'disabled)
+   (maybe-jami-account-list)
    "A list of Jami accounts to be (re-)provisioned every time the Jami daemon
 service starts.  When providing this field, the account directories under
 @file{/var/lib/jami/} are recreated every time the service starts, ensuring a
diff --git a/gnu/services/vpn.scm b/gnu/services/vpn.scm
index b24e9cffb3..133a5ad9bf 100644
--- a/gnu/services/vpn.scm
+++ b/gnu/services/vpn.scm
@@ -363,7 +363,7 @@ (define-split-configuration openvpn-client-configuration
 channel to protect against DoS attacks.")
 
    (auth-user-pass
-     (maybe-string 'disabled)
+    (maybe-string)
      "Authenticate with server using username/password.  The option is a file
 containing username/password on 2 lines.  Do not use a file-like object as it
 would be added to the store and readable by any user.")
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 86a36a388d..8f32ad1dfc 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -118,3 +118,15 @@ (define-configuration config-with-maybe-string/no-serialization
 
 (test-assert "maybe value without serialization no procedure bound"
   (not (defined? 'serialize-maybe-string)))
+
+(test-assert "maybe type, no default"
+  (unspecified?
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization))))
+
+(test-assert "maybe type, with default"
+  (equal?
+   "foo"
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization
+     (name "foo")))))
-- 
2.34.0

Message #8 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Maxime Devos <maximedevos <at> telenet.be>
To: Attila Lendvai <attila <at> lendvai.name>, 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH] services: configuration: Use *unspecified*
 instead of 'disabled.
Date: Fri, 01 Apr 2022 21:46:37 +0200

[Message part 1 (text/plain, inline)]

Attila Lendvai schreef op vr 01-04-2022 om 21:19 [+0200]:
> ...as a marker for field values that have not been set. Rationale: 'disabled
> may easily [...], is confusing

Exactly, example:

> --- a/gnu/services/authentication.scm
> +++ b/gnu/services/authentication.scm
> @@ -218,7 +218,7 @@ (define-configuration nslcd-configuration
>  
>    ;; Runtime options
>    (threads
> -   (maybe-number 'disabled)
> +   (maybe-number)
>     "The number of threads to start that can handle requests and perform LDAP
>  queries.  Each thread opens a separate connection to the LDAP server.  The
>  default is to start 5 threads.")

(threads 'disabled) did not actually disable multi-threading.
FWIW, in this particular case, it could be (threads (number 5) ...)
instead (not using 'disabled' or *unspecified*), but that seems
somewhat a separate matter to me.

Greetings,
Maxime.

[signature.asc (application/pgp-signature, inline)]

Message #11 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Maxime Devos <maximedevos <at> telenet.be>
To: Attila Lendvai <attila <at> lendvai.name>, 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH] services: configuration: Use *unspecified*
 instead of 'disabled.
Date: Fri, 01 Apr 2022 21:56:58 +0200

[Message part 1 (text/plain, inline)]

Attila Lendvai schreef op vr 01-04-2022 om 21:19 [+0200]:
+    		       (if (unspecified? (syntax->datum def))
     			   #`(#,name #,getter)
     			   #`(#,name #,getter (default #,def))))

I'm not sure this does what you want it to do:

(define-syntax foo
  (lambda (s)
    (syntax-case s ()
      ((_ bar)
       (pk (syntax->datum #'bar) (unspecified? (syntax->datum #'bar)))))))
(foo *unspecified*)
;;; (*unspecified* #f)

The problem is that, from the macro systems POV, *unspecified* is just
a variable reference to the global *unspecified* --- *unspecified*
isn't magic to the reader, the reader just interprets it as a symbol.

Suggestion:

(define-syntax foo2
  (lambda (s)
    (syntax-case s ()
      ((_ bar)
       (pk (syntax->datum #'bar)
           (and (identifier? #'bar)
                (free-identifier=? #'*unspecified* #'bar)))))))
(foo2 *unspecified*)
;;; (*unspecified* #t)

Greetings,
Maxime.

[signature.asc (application/pgp-signature, inline)]

Message #14 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Maxime Devos <maximedevos <at> telenet.be>
To: Attila Lendvai <attila <at> lendvai.name>, 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH] services: configuration: Use *unspecified*
 instead of 'disabled.
Date: Fri, 01 Apr 2022 21:58:38 +0200

[Message part 1 (text/plain, inline)]

Attila Lendvai schreef op vr 01-04-2022 om 21:19 [+0200]:
> the reason i didn't do the (field1 maybe-string "") syntax *i.e. no
> parens around maybe-string), is that i couldn't convince the hygienic
> macro system about it.

Do you have some non-working code?  Maybe I can make it work ...

Greetings,
Maxime.

[signature.asc (application/pgp-signature, inline)]

Message #17 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH] services: configuration: Use *unspecified*
 instead of 'disabled.
Date: Mon, 04 Apr 2022 07:46:15 +0000

[Message part 1 (text/plain, inline)]

> > the reason i didn't do the (field1 maybe-string "") syntax *i.e. no
> > parens around maybe-string), is that i couldn't convince the hygienic
> > macro system about it.
>
> Do you have some non-working code? Maybe I can make it work ...

thank you for your kind offer Maxime! i have attached a half-baked patch.

it should also resolve your other nice catch of my mistaken use of UNSPECIFIED? on syntax objects.

in this change i try to introduce a codepath for a canonical form for DEFINE-CONFIGURATION fields, but it won't work this way, because this way the SYNTAX-CASE forms will only match when *every* field is of the specified shape.

the solution is probably in the direction of introducing a new DEFINE-CONFIGURATION-HELPER/FIELD somehow, but hygienic macros are a rather new territory for me...

as for the (threads (number 5)) change: i'd rather not do it in this commit to try to keep it as much idempotent wrt behavior as possible.

--
• attila lendvai
• PGP: 963F 5D5F 45C7 DFCD 0A39
--
“The important thing is to not stop questioning. Curiosity has its own reason for existing.”
	— Albert Einstein (1879–1955)

[0001-WIP-define-configuration-accepts-field1-maybe-string-forms.patch (text/x-patch, attachment)]

Message #20 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Maxime Devos <maximedevos <at> telenet.be>
To: Attila Lendvai <attila <at> lendvai.name>
Cc: 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH] services: configuration: Use *unspecified*
 instead of 'disabled.
Date: Mon, 04 Apr 2022 13:25:11 +0200

[Message part 1 (text/plain, inline)]

Attila Lendvai schreef op ma 04-04-2022 om 07:46 [+0000]:
> in this change i try to introduce a codepath for a canonical form for
> DEFINE-CONFIGURATION fields, but it won't work this way, because this
> way the SYNTAX-CASE forms will only match when *every* field is of
> the specified shape.

See attachement for poposed solution. (Not done: *unspecified* instead
of the symbol 'disabled' as default).

Greetings,
Maxime.

[aaa.diff (text/x-patch, inline)]

diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index 0de350a4df..06bb73c9fa 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2021 Xinglu Chen <public <at> yoctocell.xyz>
 ;;; Copyright © 2021 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
 ;;; Copyright © 2021 Andrew Tropin <andrew <at> trop.in>
+;;; Copyright © 2022 Maxime Devos <maximedevos <at> telenet.be>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -162,9 +163,21 @@ does not have a default value" field kind)))
 (define-syntax-rule (define-maybe/no-serialization stem)
   (define-maybe stem (no-serialization)))
 
+(define (analyse-field-type+def s)
+  (syntax-case s ()
+    ((field-type def ...)
+     (identifier? #'field-type)
+     (values #'(field-type def ...)))
+    (field-type
+     (identifier? #'field-type)
+     (values #'(field-type)))))
+
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
-    ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
+    ((_ stem (field field-type+def doc custom-serializer ...) ...)
+     ;; TODO: fix indentation, maybe with-syntax*?
+     (with-syntax ((((field-type def ...) ...)
+                    (map analyse-field-type+def #'(field-type+def ...))))
      (with-syntax (((field-getter ...)
                     (map (lambda (field)
                            (id #'stem #'stem #'- field))
@@ -233,7 +246,7 @@ does not have a default value" field kind)))
     	     (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
     	       (validate-configuration conf
     				       #,(id #'stem #'stem #'-fields))
-    	       conf)))))))
+              conf))))))))
 
 (define no-serialization         ;syntactic keyword for 'define-configuration'
   '(no serialization))
@@ -241,26 +254,26 @@ does not have a default value" field kind)))
 (define-syntax define-configuration
   (lambda (s)
     (syntax-case s (no-serialization prefix)
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem (field field-type+def doc custom-serializer ...) ...
           (no-serialization))
        (define-configuration-helper
-         #f #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #f #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...)))
-      ((_ stem  (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem  (field field-type+def doc custom-serializer ...) ...
           (prefix serializer-prefix))
        (define-configuration-helper
-         #t #'serializer-prefix #'(_ stem (field (field-type def ...)
+         #t #'serializer-prefix #'(_ stem (field field-type+def
                                                  doc custom-serializer ...)
                  ...)))
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
+      ((_ stem (field field-type+def doc custom-serializer ...) ...)
        (define-configuration-helper
-         #t #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #t #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...))))))
 
 (define-syntax-rule (define-configuration/no-serialization
-                      stem (field (field-type def ...)
+                      stem (field field-type+def
                                   doc custom-serializer ...) ...)
-  (define-configuration stem (field (field-type def ...)
+  (define-configuration stem (field field-type+def
                                     doc custom-serializer ...) ...
     (no-serialization)))
 

[signature.asc (application/pgp-signature, inline)]

Message #23 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v2 1/2] services: configuration: Support (field1 maybe-number
 "") format.
Date: Thu,  7 Apr 2022 15:52:13 +0200

As opposed to explicitly using 'disabled as value, or using the
(field1 (maybe-number) "") format.

It's mostly the work of Maxime Devos <maximedevos <at> telenet.be>, with some
modifications by me.

* gnu/services/configuration.scm (normalize-field-type+def): New function.
(define-configuration-helper) (define-configuration): Support new field
format.
* tests/services/configuration.scm (config-with-maybe-number->string): New
function.
("maybe value serialization of the instance"): New test.
("maybe value serialization of the instance, unspecified"): New test.
---
 gnu/services/configuration.scm   | 169 +++++++++++++++++--------------
 tests/services/configuration.scm |  28 ++++-
 2 files changed, 114 insertions(+), 83 deletions(-)

diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index 0de350a4df..bdca33ed68 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2021 Xinglu Chen <public <at> yoctocell.xyz>
 ;;; Copyright © 2021 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
 ;;; Copyright © 2021 Andrew Tropin <andrew <at> trop.in>
+;;; Copyright © 2022 Maxime Devos <maximedevos <at> telenet.be>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -162,78 +163,90 @@ (define-maybe-helper #t #f #'(_ stem))))))
 (define-syntax-rule (define-maybe/no-serialization stem)
   (define-maybe stem (no-serialization)))
 
+(define (normalize-field-type+def s)
+  (syntax-case s ()
+    ((field-type def)
+     (identifier? #'field-type)
+     (values #'(field-type def)))
+    ((field-type)
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))
+    (field-type
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))))
+
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
-    ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
-     (with-syntax (((field-getter ...)
-                    (map (lambda (field)
-                           (id #'stem #'stem #'- field))
-    			 #'(field ...)))
-                   ((field-predicate ...)
-                    (map (lambda (type)
-                           (id #'stem type #'?))
-    			 #'(field-type ...)))
-                   ((field-default ...)
-                    (map (match-lambda
-    			   ((field-type default-value)
-                            default-value)
-    			   ((field-type)
-                            ;; Quote `undefined' to prevent a possibly
-                            ;; unbound warning.
-                            (syntax 'undefined)))
-    			 #'((field-type def ...) ...)))
-                   ((field-serializer ...)
-                    (map (lambda (type custom-serializer)
-                           (and serialize?
-                                (match custom-serializer
-                                  ((serializer)
-                                   serializer)
-                                  (()
-                                   (if serializer-prefix
-                                       (id #'stem
-                                           serializer-prefix
-                                           #'serialize- type)
-                                       (id #'stem #'serialize- type))))))
-                         #'(field-type ...)
-                         #'((custom-serializer ...) ...))))
-       #`(begin
-    	   (define-record-type* #,(id #'stem #'< #'stem #'>)
-    	     #,(id #'stem #'% #'stem)
-    	     #,(id #'stem #'make- #'stem)
-    	     #,(id #'stem #'stem #'?)
-    	     (%location #,(id #'stem #'stem #'-location)
-    			(default (and=> (current-source-location)
-    					source-properties->location))
-    			(innate))
-    	     #,@(map (lambda (name getter def)
-    		       (if (eq? (syntax->datum def) (quote 'undefined))
-    			   #`(#,name #,getter)
-    			   #`(#,name #,getter (default #,def))))
-    		     #'(field ...)
-    		     #'(field-getter ...)
-    		     #'(field-default ...)))
-    	   (define #,(id #'stem #'stem #'-fields)
-    	     (list (configuration-field
-    		    (name 'field)
-    		    (type 'field-type)
-    		    (getter field-getter)
-    		    (predicate field-predicate)
-    		    (serializer field-serializer)
-    		    (default-value-thunk
-    		      (lambda ()
-    			(display '#,(id #'stem #'% #'stem))
-    			(if (eq? (syntax->datum field-default)
-    				 'undefined)
-    			    (configuration-no-default-value
-    			     '#,(id #'stem #'% #'stem) 'field)
-    			    field-default)))
-    		    (documentation doc))
-    		   ...))
-    	   (define-syntax-rule (stem arg (... ...))
-    	     (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
-    	       (validate-configuration conf
-    				       #,(id #'stem #'stem #'-fields))
-    	       conf)))))))
+    ((_ stem (field field-type+def doc custom-serializer ...) ...)
+     (with-syntax
+         ((((field-type def) ...)
+           (map normalize-field-type+def #'(field-type+def ...))))
+       (with-syntax
+           (((field-getter ...)
+             (map (lambda (field)
+                    (id #'stem #'stem #'- field))
+                  #'(field ...)))
+            ((field-predicate ...)
+             (map (lambda (type)
+                    (id #'stem type #'?))
+                  #'(field-type ...)))
+            ((field-default ...)
+             (map (match-lambda
+                    ((field-type default-value)
+                     default-value))
+                  #'((field-type def) ...)))
+            ((field-serializer ...)
+             (map (lambda (type custom-serializer)
+                    (and serialize?
+                         (match custom-serializer
+                           ((serializer)
+                            serializer)
+                           (()
+                            (if serializer-prefix
+                                (id #'stem
+                                    serializer-prefix
+                                    #'serialize- type)
+                                (id #'stem #'serialize- type))))))
+                  #'(field-type ...)
+                  #'((custom-serializer ...) ...))))
+         #`(begin
+             (define-record-type* #,(id #'stem #'< #'stem #'>)
+               #,(id #'stem #'% #'stem)
+               #,(id #'stem #'make- #'stem)
+               #,(id #'stem #'stem #'?)
+               (%location #,(id #'stem #'stem #'-location)
+                          (default (and=> (current-source-location)
+                                          source-properties->location))
+                          (innate))
+               #,@(map (lambda (name getter def)
+                         (if (eq? (syntax->datum def) (quote 'undefined))
+                             #`(#,name #,getter)
+                             #`(#,name #,getter (default #,def))))
+                       #'(field ...)
+                       #'(field-getter ...)
+                       #'(field-default ...)))
+             (define #,(id #'stem #'stem #'-fields)
+               (list (configuration-field
+                      (name 'field)
+                      (type 'field-type)
+                      (getter field-getter)
+                      (predicate field-predicate)
+                      (serializer field-serializer)
+                      (default-value-thunk
+                        (lambda ()
+                          (display '#,(id #'stem #'% #'stem))
+                          (if (eq? (syntax->datum field-default)
+                                   'undefined)
+                              (configuration-no-default-value
+                               '#,(id #'stem #'% #'stem) 'field)
+                              field-default)))
+                      (documentation doc))
+                     ...))
+             (define-syntax-rule (stem arg (... ...))
+               (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
+                 (validate-configuration conf
+                                         #,(id #'stem #'stem #'-fields))
+                 conf))))))))
 
 (define no-serialization         ;syntactic keyword for 'define-configuration'
   '(no serialization))
@@ -241,26 +254,26 @@ (define no-serialization         ;syntactic keyword for 'define-configuration'
 (define-syntax define-configuration
   (lambda (s)
     (syntax-case s (no-serialization prefix)
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem (field field-type+def doc custom-serializer ...) ...
           (no-serialization))
        (define-configuration-helper
-         #f #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #f #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...)))
-      ((_ stem  (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem  (field field-type+def doc custom-serializer ...) ...
           (prefix serializer-prefix))
        (define-configuration-helper
-         #t #'serializer-prefix #'(_ stem (field (field-type def ...)
+         #t #'serializer-prefix #'(_ stem (field field-type+def
                                                  doc custom-serializer ...)
                  ...)))
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
+      ((_ stem (field field-type+def doc custom-serializer ...) ...)
        (define-configuration-helper
-         #t #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #t #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...))))))
 
 (define-syntax-rule (define-configuration/no-serialization
-                      stem (field (field-type def ...)
+                      stem (field field-type+def
                                   doc custom-serializer ...) ...)
-  (define-configuration stem (field (field-type def ...)
+  (define-configuration stem (field field-type+def
                                     doc custom-serializer ...) ...
     (no-serialization)))
 
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 86a36a388d..0debf8095b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -27,6 +27,9 @@ (define-module (tests services configuration)
 
 (test-begin "services-configuration")
 
+(define (serialize-number field value)
+  (format #f "~a=~a" field value))
+
 
 ;;;
 ;;; define-configuration macro.
@@ -47,7 +50,6 @@ (define-configuration port-configuration-cs
   80
   (port-configuration-cs-port (port-configuration-cs)))
 
-(define serialize-number "")
 (define-configuration port-configuration-ndv
   (port (number) "The port number."))
 
@@ -101,15 +103,31 @@ (define-configuration configuration-with-prefix
 (define-maybe number)
 
 (define-configuration config-with-maybe-number
-  (port (maybe-number 80) "The port number."))
-
-(define (serialize-number field value)
-  (format #f "~a=~a" field value))
+  (port  (maybe-number 80) "")
+  (count maybe-number ""))
 
 (test-equal "maybe value serialization"
   "port=80"
   (serialize-maybe-number "port" 80))
 
+(define (config-with-maybe-number->string x)
+  (eval (gexp->approximate-sexp
+         (serialize-configuration x config-with-maybe-number-fields))
+        (current-module)))
+
+(test-equal "maybe value serialization of the instance"
+  "port=42count=43"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42)
+    (count 43))))
+
+(test-equal "maybe value serialization of the instance, unspecified"
+  "port=42"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42))))
+
 (define-maybe/no-serialization string)
 
 (define-configuration config-with-maybe-string/no-serialization
-- 
2.34.0

Message #26 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v2 2/2] services: configuration: Use *unspecified* instead of
 'disabled.
Date: Thu,  7 Apr 2022 15:52:15 +0200

...as a marker for field values that have not been set. Rationale: 'disabled
may easily clash with user values for boolean fields, is confusing (i.e. its
meaning is *not* boolean false, bug unspecified) and it also passes through
silently the symbol? predicate of a field of type symbol.

Relax the syntax to accept (field1 (maybe-string) "") forms, in which case it
uses *unspecified* as default value.

Possible future improvement: also accept (field1 maybe-string "") forms,
i.e. without the extra parens around maybe types without defaults.

* gnu/services/configuration.scm (configuration-missing-default-value):
Renamed from configuration-no-default-value.
* gnu/services/configuration.scm (define-maybe-helper): Use *unspecified*
instead of 'disabled, and make the default value optional.
---

i haven't tested every service that got touched by this change. consider
it as a slightly tested proposal, that may very well end up being useful
as it is.

i have my service code on my server running on top of this, though. it
exercises serialization, and some nontrivial defaulting and
instantiations.

 gnu/home/services/desktop.scm    | 12 ++---
 gnu/services/authentication.scm  | 82 ++++++++++++++++----------------
 gnu/services/cgit.scm            | 12 ++---
 gnu/services/configuration.scm   | 17 ++++---
 gnu/services/file-sharing.scm    | 24 +++++-----
 gnu/services/messaging.scm       | 37 +++++++-------
 gnu/services/networking.scm      | 12 ++---
 gnu/services/pm.scm              | 54 ++++++++++-----------
 gnu/services/telephony.scm       | 14 +++---
 gnu/services/vpn.scm             |  2 +-
 tests/services/configuration.scm | 12 +++++
 11 files changed, 144 insertions(+), 134 deletions(-)

diff --git a/gnu/home/services/desktop.scm b/gnu/home/services/desktop.scm
index cbb9cf76da..a54ad0d115 100644
--- a/gnu/home/services/desktop.scm
+++ b/gnu/home/services/desktop.scm
@@ -91,26 +91,26 @@ (define-configuration home-redshift-configuration
    "Nighttime color temperature (kelvins).")
 
   (daytime-brightness
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Daytime screen brightness, between 0.1 and 1.0.")
   (nighttime-brightness
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Nighttime screen brightness, between 0.1 and 1.0.")
 
   (latitude
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Latitude, when @code{location-provider} is @code{'manual}.")
   (longitude
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Longitude, when @code{location-provider} is @code{'manual}.")
 
   (dawn-time
-   (maybe-string 'disabled)
+   (maybe-string)
    "Custom time for the transition from night to day in the
 morning---@code{\"HH:MM\"} format.  When specified, solar elevation is not
 used to determine the daytime/nighttime period.")
   (dusk-time
-   (maybe-string 'disabled)
+   (maybe-string)
    "Likewise, custom time for the transition from day to night in the
 evening.")
 
diff --git a/gnu/services/authentication.scm b/gnu/services/authentication.scm
index cb0ef6d85a..1c4800bfbd 100644
--- a/gnu/services/authentication.scm
+++ b/gnu/services/authentication.scm
@@ -218,7 +218,7 @@ (define-configuration nslcd-configuration
 
   ;; Runtime options
   (threads
-   (maybe-number 'disabled)
+   (maybe-number)
    "The number of threads to start that can handle requests and perform LDAP
 queries.  Each thread opens a separate connection to the LDAP server.  The
 default is to start 5 threads.")
@@ -243,45 +243,45 @@ (define-configuration nslcd-configuration
    "The list of LDAP server URIs.  Normally, only the first server will be
 used with the following servers as fall-back.")
   (ldap-version
-   (maybe-string 'disabled)
+   (maybe-string)
    "The version of the LDAP protocol to use.  The default is to use the
 maximum version supported by the LDAP library.")
   (binddn
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the distinguished name with which to bind to the directory
 server for lookups.  The default is to bind anonymously.")
   (bindpw
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the credentials with which to bind.  This option is only
 applicable when used with binddn.")
   (rootpwmoddn
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the distinguished name to use when the root user tries to modify
 a user's password using the PAM module.")
   (rootpwmodpw
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the credentials with which to bind if the root user tries to
 change a user's password.  This option is only applicable when used with
 rootpwmoddn")
 
   ;; SASL authentication options
   (sasl-mech
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the SASL mechanism to be used when performing SASL
 authentication.")
   (sasl-realm
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the SASL realm to be used when performing SASL authentication.")
   (sasl-authcid
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the authentication identity to be used when performing SASL
 authentication.")
   (sasl-authzid
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the authorization identity to be used when performing SASL
 authentication.")
   (sasl-canonicalize?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Determines whether the LDAP server host name should be canonicalised.  If
 this is enabled the LDAP library will do a reverse host name lookup.  By
 default, it is left up to the LDAP library whether this check is performed or
@@ -289,7 +289,7 @@ (define-configuration nslcd-configuration
 
   ;; Kerberos authentication options
   (krb5-ccname
-   (maybe-string 'disabled)
+   (maybe-string)
    "Set the name for the GSS-API Kerberos credentials cache.")
 
   ;; Search / mapping options
@@ -302,11 +302,11 @@ (define-configuration nslcd-configuration
 default scope is subtree; base scope is almost never useful for name service
 lookups; children scope is not supported on all servers.")
   (deref
-   (maybe-deref-option 'disabled)
+   (maybe-deref-option)
    "Specifies the policy for dereferencing aliases.  The default policy is to
 never dereference aliases.")
   (referrals
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Specifies whether automatic referral chasing should be enabled.  The
 default behaviour is to chase referrals.")
   (maps
@@ -322,132 +322,132 @@ (define-configuration nslcd-configuration
 
   ;; Timing / reconnect options
   (bind-timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time limit in seconds to use when connecting to the
 directory server.  The default value is 10 seconds.")
   (timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time limit (in seconds) to wait for a response from the LDAP
 server.  A value of zero, which is the default, is to wait indefinitely for
 searches to be completed.")
   (idle-timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the period if inactivity (in seconds) after which the con‐
 nection to the LDAP server will be closed.  The default is not to time out
 connections.")
   (reconnect-sleeptime
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the number of seconds to sleep when connecting to all LDAP
 servers fails.  By default one second is waited between the first failure and
 the first retry.")
   (reconnect-retrytime
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time after which the LDAP server is considered to be
 permanently unavailable.  Once this time is reached retries will be done only
 once per this time period.  The default value is 10 seconds.")
 
   ;; TLS options
   (ssl
-   (maybe-ssl-option 'disabled)
+   (maybe-ssl-option)
    "Specifies whether to use SSL/TLS or not (the default is not to).  If
 'start-tls is specified then StartTLS is used rather than raw LDAP over SSL.")
   (tls-reqcert
-   (maybe-tls-reqcert-option 'disabled)
+   (maybe-tls-reqcert-option)
    "Specifies what checks to perform on a server-supplied certificate.
 The meaning of the values is described in the ldap.conf(5) manual page.")
   (tls-cacertdir
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the directory containing X.509 certificates for peer authen‐
 tication.  This parameter is ignored when using GnuTLS.")
   (tls-cacertfile
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the X.509 certificate for peer authentication.")
   (tls-randfile
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to an entropy source.  This parameter is ignored when
 using GnuTLS.")
   (tls-ciphers
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the ciphers to use for TLS as a string.")
   (tls-cert
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the file containing the local certificate for client
 TLS authentication.")
   (tls-key
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the file containing the private key for client TLS
 authentication.")
 
   ;; Other options
   (pagesize
-   (maybe-number 'disabled)
+   (maybe-number)
    "Set this to a number greater than 0 to request paged results from the LDAP
 server in accordance with RFC2696.  The default (0) is to not request paged
 results.")
   (nss-initgroups-ignoreusers
-   (maybe-ignore-users-option 'disabled)
+   (maybe-ignore-users-option)
    "This option prevents group membership lookups through LDAP for the
 specified users.  Alternatively, the value 'all-local may be used.  With that
 value nslcd builds a full list of non-LDAP users on startup.")
   (nss-min-uid
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option ensures that LDAP users with a numeric user id lower than the
 specified value are ignored.")
   (nss-uid-offset
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option specifies an offset that is added to all LDAP numeric user
 ids.  This can be used to avoid user id collisions with local users.")
   (nss-gid-offset
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option specifies an offset that is added to all LDAP numeric group
 ids.  This can be used to avoid user id collisions with local groups.")
   (nss-nested-groups
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, the member attribute of a group may point to
 another group.  Members of nested groups are also returned in the higher level
 group and parent groups are returned when finding groups for a specific user.
 The default is not to perform extra searches for nested groups.")
   (nss-getgrent-skipmembers
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, the group member list is not retrieved when looking
 up groups.  Lookups for finding which groups a user belongs to will remain
 functional so the user will likely still get the correct groups assigned on
 login.")
   (nss-disable-enumeration
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, functions which cause all user/group entries to be
 loaded from the directory will not succeed in doing so.  This can dramatically
 reduce LDAP server load in situations where there are a great number of users
 and/or groups.  This option is not recommended for most configurations.")
   (validnames
-   (maybe-string 'disabled)
+   (maybe-string)
    "This option can be used to specify how user and group names are verified
 within the system.  This pattern is used to check all user and group names
 that are requested and returned from LDAP.")
   (ignorecase
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "This specifies whether or not to perform searches using case-insensitive
 matching.  Enabling this could open up the system to authorization bypass
 vulnerabilities and introduce nscd cache poisoning vulnerabilities which allow
 denial of service.")
   (pam-authc-ppolicy
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "This option specifies whether password policy controls are requested and
 handled from the LDAP server when performing user authentication.")
   (pam-authc-search
-   (maybe-string 'disabled)
+   (maybe-string)
    "By default nslcd performs an LDAP search with the user's credentials after
 BIND (authentication) to ensure that the BIND operation was successful.  The
 default search is a simple check to see if the user's DN exists.  A search
 filter can be specified that will be used instead.  It should return at least
 one entry.")
   (pam-authz-search
-   (maybe-string 'disabled)
+   (maybe-string)
    "This option allows flexible fine tuning of the authorisation check that
 should be performed.  The search filter specified is executed and if any
 entries match, access is granted, otherwise access is denied.")
   (pam-password-prohibit-message
-   (maybe-string 'disabled)
+   (maybe-string)
    "If this option is set password modification using pam_ldap will be denied
 and the specified message will be presented to the user instead.  The message
 can be used to direct the user to an alternative means of changing their
diff --git a/gnu/services/cgit.scm b/gnu/services/cgit.scm
index bfc89a40a4..bcb3e1a796 100644
--- a/gnu/services/cgit.scm
+++ b/gnu/services/cgit.scm
@@ -241,27 +241,27 @@ (define-configuration repository-cgit-configuration
    (repo-file-object "")
    "Override the default @code{email-filter}.")
   (enable-commit-graph?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-commit-graph?}.")
   (enable-log-filecount?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-log-filecount?}.")
   (enable-log-linecount?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-log-linecount?}.")
   (enable-remote-branches?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "Flag which, when set to @code{#t}, will make cgit display remote
 branches in the summary and refs views.")
   (enable-subject-links?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to override the global setting
 @code{enable-subject-links?}.")
   (enable-html-serving?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to override the global setting
 @code{enable-html-serving?}.")
   (hide?
diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index bdca33ed68..f6b20fb82b 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -93,7 +93,7 @@ (define (configuration-field-error field val)
 (define (configuration-missing-field kind field)
   (configuration-error
    (format #f "~a configuration missing required field ~a" kind field)))
-(define (configuration-no-default-value kind field)
+(define (configuration-missing-default-value kind field)
   (configuration-error
    (format #f "The field `~a' of the `~a' configuration record \
 does not have a default value" field kind)))
@@ -142,7 +142,8 @@ (define (define-maybe-helper serialize? prefix syn)
                                     (id #'stem #'serialize-maybe- #'stem))))
        #`(begin
            (define (maybe-stem? val)
-             (or (eq? val 'disabled) (stem? val)))
+             (or (unspecified? val)
+                 (stem? val)))
            #,@(if serialize?
                   (list #'(define (serialize-maybe-stem field-name val)
                             (if (stem? val)
@@ -170,10 +171,10 @@ (define (normalize-field-type+def s)
      (values #'(field-type def)))
     ((field-type)
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))
+     (values #'(field-type *unspecified*)))
     (field-type
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))))
+     (values #'(field-type *unspecified*)))))
 
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
@@ -219,9 +220,7 @@ (define-record-type* #,(id #'stem #'< #'stem #'>)
                                           source-properties->location))
                           (innate))
                #,@(map (lambda (name getter def)
-                         (if (eq? (syntax->datum def) (quote 'undefined))
-                             #`(#,name #,getter)
-                             #`(#,name #,getter (default #,def))))
+                         #`(#,name #,getter (default #,def)))
                        #'(field ...)
                        #'(field-getter ...)
                        #'(field-default ...)))
@@ -236,8 +235,8 @@ (define #,(id #'stem #'stem #'-fields)
                         (lambda ()
                           (display '#,(id #'stem #'% #'stem))
                           (if (eq? (syntax->datum field-default)
-                                   'undefined)
-                              (configuration-no-default-value
+                                   '*unspecified*)
+                              (configuration-missing-default-value
                                '#,(id #'stem #'% #'stem) 'field)
                               field-default)))
                       (documentation doc))
diff --git a/gnu/services/file-sharing.scm b/gnu/services/file-sharing.scm
index e3d681b08f..6e71fa9154 100644
--- a/gnu/services/file-sharing.scm
+++ b/gnu/services/file-sharing.scm
@@ -115,8 +115,7 @@ (define-maybe string)
 (set! serialize-maybe-string
   (lambda (field-name val)
     (serialize-string field-name
-                      (if (and (symbol? val)
-                               (eq? val 'disabled))
+                      (if (unspecified? val)
                           ""
                           val))))
 
@@ -181,8 +180,7 @@ (define (serialize-file-object field-name val)
 (define-maybe file-object)
 (set! serialize-maybe-file-object
   (lambda (field-name val)
-    (if (and (symbol? val)
-             (eq? val 'disabled))
+    (if (unspecified? val)
         (serialize-string field-name "")
         (serialize-file-object field-name val))))
 
@@ -281,7 +279,7 @@ (define-configuration transmission-daemon-configuration
 torrent is complete.  Otherwise, files for all torrents (including those still
 being downloaded) will be placed in @code{download-dir}.")
   (incomplete-dir
-   (maybe-string 'disabled)
+   (maybe-string)
    "The directory in which files from incompletely downloaded torrents will be
 held when @code{incomplete-dir-enabled?} is @code{#t}.")
   (umask
@@ -305,7 +303,7 @@ (define-configuration transmission-daemon-configuration
 automatically (and the original files removed, if
 @code{trash-original-torrent-files?} is @code{#t}).")
   (watch-dir
-   (maybe-string 'disabled)
+   (maybe-string)
    "The directory to be watched for @file{.torrent} files indicating new
 torrents to be added, when @code{watch-dir-enabled} is @code{#t}.")
   (trash-original-torrent-files?
@@ -401,11 +399,11 @@ (define-configuration transmission-daemon-configuration
 @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or
 @code{require-encrypted-connections}.")
   (peer-congestion-algorithm
-   (maybe-string 'disabled)
+   (maybe-string)
    "The TCP congestion-control algorithm to use for peer connections,
 specified using a string recognized by the operating system in calls to
-@code{setsockopt} (or set to @code{disabled}, in which case the
-operating-system default is used).
+@code{setsockopt} (or leave it unset, in which case the operating-system
+default is used).
 
 Note that on GNU/Linux systems, the kernel must be configured to allow
 processes to use a congestion-control algorithm not in the default set;
@@ -465,7 +463,7 @@ (define-configuration transmission-daemon-configuration
    "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it
 has most recently downloaded from @code{blocklist-url}.")
   (blocklist-url
-   (maybe-string 'disabled)
+   (maybe-string)
    "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule
 @file{.dat} format) to be periodically downloaded and applied when
 @code{blocklist-enabled?} is @code{#t}.")
@@ -564,11 +562,11 @@ (define-configuration transmission-daemon-configuration
 the side effect of disabling host-name whitelisting (see
 @code{rpc-host-whitelist-enabled?}.")
   (rpc-username
-   (maybe-string 'disabled)
+   (maybe-string)
    "The username required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.")
   (rpc-password
-   (maybe-transmission-password-hash 'disabled)
+   (maybe-transmission-password-hash)
    "The password required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.  This must be specified
 using a password hash in the format recognized by Transmission clients, either
@@ -613,7 +611,7 @@ (define-configuration transmission-daemon-configuration
 @code{script-torrent-done-filename} will be invoked each time a torrent
 completes.")
   (script-torrent-done-filename
-   (maybe-file-object 'disabled)
+   (maybe-file-object)
    "A file name or file-like object specifying a script to run each time a
 torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}.")
   (scrape-paused-torrents-enabled?
diff --git a/gnu/services/messaging.scm b/gnu/services/messaging.scm
index 4bceb1d37a..5f20d768ef 100644
--- a/gnu/services/messaging.scm
+++ b/gnu/services/messaging.scm
@@ -72,6 +72,7 @@ (define (make-pred arg)
       (lambda (field target)
         (and (memq (syntax->datum target) `(common ,arg)) field)))
     (syntax-case stx ()
+      ;; TODO Also handle (field-type) form, without a default.
       ((_ stem (field (field-type def) doc target) ...)
        (with-syntax (((new-field-type ...)
                       (map (lambda (field-type target)
@@ -85,7 +86,7 @@ (define (make-pred arg)
                      ((new-def ...)
                       (map (lambda (def target)
                              (if (eq? 'common (syntax->datum target))
-                                 #''disabled def))
+                                 #'*unspecified* def))
                            #'(def ...) #'(target ...)))
                      ((new-doc ...)
                       (map (lambda (doc target)
@@ -195,7 +196,7 @@ (define (serialize-file-object-list field-name val)
 (define-maybe file-object-list)
 
 (define (raw-content? val)
-  (not (eq? val 'disabled)))
+  (not (unspecified? val)))
 (define (serialize-raw-content field-name val)
   val)
 (define-maybe raw-content)
@@ -223,15 +224,15 @@ (define-maybe mod-muc-configuration)
 
 (define-configuration ssl-configuration
   (protocol
-   (maybe-string 'disabled)
+   (maybe-string)
    "This determines what handshake to use.")
 
   (key
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "Path to your private key file.")
 
   (certificate
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "Path to your certificate file.")
 
   (capath
@@ -240,48 +241,48 @@ (define-configuration ssl-configuration
 trust when verifying the certificates of remote servers.")
 
   (cafile
-   (maybe-file-object 'disabled)
+   (maybe-file-object)
    "Path to a file containing root certificates that you wish Prosody to trust.
 Similar to @code{capath} but with all certificates concatenated together.")
 
   (verify
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of verification options (these mostly map to OpenSSL's
 @code{set_verify()} flags).")
 
   (options
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of general options relating to SSL/TLS.  These map to OpenSSL's
 @code{set_options()}.  For a full list of options available in LuaSec, see the
 LuaSec source.")
 
   (depth
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "How long a chain of certificate authorities to check when looking for a
 trusted root certificate.")
 
   (ciphers
-   (maybe-string 'disabled)
+   (maybe-string)
    "An OpenSSL cipher string.  This selects what ciphers Prosody will offer to
 clients, and in what order.")
 
   (dhparam
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "A path to a file containing parameters for Diffie-Hellman key exchange.  You
 can create such a file with:
 @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}")
 
   (curve
-   (maybe-string 'disabled)
+   (maybe-string)
    "Curve for Elliptic curve Diffie-Hellman. Prosody's default is
 @samp{\"secp384r1\"}.")
 
   (verifyext
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of \"extra\" verification options.")
 
   (password
-   (maybe-string 'disabled)
+   (maybe-string)
    "Password for encrypted private keys."))
 (define (serialize-ssl-configuration field-name val)
   #~(format #f "ssl = {\n~a};\n"
@@ -469,12 +470,12 @@ (define-all-configurations prosody-configuration
      global)
 
     (http-max-content-size
-     (maybe-non-negative-integer 'disabled)
+     (maybe-non-negative-integer *unspecified*)
      "Maximum allowed size of the HTTP body (in bytes)."
      common)
 
     (http-external-url
-     (maybe-string 'disabled)
+     (maybe-string *unspecified*)
      "Some modules expose their own URL in various ways.  This URL is built
 from the protocol, host and port used.  If Prosody sits behind a proxy, the
 public URL will be @code{http-external-url} instead.  See
@@ -551,7 +552,7 @@ (define-all-configurations prosody-configuration
      int-component)
 
     (mod-muc
-     (maybe-mod-muc-configuration 'disabled)
+     (maybe-mod-muc-configuration *unspecified*)
      "Multi-user chat (MUC) is Prosody's module for allowing you to create
 hosted chatrooms/conferences for XMPP users.
 
@@ -568,7 +569,7 @@ (define-all-configurations prosody-configuration
      ext-component)
 
     (raw-content
-     (maybe-raw-content 'disabled)
+     (maybe-raw-content *unspecified*)
      "Raw content that will be added to the configuration file."
      common)))
 
diff --git a/gnu/services/networking.scm b/gnu/services/networking.scm
index 5bb8638930..b5c46218e7 100644
--- a/gnu/services/networking.scm
+++ b/gnu/services/networking.scm
@@ -763,17 +763,17 @@ (define-configuration/no-serialization opendht-configuration
    "The node host name that is used to make the first connection to the
 network.  A specific port value can be provided by appending the @code{:PORT}
 suffix.  By default, it uses the Jami bootstrap nodes, but any host can be
-specified here.  It's also possible to disable bootstrapping by setting this
-to the @code{'disabled} symbol.")
+specified here.  It's also possible to disable bootstrapping by explicitly
+setting this field to the @code{*unspecified*} value.")
   (port
    (maybe-number 4222)
-   "The UDP port to bind to.  When set to @code{'disabled}, an available port
-is automatically selected.")
+   "The UDP port to bind to.  When set to @code{*unspecified*}, an available
+port is automatically selected.")
   (proxy-server-port
-   (maybe-number 'disabled)
+   (maybe-number)
    "Spawn a proxy server listening on the specified port.")
   (proxy-server-port-tls
-   (maybe-number 'disabled)
+   (maybe-number)
    "Spawn a proxy server listening to TLS connections on the specified
 port."))
 
diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index e48236dbca..d1250ab488 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -114,55 +114,55 @@ (define-configuration tlp-configuration
    "Same as @code{max-lost-work-secs-on-ac} but on BAT mode.")
 
   (cpu-scaling-governor-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "CPU frequency scaling governor on AC mode.  With intel_pstate
 driver, alternatives are powersave and performance.  With acpi-cpufreq driver,
 alternatives are ondemand, powersave, performance and conservative.")
 
   (cpu-scaling-governor-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode.")
 
   (cpu-scaling-min-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the min available frequency for the scaling governor on AC.")
 
   (cpu-scaling-max-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the max available frequency for the scaling governor on AC.")
 
   (cpu-scaling-min-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the min available frequency for the scaling governor on BAT.")
 
   (cpu-scaling-max-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the max available frequency for the scaling governor on BAT.")
 
   (cpu-min-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Limit the min P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-max-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Limit the max P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-min-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Same as @code{cpu-min-perf-on-ac} on BAT mode.")
 
   (cpu-max-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Same as @code{cpu-max-perf-on-ac} on BAT mode.")
 
   (cpu-boost-on-ac?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Enable CPU turbo boost feature on AC mode.")
 
   (cpu-boost-on-bat?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Same as @code{cpu-boost-on-ac?} on BAT mode.")
 
   (sched-powersave-on-ac?
@@ -179,7 +179,7 @@ (define-configuration tlp-configuration
    "Enable Linux kernel NMI watchdog.")
 
   (phc-controls
-   (maybe-string 'disabled)
+   (maybe-string)
    "For Linux kernels with PHC patch applied, change CPU voltages.
 An example value would be @samp{\"F:V F:V F:V F:V\"}.")
 
@@ -205,16 +205,16 @@ (define-configuration tlp-configuration
    "Same as @code{disk-apm-bat} but on BAT mode.")
 
   (disk-spindown-timeout-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Hard disk spin down timeout.  One value has to be specified for
 each declared hard disk.")
 
   (disk-spindown-timeout-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode.")
 
   (disk-iosched
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Select IO scheduler for disk devices.  One value has to be specified
 for each declared hard disk.  Example alternatives are cfq, deadline and noop.")
 
@@ -228,16 +228,16 @@ (define-configuration tlp-configuration
    "Same as @code{sata-linkpwr-ac} but on BAT mode.")
 
   (sata-linkpwr-blacklist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Exclude specified SATA host devices for link power management.")
 
   (ahci-runtime-pm-on-ac?
-   (maybe-on-off-boolean 'disabled)
+   (maybe-on-off-boolean)
    "Enable Runtime Power Management for AHCI controller and disks
 on AC mode.")
 
   (ahci-runtime-pm-on-bat?
-   (maybe-on-off-boolean 'disabled)
+   (maybe-on-off-boolean)
    "Same as @code{ahci-runtime-pm-on-ac} on BAT mode.")
 
   (ahci-runtime-pm-timeout
@@ -254,19 +254,19 @@ (define-configuration tlp-configuration
    "Same as @code{pcie-aspm-ac} but on BAT mode.")
 
   (start-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 0 should begin charging.")
 
   (stop-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 0 should stop charging.")
 
   (start-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 1 should begin charging.")
 
   (stop-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 1 should stop charging.")
 
   (radeon-power-profile-on-ac
@@ -346,7 +346,7 @@ (define-configuration tlp-configuration
 blacklisted ones.")
 
   (runtime-pm-blacklist
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Exclude specified PCI(e) device addresses from Runtime Power Management.")
 
   (runtime-pm-driver-blacklist
@@ -359,7 +359,7 @@ (define-configuration tlp-configuration
    "Enable USB autosuspend feature.")
 
   (usb-blacklist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Exclude specified devices from USB autosuspend.")
 
   (usb-blacklist-wwan?
@@ -367,12 +367,12 @@ (define-configuration tlp-configuration
    "Exclude WWAN devices from USB autosuspend.")
 
   (usb-whitelist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Include specified devices into USB autosuspend, even if they are
 already excluded by the driver or via @code{usb-blacklist-wwan?}.")
 
   (usb-autosuspend-disable-on-shutdown?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Enable USB autosuspend before shutdown.")
 
   (restore-device-state-on-startup?
diff --git a/gnu/services/telephony.scm b/gnu/services/telephony.scm
index 157d96abd6..c153cb37c3 100644
--- a/gnu/services/telephony.scm
+++ b/gnu/services/telephony.scm
@@ -155,7 +155,7 @@ (define-configuration jami-account
 secret key material of the Jami account it contains."
    empty-serializer)
   (allowed-contacts
-   (maybe-account-fingerprint-list 'disabled)
+   (maybe-account-fingerprint-list)
    "The list of allowed contacts for the account, entered as their 40
 characters long fingerprint.  Messages or calls from accounts not in that list
 will be rejected.  When unspecified, the configuration of the account archive
@@ -164,7 +164,7 @@ (define-configuration jami-account
 the account."
    empty-serializer)
   (moderators
-   (maybe-account-fingerprint-list 'disabled)
+   (maybe-account-fingerprint-list)
    "The list of contacts that should have moderation privileges (to ban, mute,
 etc. other users) in rendezvous conferences, entered as their 40 characters
 long fingerprint.  When unspecified, the configuration of the account archive
@@ -173,24 +173,24 @@ (define-configuration jami-account
    empty-serializer)
   ;; The serializable fields below are to be set with set-account-details.
   (rendezvous-point?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Whether the account should operate in the rendezvous mode.  In this mode,
 all the incoming audio/video calls are mixed into a conference.  When left
 unspecified, the value from the account archive prevails.")
   (peer-discovery?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Whether peer discovery should be enabled.  Peer discovery is used to
 discover other OpenDHT nodes on the local network, which can be useful to
 maintain communication between devices on such network even when the
 connection to the the Internet has been lost.  When left unspecified, the
 value from the account archive prevails.")
   (bootstrap-hostnames
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of hostnames or IPs pointing to OpenDHT nodes, that should be used
 to initially join the OpenDHT network.  When left unspecified, the value from
 the account archive prevails.")
   (name-server-uri
-   (maybe-string 'disabled)
+   (maybe-string)
    "The URI of the name server to use, that can be used to retrieve the
 account fingerprint for a registered username."))
 
@@ -245,7 +245,7 @@ (define-configuration/no-serialization jami-configuration
    (boolean #f)
    "Whether to force automatic answer to incoming calls.")
   (accounts
-   (maybe-jami-account-list 'disabled)
+   (maybe-jami-account-list)
    "A list of Jami accounts to be (re-)provisioned every time the Jami daemon
 service starts.  When providing this field, the account directories under
 @file{/var/lib/jami/} are recreated every time the service starts, ensuring a
diff --git a/gnu/services/vpn.scm b/gnu/services/vpn.scm
index b24e9cffb3..133a5ad9bf 100644
--- a/gnu/services/vpn.scm
+++ b/gnu/services/vpn.scm
@@ -363,7 +363,7 @@ (define-split-configuration openvpn-client-configuration
 channel to protect against DoS attacks.")
 
    (auth-user-pass
-     (maybe-string 'disabled)
+    (maybe-string)
      "Authenticate with server using username/password.  The option is a file
 containing username/password on 2 lines.  Do not use a file-like object as it
 would be added to the store and readable by any user.")
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 0debf8095b..334a1e409b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -136,3 +136,15 @@ (define-configuration config-with-maybe-string/no-serialization
 
 (test-assert "maybe value without serialization no procedure bound"
   (not (defined? 'serialize-maybe-string)))
+
+(test-assert "maybe type, no default"
+  (unspecified?
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization))))
+
+(test-assert "maybe type, with default"
+  (equal?
+   "foo"
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization
+     (name "foo")))))
-- 
2.34.0

Message #29 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v3 1/2] services: configuration: Support (field1 maybe-number
 "") format.
Date: Thu,  7 Apr 2022 17:01:40 +0200

As opposed to explicitly using 'disabled as value, or using the
(field1 (maybe-number) "") format.

It's mostly the work of Maxime Devos shared under #54674, with some
modifications by Attila Lendvai.

* gnu/services/configuration.scm (normalize-field-type+def): New function.
(define-configuration-helper) (define-configuration): Support new field
format.
* tests/services/configuration.scm (config-with-maybe-number->string): New
function.
("maybe value serialization of the instance"): New test.
("maybe value serialization of the instance, unspecified"): New test.
---

v3: clean up the commit message. the code was not changed.

note that a large part of the diff is whitespace only.

 gnu/services/configuration.scm   | 169 +++++++++++++++++--------------
 tests/services/configuration.scm |  28 ++++-
 2 files changed, 114 insertions(+), 83 deletions(-)

diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index 0de350a4df..bdca33ed68 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2021 Xinglu Chen <public <at> yoctocell.xyz>
 ;;; Copyright © 2021 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
 ;;; Copyright © 2021 Andrew Tropin <andrew <at> trop.in>
+;;; Copyright © 2022 Maxime Devos <maximedevos <at> telenet.be>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -162,78 +163,90 @@ (define-maybe-helper #t #f #'(_ stem))))))
 (define-syntax-rule (define-maybe/no-serialization stem)
   (define-maybe stem (no-serialization)))
 
+(define (normalize-field-type+def s)
+  (syntax-case s ()
+    ((field-type def)
+     (identifier? #'field-type)
+     (values #'(field-type def)))
+    ((field-type)
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))
+    (field-type
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))))
+
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
-    ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
-     (with-syntax (((field-getter ...)
-                    (map (lambda (field)
-                           (id #'stem #'stem #'- field))
-    			 #'(field ...)))
-                   ((field-predicate ...)
-                    (map (lambda (type)
-                           (id #'stem type #'?))
-    			 #'(field-type ...)))
-                   ((field-default ...)
-                    (map (match-lambda
-    			   ((field-type default-value)
-                            default-value)
-    			   ((field-type)
-                            ;; Quote `undefined' to prevent a possibly
-                            ;; unbound warning.
-                            (syntax 'undefined)))
-    			 #'((field-type def ...) ...)))
-                   ((field-serializer ...)
-                    (map (lambda (type custom-serializer)
-                           (and serialize?
-                                (match custom-serializer
-                                  ((serializer)
-                                   serializer)
-                                  (()
-                                   (if serializer-prefix
-                                       (id #'stem
-                                           serializer-prefix
-                                           #'serialize- type)
-                                       (id #'stem #'serialize- type))))))
-                         #'(field-type ...)
-                         #'((custom-serializer ...) ...))))
-       #`(begin
-    	   (define-record-type* #,(id #'stem #'< #'stem #'>)
-    	     #,(id #'stem #'% #'stem)
-    	     #,(id #'stem #'make- #'stem)
-    	     #,(id #'stem #'stem #'?)
-    	     (%location #,(id #'stem #'stem #'-location)
-    			(default (and=> (current-source-location)
-    					source-properties->location))
-    			(innate))
-    	     #,@(map (lambda (name getter def)
-    		       (if (eq? (syntax->datum def) (quote 'undefined))
-    			   #`(#,name #,getter)
-    			   #`(#,name #,getter (default #,def))))
-    		     #'(field ...)
-    		     #'(field-getter ...)
-    		     #'(field-default ...)))
-    	   (define #,(id #'stem #'stem #'-fields)
-    	     (list (configuration-field
-    		    (name 'field)
-    		    (type 'field-type)
-    		    (getter field-getter)
-    		    (predicate field-predicate)
-    		    (serializer field-serializer)
-    		    (default-value-thunk
-    		      (lambda ()
-    			(display '#,(id #'stem #'% #'stem))
-    			(if (eq? (syntax->datum field-default)
-    				 'undefined)
-    			    (configuration-no-default-value
-    			     '#,(id #'stem #'% #'stem) 'field)
-    			    field-default)))
-    		    (documentation doc))
-    		   ...))
-    	   (define-syntax-rule (stem arg (... ...))
-    	     (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
-    	       (validate-configuration conf
-    				       #,(id #'stem #'stem #'-fields))
-    	       conf)))))))
+    ((_ stem (field field-type+def doc custom-serializer ...) ...)
+     (with-syntax
+         ((((field-type def) ...)
+           (map normalize-field-type+def #'(field-type+def ...))))
+       (with-syntax
+           (((field-getter ...)
+             (map (lambda (field)
+                    (id #'stem #'stem #'- field))
+                  #'(field ...)))
+            ((field-predicate ...)
+             (map (lambda (type)
+                    (id #'stem type #'?))
+                  #'(field-type ...)))
+            ((field-default ...)
+             (map (match-lambda
+                    ((field-type default-value)
+                     default-value))
+                  #'((field-type def) ...)))
+            ((field-serializer ...)
+             (map (lambda (type custom-serializer)
+                    (and serialize?
+                         (match custom-serializer
+                           ((serializer)
+                            serializer)
+                           (()
+                            (if serializer-prefix
+                                (id #'stem
+                                    serializer-prefix
+                                    #'serialize- type)
+                                (id #'stem #'serialize- type))))))
+                  #'(field-type ...)
+                  #'((custom-serializer ...) ...))))
+         #`(begin
+             (define-record-type* #,(id #'stem #'< #'stem #'>)
+               #,(id #'stem #'% #'stem)
+               #,(id #'stem #'make- #'stem)
+               #,(id #'stem #'stem #'?)
+               (%location #,(id #'stem #'stem #'-location)
+                          (default (and=> (current-source-location)
+                                          source-properties->location))
+                          (innate))
+               #,@(map (lambda (name getter def)
+                         (if (eq? (syntax->datum def) (quote 'undefined))
+                             #`(#,name #,getter)
+                             #`(#,name #,getter (default #,def))))
+                       #'(field ...)
+                       #'(field-getter ...)
+                       #'(field-default ...)))
+             (define #,(id #'stem #'stem #'-fields)
+               (list (configuration-field
+                      (name 'field)
+                      (type 'field-type)
+                      (getter field-getter)
+                      (predicate field-predicate)
+                      (serializer field-serializer)
+                      (default-value-thunk
+                        (lambda ()
+                          (display '#,(id #'stem #'% #'stem))
+                          (if (eq? (syntax->datum field-default)
+                                   'undefined)
+                              (configuration-no-default-value
+                               '#,(id #'stem #'% #'stem) 'field)
+                              field-default)))
+                      (documentation doc))
+                     ...))
+             (define-syntax-rule (stem arg (... ...))
+               (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
+                 (validate-configuration conf
+                                         #,(id #'stem #'stem #'-fields))
+                 conf))))))))
 
 (define no-serialization         ;syntactic keyword for 'define-configuration'
   '(no serialization))
@@ -241,26 +254,26 @@ (define no-serialization         ;syntactic keyword for 'define-configuration'
 (define-syntax define-configuration
   (lambda (s)
     (syntax-case s (no-serialization prefix)
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem (field field-type+def doc custom-serializer ...) ...
           (no-serialization))
        (define-configuration-helper
-         #f #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #f #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...)))
-      ((_ stem  (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem  (field field-type+def doc custom-serializer ...) ...
           (prefix serializer-prefix))
        (define-configuration-helper
-         #t #'serializer-prefix #'(_ stem (field (field-type def ...)
+         #t #'serializer-prefix #'(_ stem (field field-type+def
                                                  doc custom-serializer ...)
                  ...)))
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
+      ((_ stem (field field-type+def doc custom-serializer ...) ...)
        (define-configuration-helper
-         #t #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #t #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...))))))
 
 (define-syntax-rule (define-configuration/no-serialization
-                      stem (field (field-type def ...)
+                      stem (field field-type+def
                                   doc custom-serializer ...) ...)
-  (define-configuration stem (field (field-type def ...)
+  (define-configuration stem (field field-type+def
                                     doc custom-serializer ...) ...
     (no-serialization)))
 
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 86a36a388d..0debf8095b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -27,6 +27,9 @@ (define-module (tests services configuration)
 
 (test-begin "services-configuration")
 
+(define (serialize-number field value)
+  (format #f "~a=~a" field value))
+
 
 ;;;
 ;;; define-configuration macro.
@@ -47,7 +50,6 @@ (define-configuration port-configuration-cs
   80
   (port-configuration-cs-port (port-configuration-cs)))
 
-(define serialize-number "")
 (define-configuration port-configuration-ndv
   (port (number) "The port number."))
 
@@ -101,15 +103,31 @@ (define-configuration configuration-with-prefix
 (define-maybe number)
 
 (define-configuration config-with-maybe-number
-  (port (maybe-number 80) "The port number."))
-
-(define (serialize-number field value)
-  (format #f "~a=~a" field value))
+  (port  (maybe-number 80) "")
+  (count maybe-number ""))
 
 (test-equal "maybe value serialization"
   "port=80"
   (serialize-maybe-number "port" 80))
 
+(define (config-with-maybe-number->string x)
+  (eval (gexp->approximate-sexp
+         (serialize-configuration x config-with-maybe-number-fields))
+        (current-module)))
+
+(test-equal "maybe value serialization of the instance"
+  "port=42count=43"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42)
+    (count 43))))
+
+(test-equal "maybe value serialization of the instance, unspecified"
+  "port=42"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42))))
+
 (define-maybe/no-serialization string)
 
 (define-configuration config-with-maybe-string/no-serialization
-- 
2.34.0

Message #32 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v3 2/2] services: configuration: Use *unspecified* instead of
 'disabled.
Date: Thu,  7 Apr 2022 17:01:42 +0200

Use it as a marker for field values that have not been set.

Rationale: 'disabled may easily clash with user values for boolean fields, is
confusing (i.e. its meaning is *not* boolean false, but unspecified) and it
also passes through silently the symbol? predicate of a field of type symbol.

* gnu/services/configuration.scm (configuration-missing-default-value):
Renamed from configuration-no-default-value.
* gnu/services/configuration.scm (define-maybe-helper): Use *unspecified*
instead of 'disabled, and make the default value optional.
* tests/services/configuration.scm ("maybe type, no default")
("maybe type, with default"): New tests.
---

v3 cleans up the commit message. the code is not changed.

 gnu/home/services/desktop.scm    | 12 ++---
 gnu/services/authentication.scm  | 82 ++++++++++++++++----------------
 gnu/services/cgit.scm            | 12 ++---
 gnu/services/configuration.scm   | 17 ++++---
 gnu/services/file-sharing.scm    | 24 +++++-----
 gnu/services/messaging.scm       | 37 +++++++-------
 gnu/services/networking.scm      | 12 ++---
 gnu/services/pm.scm              | 54 ++++++++++-----------
 gnu/services/telephony.scm       | 14 +++---
 gnu/services/vpn.scm             |  2 +-
 tests/services/configuration.scm | 12 +++++
 11 files changed, 144 insertions(+), 134 deletions(-)

diff --git a/gnu/home/services/desktop.scm b/gnu/home/services/desktop.scm
index cbb9cf76da..a54ad0d115 100644
--- a/gnu/home/services/desktop.scm
+++ b/gnu/home/services/desktop.scm
@@ -91,26 +91,26 @@ (define-configuration home-redshift-configuration
    "Nighttime color temperature (kelvins).")
 
   (daytime-brightness
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Daytime screen brightness, between 0.1 and 1.0.")
   (nighttime-brightness
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Nighttime screen brightness, between 0.1 and 1.0.")
 
   (latitude
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Latitude, when @code{location-provider} is @code{'manual}.")
   (longitude
-   (maybe-inexact-number 'disabled)
+   (maybe-inexact-number)
    "Longitude, when @code{location-provider} is @code{'manual}.")
 
   (dawn-time
-   (maybe-string 'disabled)
+   (maybe-string)
    "Custom time for the transition from night to day in the
 morning---@code{\"HH:MM\"} format.  When specified, solar elevation is not
 used to determine the daytime/nighttime period.")
   (dusk-time
-   (maybe-string 'disabled)
+   (maybe-string)
    "Likewise, custom time for the transition from day to night in the
 evening.")
 
diff --git a/gnu/services/authentication.scm b/gnu/services/authentication.scm
index cb0ef6d85a..1c4800bfbd 100644
--- a/gnu/services/authentication.scm
+++ b/gnu/services/authentication.scm
@@ -218,7 +218,7 @@ (define-configuration nslcd-configuration
 
   ;; Runtime options
   (threads
-   (maybe-number 'disabled)
+   (maybe-number)
    "The number of threads to start that can handle requests and perform LDAP
 queries.  Each thread opens a separate connection to the LDAP server.  The
 default is to start 5 threads.")
@@ -243,45 +243,45 @@ (define-configuration nslcd-configuration
    "The list of LDAP server URIs.  Normally, only the first server will be
 used with the following servers as fall-back.")
   (ldap-version
-   (maybe-string 'disabled)
+   (maybe-string)
    "The version of the LDAP protocol to use.  The default is to use the
 maximum version supported by the LDAP library.")
   (binddn
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the distinguished name with which to bind to the directory
 server for lookups.  The default is to bind anonymously.")
   (bindpw
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the credentials with which to bind.  This option is only
 applicable when used with binddn.")
   (rootpwmoddn
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the distinguished name to use when the root user tries to modify
 a user's password using the PAM module.")
   (rootpwmodpw
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the credentials with which to bind if the root user tries to
 change a user's password.  This option is only applicable when used with
 rootpwmoddn")
 
   ;; SASL authentication options
   (sasl-mech
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the SASL mechanism to be used when performing SASL
 authentication.")
   (sasl-realm
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the SASL realm to be used when performing SASL authentication.")
   (sasl-authcid
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the authentication identity to be used when performing SASL
 authentication.")
   (sasl-authzid
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the authorization identity to be used when performing SASL
 authentication.")
   (sasl-canonicalize?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Determines whether the LDAP server host name should be canonicalised.  If
 this is enabled the LDAP library will do a reverse host name lookup.  By
 default, it is left up to the LDAP library whether this check is performed or
@@ -289,7 +289,7 @@ (define-configuration nslcd-configuration
 
   ;; Kerberos authentication options
   (krb5-ccname
-   (maybe-string 'disabled)
+   (maybe-string)
    "Set the name for the GSS-API Kerberos credentials cache.")
 
   ;; Search / mapping options
@@ -302,11 +302,11 @@ (define-configuration nslcd-configuration
 default scope is subtree; base scope is almost never useful for name service
 lookups; children scope is not supported on all servers.")
   (deref
-   (maybe-deref-option 'disabled)
+   (maybe-deref-option)
    "Specifies the policy for dereferencing aliases.  The default policy is to
 never dereference aliases.")
   (referrals
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Specifies whether automatic referral chasing should be enabled.  The
 default behaviour is to chase referrals.")
   (maps
@@ -322,132 +322,132 @@ (define-configuration nslcd-configuration
 
   ;; Timing / reconnect options
   (bind-timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time limit in seconds to use when connecting to the
 directory server.  The default value is 10 seconds.")
   (timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time limit (in seconds) to wait for a response from the LDAP
 server.  A value of zero, which is the default, is to wait indefinitely for
 searches to be completed.")
   (idle-timelimit
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the period if inactivity (in seconds) after which the con‐
 nection to the LDAP server will be closed.  The default is not to time out
 connections.")
   (reconnect-sleeptime
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the number of seconds to sleep when connecting to all LDAP
 servers fails.  By default one second is waited between the first failure and
 the first retry.")
   (reconnect-retrytime
-   (maybe-number 'disabled)
+   (maybe-number)
    "Specifies the time after which the LDAP server is considered to be
 permanently unavailable.  Once this time is reached retries will be done only
 once per this time period.  The default value is 10 seconds.")
 
   ;; TLS options
   (ssl
-   (maybe-ssl-option 'disabled)
+   (maybe-ssl-option)
    "Specifies whether to use SSL/TLS or not (the default is not to).  If
 'start-tls is specified then StartTLS is used rather than raw LDAP over SSL.")
   (tls-reqcert
-   (maybe-tls-reqcert-option 'disabled)
+   (maybe-tls-reqcert-option)
    "Specifies what checks to perform on a server-supplied certificate.
 The meaning of the values is described in the ldap.conf(5) manual page.")
   (tls-cacertdir
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the directory containing X.509 certificates for peer authen‐
 tication.  This parameter is ignored when using GnuTLS.")
   (tls-cacertfile
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the X.509 certificate for peer authentication.")
   (tls-randfile
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to an entropy source.  This parameter is ignored when
 using GnuTLS.")
   (tls-ciphers
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the ciphers to use for TLS as a string.")
   (tls-cert
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the file containing the local certificate for client
 TLS authentication.")
   (tls-key
-   (maybe-string 'disabled)
+   (maybe-string)
    "Specifies the path to the file containing the private key for client TLS
 authentication.")
 
   ;; Other options
   (pagesize
-   (maybe-number 'disabled)
+   (maybe-number)
    "Set this to a number greater than 0 to request paged results from the LDAP
 server in accordance with RFC2696.  The default (0) is to not request paged
 results.")
   (nss-initgroups-ignoreusers
-   (maybe-ignore-users-option 'disabled)
+   (maybe-ignore-users-option)
    "This option prevents group membership lookups through LDAP for the
 specified users.  Alternatively, the value 'all-local may be used.  With that
 value nslcd builds a full list of non-LDAP users on startup.")
   (nss-min-uid
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option ensures that LDAP users with a numeric user id lower than the
 specified value are ignored.")
   (nss-uid-offset
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option specifies an offset that is added to all LDAP numeric user
 ids.  This can be used to avoid user id collisions with local users.")
   (nss-gid-offset
-   (maybe-number 'disabled)
+   (maybe-number)
    "This option specifies an offset that is added to all LDAP numeric group
 ids.  This can be used to avoid user id collisions with local groups.")
   (nss-nested-groups
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, the member attribute of a group may point to
 another group.  Members of nested groups are also returned in the higher level
 group and parent groups are returned when finding groups for a specific user.
 The default is not to perform extra searches for nested groups.")
   (nss-getgrent-skipmembers
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, the group member list is not retrieved when looking
 up groups.  Lookups for finding which groups a user belongs to will remain
 functional so the user will likely still get the correct groups assigned on
 login.")
   (nss-disable-enumeration
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "If this option is set, functions which cause all user/group entries to be
 loaded from the directory will not succeed in doing so.  This can dramatically
 reduce LDAP server load in situations where there are a great number of users
 and/or groups.  This option is not recommended for most configurations.")
   (validnames
-   (maybe-string 'disabled)
+   (maybe-string)
    "This option can be used to specify how user and group names are verified
 within the system.  This pattern is used to check all user and group names
 that are requested and returned from LDAP.")
   (ignorecase
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "This specifies whether or not to perform searches using case-insensitive
 matching.  Enabling this could open up the system to authorization bypass
 vulnerabilities and introduce nscd cache poisoning vulnerabilities which allow
 denial of service.")
   (pam-authc-ppolicy
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "This option specifies whether password policy controls are requested and
 handled from the LDAP server when performing user authentication.")
   (pam-authc-search
-   (maybe-string 'disabled)
+   (maybe-string)
    "By default nslcd performs an LDAP search with the user's credentials after
 BIND (authentication) to ensure that the BIND operation was successful.  The
 default search is a simple check to see if the user's DN exists.  A search
 filter can be specified that will be used instead.  It should return at least
 one entry.")
   (pam-authz-search
-   (maybe-string 'disabled)
+   (maybe-string)
    "This option allows flexible fine tuning of the authorisation check that
 should be performed.  The search filter specified is executed and if any
 entries match, access is granted, otherwise access is denied.")
   (pam-password-prohibit-message
-   (maybe-string 'disabled)
+   (maybe-string)
    "If this option is set password modification using pam_ldap will be denied
 and the specified message will be presented to the user instead.  The message
 can be used to direct the user to an alternative means of changing their
diff --git a/gnu/services/cgit.scm b/gnu/services/cgit.scm
index bfc89a40a4..bcb3e1a796 100644
--- a/gnu/services/cgit.scm
+++ b/gnu/services/cgit.scm
@@ -241,27 +241,27 @@ (define-configuration repository-cgit-configuration
    (repo-file-object "")
    "Override the default @code{email-filter}.")
   (enable-commit-graph?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-commit-graph?}.")
   (enable-log-filecount?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-log-filecount?}.")
   (enable-log-linecount?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to disable the global setting
 @code{enable-log-linecount?}.")
   (enable-remote-branches?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "Flag which, when set to @code{#t}, will make cgit display remote
 branches in the summary and refs views.")
   (enable-subject-links?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to override the global setting
 @code{enable-subject-links?}.")
   (enable-html-serving?
-   (maybe-repo-boolean 'disabled)
+   (maybe-repo-boolean)
    "A flag which can be used to override the global setting
 @code{enable-html-serving?}.")
   (hide?
diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index bdca33ed68..f6b20fb82b 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -93,7 +93,7 @@ (define (configuration-field-error field val)
 (define (configuration-missing-field kind field)
   (configuration-error
    (format #f "~a configuration missing required field ~a" kind field)))
-(define (configuration-no-default-value kind field)
+(define (configuration-missing-default-value kind field)
   (configuration-error
    (format #f "The field `~a' of the `~a' configuration record \
 does not have a default value" field kind)))
@@ -142,7 +142,8 @@ (define (define-maybe-helper serialize? prefix syn)
                                     (id #'stem #'serialize-maybe- #'stem))))
        #`(begin
            (define (maybe-stem? val)
-             (or (eq? val 'disabled) (stem? val)))
+             (or (unspecified? val)
+                 (stem? val)))
            #,@(if serialize?
                   (list #'(define (serialize-maybe-stem field-name val)
                             (if (stem? val)
@@ -170,10 +171,10 @@ (define (normalize-field-type+def s)
      (values #'(field-type def)))
     ((field-type)
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))
+     (values #'(field-type *unspecified*)))
     (field-type
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))))
+     (values #'(field-type *unspecified*)))))
 
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
@@ -219,9 +220,7 @@ (define-record-type* #,(id #'stem #'< #'stem #'>)
                                           source-properties->location))
                           (innate))
                #,@(map (lambda (name getter def)
-                         (if (eq? (syntax->datum def) (quote 'undefined))
-                             #`(#,name #,getter)
-                             #`(#,name #,getter (default #,def))))
+                         #`(#,name #,getter (default #,def)))
                        #'(field ...)
                        #'(field-getter ...)
                        #'(field-default ...)))
@@ -236,8 +235,8 @@ (define #,(id #'stem #'stem #'-fields)
                         (lambda ()
                           (display '#,(id #'stem #'% #'stem))
                           (if (eq? (syntax->datum field-default)
-                                   'undefined)
-                              (configuration-no-default-value
+                                   '*unspecified*)
+                              (configuration-missing-default-value
                                '#,(id #'stem #'% #'stem) 'field)
                               field-default)))
                       (documentation doc))
diff --git a/gnu/services/file-sharing.scm b/gnu/services/file-sharing.scm
index e3d681b08f..6e71fa9154 100644
--- a/gnu/services/file-sharing.scm
+++ b/gnu/services/file-sharing.scm
@@ -115,8 +115,7 @@ (define-maybe string)
 (set! serialize-maybe-string
   (lambda (field-name val)
     (serialize-string field-name
-                      (if (and (symbol? val)
-                               (eq? val 'disabled))
+                      (if (unspecified? val)
                           ""
                           val))))
 
@@ -181,8 +180,7 @@ (define (serialize-file-object field-name val)
 (define-maybe file-object)
 (set! serialize-maybe-file-object
   (lambda (field-name val)
-    (if (and (symbol? val)
-             (eq? val 'disabled))
+    (if (unspecified? val)
         (serialize-string field-name "")
         (serialize-file-object field-name val))))
 
@@ -281,7 +279,7 @@ (define-configuration transmission-daemon-configuration
 torrent is complete.  Otherwise, files for all torrents (including those still
 being downloaded) will be placed in @code{download-dir}.")
   (incomplete-dir
-   (maybe-string 'disabled)
+   (maybe-string)
    "The directory in which files from incompletely downloaded torrents will be
 held when @code{incomplete-dir-enabled?} is @code{#t}.")
   (umask
@@ -305,7 +303,7 @@ (define-configuration transmission-daemon-configuration
 automatically (and the original files removed, if
 @code{trash-original-torrent-files?} is @code{#t}).")
   (watch-dir
-   (maybe-string 'disabled)
+   (maybe-string)
    "The directory to be watched for @file{.torrent} files indicating new
 torrents to be added, when @code{watch-dir-enabled} is @code{#t}.")
   (trash-original-torrent-files?
@@ -401,11 +399,11 @@ (define-configuration transmission-daemon-configuration
 @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or
 @code{require-encrypted-connections}.")
   (peer-congestion-algorithm
-   (maybe-string 'disabled)
+   (maybe-string)
    "The TCP congestion-control algorithm to use for peer connections,
 specified using a string recognized by the operating system in calls to
-@code{setsockopt} (or set to @code{disabled}, in which case the
-operating-system default is used).
+@code{setsockopt} (or leave it unset, in which case the operating-system
+default is used).
 
 Note that on GNU/Linux systems, the kernel must be configured to allow
 processes to use a congestion-control algorithm not in the default set;
@@ -465,7 +463,7 @@ (define-configuration transmission-daemon-configuration
    "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it
 has most recently downloaded from @code{blocklist-url}.")
   (blocklist-url
-   (maybe-string 'disabled)
+   (maybe-string)
    "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule
 @file{.dat} format) to be periodically downloaded and applied when
 @code{blocklist-enabled?} is @code{#t}.")
@@ -564,11 +562,11 @@ (define-configuration transmission-daemon-configuration
 the side effect of disabling host-name whitelisting (see
 @code{rpc-host-whitelist-enabled?}.")
   (rpc-username
-   (maybe-string 'disabled)
+   (maybe-string)
    "The username required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.")
   (rpc-password
-   (maybe-transmission-password-hash 'disabled)
+   (maybe-transmission-password-hash)
    "The password required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.  This must be specified
 using a password hash in the format recognized by Transmission clients, either
@@ -613,7 +611,7 @@ (define-configuration transmission-daemon-configuration
 @code{script-torrent-done-filename} will be invoked each time a torrent
 completes.")
   (script-torrent-done-filename
-   (maybe-file-object 'disabled)
+   (maybe-file-object)
    "A file name or file-like object specifying a script to run each time a
 torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}.")
   (scrape-paused-torrents-enabled?
diff --git a/gnu/services/messaging.scm b/gnu/services/messaging.scm
index 4bceb1d37a..5f20d768ef 100644
--- a/gnu/services/messaging.scm
+++ b/gnu/services/messaging.scm
@@ -72,6 +72,7 @@ (define (make-pred arg)
       (lambda (field target)
         (and (memq (syntax->datum target) `(common ,arg)) field)))
     (syntax-case stx ()
+      ;; TODO Also handle (field-type) form, without a default.
       ((_ stem (field (field-type def) doc target) ...)
        (with-syntax (((new-field-type ...)
                       (map (lambda (field-type target)
@@ -85,7 +86,7 @@ (define (make-pred arg)
                      ((new-def ...)
                       (map (lambda (def target)
                              (if (eq? 'common (syntax->datum target))
-                                 #''disabled def))
+                                 #'*unspecified* def))
                            #'(def ...) #'(target ...)))
                      ((new-doc ...)
                       (map (lambda (doc target)
@@ -195,7 +196,7 @@ (define (serialize-file-object-list field-name val)
 (define-maybe file-object-list)
 
 (define (raw-content? val)
-  (not (eq? val 'disabled)))
+  (not (unspecified? val)))
 (define (serialize-raw-content field-name val)
   val)
 (define-maybe raw-content)
@@ -223,15 +224,15 @@ (define-maybe mod-muc-configuration)
 
 (define-configuration ssl-configuration
   (protocol
-   (maybe-string 'disabled)
+   (maybe-string)
    "This determines what handshake to use.")
 
   (key
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "Path to your private key file.")
 
   (certificate
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "Path to your certificate file.")
 
   (capath
@@ -240,48 +241,48 @@ (define-configuration ssl-configuration
 trust when verifying the certificates of remote servers.")
 
   (cafile
-   (maybe-file-object 'disabled)
+   (maybe-file-object)
    "Path to a file containing root certificates that you wish Prosody to trust.
 Similar to @code{capath} but with all certificates concatenated together.")
 
   (verify
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of verification options (these mostly map to OpenSSL's
 @code{set_verify()} flags).")
 
   (options
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of general options relating to SSL/TLS.  These map to OpenSSL's
 @code{set_options()}.  For a full list of options available in LuaSec, see the
 LuaSec source.")
 
   (depth
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "How long a chain of certificate authorities to check when looking for a
 trusted root certificate.")
 
   (ciphers
-   (maybe-string 'disabled)
+   (maybe-string)
    "An OpenSSL cipher string.  This selects what ciphers Prosody will offer to
 clients, and in what order.")
 
   (dhparam
-   (maybe-file-name 'disabled)
+   (maybe-file-name)
    "A path to a file containing parameters for Diffie-Hellman key exchange.  You
 can create such a file with:
 @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}")
 
   (curve
-   (maybe-string 'disabled)
+   (maybe-string)
    "Curve for Elliptic curve Diffie-Hellman. Prosody's default is
 @samp{\"secp384r1\"}.")
 
   (verifyext
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of \"extra\" verification options.")
 
   (password
-   (maybe-string 'disabled)
+   (maybe-string)
    "Password for encrypted private keys."))
 (define (serialize-ssl-configuration field-name val)
   #~(format #f "ssl = {\n~a};\n"
@@ -469,12 +470,12 @@ (define-all-configurations prosody-configuration
      global)
 
     (http-max-content-size
-     (maybe-non-negative-integer 'disabled)
+     (maybe-non-negative-integer *unspecified*)
      "Maximum allowed size of the HTTP body (in bytes)."
      common)
 
     (http-external-url
-     (maybe-string 'disabled)
+     (maybe-string *unspecified*)
      "Some modules expose their own URL in various ways.  This URL is built
 from the protocol, host and port used.  If Prosody sits behind a proxy, the
 public URL will be @code{http-external-url} instead.  See
@@ -551,7 +552,7 @@ (define-all-configurations prosody-configuration
      int-component)
 
     (mod-muc
-     (maybe-mod-muc-configuration 'disabled)
+     (maybe-mod-muc-configuration *unspecified*)
      "Multi-user chat (MUC) is Prosody's module for allowing you to create
 hosted chatrooms/conferences for XMPP users.
 
@@ -568,7 +569,7 @@ (define-all-configurations prosody-configuration
      ext-component)
 
     (raw-content
-     (maybe-raw-content 'disabled)
+     (maybe-raw-content *unspecified*)
      "Raw content that will be added to the configuration file."
      common)))
 
diff --git a/gnu/services/networking.scm b/gnu/services/networking.scm
index 5bb8638930..b5c46218e7 100644
--- a/gnu/services/networking.scm
+++ b/gnu/services/networking.scm
@@ -763,17 +763,17 @@ (define-configuration/no-serialization opendht-configuration
    "The node host name that is used to make the first connection to the
 network.  A specific port value can be provided by appending the @code{:PORT}
 suffix.  By default, it uses the Jami bootstrap nodes, but any host can be
-specified here.  It's also possible to disable bootstrapping by setting this
-to the @code{'disabled} symbol.")
+specified here.  It's also possible to disable bootstrapping by explicitly
+setting this field to the @code{*unspecified*} value.")
   (port
    (maybe-number 4222)
-   "The UDP port to bind to.  When set to @code{'disabled}, an available port
-is automatically selected.")
+   "The UDP port to bind to.  When set to @code{*unspecified*}, an available
+port is automatically selected.")
   (proxy-server-port
-   (maybe-number 'disabled)
+   (maybe-number)
    "Spawn a proxy server listening on the specified port.")
   (proxy-server-port-tls
-   (maybe-number 'disabled)
+   (maybe-number)
    "Spawn a proxy server listening to TLS connections on the specified
 port."))
 
diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index e48236dbca..d1250ab488 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -114,55 +114,55 @@ (define-configuration tlp-configuration
    "Same as @code{max-lost-work-secs-on-ac} but on BAT mode.")
 
   (cpu-scaling-governor-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "CPU frequency scaling governor on AC mode.  With intel_pstate
 driver, alternatives are powersave and performance.  With acpi-cpufreq driver,
 alternatives are ondemand, powersave, performance and conservative.")
 
   (cpu-scaling-governor-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode.")
 
   (cpu-scaling-min-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the min available frequency for the scaling governor on AC.")
 
   (cpu-scaling-max-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the max available frequency for the scaling governor on AC.")
 
   (cpu-scaling-min-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the min available frequency for the scaling governor on BAT.")
 
   (cpu-scaling-max-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Set the max available frequency for the scaling governor on BAT.")
 
   (cpu-min-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Limit the min P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-max-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Limit the max P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-min-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Same as @code{cpu-min-perf-on-ac} on BAT mode.")
 
   (cpu-max-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Same as @code{cpu-max-perf-on-ac} on BAT mode.")
 
   (cpu-boost-on-ac?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Enable CPU turbo boost feature on AC mode.")
 
   (cpu-boost-on-bat?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Same as @code{cpu-boost-on-ac?} on BAT mode.")
 
   (sched-powersave-on-ac?
@@ -179,7 +179,7 @@ (define-configuration tlp-configuration
    "Enable Linux kernel NMI watchdog.")
 
   (phc-controls
-   (maybe-string 'disabled)
+   (maybe-string)
    "For Linux kernels with PHC patch applied, change CPU voltages.
 An example value would be @samp{\"F:V F:V F:V F:V\"}.")
 
@@ -205,16 +205,16 @@ (define-configuration tlp-configuration
    "Same as @code{disk-apm-bat} but on BAT mode.")
 
   (disk-spindown-timeout-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Hard disk spin down timeout.  One value has to be specified for
 each declared hard disk.")
 
   (disk-spindown-timeout-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode.")
 
   (disk-iosched
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Select IO scheduler for disk devices.  One value has to be specified
 for each declared hard disk.  Example alternatives are cfq, deadline and noop.")
 
@@ -228,16 +228,16 @@ (define-configuration tlp-configuration
    "Same as @code{sata-linkpwr-ac} but on BAT mode.")
 
   (sata-linkpwr-blacklist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Exclude specified SATA host devices for link power management.")
 
   (ahci-runtime-pm-on-ac?
-   (maybe-on-off-boolean 'disabled)
+   (maybe-on-off-boolean)
    "Enable Runtime Power Management for AHCI controller and disks
 on AC mode.")
 
   (ahci-runtime-pm-on-bat?
-   (maybe-on-off-boolean 'disabled)
+   (maybe-on-off-boolean)
    "Same as @code{ahci-runtime-pm-on-ac} on BAT mode.")
 
   (ahci-runtime-pm-timeout
@@ -254,19 +254,19 @@ (define-configuration tlp-configuration
    "Same as @code{pcie-aspm-ac} but on BAT mode.")
 
   (start-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 0 should begin charging.")
 
   (stop-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 0 should stop charging.")
 
   (start-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 1 should begin charging.")
 
   (stop-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   (maybe-non-negative-integer)
    "Percentage when battery 1 should stop charging.")
 
   (radeon-power-profile-on-ac
@@ -346,7 +346,7 @@ (define-configuration tlp-configuration
 blacklisted ones.")
 
   (runtime-pm-blacklist
-   (maybe-space-separated-string-list 'disabled)
+   (maybe-space-separated-string-list)
    "Exclude specified PCI(e) device addresses from Runtime Power Management.")
 
   (runtime-pm-driver-blacklist
@@ -359,7 +359,7 @@ (define-configuration tlp-configuration
    "Enable USB autosuspend feature.")
 
   (usb-blacklist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Exclude specified devices from USB autosuspend.")
 
   (usb-blacklist-wwan?
@@ -367,12 +367,12 @@ (define-configuration tlp-configuration
    "Exclude WWAN devices from USB autosuspend.")
 
   (usb-whitelist
-   (maybe-string 'disabled)
+   (maybe-string)
    "Include specified devices into USB autosuspend, even if they are
 already excluded by the driver or via @code{usb-blacklist-wwan?}.")
 
   (usb-autosuspend-disable-on-shutdown?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Enable USB autosuspend before shutdown.")
 
   (restore-device-state-on-startup?
diff --git a/gnu/services/telephony.scm b/gnu/services/telephony.scm
index 157d96abd6..c153cb37c3 100644
--- a/gnu/services/telephony.scm
+++ b/gnu/services/telephony.scm
@@ -155,7 +155,7 @@ (define-configuration jami-account
 secret key material of the Jami account it contains."
    empty-serializer)
   (allowed-contacts
-   (maybe-account-fingerprint-list 'disabled)
+   (maybe-account-fingerprint-list)
    "The list of allowed contacts for the account, entered as their 40
 characters long fingerprint.  Messages or calls from accounts not in that list
 will be rejected.  When unspecified, the configuration of the account archive
@@ -164,7 +164,7 @@ (define-configuration jami-account
 the account."
    empty-serializer)
   (moderators
-   (maybe-account-fingerprint-list 'disabled)
+   (maybe-account-fingerprint-list)
    "The list of contacts that should have moderation privileges (to ban, mute,
 etc. other users) in rendezvous conferences, entered as their 40 characters
 long fingerprint.  When unspecified, the configuration of the account archive
@@ -173,24 +173,24 @@ (define-configuration jami-account
    empty-serializer)
   ;; The serializable fields below are to be set with set-account-details.
   (rendezvous-point?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Whether the account should operate in the rendezvous mode.  In this mode,
 all the incoming audio/video calls are mixed into a conference.  When left
 unspecified, the value from the account archive prevails.")
   (peer-discovery?
-   (maybe-boolean 'disabled)
+   (maybe-boolean)
    "Whether peer discovery should be enabled.  Peer discovery is used to
 discover other OpenDHT nodes on the local network, which can be useful to
 maintain communication between devices on such network even when the
 connection to the the Internet has been lost.  When left unspecified, the
 value from the account archive prevails.")
   (bootstrap-hostnames
-   (maybe-string-list 'disabled)
+   (maybe-string-list)
    "A list of hostnames or IPs pointing to OpenDHT nodes, that should be used
 to initially join the OpenDHT network.  When left unspecified, the value from
 the account archive prevails.")
   (name-server-uri
-   (maybe-string 'disabled)
+   (maybe-string)
    "The URI of the name server to use, that can be used to retrieve the
 account fingerprint for a registered username."))
 
@@ -245,7 +245,7 @@ (define-configuration/no-serialization jami-configuration
    (boolean #f)
    "Whether to force automatic answer to incoming calls.")
   (accounts
-   (maybe-jami-account-list 'disabled)
+   (maybe-jami-account-list)
    "A list of Jami accounts to be (re-)provisioned every time the Jami daemon
 service starts.  When providing this field, the account directories under
 @file{/var/lib/jami/} are recreated every time the service starts, ensuring a
diff --git a/gnu/services/vpn.scm b/gnu/services/vpn.scm
index b24e9cffb3..133a5ad9bf 100644
--- a/gnu/services/vpn.scm
+++ b/gnu/services/vpn.scm
@@ -363,7 +363,7 @@ (define-split-configuration openvpn-client-configuration
 channel to protect against DoS attacks.")
 
    (auth-user-pass
-     (maybe-string 'disabled)
+    (maybe-string)
      "Authenticate with server using username/password.  The option is a file
 containing username/password on 2 lines.  Do not use a file-like object as it
 would be added to the store and readable by any user.")
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 0debf8095b..334a1e409b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -136,3 +136,15 @@ (define-configuration config-with-maybe-string/no-serialization
 
 (test-assert "maybe value without serialization no procedure bound"
   (not (defined? 'serialize-maybe-string)))
+
+(test-assert "maybe type, no default"
+  (unspecified?
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization))))
+
+(test-assert "maybe type, with default"
+  (equal?
+   "foo"
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization
+     (name "foo")))))
-- 
2.34.0

Message #35 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH] services: configuration: Use *unspecified*
 instead of 'disabled.
Date: Mon, 18 Apr 2022 09:26:48 +0000

i don't want to be pushy, but some changes that i wish i could publish is held back by the fate of this patchset (https://github.com/attila-lendvai/guix-crypto/commits/staging). hence i wish there was some progress on this, and i'm willing to do whatever may help the process (e.g. writing some more tests?).

i'd be satisfied with a simple promise that it's already being investigated/tested, or even with a rejection that this is not the right direction and it probably won't be accepted. it would be disappointing, but then i could refactor my channel to work with the current guix proper codebase and publish it.

--
• attila lendvai
• PGP: 963F 5D5F 45C7 DFCD 0A39
--
“Keep things as simple as you can, but no simpler.”
	— Albert Einstein (1879–1955), variations: things/explanation; Einstein/Occam

Message #38 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v4 1/2] services: configuration: Support (field1 maybe-number
 "") format.
Date: Wed, 20 Apr 2022 11:15:53 +0200

As opposed to explicitly using 'disabled as value, or using the
(field1 (maybe-number) "") format.

It's mostly the work of Maxime Devos shared under #54674, with some
modifications by Attila Lendvai.

* gnu/services/configuration.scm (normalize-field-type+def): New function.
(define-configuration-helper) (define-configuration): Support new field
format.
* tests/services/configuration.scm (config-with-maybe-number->string): New
function.
("maybe value serialization of the instance"): New test.
("maybe value serialization of the instance, unspecified"): New test.
---

v4: the only change is to drop the extra parens around the type in
all the (field1 (maybe-foo) "") forms.

 gnu/services/configuration.scm   | 169 +++++++++++++++++--------------
 tests/services/configuration.scm |  28 ++++-
 2 files changed, 114 insertions(+), 83 deletions(-)

diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index 0de350a4df..bdca33ed68 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2021 Xinglu Chen <public <at> yoctocell.xyz>
 ;;; Copyright © 2021 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
 ;;; Copyright © 2021 Andrew Tropin <andrew <at> trop.in>
+;;; Copyright © 2022 Maxime Devos <maximedevos <at> telenet.be>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -162,78 +163,90 @@ (define-maybe-helper #t #f #'(_ stem))))))
 (define-syntax-rule (define-maybe/no-serialization stem)
   (define-maybe stem (no-serialization)))
 
+(define (normalize-field-type+def s)
+  (syntax-case s ()
+    ((field-type def)
+     (identifier? #'field-type)
+     (values #'(field-type def)))
+    ((field-type)
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))
+    (field-type
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))))
+
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
-    ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
-     (with-syntax (((field-getter ...)
-                    (map (lambda (field)
-                           (id #'stem #'stem #'- field))
-    			 #'(field ...)))
-                   ((field-predicate ...)
-                    (map (lambda (type)
-                           (id #'stem type #'?))
-    			 #'(field-type ...)))
-                   ((field-default ...)
-                    (map (match-lambda
-    			   ((field-type default-value)
-                            default-value)
-    			   ((field-type)
-                            ;; Quote `undefined' to prevent a possibly
-                            ;; unbound warning.
-                            (syntax 'undefined)))
-    			 #'((field-type def ...) ...)))
-                   ((field-serializer ...)
-                    (map (lambda (type custom-serializer)
-                           (and serialize?
-                                (match custom-serializer
-                                  ((serializer)
-                                   serializer)
-                                  (()
-                                   (if serializer-prefix
-                                       (id #'stem
-                                           serializer-prefix
-                                           #'serialize- type)
-                                       (id #'stem #'serialize- type))))))
-                         #'(field-type ...)
-                         #'((custom-serializer ...) ...))))
-       #`(begin
-    	   (define-record-type* #,(id #'stem #'< #'stem #'>)
-    	     #,(id #'stem #'% #'stem)
-    	     #,(id #'stem #'make- #'stem)
-    	     #,(id #'stem #'stem #'?)
-    	     (%location #,(id #'stem #'stem #'-location)
-    			(default (and=> (current-source-location)
-    					source-properties->location))
-    			(innate))
-    	     #,@(map (lambda (name getter def)
-    		       (if (eq? (syntax->datum def) (quote 'undefined))
-    			   #`(#,name #,getter)
-    			   #`(#,name #,getter (default #,def))))
-    		     #'(field ...)
-    		     #'(field-getter ...)
-    		     #'(field-default ...)))
-    	   (define #,(id #'stem #'stem #'-fields)
-    	     (list (configuration-field
-    		    (name 'field)
-    		    (type 'field-type)
-    		    (getter field-getter)
-    		    (predicate field-predicate)
-    		    (serializer field-serializer)
-    		    (default-value-thunk
-    		      (lambda ()
-    			(display '#,(id #'stem #'% #'stem))
-    			(if (eq? (syntax->datum field-default)
-    				 'undefined)
-    			    (configuration-no-default-value
-    			     '#,(id #'stem #'% #'stem) 'field)
-    			    field-default)))
-    		    (documentation doc))
-    		   ...))
-    	   (define-syntax-rule (stem arg (... ...))
-    	     (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
-    	       (validate-configuration conf
-    				       #,(id #'stem #'stem #'-fields))
-    	       conf)))))))
+    ((_ stem (field field-type+def doc custom-serializer ...) ...)
+     (with-syntax
+         ((((field-type def) ...)
+           (map normalize-field-type+def #'(field-type+def ...))))
+       (with-syntax
+           (((field-getter ...)
+             (map (lambda (field)
+                    (id #'stem #'stem #'- field))
+                  #'(field ...)))
+            ((field-predicate ...)
+             (map (lambda (type)
+                    (id #'stem type #'?))
+                  #'(field-type ...)))
+            ((field-default ...)
+             (map (match-lambda
+                    ((field-type default-value)
+                     default-value))
+                  #'((field-type def) ...)))
+            ((field-serializer ...)
+             (map (lambda (type custom-serializer)
+                    (and serialize?
+                         (match custom-serializer
+                           ((serializer)
+                            serializer)
+                           (()
+                            (if serializer-prefix
+                                (id #'stem
+                                    serializer-prefix
+                                    #'serialize- type)
+                                (id #'stem #'serialize- type))))))
+                  #'(field-type ...)
+                  #'((custom-serializer ...) ...))))
+         #`(begin
+             (define-record-type* #,(id #'stem #'< #'stem #'>)
+               #,(id #'stem #'% #'stem)
+               #,(id #'stem #'make- #'stem)
+               #,(id #'stem #'stem #'?)
+               (%location #,(id #'stem #'stem #'-location)
+                          (default (and=> (current-source-location)
+                                          source-properties->location))
+                          (innate))
+               #,@(map (lambda (name getter def)
+                         (if (eq? (syntax->datum def) (quote 'undefined))
+                             #`(#,name #,getter)
+                             #`(#,name #,getter (default #,def))))
+                       #'(field ...)
+                       #'(field-getter ...)
+                       #'(field-default ...)))
+             (define #,(id #'stem #'stem #'-fields)
+               (list (configuration-field
+                      (name 'field)
+                      (type 'field-type)
+                      (getter field-getter)
+                      (predicate field-predicate)
+                      (serializer field-serializer)
+                      (default-value-thunk
+                        (lambda ()
+                          (display '#,(id #'stem #'% #'stem))
+                          (if (eq? (syntax->datum field-default)
+                                   'undefined)
+                              (configuration-no-default-value
+                               '#,(id #'stem #'% #'stem) 'field)
+                              field-default)))
+                      (documentation doc))
+                     ...))
+             (define-syntax-rule (stem arg (... ...))
+               (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
+                 (validate-configuration conf
+                                         #,(id #'stem #'stem #'-fields))
+                 conf))))))))
 
 (define no-serialization         ;syntactic keyword for 'define-configuration'
   '(no serialization))
@@ -241,26 +254,26 @@ (define no-serialization         ;syntactic keyword for 'define-configuration'
 (define-syntax define-configuration
   (lambda (s)
     (syntax-case s (no-serialization prefix)
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem (field field-type+def doc custom-serializer ...) ...
           (no-serialization))
        (define-configuration-helper
-         #f #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #f #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...)))
-      ((_ stem  (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem  (field field-type+def doc custom-serializer ...) ...
           (prefix serializer-prefix))
        (define-configuration-helper
-         #t #'serializer-prefix #'(_ stem (field (field-type def ...)
+         #t #'serializer-prefix #'(_ stem (field field-type+def
                                                  doc custom-serializer ...)
                  ...)))
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
+      ((_ stem (field field-type+def doc custom-serializer ...) ...)
        (define-configuration-helper
-         #t #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #t #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...))))))
 
 (define-syntax-rule (define-configuration/no-serialization
-                      stem (field (field-type def ...)
+                      stem (field field-type+def
                                   doc custom-serializer ...) ...)
-  (define-configuration stem (field (field-type def ...)
+  (define-configuration stem (field field-type+def
                                     doc custom-serializer ...) ...
     (no-serialization)))
 
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 86a36a388d..0debf8095b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -27,6 +27,9 @@ (define-module (tests services configuration)
 
 (test-begin "services-configuration")
 
+(define (serialize-number field value)
+  (format #f "~a=~a" field value))
+
 
 ;;;
 ;;; define-configuration macro.
@@ -47,7 +50,6 @@ (define-configuration port-configuration-cs
   80
   (port-configuration-cs-port (port-configuration-cs)))
 
-(define serialize-number "")
 (define-configuration port-configuration-ndv
   (port (number) "The port number."))
 
@@ -101,15 +103,31 @@ (define-configuration configuration-with-prefix
 (define-maybe number)
 
 (define-configuration config-with-maybe-number
-  (port (maybe-number 80) "The port number."))
-
-(define (serialize-number field value)
-  (format #f "~a=~a" field value))
+  (port  (maybe-number 80) "")
+  (count maybe-number ""))
 
 (test-equal "maybe value serialization"
   "port=80"
   (serialize-maybe-number "port" 80))
 
+(define (config-with-maybe-number->string x)
+  (eval (gexp->approximate-sexp
+         (serialize-configuration x config-with-maybe-number-fields))
+        (current-module)))
+
+(test-equal "maybe value serialization of the instance"
+  "port=42count=43"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42)
+    (count 43))))
+
+(test-equal "maybe value serialization of the instance, unspecified"
+  "port=42"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42))))
+
 (define-maybe/no-serialization string)
 
 (define-configuration config-with-maybe-string/no-serialization
-- 
2.35.1

Message #41 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v4 2/2] services: configuration: Use *unspecified* instead of
 'disabled.
Date: Wed, 20 Apr 2022 11:15:55 +0200

Use *unspecified* as a marker for field values that have not been set.

Rationale: 'disabled may easily clash with user values for boolean fields, is
confusing (i.e. its meaning is *not* boolean false, but unspecified) and it
also passes silently through the symbol? predicate of a field of type symbol.

* gnu/services/configuration.scm (configuration-missing-default-value):
Renamed from configuration-no-default-value.
* gnu/services/configuration.scm (define-maybe-helper): Use *unspecified*
instead of 'disabled, and make the default value optional.
* tests/services/configuration.scm ("maybe type, no default")
("maybe type, with default"): New tests.
---
 gnu/home/services/desktop.scm    | 12 ++---
 gnu/services/authentication.scm  | 82 ++++++++++++++++----------------
 gnu/services/cgit.scm            | 12 ++---
 gnu/services/configuration.scm   | 17 ++++---
 gnu/services/file-sharing.scm    | 24 +++++-----
 gnu/services/messaging.scm       | 37 +++++++-------
 gnu/services/networking.scm      | 12 ++---
 gnu/services/pm.scm              | 54 ++++++++++-----------
 gnu/services/telephony.scm       | 14 +++---
 gnu/services/vpn.scm             |  2 +-
 tests/services/configuration.scm | 12 +++++
 11 files changed, 144 insertions(+), 134 deletions(-)

diff --git a/gnu/home/services/desktop.scm b/gnu/home/services/desktop.scm
index cbb9cf76da..b0f4d969b0 100644
--- a/gnu/home/services/desktop.scm
+++ b/gnu/home/services/desktop.scm
@@ -91,26 +91,26 @@ (define-configuration home-redshift-configuration
    "Nighttime color temperature (kelvins).")
 
   (daytime-brightness
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Daytime screen brightness, between 0.1 and 1.0.")
   (nighttime-brightness
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Nighttime screen brightness, between 0.1 and 1.0.")
 
   (latitude
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Latitude, when @code{location-provider} is @code{'manual}.")
   (longitude
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Longitude, when @code{location-provider} is @code{'manual}.")
 
   (dawn-time
-   (maybe-string 'disabled)
+   maybe-string
    "Custom time for the transition from night to day in the
 morning---@code{\"HH:MM\"} format.  When specified, solar elevation is not
 used to determine the daytime/nighttime period.")
   (dusk-time
-   (maybe-string 'disabled)
+   maybe-string
    "Likewise, custom time for the transition from day to night in the
 evening.")
 
diff --git a/gnu/services/authentication.scm b/gnu/services/authentication.scm
index cb0ef6d85a..f7becdfafb 100644
--- a/gnu/services/authentication.scm
+++ b/gnu/services/authentication.scm
@@ -218,7 +218,7 @@ (define-configuration nslcd-configuration
 
   ;; Runtime options
   (threads
-   (maybe-number 'disabled)
+   maybe-number
    "The number of threads to start that can handle requests and perform LDAP
 queries.  Each thread opens a separate connection to the LDAP server.  The
 default is to start 5 threads.")
@@ -243,45 +243,45 @@ (define-configuration nslcd-configuration
    "The list of LDAP server URIs.  Normally, only the first server will be
 used with the following servers as fall-back.")
   (ldap-version
-   (maybe-string 'disabled)
+   maybe-string
    "The version of the LDAP protocol to use.  The default is to use the
 maximum version supported by the LDAP library.")
   (binddn
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the distinguished name with which to bind to the directory
 server for lookups.  The default is to bind anonymously.")
   (bindpw
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the credentials with which to bind.  This option is only
 applicable when used with binddn.")
   (rootpwmoddn
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the distinguished name to use when the root user tries to modify
 a user's password using the PAM module.")
   (rootpwmodpw
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the credentials with which to bind if the root user tries to
 change a user's password.  This option is only applicable when used with
 rootpwmoddn")
 
   ;; SASL authentication options
   (sasl-mech
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the SASL mechanism to be used when performing SASL
 authentication.")
   (sasl-realm
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the SASL realm to be used when performing SASL authentication.")
   (sasl-authcid
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the authentication identity to be used when performing SASL
 authentication.")
   (sasl-authzid
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the authorization identity to be used when performing SASL
 authentication.")
   (sasl-canonicalize?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Determines whether the LDAP server host name should be canonicalised.  If
 this is enabled the LDAP library will do a reverse host name lookup.  By
 default, it is left up to the LDAP library whether this check is performed or
@@ -289,7 +289,7 @@ (define-configuration nslcd-configuration
 
   ;; Kerberos authentication options
   (krb5-ccname
-   (maybe-string 'disabled)
+   maybe-string
    "Set the name for the GSS-API Kerberos credentials cache.")
 
   ;; Search / mapping options
@@ -302,11 +302,11 @@ (define-configuration nslcd-configuration
 default scope is subtree; base scope is almost never useful for name service
 lookups; children scope is not supported on all servers.")
   (deref
-   (maybe-deref-option 'disabled)
+   maybe-deref-option
    "Specifies the policy for dereferencing aliases.  The default policy is to
 never dereference aliases.")
   (referrals
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Specifies whether automatic referral chasing should be enabled.  The
 default behaviour is to chase referrals.")
   (maps
@@ -322,132 +322,132 @@ (define-configuration nslcd-configuration
 
   ;; Timing / reconnect options
   (bind-timelimit
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the time limit in seconds to use when connecting to the
 directory server.  The default value is 10 seconds.")
   (timelimit
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the time limit (in seconds) to wait for a response from the LDAP
 server.  A value of zero, which is the default, is to wait indefinitely for
 searches to be completed.")
   (idle-timelimit
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the period if inactivity (in seconds) after which the con‐
 nection to the LDAP server will be closed.  The default is not to time out
 connections.")
   (reconnect-sleeptime
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the number of seconds to sleep when connecting to all LDAP
 servers fails.  By default one second is waited between the first failure and
 the first retry.")
   (reconnect-retrytime
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the time after which the LDAP server is considered to be
 permanently unavailable.  Once this time is reached retries will be done only
 once per this time period.  The default value is 10 seconds.")
 
   ;; TLS options
   (ssl
-   (maybe-ssl-option 'disabled)
+   maybe-ssl-option
    "Specifies whether to use SSL/TLS or not (the default is not to).  If
 'start-tls is specified then StartTLS is used rather than raw LDAP over SSL.")
   (tls-reqcert
-   (maybe-tls-reqcert-option 'disabled)
+   maybe-tls-reqcert-option
    "Specifies what checks to perform on a server-supplied certificate.
 The meaning of the values is described in the ldap.conf(5) manual page.")
   (tls-cacertdir
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the directory containing X.509 certificates for peer authen‐
 tication.  This parameter is ignored when using GnuTLS.")
   (tls-cacertfile
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to the X.509 certificate for peer authentication.")
   (tls-randfile
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to an entropy source.  This parameter is ignored when
 using GnuTLS.")
   (tls-ciphers
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the ciphers to use for TLS as a string.")
   (tls-cert
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to the file containing the local certificate for client
 TLS authentication.")
   (tls-key
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to the file containing the private key for client TLS
 authentication.")
 
   ;; Other options
   (pagesize
-   (maybe-number 'disabled)
+   maybe-number
    "Set this to a number greater than 0 to request paged results from the LDAP
 server in accordance with RFC2696.  The default (0) is to not request paged
 results.")
   (nss-initgroups-ignoreusers
-   (maybe-ignore-users-option 'disabled)
+   maybe-ignore-users-option
    "This option prevents group membership lookups through LDAP for the
 specified users.  Alternatively, the value 'all-local may be used.  With that
 value nslcd builds a full list of non-LDAP users on startup.")
   (nss-min-uid
-   (maybe-number 'disabled)
+   maybe-number
    "This option ensures that LDAP users with a numeric user id lower than the
 specified value are ignored.")
   (nss-uid-offset
-   (maybe-number 'disabled)
+   maybe-number
    "This option specifies an offset that is added to all LDAP numeric user
 ids.  This can be used to avoid user id collisions with local users.")
   (nss-gid-offset
-   (maybe-number 'disabled)
+   maybe-number
    "This option specifies an offset that is added to all LDAP numeric group
 ids.  This can be used to avoid user id collisions with local groups.")
   (nss-nested-groups
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "If this option is set, the member attribute of a group may point to
 another group.  Members of nested groups are also returned in the higher level
 group and parent groups are returned when finding groups for a specific user.
 The default is not to perform extra searches for nested groups.")
   (nss-getgrent-skipmembers
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "If this option is set, the group member list is not retrieved when looking
 up groups.  Lookups for finding which groups a user belongs to will remain
 functional so the user will likely still get the correct groups assigned on
 login.")
   (nss-disable-enumeration
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "If this option is set, functions which cause all user/group entries to be
 loaded from the directory will not succeed in doing so.  This can dramatically
 reduce LDAP server load in situations where there are a great number of users
 and/or groups.  This option is not recommended for most configurations.")
   (validnames
-   (maybe-string 'disabled)
+   maybe-string
    "This option can be used to specify how user and group names are verified
 within the system.  This pattern is used to check all user and group names
 that are requested and returned from LDAP.")
   (ignorecase
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "This specifies whether or not to perform searches using case-insensitive
 matching.  Enabling this could open up the system to authorization bypass
 vulnerabilities and introduce nscd cache poisoning vulnerabilities which allow
 denial of service.")
   (pam-authc-ppolicy
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "This option specifies whether password policy controls are requested and
 handled from the LDAP server when performing user authentication.")
   (pam-authc-search
-   (maybe-string 'disabled)
+   maybe-string
    "By default nslcd performs an LDAP search with the user's credentials after
 BIND (authentication) to ensure that the BIND operation was successful.  The
 default search is a simple check to see if the user's DN exists.  A search
 filter can be specified that will be used instead.  It should return at least
 one entry.")
   (pam-authz-search
-   (maybe-string 'disabled)
+   maybe-string
    "This option allows flexible fine tuning of the authorisation check that
 should be performed.  The search filter specified is executed and if any
 entries match, access is granted, otherwise access is denied.")
   (pam-password-prohibit-message
-   (maybe-string 'disabled)
+   maybe-string
    "If this option is set password modification using pam_ldap will be denied
 and the specified message will be presented to the user instead.  The message
 can be used to direct the user to an alternative means of changing their
diff --git a/gnu/services/cgit.scm b/gnu/services/cgit.scm
index bfc89a40a4..c2c003983a 100644
--- a/gnu/services/cgit.scm
+++ b/gnu/services/cgit.scm
@@ -241,27 +241,27 @@ (define-configuration repository-cgit-configuration
    (repo-file-object "")
    "Override the default @code{email-filter}.")
   (enable-commit-graph?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to disable the global setting
 @code{enable-commit-graph?}.")
   (enable-log-filecount?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to disable the global setting
 @code{enable-log-filecount?}.")
   (enable-log-linecount?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to disable the global setting
 @code{enable-log-linecount?}.")
   (enable-remote-branches?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "Flag which, when set to @code{#t}, will make cgit display remote
 branches in the summary and refs views.")
   (enable-subject-links?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to override the global setting
 @code{enable-subject-links?}.")
   (enable-html-serving?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to override the global setting
 @code{enable-html-serving?}.")
   (hide?
diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index bdca33ed68..f6b20fb82b 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -93,7 +93,7 @@ (define (configuration-field-error field val)
 (define (configuration-missing-field kind field)
   (configuration-error
    (format #f "~a configuration missing required field ~a" kind field)))
-(define (configuration-no-default-value kind field)
+(define (configuration-missing-default-value kind field)
   (configuration-error
    (format #f "The field `~a' of the `~a' configuration record \
 does not have a default value" field kind)))
@@ -142,7 +142,8 @@ (define (define-maybe-helper serialize? prefix syn)
                                     (id #'stem #'serialize-maybe- #'stem))))
        #`(begin
            (define (maybe-stem? val)
-             (or (eq? val 'disabled) (stem? val)))
+             (or (unspecified? val)
+                 (stem? val)))
            #,@(if serialize?
                   (list #'(define (serialize-maybe-stem field-name val)
                             (if (stem? val)
@@ -170,10 +171,10 @@ (define (normalize-field-type+def s)
      (values #'(field-type def)))
     ((field-type)
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))
+     (values #'(field-type *unspecified*)))
     (field-type
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))))
+     (values #'(field-type *unspecified*)))))
 
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
@@ -219,9 +220,7 @@ (define-record-type* #,(id #'stem #'< #'stem #'>)
                                           source-properties->location))
                           (innate))
                #,@(map (lambda (name getter def)
-                         (if (eq? (syntax->datum def) (quote 'undefined))
-                             #`(#,name #,getter)
-                             #`(#,name #,getter (default #,def))))
+                         #`(#,name #,getter (default #,def)))
                        #'(field ...)
                        #'(field-getter ...)
                        #'(field-default ...)))
@@ -236,8 +235,8 @@ (define #,(id #'stem #'stem #'-fields)
                         (lambda ()
                           (display '#,(id #'stem #'% #'stem))
                           (if (eq? (syntax->datum field-default)
-                                   'undefined)
-                              (configuration-no-default-value
+                                   '*unspecified*)
+                              (configuration-missing-default-value
                                '#,(id #'stem #'% #'stem) 'field)
                               field-default)))
                       (documentation doc))
diff --git a/gnu/services/file-sharing.scm b/gnu/services/file-sharing.scm
index e3d681b08f..e32d1f145d 100644
--- a/gnu/services/file-sharing.scm
+++ b/gnu/services/file-sharing.scm
@@ -115,8 +115,7 @@ (define-maybe string)
 (set! serialize-maybe-string
   (lambda (field-name val)
     (serialize-string field-name
-                      (if (and (symbol? val)
-                               (eq? val 'disabled))
+                      (if (unspecified? val)
                           ""
                           val))))
 
@@ -181,8 +180,7 @@ (define (serialize-file-object field-name val)
 (define-maybe file-object)
 (set! serialize-maybe-file-object
   (lambda (field-name val)
-    (if (and (symbol? val)
-             (eq? val 'disabled))
+    (if (unspecified? val)
         (serialize-string field-name "")
         (serialize-file-object field-name val))))
 
@@ -281,7 +279,7 @@ (define-configuration transmission-daemon-configuration
 torrent is complete.  Otherwise, files for all torrents (including those still
 being downloaded) will be placed in @code{download-dir}.")
   (incomplete-dir
-   (maybe-string 'disabled)
+   maybe-string
    "The directory in which files from incompletely downloaded torrents will be
 held when @code{incomplete-dir-enabled?} is @code{#t}.")
   (umask
@@ -305,7 +303,7 @@ (define-configuration transmission-daemon-configuration
 automatically (and the original files removed, if
 @code{trash-original-torrent-files?} is @code{#t}).")
   (watch-dir
-   (maybe-string 'disabled)
+   maybe-string
    "The directory to be watched for @file{.torrent} files indicating new
 torrents to be added, when @code{watch-dir-enabled} is @code{#t}.")
   (trash-original-torrent-files?
@@ -401,11 +399,11 @@ (define-configuration transmission-daemon-configuration
 @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or
 @code{require-encrypted-connections}.")
   (peer-congestion-algorithm
-   (maybe-string 'disabled)
+   maybe-string
    "The TCP congestion-control algorithm to use for peer connections,
 specified using a string recognized by the operating system in calls to
-@code{setsockopt} (or set to @code{disabled}, in which case the
-operating-system default is used).
+@code{setsockopt} (or leave it unset, in which case the operating-system
+default is used).
 
 Note that on GNU/Linux systems, the kernel must be configured to allow
 processes to use a congestion-control algorithm not in the default set;
@@ -465,7 +463,7 @@ (define-configuration transmission-daemon-configuration
    "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it
 has most recently downloaded from @code{blocklist-url}.")
   (blocklist-url
-   (maybe-string 'disabled)
+   maybe-string
    "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule
 @file{.dat} format) to be periodically downloaded and applied when
 @code{blocklist-enabled?} is @code{#t}.")
@@ -564,11 +562,11 @@ (define-configuration transmission-daemon-configuration
 the side effect of disabling host-name whitelisting (see
 @code{rpc-host-whitelist-enabled?}.")
   (rpc-username
-   (maybe-string 'disabled)
+   maybe-string
    "The username required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.")
   (rpc-password
-   (maybe-transmission-password-hash 'disabled)
+   maybe-transmission-password-hash
    "The password required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.  This must be specified
 using a password hash in the format recognized by Transmission clients, either
@@ -613,7 +611,7 @@ (define-configuration transmission-daemon-configuration
 @code{script-torrent-done-filename} will be invoked each time a torrent
 completes.")
   (script-torrent-done-filename
-   (maybe-file-object 'disabled)
+   maybe-file-object
    "A file name or file-like object specifying a script to run each time a
 torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}.")
   (scrape-paused-torrents-enabled?
diff --git a/gnu/services/messaging.scm b/gnu/services/messaging.scm
index 4bceb1d37a..f8d2c3707a 100644
--- a/gnu/services/messaging.scm
+++ b/gnu/services/messaging.scm
@@ -72,6 +72,7 @@ (define (make-pred arg)
       (lambda (field target)
         (and (memq (syntax->datum target) `(common ,arg)) field)))
     (syntax-case stx ()
+      ;; TODO Also handle (field-type) form, without a default.
       ((_ stem (field (field-type def) doc target) ...)
        (with-syntax (((new-field-type ...)
                       (map (lambda (field-type target)
@@ -85,7 +86,7 @@ (define (make-pred arg)
                      ((new-def ...)
                       (map (lambda (def target)
                              (if (eq? 'common (syntax->datum target))
-                                 #''disabled def))
+                                 #'*unspecified* def))
                            #'(def ...) #'(target ...)))
                      ((new-doc ...)
                       (map (lambda (doc target)
@@ -195,7 +196,7 @@ (define (serialize-file-object-list field-name val)
 (define-maybe file-object-list)
 
 (define (raw-content? val)
-  (not (eq? val 'disabled)))
+  (not (unspecified? val)))
 (define (serialize-raw-content field-name val)
   val)
 (define-maybe raw-content)
@@ -223,15 +224,15 @@ (define-maybe mod-muc-configuration)
 
 (define-configuration ssl-configuration
   (protocol
-   (maybe-string 'disabled)
+   maybe-string
    "This determines what handshake to use.")
 
   (key
-   (maybe-file-name 'disabled)
+   maybe-file-name
    "Path to your private key file.")
 
   (certificate
-   (maybe-file-name 'disabled)
+   maybe-file-name
    "Path to your certificate file.")
 
   (capath
@@ -240,48 +241,48 @@ (define-configuration ssl-configuration
 trust when verifying the certificates of remote servers.")
 
   (cafile
-   (maybe-file-object 'disabled)
+   maybe-file-object
    "Path to a file containing root certificates that you wish Prosody to trust.
 Similar to @code{capath} but with all certificates concatenated together.")
 
   (verify
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of verification options (these mostly map to OpenSSL's
 @code{set_verify()} flags).")
 
   (options
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of general options relating to SSL/TLS.  These map to OpenSSL's
 @code{set_options()}.  For a full list of options available in LuaSec, see the
 LuaSec source.")
 
   (depth
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "How long a chain of certificate authorities to check when looking for a
 trusted root certificate.")
 
   (ciphers
-   (maybe-string 'disabled)
+   maybe-string
    "An OpenSSL cipher string.  This selects what ciphers Prosody will offer to
 clients, and in what order.")
 
   (dhparam
-   (maybe-file-name 'disabled)
+   maybe-file-name
    "A path to a file containing parameters for Diffie-Hellman key exchange.  You
 can create such a file with:
 @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}")
 
   (curve
-   (maybe-string 'disabled)
+   maybe-string
    "Curve for Elliptic curve Diffie-Hellman. Prosody's default is
 @samp{\"secp384r1\"}.")
 
   (verifyext
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of \"extra\" verification options.")
 
   (password
-   (maybe-string 'disabled)
+   maybe-string
    "Password for encrypted private keys."))
 (define (serialize-ssl-configuration field-name val)
   #~(format #f "ssl = {\n~a};\n"
@@ -469,12 +470,12 @@ (define-all-configurations prosody-configuration
      global)
 
     (http-max-content-size
-     (maybe-non-negative-integer 'disabled)
+     (maybe-non-negative-integer *unspecified*)
      "Maximum allowed size of the HTTP body (in bytes)."
      common)
 
     (http-external-url
-     (maybe-string 'disabled)
+     (maybe-string *unspecified*)
      "Some modules expose their own URL in various ways.  This URL is built
 from the protocol, host and port used.  If Prosody sits behind a proxy, the
 public URL will be @code{http-external-url} instead.  See
@@ -551,7 +552,7 @@ (define-all-configurations prosody-configuration
      int-component)
 
     (mod-muc
-     (maybe-mod-muc-configuration 'disabled)
+     (maybe-mod-muc-configuration *unspecified*)
      "Multi-user chat (MUC) is Prosody's module for allowing you to create
 hosted chatrooms/conferences for XMPP users.
 
@@ -568,7 +569,7 @@ (define-all-configurations prosody-configuration
      ext-component)
 
     (raw-content
-     (maybe-raw-content 'disabled)
+     (maybe-raw-content *unspecified*)
      "Raw content that will be added to the configuration file."
      common)))
 
diff --git a/gnu/services/networking.scm b/gnu/services/networking.scm
index 5bb8638930..e7fdac94e2 100644
--- a/gnu/services/networking.scm
+++ b/gnu/services/networking.scm
@@ -763,17 +763,17 @@ (define-configuration/no-serialization opendht-configuration
    "The node host name that is used to make the first connection to the
 network.  A specific port value can be provided by appending the @code{:PORT}
 suffix.  By default, it uses the Jami bootstrap nodes, but any host can be
-specified here.  It's also possible to disable bootstrapping by setting this
-to the @code{'disabled} symbol.")
+specified here.  It's also possible to disable bootstrapping by explicitly
+setting this field to the @code{*unspecified*} value.")
   (port
    (maybe-number 4222)
-   "The UDP port to bind to.  When set to @code{'disabled}, an available port
-is automatically selected.")
+   "The UDP port to bind to.  When set to @code{*unspecified*}, an available
+port is automatically selected.")
   (proxy-server-port
-   (maybe-number 'disabled)
+   maybe-number
    "Spawn a proxy server listening on the specified port.")
   (proxy-server-port-tls
-   (maybe-number 'disabled)
+   maybe-number
    "Spawn a proxy server listening to TLS connections on the specified
 port."))
 
diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index e48236dbca..3daf484cc1 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -114,55 +114,55 @@ (define-configuration tlp-configuration
    "Same as @code{max-lost-work-secs-on-ac} but on BAT mode.")
 
   (cpu-scaling-governor-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "CPU frequency scaling governor on AC mode.  With intel_pstate
 driver, alternatives are powersave and performance.  With acpi-cpufreq driver,
 alternatives are ondemand, powersave, performance and conservative.")
 
   (cpu-scaling-governor-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode.")
 
   (cpu-scaling-min-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the min available frequency for the scaling governor on AC.")
 
   (cpu-scaling-max-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the max available frequency for the scaling governor on AC.")
 
   (cpu-scaling-min-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the min available frequency for the scaling governor on BAT.")
 
   (cpu-scaling-max-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the max available frequency for the scaling governor on BAT.")
 
   (cpu-min-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Limit the min P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-max-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Limit the max P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-min-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Same as @code{cpu-min-perf-on-ac} on BAT mode.")
 
   (cpu-max-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Same as @code{cpu-max-perf-on-ac} on BAT mode.")
 
   (cpu-boost-on-ac?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Enable CPU turbo boost feature on AC mode.")
 
   (cpu-boost-on-bat?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Same as @code{cpu-boost-on-ac?} on BAT mode.")
 
   (sched-powersave-on-ac?
@@ -179,7 +179,7 @@ (define-configuration tlp-configuration
    "Enable Linux kernel NMI watchdog.")
 
   (phc-controls
-   (maybe-string 'disabled)
+   maybe-string
    "For Linux kernels with PHC patch applied, change CPU voltages.
 An example value would be @samp{\"F:V F:V F:V F:V\"}.")
 
@@ -205,16 +205,16 @@ (define-configuration tlp-configuration
    "Same as @code{disk-apm-bat} but on BAT mode.")
 
   (disk-spindown-timeout-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Hard disk spin down timeout.  One value has to be specified for
 each declared hard disk.")
 
   (disk-spindown-timeout-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode.")
 
   (disk-iosched
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Select IO scheduler for disk devices.  One value has to be specified
 for each declared hard disk.  Example alternatives are cfq, deadline and noop.")
 
@@ -228,16 +228,16 @@ (define-configuration tlp-configuration
    "Same as @code{sata-linkpwr-ac} but on BAT mode.")
 
   (sata-linkpwr-blacklist
-   (maybe-string 'disabled)
+   maybe-string
    "Exclude specified SATA host devices for link power management.")
 
   (ahci-runtime-pm-on-ac?
-   (maybe-on-off-boolean 'disabled)
+   maybe-on-off-boolean
    "Enable Runtime Power Management for AHCI controller and disks
 on AC mode.")
 
   (ahci-runtime-pm-on-bat?
-   (maybe-on-off-boolean 'disabled)
+   maybe-on-off-boolean
    "Same as @code{ahci-runtime-pm-on-ac} on BAT mode.")
 
   (ahci-runtime-pm-timeout
@@ -254,19 +254,19 @@ (define-configuration tlp-configuration
    "Same as @code{pcie-aspm-ac} but on BAT mode.")
 
   (start-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 0 should begin charging.")
 
   (stop-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 0 should stop charging.")
 
   (start-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 1 should begin charging.")
 
   (stop-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 1 should stop charging.")
 
   (radeon-power-profile-on-ac
@@ -346,7 +346,7 @@ (define-configuration tlp-configuration
 blacklisted ones.")
 
   (runtime-pm-blacklist
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Exclude specified PCI(e) device addresses from Runtime Power Management.")
 
   (runtime-pm-driver-blacklist
@@ -359,7 +359,7 @@ (define-configuration tlp-configuration
    "Enable USB autosuspend feature.")
 
   (usb-blacklist
-   (maybe-string 'disabled)
+   maybe-string
    "Exclude specified devices from USB autosuspend.")
 
   (usb-blacklist-wwan?
@@ -367,12 +367,12 @@ (define-configuration tlp-configuration
    "Exclude WWAN devices from USB autosuspend.")
 
   (usb-whitelist
-   (maybe-string 'disabled)
+   maybe-string
    "Include specified devices into USB autosuspend, even if they are
 already excluded by the driver or via @code{usb-blacklist-wwan?}.")
 
   (usb-autosuspend-disable-on-shutdown?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Enable USB autosuspend before shutdown.")
 
   (restore-device-state-on-startup?
diff --git a/gnu/services/telephony.scm b/gnu/services/telephony.scm
index d8ebc7b39d..1ccf060762 100644
--- a/gnu/services/telephony.scm
+++ b/gnu/services/telephony.scm
@@ -156,7 +156,7 @@ (define-configuration jami-account
 secret key material of the Jami account it contains."
    empty-serializer)
   (allowed-contacts
-   (maybe-account-fingerprint-list 'disabled)
+   maybe-account-fingerprint-list
    "The list of allowed contacts for the account, entered as their 40
 characters long fingerprint.  Messages or calls from accounts not in that list
 will be rejected.  When unspecified, the configuration of the account archive
@@ -165,7 +165,7 @@ (define-configuration jami-account
 the account."
    empty-serializer)
   (moderators
-   (maybe-account-fingerprint-list 'disabled)
+   maybe-account-fingerprint-list
    "The list of contacts that should have moderation privileges (to ban, mute,
 etc. other users) in rendezvous conferences, entered as their 40 characters
 long fingerprint.  When unspecified, the configuration of the account archive
@@ -174,24 +174,24 @@ (define-configuration jami-account
    empty-serializer)
   ;; The serializable fields below are to be set with set-account-details.
   (rendezvous-point?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Whether the account should operate in the rendezvous mode.  In this mode,
 all the incoming audio/video calls are mixed into a conference.  When left
 unspecified, the value from the account archive prevails.")
   (peer-discovery?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Whether peer discovery should be enabled.  Peer discovery is used to
 discover other OpenDHT nodes on the local network, which can be useful to
 maintain communication between devices on such network even when the
 connection to the the Internet has been lost.  When left unspecified, the
 value from the account archive prevails.")
   (bootstrap-hostnames
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of hostnames or IPs pointing to OpenDHT nodes, that should be used
 to initially join the OpenDHT network.  When left unspecified, the value from
 the account archive prevails.")
   (name-server-uri
-   (maybe-string 'disabled)
+   maybe-string
    "The URI of the name server to use, that can be used to retrieve the
 account fingerprint for a registered username."))
 
@@ -246,7 +246,7 @@ (define-configuration/no-serialization jami-configuration
    (boolean #f)
    "Whether to force automatic answer to incoming calls.")
   (accounts
-   (maybe-jami-account-list 'disabled)
+   maybe-jami-account-list
    "A list of Jami accounts to be (re-)provisioned every time the Jami daemon
 service starts.  When providing this field, the account directories under
 @file{/var/lib/jami/} are recreated every time the service starts, ensuring a
diff --git a/gnu/services/vpn.scm b/gnu/services/vpn.scm
index b24e9cffb3..6a6875e70a 100644
--- a/gnu/services/vpn.scm
+++ b/gnu/services/vpn.scm
@@ -363,7 +363,7 @@ (define-split-configuration openvpn-client-configuration
 channel to protect against DoS attacks.")
 
    (auth-user-pass
-     (maybe-string 'disabled)
+    maybe-string
      "Authenticate with server using username/password.  The option is a file
 containing username/password on 2 lines.  Do not use a file-like object as it
 would be added to the store and readable by any user.")
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 0debf8095b..334a1e409b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -136,3 +136,15 @@ (define-configuration config-with-maybe-string/no-serialization
 
 (test-assert "maybe value without serialization no procedure bound"
   (not (defined? 'serialize-maybe-string)))
+
+(test-assert "maybe type, no default"
+  (unspecified?
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization))))
+
+(test-assert "maybe type, with default"
+  (equal?
+   "foo"
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization
+     (name "foo")))))
-- 
2.35.1

Message #44 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Maxime Devos <maximedevos <at> telenet.be>
To: Attila Lendvai <attila <at> lendvai.name>, 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH v4 1/2] services: configuration: Support
 (field1 maybe-number "") format.
Date: Sat, 23 Apr 2022 16:55:31 +0200

[Message part 1 (text/plain, inline)]

I didn't look into the code in detail, but for this kind of thing,
if it compiles, it probably works.  For completeness, you might want to
run a few system tests (‘make check-system’ IIRC).

However, ...

Attila Lendvai schreef op wo 20-04-2022 om 11:15 [+0200]:
> As opposed to explicitly using 'disabled as value, or using the
> (field1 (maybe-number) "") format.
> 
> It's mostly the work of Maxime Devos shared under #54674, with some
> modifications by Attila Lendvai.
> 
> * gnu/services/configuration.scm (normalize-field-type+def): New function.
> (define-configuration-helper) (define-configuration): Support new field
> format.
> * tests/services/configuration.scm (config-with-maybe-number->string): New
> function.
> ("maybe value serialization of the instance"): New test.
> ("maybe value serialization of the instance, unspecified"): New test.

... 'define-configuration' and 'disabled' is documented in the manual
(guix)Complex Configurations:

     When defining a “maybe type”, the corresponding serializer for the
     regular type will be used by default.  For example, a field of
     type ‘maybe-string’ will be serialized using the
     ‘serialize-string’ procedure by default, you can of course change
     this by specifying a custom serializer procedure.  Likewise, the
     type of the value would have to be a string, unless it is set to
     the ‘disabled’ symbol.

It also appears in other locations in the documentation:

     ‘daytime-brightness’ (default: ‘disabled’) (type: maybe-inexact-number)
          Daytime screen brightness, between 0.1 and 1.0.

   The available configuration parameters follow.  Each parameter
definition is preceded by its type; for example, ‘string-list foo’
indicates that the ‘foo’ parameter should be specified as a list of
strings.  Types starting with ‘maybe-’ denote parameters that won’t show
up in ‘prosody.cfg.lua’ when their value is ‘'disabled’.

     [...]

So the documentation appears to be needed to be changed as well.

Greetings,
Maxime.

[signature.asc (application/pgp-signature, inline)]

Message #47 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH] doc: Follow the 'disabled -> *unspecified* configuration
 refactor.
Date: Mon, 25 Apr 2022 00:41:25 +0200

---

update the doc in a separate commit. you may want to squash it on the
refactor commit, depending on what trade off the project prefers.

 doc/guix.texi | 85 ++++++++++++++++++++++++++-------------------------
 1 file changed, 43 insertions(+), 42 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index a865b2e2e4..ac1b4d1d37 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -18623,15 +18623,16 @@ The node host name that is used to make the first connection to the
 network.  A specific port value can be provided by appending the
 @code{:PORT} suffix.  By default, it uses the Jami bootstrap nodes, but
 any host can be specified here.  It's also possible to disable
-bootsrapping by setting this to the @code{'disabled} symbol.
+bootsrapping by explicitly setting this to the @code{*unspecified*}
+value.
 
 Defaults to @samp{"bootstrap.jami.net:4222"}.
 
 @end deftypevr
 
 @deftypevr {@code{opendht-configuration} parameter} maybe-number port
-The UDP port to bind to.  When set to @code{'disabled}, an available
-port is automatically selected.
+The UDP port to bind to.  When explicitly set to @code{*unspecified*},
+an available port is automatically selected.
 
 Defaults to @samp{4222}.
 
@@ -24396,7 +24397,7 @@ The available configuration parameters follow.  Each parameter
 definition is preceded by its type; for example, @samp{string-list foo}
 indicates that the @code{foo} parameter should be specified as a list of
 strings.  Types starting with @code{maybe-} denote parameters that won't
-show up in @code{prosody.cfg.lua} when their value is @code{'disabled}.
+show up in @code{prosody.cfg.lua} when their value is left unspecified.
 
 There is also a way to specify the configuration as a string, if you
 have an old @code{prosody.cfg.lua} file that you want to port over from
@@ -25010,7 +25011,7 @@ Whether to enable debug level messages.
 @item @code{auto-answer?} (default: @code{#f}) (type: boolean)
 Whether to force automatic answer to incoming calls.
 
-@item @code{accounts} (default: @code{disabled}) (type: maybe-jami-account-list)
+@item @code{accounts} (type: maybe-jami-account-list)
 A list of Jami accounts to be (re-)provisioned every time the Jami
 daemon service starts.  When providing this field, the account
 directories under @file{/var/lib/jami/} are recreated every time the
@@ -25032,39 +25033,39 @@ should @emph{not} be encrypted.  It is highly recommended to make it
 readable only to the @samp{root} user (i.e., not in the store), to guard
 against leaking the secret key material of the Jami account it contains.
 
-@item @code{allowed-contacts} (default: @code{disabled}) (type: maybe-account-fingerprint-list)
+@item @code{allowed-contacts} (type: maybe-account-fingerprint-list)
 The list of allowed contacts for the account, entered as their 40
 characters long fingerprint.  Messages or calls from accounts not in
-that list will be rejected.  When unspecified, the configuration of the
-account archive is used as-is with respect to contacts and public
+that list will be rejected.  When left specified, the configuration of
+the account archive is used as-is with respect to contacts and public
 inbound calls/messaging allowance, which typically defaults to allow any
 contact to communicate with the account.
 
-@item @code{moderators} (default: @code{disabled}) (type: maybe-account-fingerprint-list)
+@item @code{moderators} (type: maybe-account-fingerprint-list)
 The list of contacts that should have moderation privileges (to ban,
 mute, etc.  other users) in rendezvous conferences, entered as their 40
-characters long fingerprint.  When unspecified, the configuration of the
-account archive is used as-is with respect to moderation, which
+characters long fingerprint.  When left unspecified, the configuration
+of the account archive is used as-is with respect to moderation, which
 typically defaults to allow anyone to moderate.
 
-@item @code{rendezvous-point?} (default: @code{disabled}) (type: maybe-boolean)
+@item @code{rendezvous-point?} (type: maybe-boolean)
 Whether the account should operate in the rendezvous mode.  In this
 mode, all the incoming audio/video calls are mixed into a conference.
 When left unspecified, the value from the account archive prevails.
 
-@item @code{peer-discovery?} (default: @code{disabled}) (type: maybe-boolean)
+@item @code{peer-discovery?} (type: maybe-boolean)
 Whether peer discovery should be enabled.  Peer discovery is used to
 discover other OpenDHT nodes on the local network, which can be useful
 to maintain communication between devices on such network even when the
 connection to the the Internet has been lost.  When left unspecified,
 the value from the account archive prevails.
 
-@item @code{bootstrap-hostnames} (default: @code{disabled}) (type: maybe-string-list)
+@item @code{bootstrap-hostnames} (type: maybe-string-list)
 A list of hostnames or IPs pointing to OpenDHT nodes, that should be
 used to initially join the OpenDHT network.  When left unspecified, the
 value from the account archive prevails.
 
-@item @code{name-server-uri} (default: @code{disabled}) (type: maybe-string)
+@item @code{name-server-uri} (type: maybe-string)
 The URI of the name server to use, that can be used to retrieve the
 account fingerprint for a registered username.
 
@@ -25698,8 +25699,8 @@ Defaults to @samp{prefer-encrypted-connections}.
 @deftypevr {@code{transmission-daemon-configuration} parameter} maybe-string peer-congestion-algorithm
 The TCP congestion-control algorithm to use for peer connections,
 specified using a string recognized by the operating system in calls to
-@code{setsockopt} (or set to @code{disabled}, in which case the
-operating-system default is used).
+@code{setsockopt}.  When left unspecified, the operating-system default
+is used.
 
 Note that on GNU/Linux systems, the kernel must be configured to allow
 processes to use a congestion-control algorithm not in the default set;
@@ -29327,7 +29328,7 @@ Defaults to @samp{tun}.
 
 If you do not have some of these files (eg.@: you use a username and
 password), you can disable any of the following three fields by setting
-it to @code{'disabled}.
+it to @code{*unspecified*}.
 
 @deftypevr {@code{openvpn-client-configuration} parameter} maybe-string ca
 The certificate authority to check connections against.
@@ -29401,7 +29402,6 @@ Authenticate with server using username/password.  The option is a file
 containing username/password on 2 lines.  Do not use a file-like object as it
 would be added to the store and readable by any user.
 
-Defaults to @samp{'disabled}.
 @end deftypevr
 
 @deftypevr {@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?
@@ -29482,7 +29482,7 @@ Defaults to @samp{tun}.
 
 If you do not have some of these files (eg.@: you use a username and
 password), you can disable any of the following three fields by setting
-it to @code{'disabled}.
+it to @code{*unspecified*}.
 
 @deftypevr {@code{openvpn-server-configuration} parameter} maybe-string ca
 The certificate authority to check connections against.
@@ -30281,10 +30281,10 @@ content by adding a valid @code{tlp-configuration}:
 @end deffn
 
 Each parameter definition is preceded by its type; for example,
-@samp{boolean foo} indicates that the @code{foo} parameter
-should be specified as a boolean.  Types starting with
-@code{maybe-} denote parameters that won't show up in TLP config file
-when their value is @code{'disabled}.
+@samp{boolean foo} indicates that the @code{foo} parameter should be
+specified as a boolean.  Types starting with @code{maybe-} denote
+parameters that won't show up in TLP config file when their value is
+left unset, or is explicitly set to the @code{*unspecified*} value.
 
 @c The following documentation was initially generated by
 @c (generate-tlp-documentation) in (gnu services pm).  Manually maintained
@@ -37840,15 +37840,16 @@ macro which is a shorthand of this.
 @deffn {Scheme Syntax} define-maybe @var{type}
 Sometimes a field should not be serialized if the user doesn’t specify a
 value.  To achieve this, you can use the @code{define-maybe} macro to
-define a ``maybe type''; if the value of a maybe type is set to the
-@code{disabled}, it will not be serialized.
+define a ``maybe type''; if the value of a maybe type is left unset, or
+is set to the @code{*unspecified*} value, then it will not be
+serialized.
 
 When defining a ``maybe type'', the corresponding serializer for the
 regular type will be used by default.  For example, a field of type
 @code{maybe-string} will be serialized using the @code{serialize-string}
 procedure by default, you can of course change this by specifying a
 custom serializer procedure.  Likewise, the type of the value would have
-to be a string, unless it is set to the @code{disabled} symbol.
+to be a string, or left unspecified.
 
 @lisp
 (define-maybe string)
@@ -37858,9 +37859,9 @@ to be a string, unless it is set to the @code{disabled} symbol.
 
 (define-configuration baz-configuration
   (name
-   ;; Nothing will be serialized by default.  If set to a string, the
-   ;; `serialize-string' procedure will be used to serialize the string.
-   (maybe-string 'disabled)
+   ;; If set to a string, the `serialize-string' procedure will be used
+   ;; to serialize the string.  Otherwise this field is not serialized.
+   maybe-string    ; equivalent to (maybe-string *unspecified*)
    "The name of this module."))
 @end lisp
 
@@ -37877,7 +37878,7 @@ serializer name by using the @code{prefix} literal.
 
 There is also the @code{no-serialization} literal, which when set means
 that no serializer will be defined for the ``maybe type'', regardless of
-its value is @code{disabled} or not.
+whether its value is set or not.
 @code{define-maybe/no-serialization} is a shorthand for specifying the
 @code{no-serialization} literal.
 
@@ -37886,7 +37887,7 @@ its value is @code{disabled} or not.
 
 (define-configuration/no-serialization test-configuration
   (mode
-   (maybe-symbol 'disabled)
+   maybe-symbol
    "Docstring."))
 @end lisp
 @end deffn
@@ -38018,10 +38019,10 @@ Below is an example of a record type created using
    "The name of the contact."
    serialize-contact-name)
   (phone-number
-   (maybe-integer 'disabled)
+   maybe-integer
    "The person's phone number.")
   (email
-   (maybe-string 'disabled)
+   maybe-string
    "The person's email address.")
   (married?
    (boolean)
@@ -38745,24 +38746,24 @@ Daytime color temperature (kelvins).
 @item @code{nighttime-temperature} (default: @code{4500}) (type: integer)
 Nighttime color temperature (kelvins).
 
-@item @code{daytime-brightness} (default: @code{disabled}) (type: maybe-inexact-number)
-Daytime screen brightness, between 0.1 and 1.0.
+@item @code{daytime-brightness} (type: maybe-inexact-number)
+Daytime screen brightness, between 0.1 and 1.0, or left unspecified.
 
-@item @code{nighttime-brightness} (default: @code{disabled}) (type: maybe-inexact-number)
-Nighttime screen brightness, between 0.1 and 1.0.
+@item @code{nighttime-brightness} (type: maybe-inexact-number)
+Nighttime screen brightness, between 0.1 and 1.0, or left unspecified.
 
-@item @code{latitude} (default: @code{disabled}) (type: maybe-inexact-number)
+@item @code{latitude} (type: maybe-inexact-number)
 Latitude, when @code{location-provider} is @code{'manual}.
 
-@item @code{longitude} (default: @code{disabled}) (type: maybe-inexact-number)
+@item @code{longitude} (type: maybe-inexact-number)
 Longitude, when @code{location-provider} is @code{'manual}.
 
-@item @code{dawn-time} (default: @code{disabled}) (type: maybe-string)
+@item @code{dawn-time} (type: maybe-string)
 Custom time for the transition from night to day in the
 morning---@code{"HH:MM"} format.  When specified, solar elevation is not
 used to determine the daytime/nighttime period.
 
-@item @code{dusk-time} (default: @code{disabled}) (type: maybe-string)
+@item @code{dusk-time} (type: maybe-string)
 Likewise, custom time for the transition from day to night in the
 evening.
 
-- 
2.35.1

Message #50 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH v4 1/2] services: configuration: Support
 (field1 maybe-number "") format.
Date: Tue, 17 May 2022 11:38:35 +0000

[Message part 1 (text/plain, inline)]

thank you for suggesting `make check-system` Maxime. it pointed out some issues with the jami service that i have fixed.

i would love to reshape this into something that will get merged. is there anything i can do to help that process?

unfortunately, `make check-system` returns with the attached output. after some staring and grepping, i can't identify why these tests are failing, and whether it is a new bug at all that happens due to my changes.

i'll send the new version of the patch in upcoming mails.

--
• attila lendvai
• PGP: 963F 5D5F 45C7 DFCD 0A39
--
“Anything that can contribute to such a fundamental change in our perception of reality must therefore command our earnest attention.”
	— Albert Hofmann (1906–2008), 'LSD: My Problem Child'

[b5gqxwxi4hs5cd4qngxca91l81yd9l-jami-provisioning-test.drv.gz (application/gzip, attachment)]

Message #53 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v5 1/3] services: configuration: Support (field1 maybe-number
 "") format.
Date: Tue, 17 May 2022 13:39:26 +0200

As opposed to explicitly using 'disabled as value, or using the
(field1 (maybe-number) "") format.

It's mostly the work of Maxime Devos shared under #54674, with some
modifications by Attila Lendvai.

* gnu/services/configuration.scm (normalize-field-type+def): New function.
(define-configuration-helper) (define-configuration): Support new field
format.
* tests/services/configuration.scm (config-with-maybe-number->string): New
function.
("maybe value serialization of the instance"): New test.
("maybe value serialization of the instance, unspecified"): New test.
---

v5 fixes some jami issues

 gnu/services/configuration.scm   | 169 +++++++++++++++++--------------
 tests/services/configuration.scm |  28 ++++-
 2 files changed, 114 insertions(+), 83 deletions(-)

diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index 0de350a4df..bdca33ed68 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2021 Xinglu Chen <public <at> yoctocell.xyz>
 ;;; Copyright © 2021 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
 ;;; Copyright © 2021 Andrew Tropin <andrew <at> trop.in>
+;;; Copyright © 2022 Maxime Devos <maximedevos <at> telenet.be>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -162,78 +163,90 @@ (define-maybe-helper #t #f #'(_ stem))))))
 (define-syntax-rule (define-maybe/no-serialization stem)
   (define-maybe stem (no-serialization)))
 
+(define (normalize-field-type+def s)
+  (syntax-case s ()
+    ((field-type def)
+     (identifier? #'field-type)
+     (values #'(field-type def)))
+    ((field-type)
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))
+    (field-type
+     (identifier? #'field-type)
+     (values #'(field-type 'disabled)))))
+
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
-    ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
-     (with-syntax (((field-getter ...)
-                    (map (lambda (field)
-                           (id #'stem #'stem #'- field))
-    			 #'(field ...)))
-                   ((field-predicate ...)
-                    (map (lambda (type)
-                           (id #'stem type #'?))
-    			 #'(field-type ...)))
-                   ((field-default ...)
-                    (map (match-lambda
-    			   ((field-type default-value)
-                            default-value)
-    			   ((field-type)
-                            ;; Quote `undefined' to prevent a possibly
-                            ;; unbound warning.
-                            (syntax 'undefined)))
-    			 #'((field-type def ...) ...)))
-                   ((field-serializer ...)
-                    (map (lambda (type custom-serializer)
-                           (and serialize?
-                                (match custom-serializer
-                                  ((serializer)
-                                   serializer)
-                                  (()
-                                   (if serializer-prefix
-                                       (id #'stem
-                                           serializer-prefix
-                                           #'serialize- type)
-                                       (id #'stem #'serialize- type))))))
-                         #'(field-type ...)
-                         #'((custom-serializer ...) ...))))
-       #`(begin
-    	   (define-record-type* #,(id #'stem #'< #'stem #'>)
-    	     #,(id #'stem #'% #'stem)
-    	     #,(id #'stem #'make- #'stem)
-    	     #,(id #'stem #'stem #'?)
-    	     (%location #,(id #'stem #'stem #'-location)
-    			(default (and=> (current-source-location)
-    					source-properties->location))
-    			(innate))
-    	     #,@(map (lambda (name getter def)
-    		       (if (eq? (syntax->datum def) (quote 'undefined))
-    			   #`(#,name #,getter)
-    			   #`(#,name #,getter (default #,def))))
-    		     #'(field ...)
-    		     #'(field-getter ...)
-    		     #'(field-default ...)))
-    	   (define #,(id #'stem #'stem #'-fields)
-    	     (list (configuration-field
-    		    (name 'field)
-    		    (type 'field-type)
-    		    (getter field-getter)
-    		    (predicate field-predicate)
-    		    (serializer field-serializer)
-    		    (default-value-thunk
-    		      (lambda ()
-    			(display '#,(id #'stem #'% #'stem))
-    			(if (eq? (syntax->datum field-default)
-    				 'undefined)
-    			    (configuration-no-default-value
-    			     '#,(id #'stem #'% #'stem) 'field)
-    			    field-default)))
-    		    (documentation doc))
-    		   ...))
-    	   (define-syntax-rule (stem arg (... ...))
-    	     (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
-    	       (validate-configuration conf
-    				       #,(id #'stem #'stem #'-fields))
-    	       conf)))))))
+    ((_ stem (field field-type+def doc custom-serializer ...) ...)
+     (with-syntax
+         ((((field-type def) ...)
+           (map normalize-field-type+def #'(field-type+def ...))))
+       (with-syntax
+           (((field-getter ...)
+             (map (lambda (field)
+                    (id #'stem #'stem #'- field))
+                  #'(field ...)))
+            ((field-predicate ...)
+             (map (lambda (type)
+                    (id #'stem type #'?))
+                  #'(field-type ...)))
+            ((field-default ...)
+             (map (match-lambda
+                    ((field-type default-value)
+                     default-value))
+                  #'((field-type def) ...)))
+            ((field-serializer ...)
+             (map (lambda (type custom-serializer)
+                    (and serialize?
+                         (match custom-serializer
+                           ((serializer)
+                            serializer)
+                           (()
+                            (if serializer-prefix
+                                (id #'stem
+                                    serializer-prefix
+                                    #'serialize- type)
+                                (id #'stem #'serialize- type))))))
+                  #'(field-type ...)
+                  #'((custom-serializer ...) ...))))
+         #`(begin
+             (define-record-type* #,(id #'stem #'< #'stem #'>)
+               #,(id #'stem #'% #'stem)
+               #,(id #'stem #'make- #'stem)
+               #,(id #'stem #'stem #'?)
+               (%location #,(id #'stem #'stem #'-location)
+                          (default (and=> (current-source-location)
+                                          source-properties->location))
+                          (innate))
+               #,@(map (lambda (name getter def)
+                         (if (eq? (syntax->datum def) (quote 'undefined))
+                             #`(#,name #,getter)
+                             #`(#,name #,getter (default #,def))))
+                       #'(field ...)
+                       #'(field-getter ...)
+                       #'(field-default ...)))
+             (define #,(id #'stem #'stem #'-fields)
+               (list (configuration-field
+                      (name 'field)
+                      (type 'field-type)
+                      (getter field-getter)
+                      (predicate field-predicate)
+                      (serializer field-serializer)
+                      (default-value-thunk
+                        (lambda ()
+                          (display '#,(id #'stem #'% #'stem))
+                          (if (eq? (syntax->datum field-default)
+                                   'undefined)
+                              (configuration-no-default-value
+                               '#,(id #'stem #'% #'stem) 'field)
+                              field-default)))
+                      (documentation doc))
+                     ...))
+             (define-syntax-rule (stem arg (... ...))
+               (let ((conf (#,(id #'stem #'% #'stem) arg (... ...))))
+                 (validate-configuration conf
+                                         #,(id #'stem #'stem #'-fields))
+                 conf))))))))
 
 (define no-serialization         ;syntactic keyword for 'define-configuration'
   '(no serialization))
@@ -241,26 +254,26 @@ (define no-serialization         ;syntactic keyword for 'define-configuration'
 (define-syntax define-configuration
   (lambda (s)
     (syntax-case s (no-serialization prefix)
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem (field field-type+def doc custom-serializer ...) ...
           (no-serialization))
        (define-configuration-helper
-         #f #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #f #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...)))
-      ((_ stem  (field (field-type def ...) doc custom-serializer ...) ...
+      ((_ stem  (field field-type+def doc custom-serializer ...) ...
           (prefix serializer-prefix))
        (define-configuration-helper
-         #t #'serializer-prefix #'(_ stem (field (field-type def ...)
+         #t #'serializer-prefix #'(_ stem (field field-type+def
                                                  doc custom-serializer ...)
                  ...)))
-      ((_ stem (field (field-type def ...) doc custom-serializer ...) ...)
+      ((_ stem (field field-type+def doc custom-serializer ...) ...)
        (define-configuration-helper
-         #t #f #'(_ stem (field (field-type def ...) doc custom-serializer ...)
+         #t #f #'(_ stem (field field-type+def doc custom-serializer ...)
                  ...))))))
 
 (define-syntax-rule (define-configuration/no-serialization
-                      stem (field (field-type def ...)
+                      stem (field field-type+def
                                   doc custom-serializer ...) ...)
-  (define-configuration stem (field (field-type def ...)
+  (define-configuration stem (field field-type+def
                                     doc custom-serializer ...) ...
     (no-serialization)))
 
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 86a36a388d..0debf8095b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -27,6 +27,9 @@ (define-module (tests services configuration)
 
 (test-begin "services-configuration")
 
+(define (serialize-number field value)
+  (format #f "~a=~a" field value))
+
 
 ;;;
 ;;; define-configuration macro.
@@ -47,7 +50,6 @@ (define-configuration port-configuration-cs
   80
   (port-configuration-cs-port (port-configuration-cs)))
 
-(define serialize-number "")
 (define-configuration port-configuration-ndv
   (port (number) "The port number."))
 
@@ -101,15 +103,31 @@ (define-configuration configuration-with-prefix
 (define-maybe number)
 
 (define-configuration config-with-maybe-number
-  (port (maybe-number 80) "The port number."))
-
-(define (serialize-number field value)
-  (format #f "~a=~a" field value))
+  (port  (maybe-number 80) "")
+  (count maybe-number ""))
 
 (test-equal "maybe value serialization"
   "port=80"
   (serialize-maybe-number "port" 80))
 
+(define (config-with-maybe-number->string x)
+  (eval (gexp->approximate-sexp
+         (serialize-configuration x config-with-maybe-number-fields))
+        (current-module)))
+
+(test-equal "maybe value serialization of the instance"
+  "port=42count=43"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42)
+    (count 43))))
+
+(test-equal "maybe value serialization of the instance, unspecified"
+  "port=42"
+  (config-with-maybe-number->string
+   (config-with-maybe-number
+    (port 42))))
+
 (define-maybe/no-serialization string)
 
 (define-configuration config-with-maybe-string/no-serialization
-- 
2.35.1

Message #56 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v5 2/3] services: configuration: Use *unspecified* instead of
 'disabled.
Date: Tue, 17 May 2022 13:39:28 +0200

Use *unspecified* as a marker for field values that have not been set.

Rationale: 'disabled may easily clash with user values for boolean fields, is
confusing (i.e. its meaning is *not* boolean false, but unspecified) and it
also passes silently through the symbol? predicate of a field of type symbol.

* gnu/services/configuration.scm (configuration-missing-default-value):
Renamed from configuration-no-default-value.
* gnu/services/configuration.scm (define-maybe-helper): Use *unspecified*
instead of 'disabled, and make the default value optional.
* tests/services/configuration.scm ("maybe type, no default")
("maybe type, with default"): New tests.
---
 gnu/home/services/desktop.scm    | 12 ++---
 gnu/services/authentication.scm  | 82 ++++++++++++++++----------------
 gnu/services/cgit.scm            | 12 ++---
 gnu/services/configuration.scm   | 17 ++++---
 gnu/services/file-sharing.scm    | 24 +++++-----
 gnu/services/messaging.scm       | 37 +++++++-------
 gnu/services/networking.scm      | 12 ++---
 gnu/services/pm.scm              | 54 ++++++++++-----------
 gnu/services/telephony.scm       | 22 ++++-----
 gnu/services/vpn.scm             |  2 +-
 tests/services/configuration.scm | 12 +++++
 11 files changed, 148 insertions(+), 138 deletions(-)

diff --git a/gnu/home/services/desktop.scm b/gnu/home/services/desktop.scm
index cbb9cf76da..b0f4d969b0 100644
--- a/gnu/home/services/desktop.scm
+++ b/gnu/home/services/desktop.scm
@@ -91,26 +91,26 @@ (define-configuration home-redshift-configuration
    "Nighttime color temperature (kelvins).")
 
   (daytime-brightness
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Daytime screen brightness, between 0.1 and 1.0.")
   (nighttime-brightness
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Nighttime screen brightness, between 0.1 and 1.0.")
 
   (latitude
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Latitude, when @code{location-provider} is @code{'manual}.")
   (longitude
-   (maybe-inexact-number 'disabled)
+   maybe-inexact-number
    "Longitude, when @code{location-provider} is @code{'manual}.")
 
   (dawn-time
-   (maybe-string 'disabled)
+   maybe-string
    "Custom time for the transition from night to day in the
 morning---@code{\"HH:MM\"} format.  When specified, solar elevation is not
 used to determine the daytime/nighttime period.")
   (dusk-time
-   (maybe-string 'disabled)
+   maybe-string
    "Likewise, custom time for the transition from day to night in the
 evening.")
 
diff --git a/gnu/services/authentication.scm b/gnu/services/authentication.scm
index cb0ef6d85a..f7becdfafb 100644
--- a/gnu/services/authentication.scm
+++ b/gnu/services/authentication.scm
@@ -218,7 +218,7 @@ (define-configuration nslcd-configuration
 
   ;; Runtime options
   (threads
-   (maybe-number 'disabled)
+   maybe-number
    "The number of threads to start that can handle requests and perform LDAP
 queries.  Each thread opens a separate connection to the LDAP server.  The
 default is to start 5 threads.")
@@ -243,45 +243,45 @@ (define-configuration nslcd-configuration
    "The list of LDAP server URIs.  Normally, only the first server will be
 used with the following servers as fall-back.")
   (ldap-version
-   (maybe-string 'disabled)
+   maybe-string
    "The version of the LDAP protocol to use.  The default is to use the
 maximum version supported by the LDAP library.")
   (binddn
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the distinguished name with which to bind to the directory
 server for lookups.  The default is to bind anonymously.")
   (bindpw
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the credentials with which to bind.  This option is only
 applicable when used with binddn.")
   (rootpwmoddn
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the distinguished name to use when the root user tries to modify
 a user's password using the PAM module.")
   (rootpwmodpw
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the credentials with which to bind if the root user tries to
 change a user's password.  This option is only applicable when used with
 rootpwmoddn")
 
   ;; SASL authentication options
   (sasl-mech
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the SASL mechanism to be used when performing SASL
 authentication.")
   (sasl-realm
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the SASL realm to be used when performing SASL authentication.")
   (sasl-authcid
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the authentication identity to be used when performing SASL
 authentication.")
   (sasl-authzid
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the authorization identity to be used when performing SASL
 authentication.")
   (sasl-canonicalize?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Determines whether the LDAP server host name should be canonicalised.  If
 this is enabled the LDAP library will do a reverse host name lookup.  By
 default, it is left up to the LDAP library whether this check is performed or
@@ -289,7 +289,7 @@ (define-configuration nslcd-configuration
 
   ;; Kerberos authentication options
   (krb5-ccname
-   (maybe-string 'disabled)
+   maybe-string
    "Set the name for the GSS-API Kerberos credentials cache.")
 
   ;; Search / mapping options
@@ -302,11 +302,11 @@ (define-configuration nslcd-configuration
 default scope is subtree; base scope is almost never useful for name service
 lookups; children scope is not supported on all servers.")
   (deref
-   (maybe-deref-option 'disabled)
+   maybe-deref-option
    "Specifies the policy for dereferencing aliases.  The default policy is to
 never dereference aliases.")
   (referrals
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Specifies whether automatic referral chasing should be enabled.  The
 default behaviour is to chase referrals.")
   (maps
@@ -322,132 +322,132 @@ (define-configuration nslcd-configuration
 
   ;; Timing / reconnect options
   (bind-timelimit
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the time limit in seconds to use when connecting to the
 directory server.  The default value is 10 seconds.")
   (timelimit
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the time limit (in seconds) to wait for a response from the LDAP
 server.  A value of zero, which is the default, is to wait indefinitely for
 searches to be completed.")
   (idle-timelimit
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the period if inactivity (in seconds) after which the con‐
 nection to the LDAP server will be closed.  The default is not to time out
 connections.")
   (reconnect-sleeptime
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the number of seconds to sleep when connecting to all LDAP
 servers fails.  By default one second is waited between the first failure and
 the first retry.")
   (reconnect-retrytime
-   (maybe-number 'disabled)
+   maybe-number
    "Specifies the time after which the LDAP server is considered to be
 permanently unavailable.  Once this time is reached retries will be done only
 once per this time period.  The default value is 10 seconds.")
 
   ;; TLS options
   (ssl
-   (maybe-ssl-option 'disabled)
+   maybe-ssl-option
    "Specifies whether to use SSL/TLS or not (the default is not to).  If
 'start-tls is specified then StartTLS is used rather than raw LDAP over SSL.")
   (tls-reqcert
-   (maybe-tls-reqcert-option 'disabled)
+   maybe-tls-reqcert-option
    "Specifies what checks to perform on a server-supplied certificate.
 The meaning of the values is described in the ldap.conf(5) manual page.")
   (tls-cacertdir
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the directory containing X.509 certificates for peer authen‐
 tication.  This parameter is ignored when using GnuTLS.")
   (tls-cacertfile
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to the X.509 certificate for peer authentication.")
   (tls-randfile
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to an entropy source.  This parameter is ignored when
 using GnuTLS.")
   (tls-ciphers
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the ciphers to use for TLS as a string.")
   (tls-cert
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to the file containing the local certificate for client
 TLS authentication.")
   (tls-key
-   (maybe-string 'disabled)
+   maybe-string
    "Specifies the path to the file containing the private key for client TLS
 authentication.")
 
   ;; Other options
   (pagesize
-   (maybe-number 'disabled)
+   maybe-number
    "Set this to a number greater than 0 to request paged results from the LDAP
 server in accordance with RFC2696.  The default (0) is to not request paged
 results.")
   (nss-initgroups-ignoreusers
-   (maybe-ignore-users-option 'disabled)
+   maybe-ignore-users-option
    "This option prevents group membership lookups through LDAP for the
 specified users.  Alternatively, the value 'all-local may be used.  With that
 value nslcd builds a full list of non-LDAP users on startup.")
   (nss-min-uid
-   (maybe-number 'disabled)
+   maybe-number
    "This option ensures that LDAP users with a numeric user id lower than the
 specified value are ignored.")
   (nss-uid-offset
-   (maybe-number 'disabled)
+   maybe-number
    "This option specifies an offset that is added to all LDAP numeric user
 ids.  This can be used to avoid user id collisions with local users.")
   (nss-gid-offset
-   (maybe-number 'disabled)
+   maybe-number
    "This option specifies an offset that is added to all LDAP numeric group
 ids.  This can be used to avoid user id collisions with local groups.")
   (nss-nested-groups
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "If this option is set, the member attribute of a group may point to
 another group.  Members of nested groups are also returned in the higher level
 group and parent groups are returned when finding groups for a specific user.
 The default is not to perform extra searches for nested groups.")
   (nss-getgrent-skipmembers
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "If this option is set, the group member list is not retrieved when looking
 up groups.  Lookups for finding which groups a user belongs to will remain
 functional so the user will likely still get the correct groups assigned on
 login.")
   (nss-disable-enumeration
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "If this option is set, functions which cause all user/group entries to be
 loaded from the directory will not succeed in doing so.  This can dramatically
 reduce LDAP server load in situations where there are a great number of users
 and/or groups.  This option is not recommended for most configurations.")
   (validnames
-   (maybe-string 'disabled)
+   maybe-string
    "This option can be used to specify how user and group names are verified
 within the system.  This pattern is used to check all user and group names
 that are requested and returned from LDAP.")
   (ignorecase
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "This specifies whether or not to perform searches using case-insensitive
 matching.  Enabling this could open up the system to authorization bypass
 vulnerabilities and introduce nscd cache poisoning vulnerabilities which allow
 denial of service.")
   (pam-authc-ppolicy
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "This option specifies whether password policy controls are requested and
 handled from the LDAP server when performing user authentication.")
   (pam-authc-search
-   (maybe-string 'disabled)
+   maybe-string
    "By default nslcd performs an LDAP search with the user's credentials after
 BIND (authentication) to ensure that the BIND operation was successful.  The
 default search is a simple check to see if the user's DN exists.  A search
 filter can be specified that will be used instead.  It should return at least
 one entry.")
   (pam-authz-search
-   (maybe-string 'disabled)
+   maybe-string
    "This option allows flexible fine tuning of the authorisation check that
 should be performed.  The search filter specified is executed and if any
 entries match, access is granted, otherwise access is denied.")
   (pam-password-prohibit-message
-   (maybe-string 'disabled)
+   maybe-string
    "If this option is set password modification using pam_ldap will be denied
 and the specified message will be presented to the user instead.  The message
 can be used to direct the user to an alternative means of changing their
diff --git a/gnu/services/cgit.scm b/gnu/services/cgit.scm
index bfc89a40a4..c2c003983a 100644
--- a/gnu/services/cgit.scm
+++ b/gnu/services/cgit.scm
@@ -241,27 +241,27 @@ (define-configuration repository-cgit-configuration
    (repo-file-object "")
    "Override the default @code{email-filter}.")
   (enable-commit-graph?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to disable the global setting
 @code{enable-commit-graph?}.")
   (enable-log-filecount?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to disable the global setting
 @code{enable-log-filecount?}.")
   (enable-log-linecount?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to disable the global setting
 @code{enable-log-linecount?}.")
   (enable-remote-branches?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "Flag which, when set to @code{#t}, will make cgit display remote
 branches in the summary and refs views.")
   (enable-subject-links?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to override the global setting
 @code{enable-subject-links?}.")
   (enable-html-serving?
-   (maybe-repo-boolean 'disabled)
+   maybe-repo-boolean
    "A flag which can be used to override the global setting
 @code{enable-html-serving?}.")
   (hide?
diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index bdca33ed68..f6b20fb82b 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -93,7 +93,7 @@ (define (configuration-field-error field val)
 (define (configuration-missing-field kind field)
   (configuration-error
    (format #f "~a configuration missing required field ~a" kind field)))
-(define (configuration-no-default-value kind field)
+(define (configuration-missing-default-value kind field)
   (configuration-error
    (format #f "The field `~a' of the `~a' configuration record \
 does not have a default value" field kind)))
@@ -142,7 +142,8 @@ (define (define-maybe-helper serialize? prefix syn)
                                     (id #'stem #'serialize-maybe- #'stem))))
        #`(begin
            (define (maybe-stem? val)
-             (or (eq? val 'disabled) (stem? val)))
+             (or (unspecified? val)
+                 (stem? val)))
            #,@(if serialize?
                   (list #'(define (serialize-maybe-stem field-name val)
                             (if (stem? val)
@@ -170,10 +171,10 @@ (define (normalize-field-type+def s)
      (values #'(field-type def)))
     ((field-type)
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))
+     (values #'(field-type *unspecified*)))
     (field-type
      (identifier? #'field-type)
-     (values #'(field-type 'disabled)))))
+     (values #'(field-type *unspecified*)))))
 
 (define (define-configuration-helper serialize? serializer-prefix syn)
   (syntax-case syn ()
@@ -219,9 +220,7 @@ (define-record-type* #,(id #'stem #'< #'stem #'>)
                                           source-properties->location))
                           (innate))
                #,@(map (lambda (name getter def)
-                         (if (eq? (syntax->datum def) (quote 'undefined))
-                             #`(#,name #,getter)
-                             #`(#,name #,getter (default #,def))))
+                         #`(#,name #,getter (default #,def)))
                        #'(field ...)
                        #'(field-getter ...)
                        #'(field-default ...)))
@@ -236,8 +235,8 @@ (define #,(id #'stem #'stem #'-fields)
                         (lambda ()
                           (display '#,(id #'stem #'% #'stem))
                           (if (eq? (syntax->datum field-default)
-                                   'undefined)
-                              (configuration-no-default-value
+                                   '*unspecified*)
+                              (configuration-missing-default-value
                                '#,(id #'stem #'% #'stem) 'field)
                               field-default)))
                       (documentation doc))
diff --git a/gnu/services/file-sharing.scm b/gnu/services/file-sharing.scm
index e3d681b08f..e32d1f145d 100644
--- a/gnu/services/file-sharing.scm
+++ b/gnu/services/file-sharing.scm
@@ -115,8 +115,7 @@ (define-maybe string)
 (set! serialize-maybe-string
   (lambda (field-name val)
     (serialize-string field-name
-                      (if (and (symbol? val)
-                               (eq? val 'disabled))
+                      (if (unspecified? val)
                           ""
                           val))))
 
@@ -181,8 +180,7 @@ (define (serialize-file-object field-name val)
 (define-maybe file-object)
 (set! serialize-maybe-file-object
   (lambda (field-name val)
-    (if (and (symbol? val)
-             (eq? val 'disabled))
+    (if (unspecified? val)
         (serialize-string field-name "")
         (serialize-file-object field-name val))))
 
@@ -281,7 +279,7 @@ (define-configuration transmission-daemon-configuration
 torrent is complete.  Otherwise, files for all torrents (including those still
 being downloaded) will be placed in @code{download-dir}.")
   (incomplete-dir
-   (maybe-string 'disabled)
+   maybe-string
    "The directory in which files from incompletely downloaded torrents will be
 held when @code{incomplete-dir-enabled?} is @code{#t}.")
   (umask
@@ -305,7 +303,7 @@ (define-configuration transmission-daemon-configuration
 automatically (and the original files removed, if
 @code{trash-original-torrent-files?} is @code{#t}).")
   (watch-dir
-   (maybe-string 'disabled)
+   maybe-string
    "The directory to be watched for @file{.torrent} files indicating new
 torrents to be added, when @code{watch-dir-enabled} is @code{#t}.")
   (trash-original-torrent-files?
@@ -401,11 +399,11 @@ (define-configuration transmission-daemon-configuration
 @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or
 @code{require-encrypted-connections}.")
   (peer-congestion-algorithm
-   (maybe-string 'disabled)
+   maybe-string
    "The TCP congestion-control algorithm to use for peer connections,
 specified using a string recognized by the operating system in calls to
-@code{setsockopt} (or set to @code{disabled}, in which case the
-operating-system default is used).
+@code{setsockopt} (or leave it unset, in which case the operating-system
+default is used).
 
 Note that on GNU/Linux systems, the kernel must be configured to allow
 processes to use a congestion-control algorithm not in the default set;
@@ -465,7 +463,7 @@ (define-configuration transmission-daemon-configuration
    "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it
 has most recently downloaded from @code{blocklist-url}.")
   (blocklist-url
-   (maybe-string 'disabled)
+   maybe-string
    "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule
 @file{.dat} format) to be periodically downloaded and applied when
 @code{blocklist-enabled?} is @code{#t}.")
@@ -564,11 +562,11 @@ (define-configuration transmission-daemon-configuration
 the side effect of disabling host-name whitelisting (see
 @code{rpc-host-whitelist-enabled?}.")
   (rpc-username
-   (maybe-string 'disabled)
+   maybe-string
    "The username required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.")
   (rpc-password
-   (maybe-transmission-password-hash 'disabled)
+   maybe-transmission-password-hash
    "The password required by clients to access the @acronym{RPC} interface
 when @code{rpc-authentication-required?} is @code{#t}.  This must be specified
 using a password hash in the format recognized by Transmission clients, either
@@ -613,7 +611,7 @@ (define-configuration transmission-daemon-configuration
 @code{script-torrent-done-filename} will be invoked each time a torrent
 completes.")
   (script-torrent-done-filename
-   (maybe-file-object 'disabled)
+   maybe-file-object
    "A file name or file-like object specifying a script to run each time a
 torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}.")
   (scrape-paused-torrents-enabled?
diff --git a/gnu/services/messaging.scm b/gnu/services/messaging.scm
index 26d47f47de..04653f7dab 100644
--- a/gnu/services/messaging.scm
+++ b/gnu/services/messaging.scm
@@ -75,6 +75,7 @@ (define (make-pred arg)
       (lambda (field target)
         (and (memq (syntax->datum target) `(common ,arg)) field)))
     (syntax-case stx ()
+      ;; TODO Also handle (field-type) form, without a default.
       ((_ stem (field (field-type def) doc target) ...)
        (with-syntax (((new-field-type ...)
                       (map (lambda (field-type target)
@@ -88,7 +89,7 @@ (define (make-pred arg)
                      ((new-def ...)
                       (map (lambda (def target)
                              (if (eq? 'common (syntax->datum target))
-                                 #''disabled def))
+                                 #'*unspecified* def))
                            #'(def ...) #'(target ...)))
                      ((new-doc ...)
                       (map (lambda (doc target)
@@ -198,7 +199,7 @@ (define (serialize-file-object-list field-name val)
 (define-maybe file-object-list)
 
 (define (raw-content? val)
-  (not (eq? val 'disabled)))
+  (not (unspecified? val)))
 (define (serialize-raw-content field-name val)
   val)
 (define-maybe raw-content)
@@ -226,15 +227,15 @@ (define-maybe mod-muc-configuration)
 
 (define-configuration ssl-configuration
   (protocol
-   (maybe-string 'disabled)
+   maybe-string
    "This determines what handshake to use.")
 
   (key
-   (maybe-file-name 'disabled)
+   maybe-file-name
    "Path to your private key file.")
 
   (certificate
-   (maybe-file-name 'disabled)
+   maybe-file-name
    "Path to your certificate file.")
 
   (capath
@@ -243,48 +244,48 @@ (define-configuration ssl-configuration
 trust when verifying the certificates of remote servers.")
 
   (cafile
-   (maybe-file-object 'disabled)
+   maybe-file-object
    "Path to a file containing root certificates that you wish Prosody to trust.
 Similar to @code{capath} but with all certificates concatenated together.")
 
   (verify
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of verification options (these mostly map to OpenSSL's
 @code{set_verify()} flags).")
 
   (options
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of general options relating to SSL/TLS.  These map to OpenSSL's
 @code{set_options()}.  For a full list of options available in LuaSec, see the
 LuaSec source.")
 
   (depth
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "How long a chain of certificate authorities to check when looking for a
 trusted root certificate.")
 
   (ciphers
-   (maybe-string 'disabled)
+   maybe-string
    "An OpenSSL cipher string.  This selects what ciphers Prosody will offer to
 clients, and in what order.")
 
   (dhparam
-   (maybe-file-name 'disabled)
+   maybe-file-name
    "A path to a file containing parameters for Diffie-Hellman key exchange.  You
 can create such a file with:
 @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}")
 
   (curve
-   (maybe-string 'disabled)
+   maybe-string
    "Curve for Elliptic curve Diffie-Hellman. Prosody's default is
 @samp{\"secp384r1\"}.")
 
   (verifyext
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of \"extra\" verification options.")
 
   (password
-   (maybe-string 'disabled)
+   maybe-string
    "Password for encrypted private keys."))
 (define (serialize-ssl-configuration field-name val)
   #~(format #f "ssl = {\n~a};\n"
@@ -472,12 +473,12 @@ (define-all-configurations prosody-configuration
      global)
 
     (http-max-content-size
-     (maybe-non-negative-integer 'disabled)
+     (maybe-non-negative-integer *unspecified*)
      "Maximum allowed size of the HTTP body (in bytes)."
      common)
 
     (http-external-url
-     (maybe-string 'disabled)
+     (maybe-string *unspecified*)
      "Some modules expose their own URL in various ways.  This URL is built
 from the protocol, host and port used.  If Prosody sits behind a proxy, the
 public URL will be @code{http-external-url} instead.  See
@@ -554,7 +555,7 @@ (define-all-configurations prosody-configuration
      int-component)
 
     (mod-muc
-     (maybe-mod-muc-configuration 'disabled)
+     (maybe-mod-muc-configuration *unspecified*)
      "Multi-user chat (MUC) is Prosody's module for allowing you to create
 hosted chatrooms/conferences for XMPP users.
 
@@ -571,7 +572,7 @@ (define-all-configurations prosody-configuration
      ext-component)
 
     (raw-content
-     (maybe-raw-content 'disabled)
+     (maybe-raw-content *unspecified*)
      "Raw content that will be added to the configuration file."
      common)))
 
diff --git a/gnu/services/networking.scm b/gnu/services/networking.scm
index 399cd03c1d..8cd3a95e07 100644
--- a/gnu/services/networking.scm
+++ b/gnu/services/networking.scm
@@ -765,17 +765,17 @@ (define-configuration/no-serialization opendht-configuration
    "The node host name that is used to make the first connection to the
 network.  A specific port value can be provided by appending the @code{:PORT}
 suffix.  By default, it uses the Jami bootstrap nodes, but any host can be
-specified here.  It's also possible to disable bootstrapping by setting this
-to the @code{'disabled} symbol.")
+specified here.  It's also possible to disable bootstrapping by explicitly
+setting this field to the @code{*unspecified*} value.")
   (port
    (maybe-number 4222)
-   "The UDP port to bind to.  When set to @code{'disabled}, an available port
-is automatically selected.")
+   "The UDP port to bind to.  When set to @code{*unspecified*}, an available
+port is automatically selected.")
   (proxy-server-port
-   (maybe-number 'disabled)
+   maybe-number
    "Spawn a proxy server listening on the specified port.")
   (proxy-server-port-tls
-   (maybe-number 'disabled)
+   maybe-number
    "Spawn a proxy server listening to TLS connections on the specified
 port."))
 
diff --git a/gnu/services/pm.scm b/gnu/services/pm.scm
index e48236dbca..3daf484cc1 100644
--- a/gnu/services/pm.scm
+++ b/gnu/services/pm.scm
@@ -114,55 +114,55 @@ (define-configuration tlp-configuration
    "Same as @code{max-lost-work-secs-on-ac} but on BAT mode.")
 
   (cpu-scaling-governor-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "CPU frequency scaling governor on AC mode.  With intel_pstate
 driver, alternatives are powersave and performance.  With acpi-cpufreq driver,
 alternatives are ondemand, powersave, performance and conservative.")
 
   (cpu-scaling-governor-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode.")
 
   (cpu-scaling-min-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the min available frequency for the scaling governor on AC.")
 
   (cpu-scaling-max-freq-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the max available frequency for the scaling governor on AC.")
 
   (cpu-scaling-min-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the min available frequency for the scaling governor on BAT.")
 
   (cpu-scaling-max-freq-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Set the max available frequency for the scaling governor on BAT.")
 
   (cpu-min-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Limit the min P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-max-perf-on-ac
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Limit the max P-state to control the power dissipation of the CPU,
 in AC mode.  Values are stated as a percentage of the available performance.")
 
   (cpu-min-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Same as @code{cpu-min-perf-on-ac} on BAT mode.")
 
   (cpu-max-perf-on-bat
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Same as @code{cpu-max-perf-on-ac} on BAT mode.")
 
   (cpu-boost-on-ac?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Enable CPU turbo boost feature on AC mode.")
 
   (cpu-boost-on-bat?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Same as @code{cpu-boost-on-ac?} on BAT mode.")
 
   (sched-powersave-on-ac?
@@ -179,7 +179,7 @@ (define-configuration tlp-configuration
    "Enable Linux kernel NMI watchdog.")
 
   (phc-controls
-   (maybe-string 'disabled)
+   maybe-string
    "For Linux kernels with PHC patch applied, change CPU voltages.
 An example value would be @samp{\"F:V F:V F:V F:V\"}.")
 
@@ -205,16 +205,16 @@ (define-configuration tlp-configuration
    "Same as @code{disk-apm-bat} but on BAT mode.")
 
   (disk-spindown-timeout-on-ac
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Hard disk spin down timeout.  One value has to be specified for
 each declared hard disk.")
 
   (disk-spindown-timeout-on-bat
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode.")
 
   (disk-iosched
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Select IO scheduler for disk devices.  One value has to be specified
 for each declared hard disk.  Example alternatives are cfq, deadline and noop.")
 
@@ -228,16 +228,16 @@ (define-configuration tlp-configuration
    "Same as @code{sata-linkpwr-ac} but on BAT mode.")
 
   (sata-linkpwr-blacklist
-   (maybe-string 'disabled)
+   maybe-string
    "Exclude specified SATA host devices for link power management.")
 
   (ahci-runtime-pm-on-ac?
-   (maybe-on-off-boolean 'disabled)
+   maybe-on-off-boolean
    "Enable Runtime Power Management for AHCI controller and disks
 on AC mode.")
 
   (ahci-runtime-pm-on-bat?
-   (maybe-on-off-boolean 'disabled)
+   maybe-on-off-boolean
    "Same as @code{ahci-runtime-pm-on-ac} on BAT mode.")
 
   (ahci-runtime-pm-timeout
@@ -254,19 +254,19 @@ (define-configuration tlp-configuration
    "Same as @code{pcie-aspm-ac} but on BAT mode.")
 
   (start-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 0 should begin charging.")
 
   (stop-charge-thresh-bat0
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 0 should stop charging.")
 
   (start-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 1 should begin charging.")
 
   (stop-charge-thresh-bat1
-   (maybe-non-negative-integer 'disabled)
+   maybe-non-negative-integer
    "Percentage when battery 1 should stop charging.")
 
   (radeon-power-profile-on-ac
@@ -346,7 +346,7 @@ (define-configuration tlp-configuration
 blacklisted ones.")
 
   (runtime-pm-blacklist
-   (maybe-space-separated-string-list 'disabled)
+   maybe-space-separated-string-list
    "Exclude specified PCI(e) device addresses from Runtime Power Management.")
 
   (runtime-pm-driver-blacklist
@@ -359,7 +359,7 @@ (define-configuration tlp-configuration
    "Enable USB autosuspend feature.")
 
   (usb-blacklist
-   (maybe-string 'disabled)
+   maybe-string
    "Exclude specified devices from USB autosuspend.")
 
   (usb-blacklist-wwan?
@@ -367,12 +367,12 @@ (define-configuration tlp-configuration
    "Exclude WWAN devices from USB autosuspend.")
 
   (usb-whitelist
-   (maybe-string 'disabled)
+   maybe-string
    "Include specified devices into USB autosuspend, even if they are
 already excluded by the driver or via @code{usb-blacklist-wwan?}.")
 
   (usb-autosuspend-disable-on-shutdown?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Enable USB autosuspend before shutdown.")
 
   (restore-device-state-on-startup?
diff --git a/gnu/services/telephony.scm b/gnu/services/telephony.scm
index d8ebc7b39d..d585997524 100644
--- a/gnu/services/telephony.scm
+++ b/gnu/services/telephony.scm
@@ -156,7 +156,7 @@ (define-configuration jami-account
 secret key material of the Jami account it contains."
    empty-serializer)
   (allowed-contacts
-   (maybe-account-fingerprint-list 'disabled)
+   maybe-account-fingerprint-list
    "The list of allowed contacts for the account, entered as their 40
 characters long fingerprint.  Messages or calls from accounts not in that list
 will be rejected.  When unspecified, the configuration of the account archive
@@ -165,7 +165,7 @@ (define-configuration jami-account
 the account."
    empty-serializer)
   (moderators
-   (maybe-account-fingerprint-list 'disabled)
+   maybe-account-fingerprint-list
    "The list of contacts that should have moderation privileges (to ban, mute,
 etc. other users) in rendezvous conferences, entered as their 40 characters
 long fingerprint.  When unspecified, the configuration of the account archive
@@ -174,24 +174,24 @@ (define-configuration jami-account
    empty-serializer)
   ;; The serializable fields below are to be set with set-account-details.
   (rendezvous-point?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Whether the account should operate in the rendezvous mode.  In this mode,
 all the incoming audio/video calls are mixed into a conference.  When left
 unspecified, the value from the account archive prevails.")
   (peer-discovery?
-   (maybe-boolean 'disabled)
+   maybe-boolean
    "Whether peer discovery should be enabled.  Peer discovery is used to
 discover other OpenDHT nodes on the local network, which can be useful to
 maintain communication between devices on such network even when the
 connection to the the Internet has been lost.  When left unspecified, the
 value from the account archive prevails.")
   (bootstrap-hostnames
-   (maybe-string-list 'disabled)
+   maybe-string-list
    "A list of hostnames or IPs pointing to OpenDHT nodes, that should be used
 to initially join the OpenDHT network.  When left unspecified, the value from
 the account archive prevails.")
   (name-server-uri
-   (maybe-string 'disabled)
+   maybe-string
    "The URI of the name server to use, that can be used to retrieve the
 account fingerprint for a registered username."))
 
@@ -213,7 +213,7 @@ (define (field-name->account-detail name)
                                    name ((configuration-field-getter field)
                                          jami-account-object)))
                            ;; The define-maybe default serializer produces an
-                           ;; empty string for the 'disabled value.
+                           ;; empty string for unspecified values.
                            (value* (if (string-null? value)
                                        #f
                                        value)))
@@ -246,7 +246,7 @@ (define-configuration/no-serialization jami-configuration
    (boolean #f)
    "Whether to force automatic answer to incoming calls.")
   (accounts
-   (maybe-jami-account-list 'disabled)
+   maybe-jami-account-list
    "A list of Jami accounts to be (re-)provisioned every time the Jami daemon
 service starts.  When providing this field, the account directories under
 @file{/var/lib/jami/} are recreated every time the service starts, ensuring a
@@ -294,7 +294,7 @@ (define (jami-shepherd-services config)
          (dbus-daemon (file-append dbus "/bin/dbus-daemon"))
          (dbus-send (file-append dbus "/bin/dbus-send"))
          (accounts (jami-configuration-accounts config))
-         (declarative-mode? (not (eq? 'disabled accounts))))
+         (declarative-mode? (not (unspecified? accounts))))
 
     (with-imported-modules (source-module-closure
                             '((gnu build jami-service)
@@ -685,7 +685,7 @@ (define (archive-name->username archive)
                                           account-details)
                            (let ((username (archive-name->username
                                             archive)))
-                             (when (not (eq? 'disabled allowed-contacts))
+                             (when (not (unspecified? allowed-contacts))
                                ;; Reject calls from unknown contacts.
                                (set-account-details
                                 '(("DHT.PublicInCalls" . "false")) username)
@@ -695,7 +695,7 @@ (define (archive-name->username archive)
                                ;; Add allowed ones.
                                (for-each (cut add-contact <> username)
                                          allowed-contacts))
-                             (when (not (eq? 'disabled moderators))
+                             (when (not (unspecified? moderators))
                                ;; Disable the 'AllModerators' property.
                                (set-all-moderators #f username)
                                ;; Remove all moderators.
diff --git a/gnu/services/vpn.scm b/gnu/services/vpn.scm
index a3dc96c1a2..8be632d55f 100644
--- a/gnu/services/vpn.scm
+++ b/gnu/services/vpn.scm
@@ -363,7 +363,7 @@ (define-split-configuration openvpn-client-configuration
 channel to protect against DoS attacks.")
 
    (auth-user-pass
-     (maybe-string 'disabled)
+    maybe-string
      "Authenticate with server using username/password.  The option is a file
 containing username/password on 2 lines.  Do not use a file-like object as it
 would be added to the store and readable by any user.")
diff --git a/tests/services/configuration.scm b/tests/services/configuration.scm
index 0debf8095b..334a1e409b 100644
--- a/tests/services/configuration.scm
+++ b/tests/services/configuration.scm
@@ -136,3 +136,15 @@ (define-configuration config-with-maybe-string/no-serialization
 
 (test-assert "maybe value without serialization no procedure bound"
   (not (defined? 'serialize-maybe-string)))
+
+(test-assert "maybe type, no default"
+  (unspecified?
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization))))
+
+(test-assert "maybe type, with default"
+  (equal?
+   "foo"
+   (config-with-maybe-string/no-serialization-name
+    (config-with-maybe-string/no-serialization
+     (name "foo")))))
-- 
2.35.1

Message #59 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: 54674 <at> debbugs.gnu.org
Cc: Attila Lendvai <attila <at> lendvai.name>
Subject: [PATCH v5 3/3] doc: Follow the 'disabled -> *unspecified*
 configuration refactor.
Date: Tue, 17 May 2022 13:39:30 +0200

---
 doc/guix.texi | 85 ++++++++++++++++++++++++++-------------------------
 1 file changed, 43 insertions(+), 42 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 5399584cb0..a578a5bd60 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -18632,15 +18632,16 @@ The node host name that is used to make the first connection to the
 network.  A specific port value can be provided by appending the
 @code{:PORT} suffix.  By default, it uses the Jami bootstrap nodes, but
 any host can be specified here.  It's also possible to disable
-bootsrapping by setting this to the @code{'disabled} symbol.
+bootsrapping by explicitly setting this to the @code{*unspecified*}
+value.
 
 Defaults to @samp{"bootstrap.jami.net:4222"}.
 
 @end deftypevr
 
 @deftypevr {@code{opendht-configuration} parameter} maybe-number port
-The UDP port to bind to.  When set to @code{'disabled}, an available
-port is automatically selected.
+The UDP port to bind to.  When explicitly set to @code{*unspecified*},
+an available port is automatically selected.
 
 Defaults to @samp{4222}.
 
@@ -24405,7 +24406,7 @@ The available configuration parameters follow.  Each parameter
 definition is preceded by its type; for example, @samp{string-list foo}
 indicates that the @code{foo} parameter should be specified as a list of
 strings.  Types starting with @code{maybe-} denote parameters that won't
-show up in @code{prosody.cfg.lua} when their value is @code{'disabled}.
+show up in @code{prosody.cfg.lua} when their value is left unspecified.
 
 There is also a way to specify the configuration as a string, if you
 have an old @code{prosody.cfg.lua} file that you want to port over from
@@ -25019,7 +25020,7 @@ Whether to enable debug level messages.
 @item @code{auto-answer?} (default: @code{#f}) (type: boolean)
 Whether to force automatic answer to incoming calls.
 
-@item @code{accounts} (default: @code{disabled}) (type: maybe-jami-account-list)
+@item @code{accounts} (type: maybe-jami-account-list)
 A list of Jami accounts to be (re-)provisioned every time the Jami
 daemon service starts.  When providing this field, the account
 directories under @file{/var/lib/jami/} are recreated every time the
@@ -25041,39 +25042,39 @@ should @emph{not} be encrypted.  It is highly recommended to make it
 readable only to the @samp{root} user (i.e., not in the store), to guard
 against leaking the secret key material of the Jami account it contains.
 
-@item @code{allowed-contacts} (default: @code{disabled}) (type: maybe-account-fingerprint-list)
+@item @code{allowed-contacts} (type: maybe-account-fingerprint-list)
 The list of allowed contacts for the account, entered as their 40
 characters long fingerprint.  Messages or calls from accounts not in
-that list will be rejected.  When unspecified, the configuration of the
-account archive is used as-is with respect to contacts and public
+that list will be rejected.  When left specified, the configuration of
+the account archive is used as-is with respect to contacts and public
 inbound calls/messaging allowance, which typically defaults to allow any
 contact to communicate with the account.
 
-@item @code{moderators} (default: @code{disabled}) (type: maybe-account-fingerprint-list)
+@item @code{moderators} (type: maybe-account-fingerprint-list)
 The list of contacts that should have moderation privileges (to ban,
 mute, etc.  other users) in rendezvous conferences, entered as their 40
-characters long fingerprint.  When unspecified, the configuration of the
-account archive is used as-is with respect to moderation, which
+characters long fingerprint.  When left unspecified, the configuration
+of the account archive is used as-is with respect to moderation, which
 typically defaults to allow anyone to moderate.
 
-@item @code{rendezvous-point?} (default: @code{disabled}) (type: maybe-boolean)
+@item @code{rendezvous-point?} (type: maybe-boolean)
 Whether the account should operate in the rendezvous mode.  In this
 mode, all the incoming audio/video calls are mixed into a conference.
 When left unspecified, the value from the account archive prevails.
 
-@item @code{peer-discovery?} (default: @code{disabled}) (type: maybe-boolean)
+@item @code{peer-discovery?} (type: maybe-boolean)
 Whether peer discovery should be enabled.  Peer discovery is used to
 discover other OpenDHT nodes on the local network, which can be useful
 to maintain communication between devices on such network even when the
 connection to the the Internet has been lost.  When left unspecified,
 the value from the account archive prevails.
 
-@item @code{bootstrap-hostnames} (default: @code{disabled}) (type: maybe-string-list)
+@item @code{bootstrap-hostnames} (type: maybe-string-list)
 A list of hostnames or IPs pointing to OpenDHT nodes, that should be
 used to initially join the OpenDHT network.  When left unspecified, the
 value from the account archive prevails.
 
-@item @code{name-server-uri} (default: @code{disabled}) (type: maybe-string)
+@item @code{name-server-uri} (type: maybe-string)
 The URI of the name server to use, that can be used to retrieve the
 account fingerprint for a registered username.
 
@@ -25707,8 +25708,8 @@ Defaults to @samp{prefer-encrypted-connections}.
 @deftypevr {@code{transmission-daemon-configuration} parameter} maybe-string peer-congestion-algorithm
 The TCP congestion-control algorithm to use for peer connections,
 specified using a string recognized by the operating system in calls to
-@code{setsockopt} (or set to @code{disabled}, in which case the
-operating-system default is used).
+@code{setsockopt}.  When left unspecified, the operating-system default
+is used.
 
 Note that on GNU/Linux systems, the kernel must be configured to allow
 processes to use a congestion-control algorithm not in the default set;
@@ -29336,7 +29337,7 @@ Defaults to @samp{tun}.
 
 If you do not have some of these files (eg.@: you use a username and
 password), you can disable any of the following three fields by setting
-it to @code{'disabled}.
+it to @code{*unspecified*}.
 
 @deftypevr {@code{openvpn-client-configuration} parameter} maybe-string ca
 The certificate authority to check connections against.
@@ -29410,7 +29411,6 @@ Authenticate with server using username/password.  The option is a file
 containing username/password on 2 lines.  Do not use a file-like object as it
 would be added to the store and readable by any user.
 
-Defaults to @samp{'disabled}.
 @end deftypevr
 
 @deftypevr {@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?
@@ -29491,7 +29491,7 @@ Defaults to @samp{tun}.
 
 If you do not have some of these files (eg.@: you use a username and
 password), you can disable any of the following three fields by setting
-it to @code{'disabled}.
+it to @code{*unspecified*}.
 
 @deftypevr {@code{openvpn-server-configuration} parameter} maybe-string ca
 The certificate authority to check connections against.
@@ -30290,10 +30290,10 @@ content by adding a valid @code{tlp-configuration}:
 @end deffn
 
 Each parameter definition is preceded by its type; for example,
-@samp{boolean foo} indicates that the @code{foo} parameter
-should be specified as a boolean.  Types starting with
-@code{maybe-} denote parameters that won't show up in TLP config file
-when their value is @code{'disabled}.
+@samp{boolean foo} indicates that the @code{foo} parameter should be
+specified as a boolean.  Types starting with @code{maybe-} denote
+parameters that won't show up in TLP config file when their value is
+left unset, or is explicitly set to the @code{*unspecified*} value.
 
 @c The following documentation was initially generated by
 @c (generate-tlp-documentation) in (gnu services pm).  Manually maintained
@@ -37853,15 +37853,16 @@ macro which is a shorthand of this.
 @deffn {Scheme Syntax} define-maybe @var{type}
 Sometimes a field should not be serialized if the user doesn’t specify a
 value.  To achieve this, you can use the @code{define-maybe} macro to
-define a ``maybe type''; if the value of a maybe type is set to the
-@code{disabled}, it will not be serialized.
+define a ``maybe type''; if the value of a maybe type is left unset, or
+is set to the @code{*unspecified*} value, then it will not be
+serialized.
 
 When defining a ``maybe type'', the corresponding serializer for the
 regular type will be used by default.  For example, a field of type
 @code{maybe-string} will be serialized using the @code{serialize-string}
 procedure by default, you can of course change this by specifying a
 custom serializer procedure.  Likewise, the type of the value would have
-to be a string, unless it is set to the @code{disabled} symbol.
+to be a string, or left unspecified.
 
 @lisp
 (define-maybe string)
@@ -37871,9 +37872,9 @@ to be a string, unless it is set to the @code{disabled} symbol.
 
 (define-configuration baz-configuration
   (name
-   ;; Nothing will be serialized by default.  If set to a string, the
-   ;; `serialize-string' procedure will be used to serialize the string.
-   (maybe-string 'disabled)
+   ;; If set to a string, the `serialize-string' procedure will be used
+   ;; to serialize the string.  Otherwise this field is not serialized.
+   maybe-string    ; equivalent to (maybe-string *unspecified*)
    "The name of this module."))
 @end lisp
 
@@ -37890,7 +37891,7 @@ serializer name by using the @code{prefix} literal.
 
 There is also the @code{no-serialization} literal, which when set means
 that no serializer will be defined for the ``maybe type'', regardless of
-its value is @code{disabled} or not.
+whether its value is set or not.
 @code{define-maybe/no-serialization} is a shorthand for specifying the
 @code{no-serialization} literal.
 
@@ -37899,7 +37900,7 @@ its value is @code{disabled} or not.
 
 (define-configuration/no-serialization test-configuration
   (mode
-   (maybe-symbol 'disabled)
+   maybe-symbol
    "Docstring."))
 @end lisp
 @end deffn
@@ -38031,10 +38032,10 @@ Below is an example of a record type created using
    "The name of the contact."
    serialize-contact-name)
   (phone-number
-   (maybe-integer 'disabled)
+   maybe-integer
    "The person's phone number.")
   (email
-   (maybe-string 'disabled)
+   maybe-string
    "The person's email address.")
   (married?
    (boolean)
@@ -38758,24 +38759,24 @@ Daytime color temperature (kelvins).
 @item @code{nighttime-temperature} (default: @code{4500}) (type: integer)
 Nighttime color temperature (kelvins).
 
-@item @code{daytime-brightness} (default: @code{disabled}) (type: maybe-inexact-number)
-Daytime screen brightness, between 0.1 and 1.0.
+@item @code{daytime-brightness} (type: maybe-inexact-number)
+Daytime screen brightness, between 0.1 and 1.0, or left unspecified.
 
-@item @code{nighttime-brightness} (default: @code{disabled}) (type: maybe-inexact-number)
-Nighttime screen brightness, between 0.1 and 1.0.
+@item @code{nighttime-brightness} (type: maybe-inexact-number)
+Nighttime screen brightness, between 0.1 and 1.0, or left unspecified.
 
-@item @code{latitude} (default: @code{disabled}) (type: maybe-inexact-number)
+@item @code{latitude} (type: maybe-inexact-number)
 Latitude, when @code{location-provider} is @code{'manual}.
 
-@item @code{longitude} (default: @code{disabled}) (type: maybe-inexact-number)
+@item @code{longitude} (type: maybe-inexact-number)
 Longitude, when @code{location-provider} is @code{'manual}.
 
-@item @code{dawn-time} (default: @code{disabled}) (type: maybe-string)
+@item @code{dawn-time} (type: maybe-string)
 Custom time for the transition from night to day in the
 morning---@code{"HH:MM"} format.  When specified, solar elevation is not
 used to determine the daytime/nighttime period.
 
-@item @code{dusk-time} (default: @code{disabled}) (type: maybe-string)
+@item @code{dusk-time} (type: maybe-string)
 Likewise, custom time for the transition from day to night in the
 evening.
 
-- 
2.35.1

Message #62 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Maxime Devos <maximedevos <at> telenet.be>
To: Attila Lendvai <attila <at> lendvai.name>, 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH v4 1/2] services: configuration: Support
 (field1 maybe-number "") format.
Date: Tue, 17 May 2022 18:15:09 +0200

[Message part 1 (text/plain, inline)]

Attila Lendvai schreef op di 17-05-2022 om 11:38 [+0000]:
> unfortunately, `make check-system` returns with the attached output.
> after some staring and grepping, i can't identify why these tests are
> failing, and whether it is a new bug at all that happens due to my
> changes.

The standard test is to run "make check-system" again without patches
and see if it still fails.

> i would love to reshape this into something that will get merged.
> is there anything i can do to help that process?

AFAICT the patch is ready, except for maybe the Jami issue.

Also, if there are more reviewers for patches in general (and likewise,
more people investigating bugs), then committers have less to take care
of (-> faster response times).  Likewise with more committers.
That's more of a long-term and general (not specific to this patch)
thing though.

Greetings,
Maxime.

[signature.asc (application/pgp-signature, inline)]

Message #65 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH v4 1/2] services: configuration: Support
 (field1 maybe-number "") format.
Date: Thu, 19 May 2022 14:21:38 +0000

[Message part 1 (text/plain, inline)]

> The standard test is to run "make check-system" again without patches
> and see if it still fails.


the trouble is that it fails even on master. i took the time now, pulled latest master, and ran a `make check-system`, and it fails the same way for me as with my patch. i've attached the log, produced this time by *master*; in essence:

This is the GNU system.  Welcome.
jami login: Jami Daemon 11.0.0, by Savoir-faire Linux 2004-2019
https://jami.net/
[Video support enabled]
[Plugins support enabled]

10:05:11.924         os_core_unix.c !pjlib 2.11 for POSIX initialized
Jami Daemon 11.0.0, by Savoir-faire Linux 2004-2019
https://jami.net/
[Video support enabled]
[Plugins support enabled]

One does not simply initialize the client: Another daemon is detected
/gnu/store/01phrvxnxrg1q0gxa35g7f77q06crf6v-shepherd-marionette.scm:1:1718: ERROR:
  1. &action-exception-error:
      service: jami
      action: start
      key: match-error
      args: ("match" "no matching pattern" #f)

[...]

--
• attila lendvai
• PGP: 963F 5D5F 45C7 DFCD 0A39
--
“You’ve stopped seeking the truth when you view doubt not as a clue to be followed but a challenge to be overcome.”
	— Peter Boghossian (1966–)

[1rq8sh17gs6y077zw2zip9617k5pn8-jami-provisioning-test.drv.gz (application/gzip, attachment)]

Message #68 received at 54674 <at> debbugs.gnu.org (full text, mbox):

From: Attila Lendvai <attila <at> lendvai.name>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54674 <at> debbugs.gnu.org
Subject: Re: [bug#54674] [PATCH v4 1/2] services: configuration: Support
 (field1 maybe-number "") format.
Date: Thu, 19 May 2022 20:41:06 +0000

FTR, master's `make check-system` failures are tracked here:

https://issues.guix.gnu.org/54786

--
• attila lendvai
• PGP: 963F 5D5F 45C7 DFCD 0A39
--
“War must be, while we defend our lives against a destroyer who would devour all; but I do not love the bright sword for its sharpness, nor the arrow for its swiftness, nor the warrior for his glory. I love only that which they defend.”
	— J. R. R. Tolkien (1892–1973), 'The Two Towers' (1954), http://youtu.be/jfxdlWje5nk

Message #73 received at 54674-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Attila Lendvai <attila <at> lendvai.name>
Cc: 54674-done <at> debbugs.gnu.org
Subject: Re: bug#54674: [PATCH] services: configuration: Use *unspecified*
 instead of 'disabled.
Date: Wed, 15 Jun 2022 00:31:12 +0200

Hi Attila,

Finally pushed!

  713d140750 * doc: Follow the 'disabled -> *unspecified* configuration refactor.
  8cb1a49a39 * services: configuration: Use *unspecified* instead of 'disabled.
  e11517052b * services: configuration: Support (field1 maybe-number "") format.

I edited the commit logs so that every change is mentioned.

Anyway, a nice improvement!

Thank you, and thanks Maxime for reviewing and helping out.

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.