all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Clément Lassieur" <clement@lassieur.org>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: 29438@debbugs.gnu.org
Subject: [bug#29438] [PATCH 2/2] services: configuration: Show default values of list types.
Date: Sun, 10 Dec 2017 14:26:39 +0100	[thread overview]
Message-ID: <87shciogs0.fsf@lassieur.org> (raw)
In-Reply-To: <87d145vw5z.fsf@gnu.org>

Ludovic Courtès <ludo@gnu.org> writes:

> Clément Lassieur <clement@lassieur.org> skribis:
>
>> * doc/guix.texi (Messaging Services): Regenerate it.
>> * gnu/services/configuration.scm (show-default?): Fix recursion.
>> * gnu/services/messaging.scm (show-default?): Fix recursion.
>
> Rather “Check VAL rather than DEFAULT.”
>
>> (prosody-configuration)[modules-enabled]: Remove default value from docstring.
>
> LGTM, though I’m afraid we’ll have a hard time keep guix.texi in sync,
> at least until we have an automated mechanism to regenerate those bits.

Thank you for reviewing!

It's a bit sad that most services' docstrings are not in sync with the
.texi file, it would be great to have an automated mechanism to update
the documentation.  I use a hackish Emacs snippet to maintain Prosody
documentation, but something like "make generate-documentation
<service>" would be much better.  I'll think about it.

--8<---------------cut here---------------start------------->8---
@c The following documentation was initially generated by
@c (generate-documentation) in (gnu services messaging).  Manually maintained
@c documentation is better, so we shouldn't hesitate to edit below as
@c needed.  However if the change you want to make to this documentation
@c can be done in an automated way, it's probably easier to change
@c (generate-documentation) than to make it below and have to deal with
@c the churn as Prosody updates.
--8<---------------cut here---------------end--------------->8---

I don't really agree with this comment that can be found in several
places in our documentation.  I believe that when there is a
(generate-documentation) procedure, manual edits shouldn't be
encouraged.  But it's probably not worth updating it while there is no
easy way to automatically generate the documentation.

> Also, I was thinking that ‘guix system search’ could display
> field/default-value pairs.  I’m not 100% sure it’s a good idea because
> that could be very verbose.
>
> Thoughts?

It would be verbose indeed, and if people want to have details about
fields and default values, they can search the manual.

  reply	other threads:[~2017-12-10 13:27 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-25 15:05 [bug#29438] [PATCH 2/2] services: configuration: Show default values of list types Clément Lassieur
2017-11-26 16:31 ` Ludovic Courtès
2017-12-10 13:26   ` Clément Lassieur [this message]
2017-12-10 14:29     ` [bug#29438] Generating service documentation Ludovic Courtès

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87shciogs0.fsf@lassieur.org \
    --to=clement@lassieur.org \
    --cc=29438@debbugs.gnu.org \
    --cc=ludo@gnu.org \
    /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 external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.