Skip to contentSkip to conversation

checkpatch: add new warnings to author signoff checks.

RFC PATCH In review Dwaipayan Ray 2 participants 3 messages Oct 4, 2020 – Oct 5, 2020 Checkpatch

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 checkpatch: add new warnings to author signoff checks.

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 <[email protected]>'

The signoff line was:
"Signed-off-by: Dave Anglin <[email protected]>"

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 <[email protected]>", "James <[email protected]>"

2) Name matches, but addresses are different.
"James Watson <[email protected]>", "James Watson <[email protected]>"

3) Name matches, but addresses without mail extensions are same. "James Watson <[email protected]>", "James Watson <[email protected]>"

For the 3rd class, a --strict check message is generated, and for the other two, warnings are generated.

---
 scripts/checkpatch.pl | 57 ++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 53 insertions(+), 4 deletions(-)
scripts/checkpatch.pl +53 -4
index 31624bbb342e..80feb15f93cb 100755
@@ -2347,6 +2347,7 @@ sub process {
 	my $signoff = 0;
 	my $author = '';
 	my $authorsignoff = 0;
+	my $authorsignoff_ctx = '';
 	my $is_patch = 0;
 	my $is_binding_patch = -1;
 	my $in_header_lines = $file ? 0 : 1;
@@ -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) {
 				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) {
+						$authorsignoff_ctx = $ctx;
+						$authorsignoff = 2;
+					} elsif ($email_name eq $author_name) {
+						$authorsignoff_ctx = $ctx;
+						$authorsignoff = 3;
+
+						my $address1 = $email_address;
+						my $address2 = $author_address;
+
+						if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
+							$address1 = $1.$2;
+						}
+						if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
+							$address2 = $1.$2;
+						}
+						if($address1 eq $address2) {
+							$authorsignoff = 4;
+						}
+					}
 				}
 			}
 		}
@@ -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
+			# 2 -> address matches, name different
+			# 3 -> name matches, address different
+			# 4 -> name matches, address matches without extension
+
+			my $ctx_msg = "'Signed-off-by: $authorsignoff_ctx' should be:\n'Signed-off-by: $author'";
+
+			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");
+			}
 		}
 	}
 
Signature · 6 lines
2.27.0

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
#1 lore raw
Quoted 22 lines · Dwaipayan Ray

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 <[email protected]>'

The signoff line was:
"Signed-off-by: Dave Anglin <[email protected]>"

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 <[email protected]>", "James <[email protected]>"

Quoted 9 lines

2) Name matches, but addresses are different.
"James Watson <[email protected]>", "James Watson <[email protected]>"

3) Name matches, but addresses without mail extensions are same. "James Watson <[email protected]>", "James Watson <[email protected]>"

For the 3rd class, a --strict check message is generated, and for the other two, warnings are generated.

Dwaipayan, I think it a good patch to start the discussion.

Feel free to send this to Joe and lkml.

Quoted 63 lines
---
 scripts/checkpatch.pl | 57 ++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 53 insertions(+), 4 deletions(-)
scripts/checkpatch.pl +30 -4
index 31624bbb342e..80feb15f93cb 100755
@@ -2347,6 +2347,7 @@ sub process {
 	my $signoff = 0;
 	my $author = '';
 	my $authorsignoff = 0;
+	my $authorsignoff_ctx = '';
 	my $is_patch = 0;
 	my $is_binding_patch = -1;
 	my $in_header_lines = $file ? 0 : 1;
@@ -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) {
 				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) {
+						$authorsignoff_ctx = $ctx;
+						$authorsignoff = 2;
+					} elsif ($email_name eq $author_name) {
+						$authorsignoff_ctx = $ctx;
+						$authorsignoff = 3;
+
+						my $address1 = $email_address;
+						my $address2 = $author_address;
+
+						if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
+							$address1 = $1.$2;
+						}
+						if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
+							$address2 = $1.$2;
+						}
+						if($address1 eq $address2) {
+							$authorsignoff = 4;
+						}
+					}
 				}
 			}
 		}
@@ -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

