checkpatch: avoid COMMIT_LOG_LONG_LINE warning for signature tags
PATCH v2 1/1 checkpatch: avoid COMMIT_LOG_LONG_LINE warning for signature tags
Currently checkpatch warns us for long lines in commits even for signature tag lines.
Generally these lines exceed 75 characters limit because of:
1) long names and long email address
2) some comments on scoped review and acknowledgement, i.e., for a dedicated pointer on what was reported by the identity in 'Reported-by'
3) some additional comments on CC: [email protected] tags
Exclude signature tag lines from this class of warning.
A quick evaluation on v5.6..v5.8 showed that this fix reduces this warning by a frequency of 17.
A quick manual check found all the dropped warnings related to signature tags.
--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +2 -2
@@ -2961,8 +2961,8 @@ sub process { # file delta changes $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || # filename then : - $line =~ /^\s*(?:Fixes:|Link:)/i || - # A Fixes: or Link: line + $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || + # A Fixes: or Link: line or signature tag line $commit_log_possible_stack_dump)) { WARN("COMMIT_LOG_LONG_LINE", "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 28 lines · Aditya Srivastava
Currently checkpatch warns us for long lines in commits even for signature tag lines.
Generally these lines exceed 75 characters limit because of:
1) long names and long email address
2) some comments on scoped review and acknowledgement, i.e., for a dedicated pointer on what was reported by the identity in 'Reported-by'
3) some additional comments on CC: [email protected] tagsExclude signature tag lines from this class of warning.
A quick evaluation on v5.6..v5.8 showed that this fix reduces this warning by a frequency of 17.
A quick manual check found all the dropped warnings related to signature tags.
Signed-off-by Aditya Srivastava <[email protected]>--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/checkpatch.pl +0
-0
scripts/checkpatch.pl sub process { · line 2968
Quoted 10 lines
scripts/checkpatch.pl +2
-2@@ -2961,8 +2961,8 @@ sub process { # file delta changes $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || # filename then : - $line =~ /^\s*(?:Fixes:|Link:)/i || - # A Fixes: or Link: line + $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || + # A Fixes: or Link: line or signature tag line $commit_log_possible_stack_dump)) { WARN("COMMIT_LOG_LONG_LINE", "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
I think this patch probably got missed. Replying for your attention :) Pardon me if it was intentional.
Thanks
Aditya
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 5 lines · Aditya Srivastava
Currently checkpatch warns us for long lines in commits even for signature tag lines.
Generally these lines exceed 75 characters limit because of:
... exceed the 75-character limit because of:
[yes, English is strange ;)]
Quoted 10 lines
1) long names and long email address
2) some comments on scoped review and acknowledgement, i.e., for a dedicated pointer on what was reported by the identity in 'Reported-by'
3) some additional comments on CC: [email protected] tagsExclude signature tag lines from this class of warning.
A quick evaluation on v5.6..v5.8 showed that this fix reduces this warning by a frequency of 17.
frequency is the wrong word here. It is simply "count" here.
Also how many warnings were there before and how many after?
The count of 17 does not tell you much on the relative impact of the change.
Quoted 3 lines
A quick manual check found all the dropped warnings related to signature tags.
What did the quick manual check found?
Do you mean the quick manual check found all ... to be false positive that should not have been warned about?
Other than that, it looks good.
Lukas
Quoted 21 lines
Signed-off-by Aditya Srivastava <[email protected]>--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/checkpatch.pl +2
-3@@ -2961,8 +2961,8 @@ sub process { # file delta changes $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || # filename then : - $line =~ /^\s*(?:Fixes:|Link:)/i || - # A Fixes: or Link: line + $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || + # A Fixes: or Link: line or signature tag line $commit_log_possible_stack_dump)) { WARN("COMMIT_LOG_LONG_LINE", "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); --
Quoted 2 lines
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 16 lines · Lukas Bulwahn
Quoted 5 lines · Aditya Srivastava
Currently checkpatch warns us for long lines in commits even for signature tag lines.
Generally these lines exceed 75 characters limit because of:
... exceed the 75-character limit because of:
[yes, English is strange ;)]
Quoted 5 lines
1) long names and long email address
2) some comments on scoped review and acknowledgement, i.e., for a dedicated pointer on what was reported by the identity in 'Reported-by'
3) some additional comments on CC: [email protected] tags
Quoted 8 lines
Quoted 5 lines
Exclude signature tag lines from this class of warning.
A quick evaluation on v5.6..v5.8 showed that this fix reduces this warning by a frequency of 17.
frequency is the wrong word here. It is simply "count" here.
Okay.
Quoted 5 lines
Also how many warnings were there before and how many after?
The count of 17 does not tell you much on the relative impact of the change.
So, before this patch, COMMIT_LOG_LONG_LINE had frequency of 1896 and after the patch, it becomes 1879 (over v5.6..v5.8). Should I add this information in commit message as well
Quoted 8 lines
Quoted 3 lines
A quick manual check found all the dropped warnings related to signature tags.
What did the quick manual check found?
Do you mean the quick manual check found all ... to be false positive that should not have been warned about?
Yes, all the dropped warnings are prefixed by signature tags. Generated list:
https://github.com/AdityaSrivast/kernel-tasks/blob/master/random/signature_tags/dropped/summary.txt
Quoted 19 lines
Other than that, it looks good.
Lukas
Quoted 15 lines
Signed-off-by Aditya Srivastava <[email protected]>--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/checkpatch.pl +0
-2@@ -2961,8 +2961,8 @@ sub process { # file delta changes $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || # filename then : - $line =~ /^\s*(?:Fixes:|Link:)/i || - # A Fixes: or Link: line
Quoted 8 lines
Quoted 8 lines
scripts/checkpatch.pl +2
-1+ $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || + # A Fixes: or Link: line or signature tag line $commit_log_possible_stack_dump)) { WARN("COMMIT_LOG_LONG_LINE", "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); --2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 30 lines · Aditya
Quoted 16 lines · Lukas Bulwahn
Quoted 5 lines · Aditya Srivastava
Currently checkpatch warns us for long lines in commits even for signature tag lines.
Generally these lines exceed 75 characters limit because of:
... exceed the 75-character limit because of:
[yes, English is strange ;)]
Quoted 5 lines
1) long names and long email address
2) some comments on scoped review and acknowledgement, i.e., for a dedicated pointer on what was reported by the identity in 'Reported-by'
3) some additional comments on CC: [email protected] tagsQuoted 8 lines
Quoted 5 lines
Exclude signature tag lines from this class of warning.
A quick evaluation on v5.6..v5.8 showed that this fix reduces this warning by a frequency of 17.
frequency is the wrong word here. It is simply "count" here.
Okay.
Quoted 2 lines
Also how many warnings were there before and how many after?
Quoted 8 lines
Quoted 3 lines
The count of 17 does not tell you much on the relative impact of the change.
So, before this patch,
COMMIT_LOG_LONG_LINEhad frequency of 1896 and after the patch, it becomes 1879 (over v5.6..v5.8). Should I add this information in commit message as well
And I repeat: "frequency" is the wrong word; this is NOT a frequency.
Just write:
There were 1896 COMMIT_LOG_LONG_LINE warnings in v5.6..v5.8 before this patch application and 1879 afterwards.
You are using the word frequency wrongly. It is probably best to just remove that word from your vocabulary for now.
Send a new patch with a corrected description and I will review.
Quoted 32 lines
Quoted 8 lines
Quoted 3 lines
A quick manual check found all the dropped warnings related to signature tags.
What did the quick manual check found?
Do you mean the quick manual check found all ... to be false positive that should not have been warned about?Yes, all the dropped warnings are prefixed by signature tags. Generated list:
https://github.com/AdityaSrivast/kernel-tasks/blob/master/random/signature_tags/dropped/summary.txtQuoted 19 lines
Other than that, it looks good.
Lukas
Quoted 15 lines
Signed-off-by Aditya Srivastava <[email protected]>--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/checkpatch.pl +0
-2@@ -2961,8 +2961,8 @@ sub process { # file delta changes $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || # filename then : - $line =~ /^\s*(?:Fixes:|Link:)/i || - # A Fixes: or Link: line
Quoted 9 lines
Quoted 8 lines
Quoted 8 lines
scripts/checkpatch.pl +2
-1+ $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || + # A Fixes: or Link: line or signature tag line $commit_log_possible_stack_dump)) { WARN("COMMIT_LOG_LONG_LINE", "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); --2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees