This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: git commit message conventions
- From: Paul Eggert <eggert at cs dot ucla dot edu>
- To: Florian Weimer <fw at deneb dot enyo dot de>
- Cc: Torvald Riegel <triegel at redhat dot com>, Joseph Myers <joseph at codesourcery dot com>, libc-alpha at sourceware dot org
- Date: Thu, 04 Jun 2015 07:40:30 -0700
- 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> <1433314909 dot 21461 dot 65 dot camel at triegel dot csb> <556ECDF8 dot 1040107 at redhat dot com> <556F3B42 dot 10406 at cs dot ucla dot edu> <87iob3650g dot fsf at mid dot deneb dot enyo dot de>
Florian Weimer wrote:
As far as I understand them, the GNU Coding Standards do not permit
the information we want to associate with each commit in ChangeLog
files.
That's not the case for many other GNU projects I deal with. People put other
information into the ChangeLog files, either before or after the
canonical-format ChangeLog entries. The Emacs CONTRIBUTE file, for example,
gives the following suggested example for a commit message (indented):
Deactivate shifted region
Do not silently extend a region that is not highlighted;
this can happen after a shift (Bug#19003).
* doc/emacs/mark.texi (Shift Selection): Document the change.
* lisp/window.el (handle-select-window):
* src/frame.c (Fhandle_switch_frame, Fselected_frame):
Deactivate the mark.
and only half the lines in this prototype are in traditional ChangeLog format.
In the projects I deal with that still have both commit messages and ChangeLog
files, I regularly make the commit message equal the ChangeLog file entry,
except I omit the indenting in the commit message and I omit the 2nd blank line
in the ChangeLog. This is not just my convention; it's what the vc-dwim command
does automatically. (And no, I didn't write vc-dwim. :-) It's a reasonable
convention, and it should be OK for glibc contributors to use it even if it's
not required for glibc.