This is the mail archive of the
mailing list for the GCC project.
Re: [PATCH][www] svnwrite.html: recommend giving checkin messages a title (was Re: Moving to git)
- From: Florian Weimer <fw at deneb dot enyo dot de>
- To: David Malcolm <dmalcolm at redhat dot com>
- Cc: Jason Merrill <jason at redhat dot com>, Segher Boessenkool <segher at kernel dot crashing dot org>, "gcc\ at gnu dot org" <gcc at gnu dot org>, Gerald Pfeifer <gerald at pfeifer dot com>
- Date: Sat, 22 Aug 2015 21:43:27 +0200
- Subject: Re: [PATCH][www] svnwrite.html: recommend giving checkin messages a title (was Re: Moving to git)
- Authentication-results: sourceware.org; auth=none
- References: <55D61512 dot 8010002 at redhat dot com> <1440099112 dot 18943 dot 38 dot camel at surprise> <20150820223226 dot GA27127 at gate dot crashing dot org> <55D656B7 dot 9000707 at redhat dot com> <1440201251 dot 18943 dot 62 dot camel at surprise>
* David Malcolm:
> +<p>The log message for a checkin should be a single line giving a
> +descriptive title for the checkin, followed by a blank line, followed by
> +the complete ChangeLog entry for the change. This is the git convention;
> +giving titles to checkins makes life easier for developers using git
> +mirrors of SVN. Typically the descriptive title should be the "Subject"
> +line of the relevant gcc-patches thread (without any "[PATCH]" or "[PING]"
For glibc, we often try to put the reason for the change in the commit
message. Especially for code deletions, you can't really add a
comment to the sources, and official policy is that you must not put
explanations into the ChangeLog file (it's just a mechanical
description of the change). So giving an explanation *somewhere* is
often nice, and the commit message is a good place for that.