From: Joe Perches <joe@perches.com>
To: Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org,
linux-kernel@vger.kernel.org
Subject: Re: [Linux-kernel-mentees] [PATCH RFC] checkpatch: add new warnings to author signoff checks.
Date: Mon, 05 Oct 2020 00:18:17 -0700 [thread overview]
Message-ID: <a5cba9bb723626091f8790c794efe8de4ab184b8.camel@perches.com> (raw)
In-Reply-To: <20201005064842.33495-1-dwaipayanray1@gmail.com>
On Mon, 2020-10-05 at 12:18 +0530, Dwaipayan Ray wrote:
> The author signed-off-by checks are currently very vague.
> Cases like same name or same address are not handled separately.
>
> For example, running checkpatch on commit be6577af0cef
> ("parisc: Add atomic64_set_release() define to avoid CPU soft lockups"),
> gives:
>
> WARNING: Missing Signed-off-by: line by nominal patch author
> 'John David Anglin <dave.anglin@bell.net>'
>
> The signoff line was:
> "Signed-off-by: Dave Anglin <dave.anglin@bell.net>"
>
> Clearly the author has signed off but with a slightly different version
> of his name. A more appropriate warning would have been to point out
> at the name mismatch instead.
>
> Introduced three new types of warnings:
>
> 1) Address matches, but names are different.
> "James Watson <james@gmail.com>", "James <james@gmail.com>"
>
> 2) Name matches, but addresses are different.
> "James Watson <james@watson.com>", "James Watson <james@gmail.com>"
>
> 3) Name matches, but addresses without mail extensions are same.
> "James Watson <james@gmail.com>", "James Watson <james+a@gmail.com>"
>
> For the 3rd class, a --strict check message is generated, and for the
> other two, warnings are generated.
I don't have any issue with the concept, but please
be consistent with spacing after if tests.
Always use a single space after if
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> @@ -2347,6 +2347,7 @@ sub process {
> my $signoff = 0;
> my $author = '';
> my $authorsignoff = 0;
> + my $authorsignoff_ctx = '';
ctx isn't a descriptive name.
Maybe $author_sob
> @@ -2674,9 +2675,34 @@ sub process {
> if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
> $signoff++;
> $in_commit_log = 0;
> - if ($author ne '') {
> + if ($author ne '' && $authorsignoff != 1) {
Has space after if
> if (same_email_addresses($1, $author)) {
> $authorsignoff = 1;
> + } else {
> + my $ctx = $1;
> + my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
> + my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);
> +
> + if($email_address eq $author_address) {
No space after if, etc...
> @@ -6891,9 +6917,32 @@ sub process {
> if ($signoff == 0) {
> ERROR("MISSING_SIGN_OFF",
> "Missing Signed-off-by: line(s)\n");
> - } elsif (!$authorsignoff) {
> - WARN("NO_AUTHOR_SIGN_OFF",
> - "Missing Signed-off-by: line by nominal patch author '$author'\n");
> + } elsif ($authorsignoff != 1) {
> + # authorsignoff values:
> + # 0 -> missing sign off
> + # 1 -> sign off present
sign off identical
> + # 2 -> address matches, name different
> + # 3 -> name matches, address different
> + # 4 -> name matches, address matches without extension
extension here isn't obvious
> +
> + my $ctx_msg = "'Signed-off-by: $authorsignoff_ctx' should be:\n'Signed-off-by: $author'";
New line not necessary or useful really.
And for mismatches, it's really not known that
it should be one way or the or the other is it?
> +
> + if($authorsignoff == 0) {
> + WARN("NO_AUTHOR_SIGN_OFF",
> + "Missing Signed-off-by: line by nominal patch author '$author'\n");
> + }
> + elsif($authorsignoff == 2) {
> + WARN("NO_AUTHOR_SIGN_OFF",
> + "Author name mismatch:\n$ctx_msg\n");
> + }
> + elsif($authorsignoff == 3) {
> + WARN("NO_AUTHOR_SIGN_OFF",
> + "Author address mismatch:\n$ctx_msg\n");
> + }
> + elsif($authorsignoff == 4) {
> + CHK("NO_AUTHOR_SIGN_OFF",
> + "Author mail extension mismatch:\n$ctx_msg\n");
> + }
> }
> }
>
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2020-10-05 7:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 6:48 [Linux-kernel-mentees] [PATCH RFC] checkpatch: add new warnings to author signoff checks Dwaipayan Ray
2020-10-05 7:18 ` Joe Perches [this message]
2020-10-05 7:40 ` Dwaipayan Ray
2020-10-05 8:05 ` Joe Perches
[not found] ` <CABJPP5CAY+qJU8wnGZ7JgugeN9CyFbdct6nAsxpY0NdyaNuWLQ@mail.gmail.com>
[not found] ` <f1536dd1c1fbf53a848b27a2817a973fbf809719.camel@perches.com>
2020-10-05 8:52 ` Dwaipayan Ray
2020-10-05 7:30 ` Lukas Bulwahn
-- strict thread matches above, loose matches on Subject: below --
2020-10-04 14:38 Dwaipayan Ray
2020-10-05 6:19 ` Lukas Bulwahn
2020-10-05 6:46 ` Dwaipayan Ray
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=a5cba9bb723626091f8790c794efe8de4ab184b8.camel@perches.com \
--to=joe@perches.com \
--cc=dwaipayanray1@gmail.com \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.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).