(address . guix-patches@gnu.org)(name . Maxim Cournoyer)(address . maxim.cournoyer@gmail.com)
This series contains some improvements to the (gnu services
configuration) module.
The first patch changes the formatting of the generated documentation
for configuration records. Previously, the generated documentation
looked a bit different from the ones that were to generated, compare the
docs for ‘getmail-configuration’ (generated) and ‘openssh-configuration’
(not generated).
Toggle snippet (11 lines)
Available ‘getmail-configuration’ fields are:
-- ‘getmail-configuration’ parameter: symbol name
A symbol to identify the getmail service.
Defaults to ‘"unset"’.
-- ‘getmail-configuration’ parameter: package package
The getmail package to use.
Toggle snippet (13 lines)
-- Data Type: openssh-configuration
This is the configuration record for OpenSSH’s ‘sshd’.
‘openssh’ (default OPENSSH)
The Openssh package to use.
‘pid-file’ (default: ‘"/var/run/sshd.pid"’)
Name of the file where ‘sshd’ writes its PID.
‘port-number’ (default: ‘22’)
TCP port on which ‘sshd’ listens for incoming connections.
The first patch will make the generated documentation look at lot more
similiar to the hand-written ones.
Toggle snippet (10 lines)
-- Data Type: getmail-configuration
Available ‘getmail-configuration’ fields are:
‘name’ (default: ‘"unset"’) (type: symbol)
A symbol to identify the getmail service.
‘package’ (default: ‘getmail’) (type: package)
The getmail package to use.
If you paid close attention you will also notice that the old generated
docs didn’t specify the default value of the ‘package’ field, whereas
the new docs do. This brings us to the second patch, it looks the
package and shows the value of the ‘name’ field of the package. This
will only show the correct package name if the ‘name’ field and the
Scheme variable corresponding to the package are the same, in most cases
it is, so I don’t think it would be a huge deal.
Xinglu Chen (2):
services: configuration: Change formatting of generated documentation.
services: configuration: Show default value when it is a package.
gnu/services/configuration.scm | 62 ++++++++++++++++++++--------------
1 file changed, 36 insertions(+), 26 deletions(-)
base-commit: 86bb77608d375043f837583332a7c852ea2080ec
--
2.32.0
-----BEGIN PGP SIGNATURE-----
iQJJBAEBCAAzFiEEAVhh4yyK5+SEykIzrPUJmaL7XHkFAmDAvF8VHHB1YmxpY0B5
b2N0b2NlbGwueHl6AAoJEKz1CZmi+1x579cP/jGOaroYfsMlBf+SY0/QSHBFBzh8
+3DGfyA5/ltMzBLHAe7aFSWUItHJqrUfGxkix2preh8iVHCq9KoGMxMr0BdEP80L
t7nj+ciTE8ua10NcIW7RJTvaAeHkpb6pcEXh2mynS5sw2/z9GlcG9rX2TuyFE9mA
Ov7rEp64Czg+yfJEmRy+D9G6JUzhJzPVzk6Uu5j9lL/7oNUB/pdEOteY/kQo+LOD
aP0dM5UZeSzVxT0RtZcSR5pwZEtUiNht/5VesPJKtXk5lK2bgHYKfDaQjYt3kTcF
vdNbZvrQYsJGSW5VORP2kKFpE9+iNebi5rP40dPnpT45H9NqgI98WM5USIauTyLU
9cxG13R+BV6F50eHSX+hF4/nOh5PmUtR2gmdv9sFLUzsq682GzAU1WYDkwxgg8qZ
ciTYb0C0PiTdLmxKF6Tw3VibBcZWpE6SdugxqDfvaBzphzpkZ91oFPbExnQJQoy2
rIigctfHHegnIqdbkanuZkkgCQYL63W+qf7UtXf5Pw6NNG6M+Uh9BU3sQoMjGRLS
CJvdq8/WbLs8/wh9YV2QG8HaMlCOV2YiAQ6UJj6WZz12DNZ0G+5KRsAzwIdNPZ6X
6u0AzLH5Wk6aYxBQ3iQgLmQKRGk4SVFhNukjL5Bgj0fFC7ITTpWQZlEpw9LvouEk
n2YqoFUdNT22EWOI
=cAuz
-----END PGP SIGNATURE-----