checkpatch: add fix and improve warning msg for Non-standard signature
PATCH 1/1 checkpatch: add fix and improve warning msg for Non-standard signature
Currently checkpatch warns for BAD_SIGN_OFF on non-standard signature styles.
A large number of these warnings occur because of typo mistakes in signoffs.
An evaluation over v4.13..v5.8 revealed that out of 539 warnings due to Non-standard signatures, 85 are due to typo mistakes.
Eg. running checkpatch on commit da785a87787c ("ARM: bcm2835: Fix integer overflow in rpi_firmware_print_firmware_revision()") reports this warning:
WARNING:Non-standard signature: Revieved-by:
Here the signoff 'Reviewed-by' is misspelt.
Provide a fix by calculating levenshtein distance for the signoff over all the standard signatures and suggest a fix if the distance for any signature is less than or equal to 2.
---
applied on my last patch and next-20201120
scripts/checkpatch.pl | 73 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 72 insertions(+), 1 deletion(-)
scripts/checkpatch.pl +72 -1
@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insert distance + my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1]; #replace + $distance[$i][$j] = 1 + get_min($dist1, $dist2, $dist3); + } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:', 'tested-by:', + 'reviewed-by:', 'reported-by:', 'suggested-by:', 'to:', 'cc:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our %standard_signature_fix = ( "Requested-by:" => { suggestion => "Suggested-by:",
@@ -2848,7 +2919,7 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - my $suggested_signature = ""; + my $suggested_signature = get_standard_signature($sign_off); my $rationale = ""; if (exists($standard_signature_fix{$sign_off})) { $suggested_signature = $standard_signature_fix{$sign_off}{'suggestion'};
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 9 lines · Aditya Srivastava
Currently checkpatch warns for
BAD_SIGN_OFFon non-standard signature styles.A large number of these warnings occur because of typo mistakes in signoffs.
An evaluation over v4.13..v5.8 revealed that out of 539 warnings due to Non-standard signatures, 85 are due to typo mistakes.
Quoted 9 lines
Eg. running checkpatch on commit
da785a87787c("ARM: bcm2835: Fix integer overflow inrpi_firmware_print_firmware_revision()") reports this warning:WARNING:Non-standard signature: Revieved-by:
Revieved-by Petr Mladek <[email protected]>Here the signoff 'Reviewed-by' is misspelt.
Again, it is better to provide a summary of the overall evaluation instead of a single example,
Quoted 1 line
Provide a fix by calculating levenshtein distance for the signoff over
it is a signature tag, not the signoff.
Quoted 7 lines
all the standard signatures and suggest a fix if the distance for any signature is less than or equal to 2.
Signed-off-by Aditya Srivastava <[email protected]>---
applied on my last patch and next-20201120
Joe, might ack this one and reject the other; so you might need to rebase later.
For the discussion with Joe now that is fine, though.
Other than that, it looks good.
Quoted 95 lines
scripts/checkpatch.pl | 73 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 72 insertions(+), 1 deletion(-)scripts/checkpatch.pl +72
-2@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insert distance + my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1]; #replace + $distance[$i][$j] = 1 + get_min($dist1, $dist2, $dist3); + } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:', 'tested-by:', + 'reviewed-by:', 'reported-by:', 'suggested-by:', 'to:', 'cc:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our %standard_signature_fix = ( "Requested-by:" => { suggestion => "Suggested-by:",@@ -2848,7 +2919,7 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - my $suggested_signature = ""; + my $suggested_signature = get_standard_signature($sign_off); my $rationale = ""; if (exists($standard_signature_fix{$sign_off})) { $suggested_signature = $standard_signature_fix{$sign_off}{'suggestion'}; --
Quoted 2 lines
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
PATCH v2 1/1 checkpatch: add fix and improve warning msg for Non-standard signature
Currently checkpatch warns for BAD_SIGN_OFF on non-standard signature styles.
A large number of these warnings occur because of typo mistakes in signoffs. An evaluation over v4.13..v5.8 revealed that out of 539 warnings due to Non-standard signatures, 85 are due to typo mistakes.
Provide a fix by calculating levenshtein distance for the signature tag over all the standard signatures and suggest a fix with signature, whose edit distance is less than or equal to 2.
According to evaluation over v4.13..v5.8, following are the incorrect signature tags with typos and their corresponding suggested fixes (according to edit distace approach):
1)Reviwed-by (count: 19) => Reviewed-by
2)Reviewd-by (count: 9) => Reviewed-by
3)Singed-off-by (count: 8) => Signed-off-by
4)Signed-of-by (count: 6) => Signed-off-by
5)Rewieved-by (count: 3) => Reviewed-by
6)Signed-off--by (count: 3) => Signed-off-by
7)Revieved-by (count: 3) => Reviewed-by
8)Reivewed-by (count: 2) => Reviewed-by
9)Signef-off-by (count: 2) => Signed-off-by
10)Test-by (count: 2) => Tested-by
11)Acked_by (count: 2) => Acked-by
12)Signed-off-by-by (count: 2) => Signed-off-by
13)Reported-by-by (count: 1) => Reported-by
14)Reporetd-by (count: 1) => Reported-by
15)Reviewed--by (count: 1) => Reviewed-by
16)Sugested-by (count: 1) => Suggested-by
17)Suggested--by (count: 1) => Suggested-by
18)Repoted-by (count: 1) => Reported-by
19)Rported-by (count: 1) => Reported-by
20)eigned-off-by (count: 1) => Signed-off-by
21)Reveiwed-by (count: 1) => Reviewed-by
22)igned-off-by (count: 1) => Signed-off-by
23)Tested-by-by (count: 1) => Tested-by
24)Sugessted-by (count: 1) => Suggested-by
25)Rewiewed-by (count: 1) => Reviewed-by
26)Teste-by (count: 1) => Tested-by
27)Signee-off-by (count: 1) => Signed-off-by
28)-By (count: 1) => To
29)Signen-off-by (count: 1) => Signed-off-by
30)eported-by (count: 1) => Reported-by
31)Reviewedy-by (count: 1) => Signed-off-by
32)Siganed-off-by (count: 1) => Signed-off-by
33)Ackedy-by (count: 1) => Acked-by
34)Review-by (count: 1) => Reviewed-by
35)Tweeted-by (count: 1) => Tested-by
36)Ack-by (count: 1) => Acked-by
37)Reorted-by (count: 1) => Reported-by
38)Suggsted-by (count: 1) => Suggested-by
39)Reviwed-By (count: 1) => Reviewed-by
---
changes in v2: modify commit message: replace specific example with overall evaluation, minor changes patch applies on next-20201120
scripts/checkpatch.pl | 85 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +83 -2
@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insert distance + my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1]; #replace + $distance[$i][$j] = 1 + get_min($dist1, $dist2, $dist3); + } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:', 'tested-by:', + 'reviewed-by:', 'reported-by:', 'suggested-by:', 'to:', 'cc:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our @typeListMisordered = ( qr{char\s+(?:un)?signed}, qr{int\s+(?:(?:un)?signed\s+)?short\s},
@@ -2773,8 +2844,18 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - WARN("BAD_SIGN_OFF", - "Non-standard signature: $sign_off\n" . $herecurr); + my $suggested_signature = get_standard_signature($sign_off); + if ($suggested_signature eq "") { + WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off\n" . $herecurr); + } + else { + if (WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off. Please use '$suggested_signature' instead\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; + } + } } if (defined $space_before && $space_before ne "") { if (WARN("BAD_SIGN_OFF",
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 86 lines · Aditya Srivastava
Currently checkpatch warns for
BAD_SIGN_OFFon non-standard signature styles.A large number of these warnings occur because of typo mistakes in signoffs. An evaluation over v4.13..v5.8 revealed that out of 539 warnings due to Non-standard signatures, 85 are due to typo mistakes.
Provide a fix by calculating levenshtein distance for the signature tag over all the standard signatures and suggest a fix with signature, whose edit distance is less than or equal to 2.
According to evaluation over v4.13..v5.8, following are the incorrect signature tags with typos and their corresponding suggested fixes (according to edit distace approach):
1)Reviwed-by (count: 19) => Reviewed-by
2)Reviewd-by (count: 9) => Reviewed-by
3)Singed-off-by (count: 8) => Signed-off-by
4)Signed-of-by (count: 6) => Signed-off-by
5)Rewieved-by (count: 3) => Reviewed-by
6)Signed-off--by (count: 3) => Signed-off-by
7)Revieved-by (count: 3) => Reviewed-by
8)Reivewed-by (count: 2) => Reviewed-by
9)Signef-off-by (count: 2) => Signed-off-by
10)Test-by (count: 2) => Tested-by
11)Acked_by (count: 2) => Acked-by
12)Signed-off-by-by (count: 2) => Signed-off-by
13)Reported-by-by (count: 1) => Reported-by
14)Reporetd-by (count: 1) => Reported-by
15)Reviewed--by (count: 1) => Reviewed-by
16)Sugested-by (count: 1) => Suggested-by
17)Suggested--by (count: 1) => Suggested-by
18)Repoted-by (count: 1) => Reported-by
19)Rported-by (count: 1) => Reported-by
20)eigned-off-by (count: 1) => Signed-off-by
21)Reveiwed-by (count: 1) => Reviewed-by
22)igned-off-by (count: 1) => Signed-off-by
23)Tested-by-by (count: 1) => Tested-by
24)Sugessted-by (count: 1) => Suggested-by
25)Rewiewed-by (count: 1) => Reviewed-by
26)Teste-by (count: 1) => Tested-by
27)Signee-off-by (count: 1) => Signed-off-by
28)-By (count: 1) => To
29)Signen-off-by (count: 1) => Signed-off-by
30)eported-by (count: 1) => Reported-by
31)Reviewedy-by (count: 1) => Signed-off-by
32)Siganed-off-by (count: 1) => Signed-off-by
33)Ackedy-by (count: 1) => Acked-by
34)Review-by (count: 1) => Reviewed-by
35)Tweeted-by (count: 1) => Tested-by
Quoted 8 lines
36)Ack-by (count: 1) => Acked-by
37)Reorted-by (count: 1) => Reported-by
38)Suggsted-by (count: 1) => Suggested-by
39)Reviwed-By (count: 1) => Reviewed-by
How about summarizing this?
Which are good corrections, which are "bad corrections"; what is the total count of corrections, how many are good, and which are bad?
How many typo variants were corrected to each valid tag?
Quoted 112 lines
Signed-off-by Aditya Srivastava <[email protected]>---
changes in v2: modify commit message: replace specific example with overall evaluation, minor changes patch applies on next-20201120scripts/checkpatch.pl | 85 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-)scripts/checkpatch.pl +83
-3@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insert distance + my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1]; #replace + $distance[$i][$j] = 1 + get_min($dist1, $dist2, $dist3); + } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:', 'tested-by:', + 'reviewed-by:', 'reported-by:', 'suggested-by:', 'to:', 'cc:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our @typeListMisordered = ( qr{char\s+(?:un)?signed}, qr{int\s+(?:(?:un)?signed\s+)?short\s},@@ -2773,8 +2844,18 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - WARN("BAD_SIGN_OFF", - "Non-standard signature: $sign_off\n" . $herecurr); + my $suggested_signature = get_standard_signature($sign_off); + if ($suggested_signature eq "") { + WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off\n" . $herecurr); + } + else { + if (WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off. Please use '$suggested_signature' instead\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; + } + } } if (defined $space_before && $space_before ne "") { if (WARN("BAD_SIGN_OFF", --
Quoted 2 lines
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
PATCH v3 1/1 checkpatch: add fix and improve warning msg for Non-standard signature
Currently checkpatch warns for BAD_SIGN_OFF on non-standard signature styles.
A large number of these warnings occur because of typo mistakes in signoffs. An evaluation over v4.13..v5.8 revealed that out of 539 warnings due to Non-standard signatures, 87 are due to typo mistakes.
Following are the standard signature tags which are often incorrectly used with their counts(over v4.13..v5.8):
1) Reviewed-by => 42
2) Signed-off-by => 25
3) Reported-by => 6
4) Acked-by => 4
5) Tested-by => 4
6) Suggested-by => 4
Provide a fix by calculating levenshtein distance for the signature tag with all the standard signatures and suggest a fix with signature, whose edit distance is less than or equal to 2 with the misspelt signature.
Out of the 87 misspelt signatures fixed with this approach, 85 were found to be good corrections and 2 were bad corrections.
The signature tags which are good corrections using this approach are:
1)Reviwed-by (count: 19) => Reviewed-by
2)Reviewd-by (count: 9) => Reviewed-by
3)Singed-off-by (count: 8) => Signed-off-by
4)Signed-of-by (count: 6) => Signed-off-by
5)Rewieved-by (count: 3) => Reviewed-by
6)Signed-off--by (count: 3) => Signed-off-by
7)Revieved-by (count: 3) => Reviewed-by
8)Reivewed-by (count: 2) => Reviewed-by
9)Signef-off-by (count: 2) => Signed-off-by
10)Test-by (count: 2) => Tested-by
11)Acked_by (count: 2) => Acked-by
12)Signed-off-by-by (count: 2) => Signed-off-by
13)Reported-by-by (count: 1) => Reported-by
14)Reporetd-by (count: 1) => Reported-by
15)Reviewed--by (count: 1) => Reviewed-by
16)Sugested-by (count: 1) => Suggested-by
17)Suggested--by (count: 1) => Suggested-by
18)Repoted-by (count: 1) => Reported-by
19)Rported-by (count: 1) => Reported-by
20)eigned-off-by (count: 1) => Signed-off-by
21)Reveiwed-by (count: 1) => Reviewed-by
22)igned-off-by (count: 1) => Signed-off-by
23)Tested-by-by (count: 1) => Tested-by
24)Sugessted-by (count: 1) => Suggested-by
25)Rewiewed-by (count: 1) => Reviewed-by
26)Teste-by (count: 1) => Tested-by
27)Signee-off-by (count: 1) => Signed-off-by
28)Signen-off-by (count: 1) => Signed-off-by
29)Reviwed-By (count: 1) => Reviewed-by
30)eported-by (count: 1) => Reported-by
31)Reviewedy-by (count: 1) => Reviewed-by
32)Siganed-off-by (count: 1) => Signed-off-by
33)Ackedy-by (count: 1) => Acked-by
34)Review-by (count: 1) => Reviewed-by
35)Suggsted-by (count: 1) => Suggested-by
36)Ack-by (count: 1) => Acked-by
37)Reorted-by (count: 1) => Reported-by
Following were found to be bad corrections:
1)-By (count: 1) => To
2)Tweeted-by (count: 1) => Tested-by
---
changes in v2: modify commit message: replace specific example with overall evaluation, minor changes
changes in v3: summarize commit message
scripts/checkpatch.pl | 85 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +83 -2
@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insert distance + my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1]; #replace + $distance[$i][$j] = 1 + get_min($dist1, $dist2, $dist3); + } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:', 'tested-by:', + 'reviewed-by:', 'reported-by:', 'suggested-by:', 'to:', 'cc:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our @typeListMisordered = ( qr{char\s+(?:un)?signed}, qr{int\s+(?:(?:un)?signed\s+)?short\s},
@@ -2773,8 +2844,18 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - WARN("BAD_SIGN_OFF", - "Non-standard signature: $sign_off\n" . $herecurr); + my $suggested_signature = get_standard_signature($sign_off); + if ($suggested_signature eq "") { + WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off\n" . $herecurr); + } + else { + if (WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off. Please use '$suggested_signature' instead\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; + } + } } if (defined $space_before && $space_before ne "") { if (WARN("BAD_SIGN_OFF",
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 6 lines · Aditya Srivastava
Currently checkpatch warns for
BAD_SIGN_OFFon non-standard signature styles.A large number of these warnings occur because of typo mistakes in signoffs. An evaluation over v4.13..v5.8 revealed that out of 539
It is not a sign-off, it is a signature tag.
Quoted 2 lines
warnings due to Non-standard signatures, 87 are due to typo mistakes.
why do you write "non-standard" capitalized?
Quoted 3 lines
Following are the standard signature tags which are often incorrectly used with their counts(over v4.13..v5.8):
This sentence above is not clear.
Quoted 7 lines
1) Reviewed-by => 42
2) Signed-off-by => 25
3) Reported-by => 6
4) Acked-by => 4
5) Tested-by => 4
6) Suggested-by => 4
You can probably drop the 1) to 6); simply indent it; I think "tag:
count" or "tag count" (where the spacing is aligned) is better
than "tag => count"
Quoted 4 lines
Provide a fix by calculating levenshtein distance for the signature tag with all the standard signatures and suggest a fix with signature, whose edit distance is less than or equal to 2 with the misspelt signature.
s/misspelt/misspelled/
Quoted 34 lines
Out of the 87 misspelt signatures fixed with this approach, 85 were found to be good corrections and 2 were bad corrections.
The signature tags which are good corrections using this approach are:
1)Reviwed-by (count: 19) => Reviewed-by 2)Reviewd-by (count: 9) => Reviewed-by 3)Singed-off-by (count: 8) => Signed-off-by 4)Signed-of-by (count: 6) => Signed-off-by 5)Rewieved-by (count: 3) => Reviewed-by 6)Signed-off--by (count: 3) => Signed-off-by 7)Revieved-by (count: 3) => Reviewed-by 8)Reivewed-by (count: 2) => Reviewed-by 9)Signef-off-by (count: 2) => Signed-off-by 10)Test-by (count: 2) => Tested-by 11)Acked_by (count: 2) => Acked-by 12)Signed-off-by-by (count: 2) => Signed-off-by 13)Reported-by-by (count: 1) => Reported-by 14)Reporetd-by (count: 1) => Reported-by 15)Reviewed--by (count: 1) => Reviewed-by 16)Sugested-by (count: 1) => Suggested-by 17)Suggested--by (count: 1) => Suggested-by 18)Repoted-by (count: 1) => Reported-by 19)Rported-by (count: 1) => Reported-by 20)eigned-off-by (count: 1) => Signed-off-by 21)Reveiwed-by (count: 1) => Reviewed-by 22)igned-off-by (count: 1) => Signed-off-by 23)Tested-by-by (count: 1) => Tested-by 24)Sugessted-by (count: 1) => Suggested-by 25)Rewiewed-by (count: 1) => Reviewed-by 26)Teste-by (count: 1) => Tested-by 27)Signee-off-by (count: 1) => Signed-off-by 28)Signen-off-by (count: 1) => Signed-off-by 29)Reviwed-By (count: 1) => Reviewed-by
Quoted 9 lines
30)eported-by (count: 1) => Reported-by 31)Reviewedy-by (count: 1) => Reviewed-by 32)Siganed-off-by (count: 1) => Signed-off-by 33)Ackedy-by (count: 1) => Acked-by 34)Review-by (count: 1) => Reviewed-by 35)Suggsted-by (count: 1) => Suggested-by 36)Ack-by (count: 1) => Acked-by 37)Reorted-by (count: 1) => Reported-by
I do not think the enumeration of all those typos is interesting for the commit message. Maybe Joe will ask, but anyone else can imagine how such typos look like.
If you think they should be kept, I would just sort it this way:
Typo variants of the tags were:
Signed-off-by:
then list all variants
Acked-by:
then list all variants
Reported-by:
then list all variants
etc.
Quoted 3 lines
Following were found to be bad corrections:
1)-By (count: 1) => To
How about not correcting to To: (It is simply too short).
The explanation is getting better, give it another try. Then we might be in a good state for Joe and lkml.
Lukas
Quoted 115 lines
2)Tweeted-by (count: 1) => Tested-by
Signed-off-by Aditya Srivastava <[email protected]>---
changes in v2: modify commit message: replace specific example with overall evaluation, minor changeschanges in v3: summarize commit message
scripts/checkpatch.pl | 85 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-)scripts/checkpatch.pl +83
-3@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insert distance + my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1]; #replace + $distance[$i][$j] = 1 + get_min($dist1, $dist2, $dist3); + } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:', 'tested-by:', + 'reviewed-by:', 'reported-by:', 'suggested-by:', 'to:', 'cc:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our @typeListMisordered = ( qr{char\s+(?:un)?signed}, qr{int\s+(?:(?:un)?signed\s+)?short\s},@@ -2773,8 +2844,18 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - WARN("BAD_SIGN_OFF", - "Non-standard signature: $sign_off\n" . $herecurr); + my $suggested_signature = get_standard_signature($sign_off); + if ($suggested_signature eq "") { + WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off\n" . $herecurr); + } + else { + if (WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off. Please use '$suggested_signature' instead\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; + } + } } if (defined $space_before && $space_before ne "") { if (WARN("BAD_SIGN_OFF", --
Quoted 2 lines
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
PATCH v4 1/1 checkpatch: add fix and improve warning msg for non-standard signature
Currently checkpatch warns for BAD_SIGN_OFF on non-standard signature styles.
A large number of these warnings occur because of typo mistakes in signature tags. An evaluation over v4.13..v5.8 showed that out of 539 warnings due to non-standard signatures, 87 are due to typo mistakes.
Following are the standard signature tags which are often incorrectly used, along with their individual counts of incorrect use (over v4.13..v5.8):
Provide a fix by calculating levenshtein distance for the signature tag with all the standard signatures and suggest a fix with a signature, whose edit distance is less than or equal to 2 with the misspelled signature.
Out of the 86 mispelled signatures fixed with this approach, 85 were found to be good corrections and 1 was bad correction.
Following was found to be a bad correction:
Tweeted-by (count: 1) => Tested-by
---
changes in v2: modify commit message: replace specific example with overall evaluation, minor changes
changes in v3: summarize commit message
changes in v4: improve commit message; remove signature suggestions of small length (ie 'cc' and 'to')
scripts/checkpatch.pl | 85 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +83 -2
@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insert distance + my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1]; #replace + $distance[$i][$j] = 1 + get_min($dist1, $dist2, $dist3); + } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:', 'tested-by:', + 'reviewed-by:', 'reported-by:', 'suggested-by:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our @typeListMisordered = ( qr{char\s+(?:un)?signed}, qr{int\s+(?:(?:un)?signed\s+)?short\s},
@@ -2773,8 +2844,18 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - WARN("BAD_SIGN_OFF", - "Non-standard signature: $sign_off\n" . $herecurr); + my $suggested_signature = get_standard_signature($sign_off); + if ($suggested_signature eq "") { + WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off\n" . $herecurr); + } + else { + if (WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off. Please use '$suggested_signature' instead\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; + } + } } if (defined $space_before && $space_before ne "") { if (WARN("BAD_SIGN_OFF",
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Re: [Linux-kernel-mentees] [PATCH v4] checkpatch: add fix and improve warning msg for non-standard signature
Aditya Srivastava <[email protected]> schrieb am Sa., 28. Nov. 2020 um 10:52:
Quoted 22 lines
Currently checkpatch warns for
BAD_SIGN_OFFon non-standard signature styles.A large number of these warnings occur because of typo mistakes in signature tags. An evaluation over v4.13..v5.8 showed that out of 539 warnings due to non-standard signatures, 87 are due to typo mistakes.
Following are the standard signature tags which are often incorrectly used, along with their individual counts of incorrect use (over v4.13..v5.8):
Reviewed-by 42Signed-off-by 25Reported-by 6Acked-by 4Tested-by 4Suggested-by 4Provide a fix by calculating levenshtein distance for the signature tag with all the standard signatures and suggest a fix with a signature, whose edit distance is less than or equal to 2 with the misspelled signature.
Quoted 6 lines
Out of the 86 mispelled signatures fixed with this approach, 85 were found to be good corrections and 1 was bad correction.
Following was found to be a bad correction:
Tweeted-by (count: 1) => Tested-by
Looks Good. Let us send it to Joe.
Quoted 129 lines
Signed-off-by Aditya Srivastava <[email protected]>---
changes in v2: modify commit message: replace specific example with overall evaluation, minor changeschanges in v3: summarize commit message
changes in v4: improve commit message; remove signature suggestions of small length (ie 'cc' and 'to')
scripts/checkpatch.pl | 85 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-)scripts/checkpatch.pl +35
-0@@ -506,6 +506,77 @@ our $signature_tags = qr{(?xi: Cc: )}; +sub get_min { + my (@arr) = @_; + my $len = scalar @arr; + if((scalar @arr) < 1) { + # if underflow, return + return; + } + my $min = $arr[0]; + for my $i (0 .. ($len-1)) { + if ($arr[$i] < $min) { + $min = $arr[$i]; + } + } + return $min; +} + +sub get_edit_distance { + my ($str1, $str2) = @_; + my $len1 = length($str1); + my $len2 = length($str2); + # two dimensional array storing minimum edit distance + my @distance; + for my $i (0 .. $len1) { + for my $j (0 .. $len2) { + if ($i == 0) { + $distance[$i][$j] = $j; + } + elsif ($j == 0) { + $distance[$i][$j] = $i; + } + elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { + $distance[$i][$j] = $distance[$i - 1][$j - 1]; + } + else { + my $dist1 = $distance[$i][$j - 1]; #insertdistance
scripts/checkpatch.pl +2
-0+ my $dist2 = $distance[$i - 1][$j]; # remove + my $dist3 = $distance[$i - 1][$j - 1];#replace
+ $distance[$i][$j] = 1 + get_min($dist1,
$dist2, $dist3);scripts/checkpatch.pl +12
-0+ } + } + } + return $distance[$len1][$len2]; +} + +sub get_standard_signature { + my ($sign_off) = @_; + $sign_off = lc($sign_off); + $sign_off =~ s/\-//g; # to match with formed hash + my @standard_signature_tags = ( + 'signed-off-by:', 'co-developed-by:', 'acked-by:','tested-by:',
scripts/checkpatch.pl +29
-2+ 'reviewed-by:', 'reported-by:', 'suggested-by:' + ); + # setting default values + my $standard_signature = 'signed-off-by'; + my $min_edit_distance = 20; + my $edit_distance; + foreach (@standard_signature_tags) { + my $signature = $_; + $_ =~ s/\-//g; + $edit_distance = get_edit_distance($sign_off, $_); + if ($edit_distance < $min_edit_distance) { + $min_edit_distance = $edit_distance; + $standard_signature = $signature; + } + } + if($min_edit_distance<=2) { + return ucfirst($standard_signature); + } + return ""; +} + our @typeListMisordered = ( qr{char\s+(?:un)?signed}, qr{int\s+(?:(?:un)?signed\s+)?short\s},@@ -2773,8 +2844,18 @@ sub process { my $ucfirst_sign_off = ucfirst(lc($sign_off)); if ($sign_off !~ /$signature_tags/) { - WARN("BAD_SIGN_OFF", - "Non-standard signature: $sign_off\n" . $herecurr); + my $suggested_signature = get_standard_signature($sign_off); + if ($suggested_signature eq "") { + WARN("BAD_SIGN_OFF", + "Non-standard signature: $sign_off\n" . $herecurr); + } + else { + if (WARN("BAD_SIGN_OFF", + "Non-standard signature:$sign_off. Please use '$suggested_signature' instead\n" . $herecurr) &&
scripts/checkpatch.pl +2
-0+ $fix) { + $fixed[$fixlinenr] =~s/$sign_off/$suggested_signature/;
scripts/checkpatch.pl +2
-1+ } + } } if (defined $space_before && $space_before ne "") { if (WARN("BAD_SIGN_OFF", --
Quoted 3 lines
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees