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

Martin Sebor msebor@gmail.com
Tue Jun 15 00:12:24 GMT 2021


On 6/14/21 10:25 AM, Jonathan Wakely via Gcc-patches wrote:
> I think this is an improvement on the current structure of the docs,
> but I'd like to hear what others think.

The text looks more detailed and arguably more accurate but also
makes it sound more complicated and rigid than necessary.  It
also doesn't look like the commit hook tries to enforce many of
these elements.  If it did, quite a number of commits would fail.

So I'm not sure about the value of documenting expectations that
only few commits would meet.  E.g., including the Component tag,
or putting PRnnnnn at the end of the Subject line with no space
(why ask for no space and not, for example PR #nnnnn?)  In fact,
unless we mean it (and are willing to enforce it) I think it
would be best to either leave it out completely, or make it clear
that it's not required.

Martin


> 
> We don't currently say document anything about commit format for the
> wwwdocs repo. Should the "wwwdocs" be a classifier (as in this email)
> or a component tag?
> 
> 



More information about the Gcc-patches mailing list