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: Segher Boessenkool <segher at kernel dot crashing dot org>
- To: David Malcolm <dmalcolm at redhat dot com>
- Cc: Jason Merrill <jason at redhat dot com>, "gcc at gnu dot org" <gcc at gnu dot org>, Gerald Pfeifer <gerald at pfeifer dot com>
- Date: Sat, 22 Aug 2015 10:37:30 -0500
- 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> <20150822105554 dot GB26285 at gate dot crashing dot org> <1440255571 dot 18943 dot 69 dot camel at surprise>
On Sat, Aug 22, 2015 at 10:59:31AM -0400, David Malcolm wrote:
> > > +<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]"
> > > +prefixes).</p>
> > It advises to *not* have an explanatory text, and it says that *not*
> > having it is the Git convention (which of course is not true).
> I'm having trouble parsing this. What did you mean by "it" in the three
> places you used it here? By "explanatory text", were you referring to
> the descriptive title, or to the text after the blank line?
Heh, sorry. First two "it"s refer to your patch / the new text; last
"it" refers to "explanatory text" earlier in the sentence.
Your suggested text says that commit messages should be a title, and a
blank line, immediately followed by a changelog. It (that is, your
suggested text) says you shouldn't put anything useful in the commit
message, like what the commit is all about.