scripts/checkpatch.pl sub process { · line 6932

Quoted 10 lines
scripts/checkpatch.pl +10 -0
+			# 1 -> sign off present
+			# 2 -> address matches, name different
+			# 3 -> name matches, address different
+			# 4 -> name matches, address matches without extension
+
+			my $ctx_msg = "'Signed-off-by: $authorsignoff_ctx' should be:\n'Signed-off-by: $author'";
+
+			if($authorsignoff == 0) {
+				WARN("NO_AUTHOR_SIGN_OFF",
+					"Missing Signed-off-by: line by nominal patch author '$author'\n");

I think in this case, we could actually turn this into an ERROR; now that we have the refined cases (2,3,4) on which we would just warn or 'note' with --strict checks.

Send it as is to Joe Perches and lkml and I will repeat my comment on that mail and we will discuss it with Joe.

Lukas

Quoted 20 lines
scripts/checkpatch.pl +13 -0
+			}
+			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");
+			}
 		}
 	}
 
Signature · 1 line
2.27.0

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#2 lore raw
Quoted 119 lines · Lukas Bulwahn
Quoted 22 lines · Dwaipayan Ray

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 <[email protected]>'

The signoff line was:
"Signed-off-by: Dave Anglin <[email protected]>"

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 <[email protected]>", "James <[email protected]>"

Quoted 9 lines

2) Name matches, but addresses are different.
"James Watson <[email protected]>", "James Watson <[email protected]>"

3) Name matches, but addresses without mail extensions are same. "James Watson <[email protected]>", "James Watson <[email protected]>"

For the 3rd class, a --strict check message is generated, and for the other two, warnings are generated.

Dwaipayan, I think it a good patch to start the discussion.

Feel free to send this to Joe and lkml.

Quoted 63 lines
---
 scripts/checkpatch.pl | 57 ++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 53 insertions(+), 4 deletions(-)
scripts/checkpatch.pl +30 -4
index 31624bbb342e..80feb15f93cb 100755
@@ -2347,6 +2347,7 @@ sub process {
      my $signoff = 0;
      my $author = '';
      my $authorsignoff = 0;
+     my $authorsignoff_ctx = '';
      my $is_patch = 0;
      my $is_binding_patch = -1;
      my $in_header_lines = $file ? 0 : 1;
@@ -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) {
                              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) {
+                                             $authorsignoff_ctx = $ctx;
+                                             $authorsignoff = 2;
+                                     } elsif ($email_name eq $author_name) {
+                                             $authorsignoff_ctx = $ctx;
+                                             $authorsignoff = 3;
+
+                                             my $address1 = $email_address;
+                                             my $address2 = $author_address;
+
+                                             if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
+                                                     $address1 = $1.$2;
+                                             }
+                                             if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
+                                                     $address2 = $1.$2;
+                                             }
+                                             if($address1 eq $address2) {
+                                                     $authorsignoff = 4;
+                                             }
+                                     }
                              }
                      }
              }
@@ -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

scripts/checkpatch.pl sub process { · line 6932

Quoted 10 lines
scripts/checkpatch.pl +10 -0
+                     # 1 -> sign off present
+                     # 2 -> address matches, name different
+                     # 3 -> name matches, address different
+                     # 4 -> name matches, address matches without extension
+
+                     my $ctx_msg = "'Signed-off-by: $authorsignoff_ctx' should be:\n'Signed-off-by: $author'";
+
+                     if($authorsignoff == 0) {
+                             WARN("NO_AUTHOR_SIGN_OFF",
+                                     "Missing Signed-off-by: line by nominal patch author '$author'\n");

I think in this case, we could actually turn this into an ERROR; now that we have the refined cases (2,3,4) on which we would just warn or 'note' with --strict checks.

Quoted 2 lines

Send it as is to Joe Perches and lkml and I will repeat my comment on that mail and we will discuss it with Joe.

Okay sure I will do that. Thanks!

Dwaipayan

Quoted 23 lines

Lukas

Quoted 20 lines
scripts/checkpatch.pl +13 -1
+                     }
+                     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");
+                     }
              }
      }
 
--

2.27.0

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees