From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] [PATCH] checkpatch: fix missing whitespace in formatted email
Date: Tue, 13 Oct 2020 07:21:37 +0200 (CEST) [thread overview]
Message-ID: <alpine.DEB.2.21.2010130717490.14590@felia> (raw)
In-Reply-To: <20201013034307.5520-1-dwaipayanray1@gmail.com>
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@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@aculab.com (big endian
> system concerns)' might be better as 'David.Laight@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@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
>
>
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
prev parent reply other threads:[~2020-10-13 5:21 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-13 3:43 [Linux-kernel-mentees] [PATCH] checkpatch: fix missing whitespace in formatted email Dwaipayan Ray
2020-10-13 5:21 ` Lukas Bulwahn [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.DEB.2.21.2010130717490.14590@felia \
--to=lukas.bulwahn@gmail.com \
--cc=dwaipayanray1@gmail.com \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).