This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: Commit messages and the move to git
Jeff Law <law@redhat.com>:
> On 11/4/19 3:29 AM, Richard Earnshaw (lists) wrote:
> > With the move to git fairly imminent now it would be nice if we could
> > agree on a more git-friendly style of commit messages; and, ideally,
> > start using them now so that the converted repository can benefit from
> > this.
> >
> > Some tools, particularly gitk or git log --oneline, can use one-line
> > summaries from a commit's log message when listing commits. It would be
> > nice if we could start adopting a style that is compatible with this, so
> > that in future commits are summarized in a useful way. Unfortunately,
> > some of our existing commits show no useful information with tools like
> > this.
> I'd suggest we sync policy with glibc. They're further along on the
> ChangeLog issues. Whatever they do in this space we should follow --
> aren't we going to be using some of their hooks/scripts?
Note that my reposurgeon conversion recipe runs gitify on the repository.
>From the documentation:
Attempt to massage comments into a git-friendly form with a blank
separator line after a summary line. This code assumes it can insert
a blank line if the first line of the comment ends with '.', ',', ':',
';', '?', or '!'. If the separator line is already present, the comment
won't be touched.
Takes a selection set, defaulting to all commits and tags.
--
<a href="http://www.catb.org/~esr/">Eric S. Raymond</a>