checkpatch: Flag suspicious attribution lines
PATCH v2 1/1 checkpatch: Flag suspicious attribution lines
Flag commit attribution tags that are unusual (often because they were a typo), but only as a warning (because sometimes a humorous or otherwise useful tag is intentionally supplied).
This picks the 6-most popular tags, each with 700 or more uses (well, S-o-b was already checked for case-sensitivity and typos, leaving only 5 new tags being checked), as determined by:
$ git log | sed -n 's/^ *\([A-Za-z-]*-by:\).*/\1/p' | \ sort | uniq -c | sort -k1,1n | tail
Most of the rejected lines were obvious typos (among others, we've had 4 cases of someone being burnt, based on Singed-off-by; and 2 cases of list-reading via an e-reader, based on eviewed-by; there are also lines forgetting a space after the ':') or otherwise tongue-in-check (3 Approximately-suggested-by). A few lines not whitelisted here may be legitimate, but as they are orders of magnitude rarer, it is therefore not worth worrying about (7 Requested-by, 3 Co-authored-by, 1 Inspired-by, etc.).
---
v2: fix regex
scripts/checkpatch.pl | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
scripts/checkpatch.pl +5 -1
@@ -1456,7 +1456,7 @@ sub process { ERROR("Author email address is mangled by the mailing list\n" . $herecurr); } -#check the patch for a signoff: +#check the patch for a signoff, and that other attribution lines are typical: if ($line =~ /^\s*signed-off-by:/i) { # This is a signoff, if ugly, so do not double report. $signoff++;
@@ -1470,6 +1470,10 @@ sub process { ERROR("space required after Signed-off-by:\n" . $herecurr); } + } elsif($line =~ /^\s*([A-Za-z-]*)-by:/ && + ($1 !~ /(Suggest|Report|Test|Ack|Review)ed/ || + $line !~ /^\s*[a-z-]*-by:\s/i)) { + WARN("suspicious attribution tag:\n" . $herecurr); } # Check if MAINTAINERS is being updated. If so, there's probably no need to
Signature · 1 line
2.20.1
Quoted 10 lines · Eric Blake
Flag commit attribution tags that are unusual (often because they were a typo), but only as a warning (because sometimes a humorous or otherwise useful tag is intentionally supplied).
This picks the 6-most popular tags, each with 700 or more uses (well, S-o-b was already checked for case-sensitivity and typos, leaving only 5 new tags being checked), as determined by:
$ git log | sed -n 's/^ *\([A-Za-z-]*-by:\).*/\1/p' | \ sort | uniq -c | sort -k1,1n | tail
Quoted 8 lines
Most of the rejected lines were obvious typos (among others, we've had 4 cases of someone being burnt, based on Singed-off-by; and 2 cases of list-reading via an e-reader, based on eviewed-by; there are also lines forgetting a space after the ':') or otherwise tongue-in-check (3 Approximately-suggested-by). A few lines not whitelisted here may be legitimate, but as they are orders of magnitude rarer, it is therefore not worth worrying about (7 Requested-by, 3 Co-authored-by, 1 Inspired-by, etc.).
'Inspired-by' is kinda Zen :) And is from Peter!
Quoted 22 lines
Signed-off-by Eric Blake <[email protected]>---
v2: fix regex
scripts/checkpatch.pl | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)scripts/checkpatch.pl +1
-1@@ -1456,7 +1456,7 @@ sub process { ERROR("Author email address is mangled by the mailing list\n" . $herecurr); } -#check the patch for a signoff: +#check the patch for a signoff, and that other attribution lines are typical: if ($line =~ /^\s*signed-off-by:/i) { # This is a signoff, if ugly, so do not double report. $signoff++;
scripts/checkpatch.pl sub process { · line 1473
Quoted 4 lines
scripts/checkpatch.pl +1
-0@@ -1470,6 +1470,10 @@ sub process { ERROR("space required after Signed-off-by:\n" . $herecurr); } + } elsif($line =~ /^\s*([A-Za-z-]*)-by:/ &&
I guess we don't mind about angry typewriters who Ack-BY ;)
scripts/checkpatch.pl sub process { · line 1475
Quoted 2 lines
scripts/checkpatch.pl +2
-0+ ($1 !~ /(Suggest|Report|Test|Ack|Review)ed/ || + $line !~ /^\s*[a-z-]*-by:\s/i)) {
Quoted 5 lines
scripts/checkpatch.pl +1
-0+ WARN("suspicious attribution tag:\n" . $herecurr); } # Check if MAINTAINERS is being updated. If so, there's probably no need to
Quoted 10 lines · Philippe Mathieu-Daudé
Quoted 9 lines · Eric Blake
Flag commit attribution tags that are unusual (often because they were a typo), but only as a warning (because sometimes a humorous or otherwise useful tag is intentionally supplied).
This picks the 6-most popular tags, each with 700 or more uses (well, S-o-b was already checked for case-sensitivity and typos, leaving only 5 new tags being checked), as determined by:
$ git log | sed -n 's/^ *\([A-Za-z-]*-by:\).*/\1/p' | \ sort | uniq -c | sort -k1,1n | tail
Use of [bB][yY] finds a few more interesting spellings...
Quoted 9 lines
Quoted 9 lines
Most of the rejected lines were obvious typos (among others, we've had 4 cases of someone being burnt, based on Singed-off-by; and 2 cases of list-reading via an e-reader, based on eviewed-by; there are also lines forgetting a space after the ':') or otherwise tongue-in-check (3 Approximately-suggested-by). A few lines not whitelisted here may be legitimate, but as they are orders of magnitude rarer, it is therefore not worth worrying about (7 Requested-by, 3 Co-authored-by, 1 Inspired-by, etc.).
Among others, 48 Reviewed-By.
Quoted 7 lines
scripts/checkpatch.pl sub process { · line 1473
Quoted 5 lines
scripts/checkpatch.pl +1
-0@@ -1470,6 +1470,10 @@ sub process { ERROR("space required after Signed-off-by:\n" . $herecurr); } + } elsif($line =~ /^\s*([A-Za-z-]*)-by:/ &&I guess we don't mind about angry typewriters who Ack-BY ;)
I can send a v3 that makes this line case-insensitive,
Quoted 3 lines
scripts/checkpatch.pl sub process { · line 1475
Quoted 3 lines
scripts/checkpatch.pl +2
-0+ ($1 !~ /(Suggest|Report|Test|Ack|Review)ed/ || + $line !~ /^\s*[a-z-]*-by:\s/i)) {
although making this line require lower-case '-by' gets a bit trickier.
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Quoted 11 lines · On Tue, 5 Feb 2019 00:29:14 +0100 Philippe Mathieu-Daudé <[email protected]>…
Quoted 10 lines · Eric Blake
Flag commit attribution tags that are unusual (often because they were a typo), but only as a warning (because sometimes a humorous or otherwise useful tag is intentionally supplied).
This picks the 6-most popular tags, each with 700 or more uses (well, S-o-b was already checked for case-sensitivity and typos, leaving only 5 new tags being checked), as determined by:
$ git log | sed -n 's/^ *\([A-Za-z-]*-by:\).*/\1/p' | \ sort | uniq -c | sort -k1,1n | tail
Quoted 8 lines
Quoted 8 lines
Most of the rejected lines were obvious typos (among others, we've had 4 cases of someone being burnt, based on Singed-off-by; and 2 cases of list-reading via an e-reader, based on eviewed-by; there are also lines forgetting a space after the ':') or otherwise tongue-in-check (3 Approximately-suggested-by). A few lines not whitelisted here may be legitimate, but as they are orders of magnitude rarer, it is therefore not worth worrying about (7 Requested-by, 3 Co-authored-by, 1 Inspired-by, etc.).
Hm, wasn't Co-authored-by: actually intended to cover the cases where someone else did write significant parts of the patch? (I cannot point to the source without searching, though...)
Quoted 2 lines
'Inspired-by' is kinda Zen :) And is from Peter!
I also like that one :)