[Linux-kernel-mentees] [PATCH] checkpatch: formatted email should have a whitespace separating address and comment

[Dwaipayan Ray]

On Tue, Oct 13, 2020 at 12:45 AM Dwaipayan Ray <dwaipayanray1 at gmail.com> wrote:
>
> commit 0c01921 ("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 email address and the mail comment.
>
> This caused issues in some cases where the email was in the form
> of "author at example.com (Comment block)". The formatted email removed
> the space at the end of address.
>
> 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)'
>
> Resolved this by adding a single space in between the address and comment
> when the extracted comment is not empty.
>
> Signed-off-by: Dwaipayan Ray <dwaipayanray1 at gmail.com>
> ---
>  scripts/checkpatch.pl | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 124ff9432b51..6000addf1af3 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -1201,7 +1201,9 @@ sub format_email {
>         } else {
>                 $formatted_email = "$name$name_comment <$address>";
>         }
> -       $formatted_email .= "$comment";
> +       if ("$comment" ne "") {
> +               $formatted_email .= " $comment";
> +       }
>         return $formatted_email;
>  }
>
> --
> 2.27.0
>

Found this issue while looking through the checkpatch records.

Investigated this after looking into Aditya's summary at
https://lore.kernel.org/linux-kernel-mentees/a1675970-9eb9-bd6a-31ff-d04f88ca30e2@gmail.com/
and definitely the space bug was affecting and causing some issues.

If it's alright, could I quickly send it over to Joe?

Thanks,
Dwaipayan.