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

Lukas Bulwahn lukas.bulwahn at gmail.com
Tue Oct 13 05:21:37 UTC 2020



On Tue, 13 Oct 2020, Dwaipayan Ray wrote:

> commit 0c01921 ("checkpatch: add new warnings to author signoff checks.")

s/commit/Commit/

you should have a 12-char sha here.

Did you checkpatch.pl your patch?

> 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

Can you be more specific than "Caused issues"?

Use present tense.

> 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.
>

Use imperative.

Maybe you add a Fixes: tag referring to the original commit?

 
> 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
> 
> 


More information about the Linux-kernel-mentees mailing list