[PATCH] doc: Quote all list values.

  • Done
  • quality assurance status badge
Details
2 participants
  • Ludovic Courtès
  • Florian Pelz
Owner
unassigned
Submitted by
Florian Pelz
Severity
normal

Debbugs page

Florian Pelz wrote 2 years ago
(address . guix-patches@gnu.org)(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)
20230412162632.4578-1-pelzflorian@pelzflorian.de
* doc/guix.texi (System Configuration)[Services]: Replace all () by
'(), and similar quotings.
(Home Configuration)[Home Services]: Likewise.
---
doc/guix.texi | 262 +++++++++++++++++++++++++-------------------------
1 file changed, 131 insertions(+), 131 deletions(-)

Toggle diff (478 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index acb6f0c2e1..53cd2f5405 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -19430,7 +19430,7 @@ Available @code{mcron-configuration} fields are:
@item @code{mcron} (default: @code{mcron}) (type: file-like)
The mcron package to use.
-@item @code{jobs} (default: @code{()}) (type: list-of-gexps)
+@item @code{jobs} (default: @code{'()}) (type: list-of-gexps)
This is a list of gexps (@pxref{G-Expressions}), where each gexp
corresponds to an mcron job specification (@pxref{Syntax, mcron job
specifications,, mcron,GNU@tie{}mcron}).
@@ -19995,7 +19995,7 @@ Data Type representing the configuration of connman.
@item @code{connman} (default: @var{connman})
The connman package to use.
-@item @code{shepherd-requirement} (default: @code{()})
+@item @code{shepherd-requirement} (default: @code{'()})
This option can be used to provide a list of symbols naming Shepherd services
that this service will depend on, such as @code{'wpa-supplicant} or
@code{'iwd} if you require authenticated access for encrypted WiFi or Ethernet
@@ -20829,7 +20829,7 @@ Whether to detach from the controlling terminal.
File containing the @dfn{host key}. This file must be readable by
root only.
-@item @code{interfaces} (default: @code{()}) (type: list)
+@item @code{interfaces} (default: @code{'()}) (type: list)
List of host names or addresses that @command{lshd} will listen on.
If empty, @command{lshd} listens for connections on all the network
interfaces.
@@ -22127,7 +22127,7 @@ When unspecified, listen for any hosts/IP addresses.
@item @code{vnc-server-port} (default: @code{5900}) (type: number)
The TCP port the VNC server should listen to.
-@item @code{extra-config} (default: @code{()}) (type: list-of-strings)
+@item @code{extra-config} (default: @code{'()}) (type: list-of-strings)
Extra configuration values to append to the LightDM configuration file.
@end table
@@ -22176,7 +22176,7 @@ The accessibility features to enable, given as list of symbols.
@item @code{reader} (type: maybe-file-like)
The command to use to launch a screen reader.
-@item @code{extra-config} (default: @code{()}) (type: list-of-strings)
+@item @code{extra-config} (default: @code{'()}) (type: list-of-strings)
Extra configuration values to append to the LightDM GTK Greeter
configuration file.
@@ -22214,7 +22214,7 @@ The Xorg server command to run.
@item @code{session-wrapper} (type: file-like)
The xinitrc session wrapper to use.
-@item @code{extra-config} (default: @code{()}) (type: list-of-strings)
+@item @code{extra-config} (default: @code{'()}) (type: list-of-strings)
Extra configuration values to append to the seat configuration section.
@end table
@@ -22241,7 +22241,7 @@ This is a list of font directories to add to the server's @dfn{font path}.
@item @code{drivers} (default: @code{'()})
This must be either the empty list, in which case Xorg chooses a graphics
driver automatically, or a list of driver names that will be tried in this
-order---e.g., @code{("modesetting" "vesa")}.
+order---e.g., @code{'("modesetting" "vesa")}.
@item @code{resolutions} (default: @code{'()})
When @code{resolutions} is the empty list, Xorg chooses an appropriate screen
@@ -22801,13 +22801,13 @@ Specifies the URI path to which the access control applies.
Access controls for all access to this path, in the same format as the
@code{access-controls} of @code{operation-access-control}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{location-access-controls} parameter} method-access-control-list method-access-controls
Access controls for method-specific access to this path.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
Available @code{method-access-controls} fields are:
@@ -22821,14 +22821,14 @@ Defaults to @samp{#f}.
@deftypevr {@code{method-access-controls} parameter} method-list methods
Methods to which this access control applies.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{method-access-controls} parameter} access-control-list access-controls
Access control directives, as a list of strings. Each string should be
one directive, such as @samp{"Order allow,deny"}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@end deftypevr
@end deftypevr
@@ -22970,7 +22970,7 @@ Defaults to @samp{""}.
Passes the specified environment variable(s) to child processes; a list
of strings.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{cups-configuration} parameter} policy-configuration-list policies
@@ -23029,7 +23029,7 @@ notify-subscriber-user-name notify-user-data"}.
@deftypevr {@code{policy-configuration} parameter} operation-access-control-list access-controls
Access control by IPP operation.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@end deftypevr
@@ -23107,7 +23107,7 @@ values are of the form @var{address}:@var{port}, where @var{address} is
either an IPv6 address enclosed in brackets, an IPv4 address, or
@code{*} to indicate all addresses.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{cups-configuration} parameter} ssl-options ssl-options
@@ -23121,7 +23121,7 @@ TLS v1.0. The @code{DenyCBC} option disables all CBC cipher suites. The
@code{DenyTLS1.0} option disables TLS v1.0 support - this sets the minimum
protocol version to TLS v1.1.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{cups-configuration} parameter} boolean strict-conformance?
@@ -23418,7 +23418,7 @@ Data type representing the configuration for @code{dbus-root-service-type}.
@item @code{dbus} (default: @code{dbus}) (type: file-like)
Package object for dbus.
-@item @code{services} (default: @code{()}) (type: list)
+@item @code{services} (default: @code{'()}) (type: list)
List of packages that provide an @file{etc/dbus-1/system.d} directory
containing additional D-Bus configuration and policy files.
For example, to allow avahi-daemon to use the system bus, @var{services}
@@ -24910,7 +24910,7 @@ the ManageSieve service, before authentication. These may differ from the
capabilities offered to authenticated users. If this field is left empty,
report what the Sieve interpreter supports by default.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{protocol-configuration} parameter} space-separated-string-list managesieve-sieve-capability
@@ -24919,7 +24919,7 @@ the ManageSieve service, before authentication. These may differ from the
capabilities offered to authenticated users. If this field is left empty,
report what the Sieve interpreter supports by default.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@@ -24953,7 +24953,7 @@ The service kind. Valid values include @code{director},
Listeners for the service. A listener is either a
@code{unix-listener-configuration}, a @code{fifo-listener-configuration}, or
an @code{inet-listener-configuration}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
Available @code{unix-listener-configuration} fields are:
@@ -25071,7 +25071,7 @@ Available @code{dict-configuration} fields are:
@deftypevr {@code{dict-configuration} parameter} free-form-fields entries
A list of key-value pairs that this dict should hold.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@end deftypevr
@@ -25115,7 +25115,7 @@ Defaults to @samp{""}.
@deftypevr {@code{userdb-configuration} parameter} free-form-args override-fields
Override fields from passwd.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@end deftypevr
@@ -25193,7 +25193,7 @@ Defaults to @samp{#t}.
@deftypevr {@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes
List of predefined mailboxes in this namespace.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
Available @code{mailbox-configuration} fields are:
@@ -25211,7 +25211,7 @@ Defaults to @samp{"no"}.
List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154.
Valid values are @code{\All}, @code{\Archive}, @code{\Drafts},
@code{\Flagged}, @code{\Junk}, @code{\Sent}, and @code{\Trash}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@end deftypevr
@@ -25234,12 +25234,12 @@ allowed to override their IP addresses and ports (for logging and for
authentication checks). @samp{disable-plaintext-auth} is also ignored
for these networks. Typically you would specify your IMAP proxy servers
here.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets
List of login access check sockets (e.g.@: tcpwrap).
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} boolean verbose-proctitle?
@@ -25312,7 +25312,7 @@ List of realms for SASL authentication mechanisms that need them.
You can leave it empty if you don't want to support multiple realms.
Many clients simply use the first one listed here, so keep the default
realm first.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} string auth-default-realm
@@ -25428,13 +25428,13 @@ List of wanted authentication mechanisms. Supported mechanisms are:
List of IPs or hostnames to all director servers, including ourself.
Ports can be specified as ip:port. The default port is the same as what
director service's @samp{inet-listener} is using.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers
List of IPs or hostnames to all backend mail servers. Ranges are
allowed too, like 10.0.0.10-10.0.0.30.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} string director-user-expire
@@ -25733,7 +25733,7 @@ too). This setting doesn't affect @samp{login-chroot}
which local users can modify, that may lead to root exploit. Usually
this should be done only if you don't allow shell access for users.
<doc/wiki/Chrooting.txt>.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} string mail-chroot
@@ -25761,7 +25761,7 @@ Defaults to @samp{"/usr/lib/dovecot"}.
@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins
List of plugins to load for all services. Plugins specific to IMAP,
LDA, etc.@: are added to this list in their own .conf files.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count
@@ -26189,7 +26189,7 @@ Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g.@: mbox).
This makes Thunderbird realize they aren't selectable and show them
greyed out, instead of only later giving "not selectable" popup error.
@end table
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{dovecot-configuration} parameter} string imap-urlauth-host
@@ -26402,7 +26402,7 @@ Defaults to @samp{""}.
@deftypevr {@code{getmail-retriever-configuration} parameter} list password-command
Override fields from passwd.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@@ -26430,7 +26430,7 @@ Defaults to @samp{""}.
@deftypevr {@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters
Extra retriever parameters.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@@ -26460,7 +26460,7 @@ Defaults to @samp{""}.
@deftypevr {@code{getmail-destination-configuration} parameter} parameter-alist extra-parameters
Extra destination parameters
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@@ -26575,7 +26575,7 @@ Defaults to @samp{#f}.
@deftypevr {@code{getmail-options-configuration} parameter} parameter-alist extra-parameters
Extra options to include.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@@ -26588,14 +26588,14 @@ A list of mailboxes that getmail should wait on the server for new mail
notifications. This depends on the server supporting the IDLE
extension.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{getmail-configuration} parameter} list environment-variables
Environment variables to set for getmail.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@@ -26769,7 +26769,7 @@ Defaults to @samp{"/var/lib/prosody"}.
@deftypevr {@code{prosody-configuration} parameter} file-object-list plugin-paths
Additional plugin directories. They are searched in all the specified
paths in order. See @url{https://prosody.im/doc/plugins_directory}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} file-name certificates
@@ -26784,7 +26784,7 @@ This is a list of accounts that are admins for the server. Note that you
must create the accounts separately. See @url{https://prosody.im/doc/admins} and
@url{https://prosody.im/doc/creating_accounts}.
Example: @code{(admins '("user1@@example.com" "user2@@example.net"))}
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} boolean use-libevent?
@@ -26798,13 +26798,13 @@ This is the list of modules Prosody will load on startup. It looks for
@code{mod_modulename.lua} in the plugins folder, so make sure that exists too.
Documentation on modules can be found at:
@url{https://prosody.im/doc/modules}.
-Defaults to @samp{("roster" "saslauth" "tls" "dialback" "disco" "carbons" "private" "blocklist" "vcard" "version" "uptime" "time" "ping" "pep" "register" "admin_adhoc")}.
+Defaults to @samp{'("roster" "saslauth" "tls" "dialback" "disco" "carbons" "private" "blocklist" "vcard" "version" "uptime" "time" "ping" "pep" "register" "admin_adhoc")}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} string-list modules-disabled
@samp{"offline"}, @samp{"c2s"} and @samp{"s2s"} are auto-loaded, but
should you want to disable them then add them to this list.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} file-object groups-file
@@ -26902,7 +26902,7 @@ Defaults to @samp{#f}.
@deftypevr {@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms
Set of mechanisms that will never be offered. See
@url{https://prosody.im/doc/modules/mod_saslauth}.
-Defaults to @samp{("DIGEST-MD5")}.
+Defaults to @samp{'("DIGEST-MD5")}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} boolean s2s-require-encryption?
@@ -26924,14 +26924,14 @@ Many servers don't support encryption or have invalid or self-signed
certificates. You can list domains here that will not be required to
authenticate using certificates. They will be authenticated using DNS@. See
@url{https://prosody.im/doc/s2s#security}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} string-list s2s-secure-domains
Even if you leave @code{s2s-secure-auth?} disabled, you can still require
valid certificates for some domains by specifying a list here. See
@url{https://prosody.im/doc/s2s#security}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} string authentication
@@ -27002,7 +27002,7 @@ internal component, you simply fill the hostname field, and the plugin you wish
to use for the component.
See @url{https://prosody.im/doc/components}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
Available @code{int-component-configuration} fields are:
@@ -27055,7 +27055,7 @@ Defaults to @samp{20}.
External components use XEP-0114, which most standalone components
support. To add an external component, you simply fill the hostname field. See
@url{https://prosody.im/doc/components}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
Available @code{ext-component-configuration} fields are:
@@ -27072,7 +27072,7 @@ Hostname of the component.
@deftypevr {@code{prosody-configuration} parameter} non-negative-integer-list component-ports
Port(s) Prosody listens on for component connections.
-Defaults to @samp{(5347)}.
+Defaults to @samp{'(5347)}.
@end deftypevr
@deftypevr {@code{prosody-configuration} parameter} string component-interface
@@ -28337,7 +28337,7 @@ The list of IP and IPv6 addresses from which @acronym{RPC} requests will
be accepted when @code{rpc-whitelist-enabled?} is @code{#t}. Wildcards
may be specified using @samp{*}.
-Defaults to @samp{("127.0.0.1" "::1")}.
+Defaults to @samp{'("127.0.0.1" "::1")}.
@end deftypevr
@@ -28358,7 +28358,7 @@ Defaults to @samp{#t}.
The list of host names recognized by the @acronym{RPC} server when
@code{rpc-host-whitelist-enabled?} is @code{#t}.
-Defaults to @samp{()}.
+Defaults to @samp{'()}.
@end deftypevr
@@ -28699,7 +28699,7 @@ Location of SSL client certificates.
@item @code{extra-options} (default: @code{""}) (type: extra-options)
Extra options will be appended to Zabbix server configuration file.
-@item @code{include-files} (default: @code{()}) (type: include-files)
+@item @code{include-files} (default: @code{'()}) (type: include-files)
You may include individual files or all files in a directory in the
configuration file.
@@ -28764,12 +28764,12 @@ Log file name for @code{log-type} @code{file} parameter.
@item @code{pid-file} (default: @code{"/var/run/zabbix/zabbix_agent.pid"}) (type: string)
Name of PID file.
-@item @code{server} (default: @code{("127.0.0.1")}) (type: list)
+@item @code{server} (default: @code{'("127.0.0.1")}) (type: list)
List of IP addresses, optionally in CIDR notation, or hostnames of
Zabbix servers and Zabbix proxies. Incoming connections will be
accepted only from the hosts listed here.
-@item @code{server-active} (default: @code{("127.0.0.1")}) (type: list)
+@item @code{server-active} (default: @code{'("127.0.0.1")}) (type: list)
List of IP:port (or hostname:port) pairs of Zabbix servers and Zabbix
proxies for active checks. If port is not specified, default port is
used. If this parameter is not specified, active checks are disabled.
@@ -28777,7 +28777,7 @@ used. If this parameter is not specified, active checks are disabled.
@item @code{extra-options} (default: @code{""}) (type: extra-options)
Extra options will be appended to Zabbix server configuration file.
-@item @code{include-files} (default: @code{()}) (type: include-files)
+@item @code{include-files} (default: @code{'()}) (type: include-files)
You may include individual files or all files in a directory in the
configuration file.
@@ -28811,7 +28811,7 @@ Available @code{zabbix-front-end-configuration} fields are:
@item @code{zabbix-server} (default: @code{zabbix-server}) (type: file-like)
The Zabbix server package to use.
-@item @code{nginx} (default: @code{()}) (type: list)
+@item @code{nginx} (default: @code{'()}) (type: list)
List of @ref{nginx-server-configuration,@code{nginx-server-configuration}}
blocks for the Zabbix front-end. When empty, a default that listens on
port 80 is used.
@@ -29057,7 +29057,7 @@ one of the following symbols: @samp{crit}, @samp{error}, @samp{warning},
@samp{notice}, @samp{info} or @samp{debug}. All messages with the
specifie
This message was truncated. Download the full message here.
Ludovic Courtès wrote 2 years ago
(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)(address . 62799@debbugs.gnu.org)
87pm6iertg.fsf@gnu.org
Hi,

Florian Pelz <pelzflorian@pelzflorian.de> skribis:

Toggle quote (4 lines)
> * doc/guix.texi (System Configuration)[Services]: Replace all () by
> '(), and similar quotings.
> (Home Configuration)[Home Services]: Likewise.

LGTM! Sorry for not noticing earlier; let’s hope it still applies…

Ludo’.
pelzflorian (Florian Pelz) wrote 2 years ago
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 62799-done@debbugs.gnu.org)
878rd5omub.fsf@pelzflorian.de
Thank you Ludo for the LGTM.

Closing. Pushed as
718eb551048ac0de520963251d5a651682676d8b without a quoting that Sergey
Trofimov already fixed and with two new quotings:

Toggle diff (21 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index 47b2b8ba62..9967d85f65 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -22446,7 +22446,7 @@ X Window
@item @code{resolutions} (default: @code{'()})
When @code{resolutions} is the empty list, Xorg chooses an appropriate screen
-resolution. Otherwise, it must be a list of resolutions---e.g., @code{((1024
+resolution. Otherwise, it must be a list of resolutions---e.g., @code{'((1024
768) (640 480))}.
@cindex keyboard layout, for Xorg
@@ -43571,7 +43571,7 @@ Mail Home Services
@item @code{defaults} (type: msmtp-configuration)
The configuration that will be set as default for all accounts.
-@item @code{accounts} (default: @code{()}) (type: list-of-msmtp-accounts)
+@item @code{accounts} (default: @code{'()}) (type: list-of-msmtp-accounts)
A list of @code{msmtp-account} records which contain information about
all your accounts.
Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 62799@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 62799
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help