checkpatch: Recognise "Debugged-by" tags

Message ID 20231024111714.1814510-1-mpe@ellerman.id.au
State New
Headers
Series checkpatch: Recognise "Debugged-by" tags |

Commit Message

Michael Ellerman Oct. 24, 2023, 11:17 a.m. UTC
  Currently checkpatch complains about "Debugged-by:" tags:

  WARNING: Non-standard signature: Debugged-by:
  #33:
  Debugged-by: Jane Doe <jane@doe.com>

There are over 150 Debugged-by tags already in the history, so
checkpatch should allow them.

Additionally checkpatch will now catch small typos, eg:

  WARNING: Non-standard signature: 'Debuged-by:' - perhaps 'Debugged-by:'?
  #17:
    Debuged-by: Jane Doe <jane@doe.com>

Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
---
 scripts/checkpatch.pl | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
  

Comments

Joe Perches Oct. 24, 2023, 2:14 p.m. UTC | #1
On Tue, 2023-10-24 at 22:17 +1100, Michael Ellerman wrote:
> Currently checkpatch complains about "Debugged-by:" tags:
> 
>   WARNING: Non-standard signature: Debugged-by:
>   #33:
>   Debugged-by: Jane Doe <jane@doe.com>
> 
> There are over 150 Debugged-by tags already in the history, so
> checkpatch should allow them.

nack.

Please do not use checkpatch to change process.
Update the process docs then update checkpatch.
  

Patch

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 7d16f863edf1..31774351bae1 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -618,6 +618,7 @@  our $signature_tags = qr{(?xi:
 	Reviewed-by:|
 	Reported-by:|
 	Suggested-by:|
+	Debugged-by:|
 	To:|
 	Cc:
 )};
@@ -711,7 +712,7 @@  sub find_standard_signature {
 	my ($sign_off) = @_;
 	my @standard_signature_tags = (
 		'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
-		'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
+		'Reviewed-by:', 'Reported-by:', 'Suggested-by:', 'Debugged-by:'
 	);
 	foreach my $signature (@standard_signature_tags) {
 		return $signature if (get_edit_distance($sign_off, $signature) <= 2);