* GNU ChangeLog Format: <> or []?
@ 2019-06-10 4:14 Chris Marusich
2019-06-10 9:43 ` Ludovic Courtès
0 siblings, 1 reply; 5+ messages in thread
From: Chris Marusich @ 2019-06-10 4:14 UTC (permalink / raw)
To: guix-devel
[-- 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 --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: GNU ChangeLog Format: <> or []?
2019-06-10 4:14 GNU ChangeLog Format: <> or []? Chris Marusich
@ 2019-06-10 9:43 ` Ludovic Courtès
2019-06-13 4:34 ` Chris Marusich
0 siblings, 1 reply; 5+ messages in thread
From: Ludovic Courtès @ 2019-06-10 9:43 UTC (permalink / raw)
To: Chris Marusich; +Cc: guix-devel
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’.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: GNU ChangeLog Format: <> or []?
2019-06-10 9:43 ` Ludovic Courtès
@ 2019-06-13 4:34 ` Chris Marusich
2019-06-13 8:23 ` Ludovic Courtès
0 siblings, 1 reply; 5+ messages in thread
From: Chris Marusich @ 2019-06-13 4:34 UTC (permalink / raw)
To: Ludovic Courtès; +Cc: guix-devel
[-- 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 --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: GNU ChangeLog Format: <> or []?
2019-06-13 4:34 ` Chris Marusich
@ 2019-06-13 8:23 ` Ludovic Courtès
2019-06-14 3:48 ` Chris Marusich
0 siblings, 1 reply; 5+ messages in thread
From: Ludovic Courtès @ 2019-06-13 8:23 UTC (permalink / raw)
To: Chris Marusich; +Cc: guix-devel
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’.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: GNU ChangeLog Format: <> or []?
2019-06-13 8:23 ` Ludovic Courtès
@ 2019-06-14 3:48 ` Chris Marusich
0 siblings, 0 replies; 5+ messages in thread
From: Chris Marusich @ 2019-06-14 3:48 UTC (permalink / raw)
To: Ludovic Courtès; +Cc: guix-devel
[-- 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 --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2019-06-14 3:48 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-06-10 4:14 GNU ChangeLog Format: <> or []? Chris Marusich
2019-06-10 9:43 ` Ludovic Courtès
2019-06-13 4:34 ` Chris Marusich
2019-06-13 8:23 ` Ludovic Courtès
2019-06-14 3:48 ` Chris Marusich
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.