From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
To: Xinglu Chen <public@yoctocell.xyz>
Cc: 48934-done@debbugs.gnu.org
Subject: bug#48934: [PATCH 0/2] Some improvements to (gnu services configuration)
Date: Mon, 02 Aug 2021 14:21:07 -0400 [thread overview]
Message-ID: <87eebb908c.fsf_-_@gmail.com> (raw)
In-Reply-To: <9de0174c0818edd7c3f1f58a264a6ea3c5c3be50.1623243063.git.public@yoctocell.xyz> (Xinglu Chen's message of "Wed, 09 Jun 2021 15:06:27 +0200")
Hello again,
Xinglu Chen <public@yoctocell.xyz> writes:
> * gnu/services/configuration.scm (generate-documentation): If the default
> value of a field is a package, show the value of the ‘name’ field of the
> package. This might not be the correct name in some cases though.
Here also, I've edited the commit message like so:
services: configuration: Derive the default value from the package variable.
If the type of a configuration field is a package, show the name of its
package *variable* as the default value.
* gnu/services/configuration.scm (generate-documentation){show-default}
{package->symbol}: New nested procedures. Use them to format the field
entries.
> ---
> gnu/services/configuration.scm | 12 ++++++++++--
> 1 file changed, 10 insertions(+), 2 deletions(-)
>
> diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
> index abcbc70520..99687d065a 100644
> --- a/gnu/services/configuration.scm
> +++ b/gnu/services/configuration.scm
> @@ -252,12 +252,20 @@ does not have a default value" field kind)))
> (configuration-field-default-value-thunk f)
> (lambda _ '%invalid))))
> (define (show-default? val)
> - (or (string? val) (number? val) (boolean? val)
> + (or (string? val) (number? val) (boolean? val) (package? val)
> (and (symbol? val) (not (eq? val '%invalid)))
> (and (list? val) (and-map show-default? val))))
> +
> + (define (show-default val)
> + (cond
> + ((package? val)
> + ;; Maybe not always correct.
> + (package-name val))
> + (else (str val))))
> +
> `(entry (% (heading (code ,(str field-name))
> ,@(if (show-default? default)
> - `(" (default: " (code ,(str default)) ")")
> + `(" (default: " (code ,(show-default default)) ")")
> '())
> " (type: "
> ,(str field-type)
I've found a (rather hacky?) way to derive a package's symbol name
instead of using its name, which eliminates the risk of a mismatch,
using such procedure:
--8<---------------cut here---------------start------------->8---
@@ -252,6 +254,21 @@ does not have a default value" field kind)))
;; A little helper to make it easier to document all those fields.
(define (generate-documentation documentation documentation-name)
(define (str x) (object->string x))
+
+ (define (package->symbol package)
+ "Return the first symbol name of a package that matches PACKAGE, else #f."
+ (let* ((module (file-name->module-name
+ (location-file (package-location package))))
+ (symbols (filter-map
+ identity
+ (module-map (lambda (symbol var)
+ (and (equal? package (variable-ref var))
+ symbol))
+ (resolve-module module)))))
+ (if (null? symbols)
+ #f
+ (first symbols))))
+
(define (generate configuration-name)
(match (assq-ref documentation configuration-name)
((fields . sub-documentation)
@@ -270,14 +287,21 @@ does not have a default value" field kind)))
(lambda _ '%invalid))))
(define (show-default? val)
(or (string? val) (number? val) (boolean? val)
+ (package? val)
(and (symbol? val) (not (eq? val '%invalid)))
(and (list? val) (and-map show-default? val))))
+ (define (show-default val)
+ (cond
+ ((package? val)
+ (symbol->string (package->symbol val)))
+ (else (str val))))
+
`(entry (% (heading
(code ,(str field-name))
,@(if (show-default? default)
`(" (default: "
--8<---------------cut here---------------end--------------->8---
Tested it to generate the new Jami service documentation, and pushed as
commit 8e1f94421873777c6bb0b83daa4f81cbacc8b3ff.
I think (guix services configuration) is starting to look good! Thanks
to your efforts toward improving the module.
Closing.
Maxim
next prev parent reply other threads:[~2021-08-02 18:22 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-09 13:04 [bug#48934] [PATCH 0/2] Some improvements to (gnu services configuration) Xinglu Chen
2021-06-09 13:06 ` [bug#48934] [PATCH 1/2] services: configuration: Change formatting of generated Xinglu Chen
2021-08-02 18:10 ` [bug#48934] [PATCH 0/2] Some improvements to (gnu services configuration) Maxim Cournoyer
2021-06-09 13:06 ` [bug#48934] [PATCH 2/2] services: configuration: Show default value when it is a Xinglu Chen
2021-08-02 18:21 ` Maxim Cournoyer [this message]
2021-08-03 7:24 ` [bug#48934] [PATCH 0/2] Some improvements to (gnu services configuration) Xinglu Chen
2021-08-03 14:38 ` Maxim Cournoyer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87eebb908c.fsf_-_@gmail.com \
--to=maxim.cournoyer@gmail.com \
--cc=48934-done@debbugs.gnu.org \
--cc=public@yoctocell.xyz \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).