[Linux-kernel-mentees] [PATCH v2] checkpatch: fix missing whitespace in formatted email

Joe Perches joe at perches.com
Tue Oct 13 06:57:50 UTC 2020

On Tue, 2020-10-13 at 12:06 +0530, Dwaipayan Ray wrote:
> Commit 0c01921e56f9 ("checkpatch: add new warnings to author signoff
> checks.") introduced new checks for author sign off. The format_email
> procedure was modified to add comment blocks to the formatted email. But
> no space was added between the email address and mail comment.
> This causes wrong email formatting in cases where the email is in the form
> "author at example.com (Comment block)". The space between the address and
> comment block is removed, which causes incorrect parsing of the
> formatted email.
> An evaluation on checkpatch brought up this case. For example,
> on commit 1129d31b55d5 ("ima: Fix ima digest hash table key calculation"),
> the following warning was reported:
> 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)'

Strictly, a comment or multiple comments can exist
in any part of an email

"John (Jon) Smith (Smitty) <jsmith at domain.tld> (tld is the best tld)

> Add a single space in between the address and comment when the
> extracted comment is not empty.

So after the address is not necessarily the best
location for a comment.

More information about the Linux-kernel-mentees mailing list