Re: [PATCH v2] docs: document patch rules

[Julien Grall <julien@xxxxxxx>]

Hi,

On 05/02/2022 11:13, Juergen Gross wrote:
> On 04.02.22 20:25, Julien Grall wrote:
> > Hi,
> >
> > On 03/02/2022 12:54, Juergen Gross wrote:
> > > +## The commit message
> > > +
> > > +The commit message is free text describing *why* the patch is done and
> > > +*how* the goal of the patch is achieved. A good commit message will 
> > > describe
> > > +the current situation, the desired goal, and the way this goal is being
> > > +achieved. Parts of that can be omitted in obvious cases.
> > > +
> > > +In case additional changes are done in the patch (like e.g. 
> > > cleanups), those
> > > +should be mentioned.
> > > +
> > > +When referencing other patches (e.g. `similar to patch xy ...`) those
> > > +patches should be referenced via their commit id (at least 12 digits)
> > > +and the patch subject, if the very same patch isn't referenced by the
> > > +`Fixes:` tag, too:
> > > +
> > > +    Similar to commit 67d01cdb5518 ("x86: infrastructure to allow 
> > > converting
> > > +    certain indirect calls to direct ones") add ...
> > > +
> > > +The following ``git config`` settings can be used to add a pretty 
> > > format for
> > > +outputting the above style in the ``git log`` or ``git show`` commands:
> > > +
> > > +        [core]
> > > +                abbrev = 12
> > > +        [pretty]
> > > +                fixes = Fixes: %h (\"%s\")
> > > +
> > > +Lines in the commit message should not exceed 75 characters, except 
> > > when
> > I was under the impression that commit message should be wrap to 72 
> > characters. This is because tools like "git log" would indent the 
> > commit message by 8 characters.
> I took that value from the docs/process/tags.pandoc file.
I also checked Linux documentation and they ask to wrap to 75 characters 
as well. Not sure where I got the 72 characters from...
There rest of my comments are NITs so:

Reviewed-by: Julien Grall <jgrall@xxxxxxxxxx>

Cheers,

--
Julien Grall