Subject: Re: bug#63082: [PATCH 04/17] services: mpd: Obsolete the 'group' field.

From: Bruno Victal <[email-masked]>
Date: Sat, 29 Apr 2023 13:12:50 +0100

On 2023-04-29 02:15, Maxim Cournoyer wrote:
> Hi,
> 
> Bruno Victal <[email-masked]> writes:
> 
> [...]
> 
>>>  @item @code{shepherd-requirement} (default: @code{()}) (type: list-of-symbol)
>>>  This is a list of symbols naming Shepherd services that this service
>>> @@ -33824,15 +33824,12 @@ Audio Services
>>>  This is a list of symbols naming Shepherd services that this service
>>>  will depend on.
>>>
>>> -@item @code{user} (default: @code{%mympd-user}) (type: user-account)
>>> +@item @code{user} (type: user-account)
>>>  Owner of the @command{mympd} process.
>>>
>>> -The default @code{%mympd-user} is a system user with the name ``mympd'',
>>> -who is a part of the group @var{group} (see below).
>>> -@item @code{group} (default: @code{%mympd-group}) (type: user-group)
>>> -Owner group of the @command{mympd} process.
>>> +@item @code{group} (default: @code{#f}) (type: boolean)
>>> +Obsolete.  Do not use.
>>
>> I'd skip documenting obsolete fields.
> 
> 'define-configuration' doesn't allow me to skip documenting a field, I
> think :-).

Right, but it can be manually removed from doc/guix.texi for now.

>>>
>>> -The default @code{%mympd-group} is a system group with name ``mympd''.
>>>  @item @code{work-directory} (default: @code{"/var/lib/mympd"}) (type: string)
>>>  Where myMPD will store its data.
>>>
>>> @@ -33872,7 +33869,7 @@ Audio Services
>>>  Override URI to myMPD.  See
>>>  @uref{https://github.com/jcorporation/myMPD/issues/950}.
>>>
>>> -@item @code{script-acl} (default: @code{(mympd-ip-acl (allow
>>> '("127.0.0.1")))}) (type: maybe-mympd-ip-acl)
>>> +@item @code{script-acl} (type: maybe-mympd-ip-acl)
>>>  ACL to access the myMPD script backend.
>>
>> Unrelated change?
> > From the generated doc, which was probably lagging behind the source.

It's unfortunate but iirc this had to be manually edited in since generate-documentation
will skip “serializing” values it doesn't know how to represent.