GNU ChangeLog Format: <> or []?

GNU ChangeLog Format: <> or []?

[Chris Marusich]

[-- Attachment #1: Type: text/plain, Size: 704 bytes --]

Hi all,

I've noticed that the GNU Standards indicate [] should be used for
conditional changes, and <> should be used for identifying the part that
changed.  However, in Guix, I've noticed that people tend to use [] not
to indicate conditional changes, but rather to indicate the part that
changed.  Is there a reason for this?  Does it matter?

Relevant sections in the GNU Standards are:

(standards) Conditional Changes
https://www.gnu.org/prep/standards/html_node/Conditional-Changes.html#Conditional-Changes

(standards) Indicating the Part Changed
https://www.gnu.org/prep/standards/html_node/Indicating-the-Part-Changed.html#Indicating-the-Part-Changed

Thank you,

-- 
Chris

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: GNU ChangeLog Format: <> or []?

[Ludovic Courtès]

Hi Chris,

Chris Marusich <cmmarusich@gmail.com> skribis:

> I've noticed that the GNU Standards indicate [] should be used for
> conditional changes, and <> should be used for identifying the part that
> changed.  However, in Guix, I've noticed that people tend to use [] not
> to indicate conditional changes, but rather to indicate the part that
> changed.  Is there a reason for this?  Does it matter?

Square brackets are used for conditionals, but I also use them for
nested entities.  I’m pretty sure I didn’t make it up, but I don’t know
where I took it from!

Anyway, I personally don’t mind seeing one style or the other—either
way it conveys the changes quite well IMO.

Thanks,
Ludo’.

Re: GNU ChangeLog Format: <> or []?

[Chris Marusich]

[-- Attachment #1: Type: text/plain, Size: 579 bytes --]

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

> Square brackets are used for conditionals, but I also use them for
> nested entities.  I’m pretty sure I didn’t make it up, but I don’t know
> where I took it from!

I didn't realize that.  It makes sense, though!  Is using it for nested
entities a common GNU ChangeLog idiom?  If so, I wonder if it's worth
adding it to the GNU Standards document.

> Anyway, I personally don’t mind seeing one style or the other—either
> way it conveys the changes quite well IMO.

Thank you for clarifying this.

-- 
Chris

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: GNU ChangeLog Format: <> or []?

[Ludovic Courtès]

Hi Chris,

Chris Marusich <cmmarusich@gmail.com> skribis:

> Ludovic Courtès <ludo@gnu.org> writes:
>
>> Square brackets are used for conditionals, but I also use them for
>> nested entities.  I’m pretty sure I didn’t make it up, but I don’t know
>> where I took it from!
>
> I didn't realize that.  It makes sense, though!  Is using it for nested
> entities a common GNU ChangeLog idiom?

It is in Guile and Guix, but that doesn’t count.  ;-)

We’d need to look for projects not written in C where there’s actual
nesting (GNU C nested functions are rarely used, except in glibc.)

> If so, I wonder if it's worth adding it to the GNU Standards document.

Maybe, though be aware that attempting to change the Standards can be
time-consuming and frustrating…

Thanks,
Ludo’.

Re: GNU ChangeLog Format: <> or []?

[Chris Marusich]

[-- Attachment #1: Type: text/plain, Size: 1237 bytes --]

Hi Ludo,

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

> Chris Marusich <cmmarusich@gmail.com> skribis:
>
>> Ludovic Courtès <ludo@gnu.org> writes:
>>
>>> Square brackets are used for conditionals, but I also use them for
>>> nested entities.  I’m pretty sure I didn’t make it up, but I don’t know
>>> where I took it from!
>>
>> I didn't realize that.  It makes sense, though!  Is using it for nested
>> entities a common GNU ChangeLog idiom?
>
> It is in Guile and Guix, but that doesn’t count.  ;-)
>
> We’d need to look for projects not written in C where there’s actual
> nesting (GNU C nested functions are rarely used, except in glibc.)

I see.  That's fair, since Guile and Guix are not the entire world.

>> If so, I wonder if it's worth adding it to the GNU Standards document.
>
> Maybe, though be aware that attempting to change the Standards can be
> time-consuming and frustrating…

I can imagine.  Maybe it isn't worth expending the effort for something
that seems so trivial, especially since as you mentioned we would need
to be able to point to a lot of projects and say, "They do it, too."

I'm content just knowing how it's used in Guile and Guix!  Thank you.

-- 
Chris

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]