Messages in this thread | | | Subject | Re: [PATCH RFC] checkpatch: add new warnings to author signoff checks. | From | Joe Perches <> | Date | Mon, 05 Oct 2020 00:18:17 -0700 |
| |
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"); > + } > } > } >
| |