[Linux-kernel-mentees] checkpatch: improving comment parsing in email

Dwaipayan Ray dwaipayanray1 at gmail.com
Tue Oct 20 17:35:31 UTC 2020

checkpatch seems to have problems parsing some types of
email comments. Some examples I could find were of the type:

1) address at example.com (Comment)
2) "Name (Comment) " address at example.com
3) address at example.com #comment

These comments aren't processed currently which causes
false BAD_SIGN_OFF warnings.

Examples are:

WARNING:BAD_SIGN_OFF: email address 'David.Laight at aculab.com
(big endian system concerns)' might be better as 'David.Laight at aculab.com
(big endian system concerns)'

WARNING:BAD_SIGN_OFF: email address 'stable at vger.kernel.org #4.20+'
might be better as 'stable at vger.kernel.org#4.20+'

The earlier warning is very frequent in the kernel.

I did send a patch solving (1 and 3),

Joe points out that comments and multiple comments can
exist at any part of email. (perhaps RFC 5322 Appendix A.5). So
that patch didn't solve the problem at the very root.

What do you recommend be done?


More information about the Linux-kernel-mentees mailing list