Re: [PATCH v3] checkpatch: improve email parsing

[Greg KH]

On Thu, Nov 05, 2020 at 09:41:15AM -0800, Joe Perches wrote:
> (adding stable and Greg KH for additional review)
> On Thu, 2020-11-05 at 17:29 +0530, Dwaipayan Ray wrote:
> > checkpatch doesn't report warnings for many common mistakes
> > in emails. Some of which are trailing commas and incorrect
> > use of email comments.
> 
> I presume you've tested this against the git tree.
> 
> Can you send me a file with the BAD_SIGN_OFF messages generated
> and if possible the git SHA-1s of the commits?
> 
> > At the same time several false positives are reported due to
> > incorrect handling of mail comments. The most common of which
> > is due to the pattern:
> > 
> > <stable@xxxxxxxxxxxxxxx> # X.X
> > 
> > Improve email parsing in checkpatch.
> > 
> > Some general comment rules are defined:
> > 
> > - Multiple name comments should not be allowed.
> > - Comments inside address should not be allowed.
> > - In general comments should be enclosed within parentheses.
> >   Exception for stable@xxxxxxxxxxxxxxx # X.X
> 
> not just vger.kernel.org, but this should also allow stable@xxxxxxxxxx
> and only allow cc: and not any other -by: type for that email address.
> 
> A process preference question for Greg and the stable team:
> 
> The most common stable forms are
> 
> 	stable@xxxxxxxxxxxxxxx # version info

That is what is documented it should be, yes.

> then
> 	stable@xxxxxxxxxxxxxxx [ version info ]

Really?  Ick, no wonder my email parsing scripts choke on that :)

> with some other relatively infrequently used outlier styles, some
> that use parentheses, but this is not frequent.

The one with '#' should be preferred.  If not, we need to change our
documentation.

thanks,

greg k-h