This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: git commit message conventions
- From: Joseph Myers <joseph at codesourcery dot com>
- To: Paul Eggert <eggert at cs dot ucla dot edu>
- Cc: <libc-alpha at sourceware dot org>
- Date: Wed, 3 Jun 2015 10:14:19 +0000
- Subject: Re: git commit message conventions
- Authentication-results: sourceware.org; auth=none
- References: <alpine dot DEB dot 2 dot 10 dot 1506022041430 dot 2704 at digraph dot polyomino dot org dot uk> <556E563C dot 1090204 at cs dot ucla dot edu>
On Tue, 2 Jun 2015, Paul Eggert wrote:
> Many other GNU projects use this style, but with one further constraint: if
> you indent the entire commit message, and omit the 2nd (empty) line, the
> entire commit message must be a valid ChangeLog entry. That way, there's a
> one-to-one relationship between commit messages and ChangeLog entries, and
> programs like vc-dwim can be used to generate commits. Projects that use such
> a style include Coreutils, Gnulib, and GNU Emacs. I suggest using it for
> glibc as well.
I propose that at this point we specifically do not adopt any further
conventions regarding how commit messages relate to ChangeLog entries
(including any conventions for how, if the ChangeLog entries are included
in the commit messages at all, the authors for those entries are
represented if not the same as the single commit author, or for how the
ChangeLog entries for the three different ChangeLog files in current use
are distinguished). That is, we only require the substantive patch
writeup to be included without making requirements that would allow any
form of automatic processing into ChangeLog entries.
--
Joseph S. Myers
joseph@codesourcery.com