[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: changelog format
From: |
Thien-Thi Nguyen |
Subject: |
Re: changelog format |
Date: |
Tue, 17 Jan 2012 14:32:11 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.0.92 (gnu/linux) |
() Stefano Lattarini <address@hidden>
() Tue, 17 Jan 2012 13:09:34 +0100
thanks for having worked on this! I like you proposal very
much, with only a couple of nits nit (find them below).
I appreciate your patience.
> A link to another entry [...]. We recommend this
> over using a version control system commit identifier
>
I'd really, really like to see "in addition to" instead of "over"
used her, since VCS commit identifiers have at least an important
advantage of their own: they make it immediate for the reader to
refer to the linked entry, instead of having to rely on (say)
"git log --grep" or "git log --since=... --until=...". This is
even more true for GUI interfaces to the VCS, where VCS commit
identifiers might be automatically turned in clickable links.
I agree that such conveniences are very compelling. My fear
is that people would use VCS commit identifiers exclusively;
saying "in addition to" is not strong enough. Any other ideas?
I think it would be nice to also ad another example with a slightly
different style. I propose this slightly edited version of the commit
message for the GNU coreutils commit 'c592a00f': [...]
Good idea. What is the ChangeLog header for this? Can i assume:
2011-12-08 Jim Meyering <address@hidden>
as per ‘git show c592a00f’? (Meta-comment: This extra step shows
how generated ChangeLog files are inconvenient to casual readers.)
I note that there is more than one paragraph, so i guess i'll change
the "short paragraph" to "paragraph(s)".
Re: changelog format, Thien-Thi Nguyen, 2012/01/17
Re: changelog format, Alfred M. Szmidt, 2012/01/17