checkpatch: add fix for non-standard signature - co-authored-by
diff mbox series

Message ID 20201202090828.12934-1-yashsri421@gmail.com
State New, archived
Headers show
Series
  • checkpatch: add fix for non-standard signature - co-authored-by
Related show

Commit Message

Aditya Srivastava Dec. 2, 2020, 9:08 a.m. UTC
Currently, checkpatch.pl warns for BAD_SIGN_OFF on the usage of
non-standard signatures.

An evaluation on v4.13..v5.8 showed that out of 539 warnings due to
non-standard signatures, 43 are due to the use of 'Co-authored-by'
tag, which may seem correct, but is not standard.

The standard signature equivalent for 'Co-authored-by' is
'Co-developed-by'.

Provide a fix by suggesting users with this signature alternative and
replacing.

Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
 scripts/checkpatch.pl | 3 +++
 1 file changed, 3 insertions(+)

Comments

Joe Perches Dec. 2, 2020, 5:16 p.m. UTC | #1
On Wed, 2020-12-02 at 14:38 +0530, Aditya Srivastava wrote:
> Currently, checkpatch.pl warns for BAD_SIGN_OFF on the usage of
> non-standard signatures.
> 
> An evaluation on v4.13..v5.8 showed that out of 539 warnings due to
> non-standard signatures, 43 are due to the use of 'Co-authored-by'
> tag, which may seem correct, but is not standard.
> 
> The standard signature equivalent for 'Co-authored-by' is
> 'Co-developed-by'.
> 
> Provide a fix by suggesting users with this signature alternative and
> replacing.

This doesn't apply to either today's linux or -next.

It is dependent on a patch that is only in Andrew Morton's mmots.
Your patch subject should show that in the brackets.
Something like:

[PATCH -mmots] checkpatch: etc...

Adding --fix options to the obvious spelling typos in these signature
by-lines tags are a different case but I think this is a relatively low
value patch as I don't believe these tags should be limited in this way.

Maybe Andrew likes it.

> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -2832,6 +2832,9 @@ sub process {
>  
> 
>  			if ($sign_off !~ /$signature_tags/) {
>  				my $suggested_signature = find_standard_signature($sign_off);
> +				if ($sign_off =~ /co-authored-by:/i) {
> +					$suggested_signature = "Co-developed-by:";
> +				}

Patch
diff mbox series

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 4a026926139f..fc036d545d2d 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2832,6 +2832,9 @@  sub process {
 
 			if ($sign_off !~ /$signature_tags/) {
 				my $suggested_signature = find_standard_signature($sign_off);
+				if ($sign_off =~ /co-authored-by:/i) {
+					$suggested_signature = "Co-developed-by:";
+				}
 				if ($suggested_signature eq "") {
 					WARN("BAD_SIGN_OFF",
 					     "Non-standard signature: $sign_off\n" . $herecurr);