This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: ChangeLog entry complexity
- From: "Carlos O'Donell" <carlos at redhat dot com>
- To: Alexandre Oliva <aoliva at redhat dot com>
- Cc: Allan McRae <allan at archlinux dot org>, libc-alpha at sourceware dot org, Siddhesh Poyarekar <siddhesh at redhat dot com>, "Joseph S. Myers" <joseph at codesourcery dot com>, David Miller <davem at davemloft dot net>, normalperson at yhbt dot net, pasky at ucw dot cz, roland at hack dot frob dot com, neleai at seznam dot cz
- Date: Thu, 04 Apr 2013 17:35:58 -0400
- Subject: Re: ChangeLog entry complexity
- References: <Pine dot LNX dot 4 dot 64 dot 1303271427040 dot 23096 at digraph dot polyomino dot org dot uk> <20130327 dot 122444 dot 1693913000175389808 dot davem at davemloft dot net> <Pine dot LNX dot 4 dot 64 dot 1303271628190 dot 23096 at digraph dot polyomino dot org dot uk> <20130327 dot 125821 dot 1593463415239280090 dot davem at davemloft dot net> <Pine dot LNX dot 4 dot 64 dot 1303271701550 dot 23096 at digraph dot polyomino dot org dot uk> <20130328043009 dot GB17540 at spoyarek dot pnq dot redhat dot com> <5154F3AB dot 6030808 at archlinux dot org> <or7gkib0mv dot fsf at livre dot home>
On 04/04/2013 02:40 PM, Alexandre Oliva wrote:
> I'm now asking myself, why couldn't we have both? Currently, it's not
> uncommon for us to just use the ChangeLog entry as the VCS commit
> message; why couldn't we add a longer rationale there, *besides* the
> ChangeLog entry? If we standardize how ChangeLogs are to be placed in
> the commit logs, we can even get subsequent ChangeLog entries
> automatically extracted from the commit history, so that it could be
> included in releases that are not accompanied by the git history, so
> that it could be machine-searched just as it is now, with the added
> benefit that we'd be able to manually search for the same info in the
> commit logs, and at the same time locate the rationale for the change.
>
> And then, I get to ask myself why the heck are we not doing that
> already? :-)
... someone needs to step up and be the champion for the change.
I think that rationale + ChangeLog in the git commit with a post-commit
hook to append to the ChangeLog is fine.
Even if you cherry-pick back into an old branch the commit carries the
log message and the post-commit hook DTRT to adjust ChangeLog.
Then extend this to NEWS :-)
Cheers,
Carlos.