[RFC] [wwwdocs] Rewrite docs on commit message and patch format

Segher Boessenkool segher@kernel.crashing.org
Tue Jun 15 12:21:12 GMT 2021


On Tue, Jun 15, 2021 at 10:39:58AM +0100, Jonathan Wakely via Gcc-patches wrote:
> I think suggesting a single format (but allowing variations on it) is
> **much** better than not saying anything at all. For new contributors
> it's helpful to say "this is what we want" so they have a guideline to
> follow.

Most people are smart enough to look at what others do and think about
why they do things that way, I hope.  And then think what is best for
themselves.  Maybe I am too optimistic :-)

> <p>A major benefit of a good, descriptive subject line is that it makes
> the output of <code>git log --oneline</code> more useful. Including the
> component tag and bug number(s) helps with that, but isn't compulsory
> if the subject is already clear and has enough context.</p>

The tags and the PR # are the least important things in the patch
subject.  If you can fit them in (without blowing the 50 char limit)
then sure; and as I said before, well-chosen headings can be shorter
than free-form text expressing the same.


Segher


More information about the Gcc-patches mailing list