Re: [PATCH] gnu-maintenance: Improve 'official-gnu-packages'; add the related procedures.

[ludo@gnu.org (Ludovic Courtès)]

Nikita Karetnikov <nikita@karetnikov.org> skribis:

>>> I noticed that 'guile-gnome' has two 'doc-url' fields.  How can I handle
>>> this?  (I ignored it for now.)
>
>> I think it’s a mistake in this case (could you report it to Karl?).  It
>> seems safe to ignore.
>
> Karl said:
>
> "[...] In general doc-url can occur more than once.  I did that when a
> package has an overall documentation page and also many significant
> manuals.  Besides guile-gnome, emacs is a prime example.
>
> In theory, I guess logo: could be duplicated [too] in the event of a
> package having more than one logo, but in practice that has never
> happened.
>
> [...]
>
> I thought of another field that can be repeated, too: doc-shop.
> E.g., in libc."
>
> So, should we create another field for 'doc-url'?

What about calling that field ‘doc-urls’ (plural) and having it hold a
list of URLs?

> And what's the best way to handle 'doc-shop'?  Can we ignore it?

What is it?  Perhaps we don’t need it for our purposes?

>> Never ever write ‘get-’ for getters.  ;-)  It provides no useful
>> information.  See <package> and other records, as examples.
>
> I know; it's easy to end up with something like:
>
>   getObject.getSetter.getString.getField()
>
> I found (name get-employee-name) in the manual and decided that it's a
> convention.

Argh, I just saw that, it’s a shame!  ;-)

Seriously, nobody uses that convention.  The convention is really
‘employee-name’.

> What about 'set-' for setters?

We don’t use them in Guix.  (The convention is ‘set-employee-name!’,
with an exclamation mark.)

Ludo’.