checkpatch: fix author Signed-off-by warning for split From: header
PATCH 1/1 checkpatch: fix author Signed-off-by warning for split From: header
Checkpatch did not handle cases where the author From: header was split into two lines. In those cases the author string went empty, and checkpatch generated a false missing author signed-off-by warning.
This patch adds support for split From: headers and resolves those false warnings.
--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)
scripts/checkpatch.pl +11 -0
@@ -2347,6 +2347,7 @@ sub process { my $signoff = 0; my $author = ''; my $authorsignoff = 0; + my $prevheader = 0; my $is_patch = 0; my $is_binding_patch = -1; my $in_header_lines = $file ? 0 : 1;
@@ -2658,12 +2659,22 @@ sub process { } } +# Check the patch for a split From: + if ($author eq '' && decode("MIME-Header", $prevheader) =~ /^From:\s*(.*)/) { + $author = $1.$line; + $author = encode("utf8", $author) if ($prevheader =~ /=\?utf-8\?/i); + $author =~ s/"//g; + $author = reformat_email($author); + $prevheader = ''; + } + # Check the patch for a From: if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { $author = $1; $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); $author =~ s/"//g; $author = reformat_email($author); + $prevheader = $line; } # Check the patch for a signoff:
Signature · 6 lines
2.27.0 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
For the patch subject line, I actually think this patch is a new feature or extension, not a fix. It was not broken, just not supported before.
So maybe: extend author Signed-off-by check for split From: header
Quoted 8 lines · Dwaipayan Ray
Checkpatch did not handle cases where the author From: header was split into two lines. In those cases the author string went empty, and checkpatch generated a false missing author signed-off-by warning.
This patch adds support for split From: headers and resolves those false warnings.
You can drop 'This patch adds'. We see it is a patch, and we see that it adds something. Just use imperative tense:
Support split From: headers in AUTHOR_SIGN_OFF check.
(That is a good commit message header as well.)
Can you provide some statistics on number of warnings before and after and maybe even in more detail, how many of the warnings disappeared with:
Missing Signed-off-by: line by nominal patch author ''
Probably even new warnings appeared?
Quoted 18 lines
Signed-off-by Dwaipayan Ray <[email protected]>--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)scripts/checkpatch.pl +1
-0@@ -2347,6 +2347,7 @@ sub process { my $signoff = 0; my $author = ''; my $authorsignoff = 0; + my $prevheader = 0; my $is_patch = 0; my $is_binding_patch = -1; my $in_header_lines = $file ? 0 : 1;
scripts/checkpatch.pl sub process { · line 2663
Quoted 5 lines
scripts/checkpatch.pl +2
-0@@ -2658,12 +2659,22 @@ sub process { } } +# Check the patch for a split From: + if ($author eq '' && decode("MIME-Header", $prevheader) =~ /^From:\s*(.*)/) {
How about extending to check if $prevheader is not 0?
Quoted 6 lines
scripts/checkpatch.pl +6
-0+ $author = $1.$line; + $author = encode("utf8", $author) if ($prevheader =~ /=\?utf-8\?/i); + $author =~ s/"//g; + $author = reformat_email($author); + $prevheader = ''; + }
scripts/checkpatch.pl sub process { · line 2679
Quoted 10 lines
scripts/checkpatch.pl +2
-0+ # Check the patch for a From: if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { $author = $1; $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); $author =~ s/"//g; $author = reformat_email($author); + $prevheader = $line; }
So here we see two almost identical parts of code now, right?
Either use a small function or restructure the code such that the differences are in two branches and the common code is part of one common control flow. You are a good programmer, you can figure this out.
Generally looks good. Let us know once you think it is ready to be tested :)
We got some checkpatch.pl evaluation experts here and I am sure they are all happy to test your change and see the evaluation get better.
Lukas
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 82 lines · Lukas Bulwahn
For the patch subject line, I actually think this patch is a new feature or extension, not a fix. It was not broken, just not supported before.
So maybe: extend author Signed-off-by check for split From: header
Quoted 8 lines · Dwaipayan Ray
Checkpatch did not handle cases where the author From: header was split into two lines. In those cases the author string went empty, and checkpatch generated a false missing author signed-off-by warning.
This patch adds support for split From: headers and resolves those false warnings.
You can drop 'This patch adds'. We see it is a patch, and we see that it adds something. Just use imperative tense:
Support split From: headers in
AUTHOR_SIGN_OFFcheck.(That is a good commit message header as well.)
Can you provide some statistics on number of warnings before and after and maybe even in more detail, how many of the warnings disappeared with:
Missing Signed-off-by: line by nominal patch author ''
Probably even new warnings appeared?
Quoted 18 lines
Signed-off-by Dwaipayan Ray <[email protected]>--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)scripts/checkpatch.pl +1
-0@@ -2347,6 +2347,7 @@ sub process { my $signoff = 0; my $author = ''; my $authorsignoff = 0; + my $prevheader = 0; my $is_patch = 0; my $is_binding_patch = -1; my $in_header_lines = $file ? 0 : 1;scripts/checkpatch.pl sub process { · line 2663
Quoted 5 lines
scripts/checkpatch.pl +2
-0@@ -2658,12 +2659,22 @@ sub process { } } +# Check the patch for a split From: + if ($author eq '' && decode("MIME-Header", $prevheader) =~ /^From:\s*(.*)/) {How about extending to check if $prevheader is not 0?
Quoted 6 lines
scripts/checkpatch.pl +6
-0+ $author = $1.$line; + $author = encode("utf8", $author) if ($prevheader =~ /=\?utf-8\?/i); + $author =~ s/"//g; + $author = reformat_email($author); + $prevheader = ''; + }scripts/checkpatch.pl sub process { · line 2679
Quoted 10 lines
scripts/checkpatch.pl +2
-0+ # Check the patch for a From: if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { $author = $1; $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); $author =~ s/"//g; $author = reformat_email($author); + $prevheader = $line; }So here we see two almost identical parts of code now, right?
Either use a small function or restructure the code such that the differences are in two branches and the common code is part of one common control flow. You are a good programmer, you can figure this out.
Quoted 6 lines
Generally looks good. Let us know once you think it is ready to be tested :)
We got some checkpatch.pl evaluation experts here and I am sure they are all happy to test your change and see the evaluation get better.
Lukas
Hi,
I will get back with the changes you told once I do it in a clean enough way.
For now, I have generated the statistics for my patch. I ran my script on all non merge commits between v5.7 and v5.8.
Before applying patch, no. of warnings:NO_AUTHOR_SIGN_OFF: 278
After applying the patch:NO_AUTHOR_SIGN_OFF: 251
Comparing the changes before and after applying the patch:
(Entries are given as no. of warnings of type NO_AUTHOR_SIGN_OFF before and after applying the patch for given commit hash).
e33bcbab16d1: 1-> 06a5d6fd33262: 1-> 0424c85e1ffea: 1-> 0c7ff09f6e262: 1-> 0148dd20602d5: 1-> 0d5f74a1eff9a: 1-> 06c47660e3c3a: 1-> 09d9cc58aff46: 1-> 09a618e6f8cdd: 1-> 0980f91778a2f: 1-> 0b77da87c84f8: 1-> 015e3ae36f71e: 1-> 0c5b4312bea5d: 1-> 041aef04524d3: 1-> 037d1e94692e0: 1-> 079eb8c7f015a: 1-> 08211d1e83ade: 1-> 09a42a5ff3dac: 1-> 0440d7a6f7390: 1-> 06b6aeffc932d: 1-> 0ce1d86dc9249: 1-> 0f645e6256bd1: 1-> 0770ae40cd6d2: 1-> 0f4d12d8009d9: 1-> 0f0a087a533b3: 1-> 0772563b27c9f: 1-> 0b03628b73564: 1-> 0
So, no new warnings have popped up, and the no. of warnings have reduced significantly. :)
I will send in the new patch once I am done with it.
Thanks,
Dwaipayan.
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 38 lines
Quoted 13 lines
scripts/checkpatch.pl +1
-0@@ -2347,6 +2347,7 @@ sub process { my $signoff = 0; my $author = ''; my $authorsignoff = 0; + my $prevheader = 0; my $is_patch = 0; my $is_binding_patch = -1; my $in_header_lines = $file ? 0 : 1;scripts/checkpatch.pl sub process { · line 2663
Quoted 5 lines
scripts/checkpatch.pl +2
-0@@ -2658,12 +2659,22 @@ sub process { } } +# Check the patch for a split From: + if ($author eq '' && decode("MIME-Header", $prevheader) =~ /^From:\s*(.*)/) {How about extending to check if $prevheader is not 0?
Quoted 6 lines
scripts/checkpatch.pl +6
-0+ $author = $1.$line; + $author = encode("utf8", $author) if ($prevheader =~ /=\?utf-8\?/i); + $author =~ s/"//g; + $author = reformat_email($author); + $prevheader = ''; + }scripts/checkpatch.pl sub process { · line 2679
Quoted 10 lines
scripts/checkpatch.pl +2
-0+ # Check the patch for a From: if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { $author = $1; $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); $author =~ s/"//g; $author = reformat_email($author); + $prevheader = $line; }
Quoted 6 lines
So here we see two almost identical parts of code now, right?
Either use a small function or restructure the code such that the differences are in two branches and the common code is part of one common control flow. You are a good programmer, you can figure this out.
Hi,
I have changed the structure around a bit.
scripts/checkpatch.pl +14 -0
@@ -1210,6 +1210,16 @@ sub reformat_email { return format_email($email_name, $email_address); } +sub format_author_email { + my ($email, $from) = @_; + + $email = encode("utf8", $email) if ($from =~ /=\?utf-8\?/i); + $email =~ s/"//g; + $email = reformat_email($email); + + return $email; +} + sub same_email_addresses { my ($email1, $email2) = @_;
@@ -2347,6 +2357,7 @@ sub process { my $signoff = 0; my $author = ''; my $authorsignoff = 0; + my $prevheader = ''; my $is_patch = 0; my $is_binding_patch = -1; my $in_header_lines = $file ? 0 : 1;
@@ -2658,12 +2669,21 @@ sub process { } } +# Check the patch for a split From: + if($prevheader ne '') { + if ($author eq '' && decode("MIME-Header", $prevheader) =~
/^From:\s*(.*)/) {
+ my $email = $1.$line;
+ $author = format_author_email($email, $prevheader);
+ }
+ $prevheader = '';
+ }
+
# Check the patch for a From:
if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
- $author = $1;
- $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
- $author =~ s/"//g;
- $author = reformat_email($author);
+ $author = format_author_email($1, $line);
+ if($author eq '') {
+ $prevheader = $line;
+ }
}# Check the patch for a signoff:
Is it good to go? I shall mail it in then.
Thanks,
Dwaipayan.
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 40 lines · Dwaipayan Ray
Quoted 40 lines
Quoted 13 lines
scripts/checkpatch.pl +1
-0@@ -2347,6 +2347,7 @@ sub process { my $signoff = 0; my $author = ''; my $authorsignoff = 0; + my $prevheader = 0; my $is_patch = 0; my $is_binding_patch = -1; my $in_header_lines = $file ? 0 : 1;scripts/checkpatch.pl sub process { · line 2663
Quoted 5 lines
scripts/checkpatch.pl +2
-0@@ -2658,12 +2659,22 @@ sub process { } } +# Check the patch for a split From: + if ($author eq '' && decode("MIME-Header", $prevheader) =~ /^From:\s*(.*)/) {How about extending to check if $prevheader is not 0?
Quoted 6 lines
scripts/checkpatch.pl +6
-0+ $author = $1.$line; + $author = encode("utf8", $author) if ($prevheader =~ /=\?utf-8\?/i); + $author =~ s/"//g; + $author = reformat_email($author); + $prevheader = ''; + }scripts/checkpatch.pl sub process { · line 2679
Quoted 10 lines
scripts/checkpatch.pl +2
-0+ # Check the patch for a From: if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { $author = $1; $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); $author =~ s/"//g; $author = reformat_email($author); + $prevheader = $line; }So here we see two almost identical parts of code now, right?
Quoted 8 lines
Quoted 4 lines
Either use a small function or restructure the code such that the differences are in two branches and the common code is part of one common control flow. You are a good programmer, you can figure this out.
Hi,
I have changed the structure around a bit.
Next time, please just send a proper PATCH v2 when you rework a patch.
Quoted 57 lines
scripts/checkpatch.pl +24
-4@@ -1210,6 +1210,16 @@ sub reformat_email { return format_email($email_name, $email_address); } +sub format_author_email { + my ($email, $from) = @_; + + $email = encode("utf8", $email) if ($from =~ /=\?utf-8\?/i); + $email =~ s/"//g; + $email = reformat_email($email); + + return $email; +} + sub same_email_addresses { my ($email1, $email2) = @_;@@ -2347,6 +2357,7 @@ sub process { my $signoff = 0; my $author = ''; my $authorsignoff = 0; + my $prevheader = ''; my $is_patch = 0; my $is_binding_patch = -1; my $in_header_lines = $file ? 0 : 1;@@ -2658,12 +2669,21 @@ sub process { } } +# Check the patch for a split From: + if($prevheader ne '') { + if ($author eq '' && decode("MIME-Header", $prevheader) =~ /^From:\s*(.*)/) { + my $email = $1.$line; + $author = format_author_email($email, $prevheader); + } + $prevheader = ''; + } + # Check the patch for a From: if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { - $author = $1; - $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); - $author =~ s/"//g; - $author = reformat_email($author); + $author = format_author_email($1, $line); + if($author eq '') { + $prevheader = $line; + } }# Check the patch for a signoff:
Quoted 2 lines
Is it good to go? I shall mail it in then.
Yes, I think it is good for a first submission.
Please use ./scripts/get_maintainers.pl to find the developers to send this patch to.
Also CC: me and the linux-kernel-mentees mailing list.
Once, the list is on the linux-kernel mailing list, we will start reviewing and testing your patch.
Lukas
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees