This is the mail archive of the gcc@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH][www] svnwrite.html: recommend giving checkin messages a title (was Re: Moving to git)


On Fri, Aug 21, 2015 at 07:54:11PM -0400, David Malcolm wrote:
> > >> In the git world, the first line of the commit message has special
> > >> meaning, being treated as the "title" of the commit.
> > >
> > > It would be nice if we could use a real commit message, not just a short
> > > title line; for example, people who prepare their patches in git already
> > > have that, and use it with format-patch as you say.
> > 
> > I think that's what David was suggesting; a short title line, followed 
> > by a blank line, followed by a more substantive commit message.
> > 
> > This change doesn't need to be tied to the git transition; it could 
> > happen either before or after.
> 
> Attached is a patch for the website which advises doing this when
> committing.

> +<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).


Segher


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]