# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
# (c) 2010-2018 Joe Perches <joe@perches.com>
-# Based on linux/scripts/checkpatch.pl v6.10-rc2-g061d1af7b0 with
+# Based on linux/scripts/checkpatch.pl v6.13-rc3-g231825b2e1ff with
# some additional Lustre-specific checks.
use strict;
my %verbose_emitted = ();
my $tree = 0;
my $chk_signoff = 0;
+my $chk_fixes_tag = 1;
my $chk_patch = 1;
my $tst_only;
my $emacs = 0;
-v, --verbose verbose mode
--no-tree run without a kernel tree
--no-signoff do not check for 'Signed-off-by' line
+ --no-fixes-tag do not check for 'Fixes:' tag
--patch treat FILE as patchfile (default)
--emacs emacs compile window format
--terse one line per report
'v|verbose!' => \$verbose,
'tree!' => \$tree,
'signoff!' => \$chk_signoff,
+ 'fixes-tag!' => \$chk_fixes_tag,
'patch!' => \$chk_patch,
'emacs!' => \$emacs,
'terse!' => \$terse,
}
$chk_signoff = 0 if ($file);
+$chk_fixes_tag = 0 if ($file);
my @rawlines = ();
my @lines = ();
our $clean = 1;
my $signoff = 0;
+ my $fixes_tag = 0;
+ my $is_revert = 0;
+ my $needs_fixes_tag = "";
my $author = '';
my $authorsignoff = 0;
my $author_sob = '';
#handle man pages
if ($line =~ /^diff --git.*?(\S+\.[1-8])$/ ||
- $line =~ /^\+\+\+\s+(\S+\.[1-8])$/) {
- if ($manfile !~ $1) {
- $manfile = $1;
- local @ARGV = $manfile;
- system($^X, "contrib/scripts/checkpatch-man.pl", @ARGV);
- $found_file = 1;
+ $line =~ /^\+\+\+\s+(\S+\.[1-8])$/) {
+ if ($manfile !~ $1) {
+ $manfile = $1;
+ local @ARGV = $manfile;
+ system($^X, "contrib/scripts/checkpatch-man.pl", @ARGV);
+ $found_file = 1;
+ }
}
- }
#make up the handle for any error we report on this line
if ($showfile) {
$fixed[$fixlinenr] =
"$ucfirst_sign_off $email";
}
+
}
if (!defined $space_after || $space_after ne " ") {
if (WARN("BAD_SIGN_OFF",
}
}
+# These indicate a bug fix
+ if (!$in_header_lines && !$is_patch &&
+ $line =~ /^This reverts commit/) {
+ $is_revert = 1;
+ }
+
+ if (!$in_header_lines && !$is_patch &&
+ $line =~ /((?:(?:BUG: K.|UB)SAN: |Call Trace:|stable\@|syzkaller))/) {
+ $needs_fixes_tag = $1;
+ }
# Check Fixes: styles is correct
if (!$in_header_lines &&
- $line =~ /^\s*fixes:?\s*(?:commit\s*)?[0-9a-f]{5,}\b/i) {
- my $orig_commit = "";
- my $id = "0123456789ab";
- my $title = "commit title";
- my $tag_case = 1;
- my $tag_space = 1;
- my $id_length = 1;
- my $id_case = 1;
+ $line =~ /^\s*(fixes:?)\s*(?:commit\s*)?([0-9a-f]{5,40})(?:\s*($balanced_parens))?/i) {
+ my $tag = $1;
+ my $orig_commit = $2;
+ my $title;
my $title_has_quotes = 0;
-
- if ($line =~ /(\s*fixes:?)\s+([0-9a-f]{5,})\s+($balanced_parens)/i) {
- my $tag = $1;
- $orig_commit = $2;
- $title = $3;
-
- $tag_case = 0 if $tag eq "Fixes:";
- $tag_space = 0 if ($line =~ /^fixes:? [0-9a-f]{5,} ($balanced_parens)/i);
-
- $id_length = 0 if ($orig_commit =~ /^[0-9a-f]{12}$/i);
- $id_case = 0 if ($orig_commit !~ /[A-F]/);
-
+ $fixes_tag = 1;
+ if (defined $3) {
# Always strip leading/trailing parens then double quotes if existing
- $title = substr($title, 1, -1);
+ $title = substr($3, 1, -1);
if ($title =~ /^".*"$/) {
$title = substr($title, 1, -1);
$title_has_quotes = 1;
}
+ } else {
+ $title = "commit title"
}
+
+ my $tag_case = not ($tag eq "Fixes:");
+ my $tag_space = not ($line =~ /^fixes:? [0-9a-f]{5,40} ($balanced_parens)/i);
+
+ my $id_length = not ($orig_commit =~ /^[0-9a-f]{12}$/i);
+ my $id_case = not ($orig_commit !~ /[A-F]/);
+
+ my $id = "0123456789ab";
my ($cid, $ctitle) = git_commit_info($orig_commit, $id,
$title);
}
if ($msg_type ne "" &&
- (show_type("LONG_LINE") || show_type($msg_type))) {
+ show_type("LONG_LINE") && show_type($msg_type)) {
my $msg_level = \&WARN;
$msg_level = \&CHK if ($file);
&{$msg_level}($msg_type,
}
}
-# Block comment styles
-# Networking with an initial /*
- if ($realfile =~ m@^(drivers/net/|net/|lnet/)@ &&
- $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
- $rawline =~ /^\+[ \t]*\*/ &&
- $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
- WARN("NETWORKING_BLOCK_COMMENT_STYLE",
- "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
- }
-
# Block comments use * on subsequent lines
if ($prevline =~ /$;[ \t]*$/ && #ends in comment
$prevrawline =~ /^\+.*?\/\*/ && #starting /*
# ignore udelay's < 10, however
if (! ($delay < 10) ) {
CHK("USLEEP_RANGE",
- "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
+ "usleep_range is preferred over udelay; see function description of usleep_range() and udelay().\n" . $herecurr);
}
if ($delay > 2000) {
WARN("LONG_UDELAY",
- "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
+ "long udelay - prefer mdelay; see function description of mdelay().\n" . $herecurr);
}
}
if ($line =~ /\bmsleep\s*\((\d+)\);/) {
if ($1 < 20) {
WARN("MSLEEP",
- "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
+ "msleep < 20ms can sleep for up to 20ms; see function description of msleep().\n" . $herecurr);
}
}
my $max = $7;
if ($min eq $max) {
WARN("USLEEP_RANGE",
- "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
+ "usleep_range should not use min == max args; see function description of usleep_range().\n" . "$here\n$stat\n");
} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
$min > $max) {
WARN("USLEEP_RANGE",
- "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
+ "usleep_range args reversed, use min then max; see function description of usleep_range().\n" . "$here\n$stat\n");
}
}
ERROR("NOT_UNIFIED_DIFF",
"Does not appear to be a unified-diff format patch\n");
}
+ if ($is_patch && $has_commit_log && $chk_fixes_tag) {
+ if ($needs_fixes_tag ne "" && !$is_revert && !$fixes_tag) {
+ WARN("MISSING_FIXES_TAG",
+ "The commit message has '$needs_fixes_tag', perhaps it also needs a 'Fixes:' tag?\n");
+ }
+ }
if ($is_patch && $has_commit_log && $chk_signoff) {
if ($signoff == 0) {
ERROR("MISSING_SIGN_OFF",
-From 0a8f65a1f12b211cfb88c048a120daca7a2c2337 Mon Sep 17 00:00:00 2001
+From 9b8a6c6384cc6863cdda7f22deddad56ac20b451 Mon Sep 17 00:00:00 2001
From: Timothy Day <timday@amazon.com>
Date: Wed, 21 Feb 2024 18:35:37 +0000
Subject: [PATCH] LU-6142 contrib: Lustre checkpatch.pl
-v6.10-rc2-g061d1af7b0
+v6.13-rc3-g231825b2e1ff
Signed-off-by: Timothy Day <timday@amazon.com>
+Change-Id: I4df9cff42d7ce377bdd221f99e5e66f4ee4524ee
---
- contrib/scripts/checkpatch.pl | 140 +++++++++++++++++++++++++++-------
- 1 file changed, 112 insertions(+), 28 deletions(-)
+ contrib/scripts/checkpatch.pl | 151 ++++++++++++++++++++++++++++------
+ 1 file changed, 124 insertions(+), 27 deletions(-)
diff --git a/contrib/scripts/checkpatch.pl b/contrib/scripts/checkpatch.pl
-index 2b812210b4..a6c52d361c 100755
+index 9eed3683ad..139061fdbd 100755
--- a/contrib/scripts/checkpatch.pl
+++ b/contrib/scripts/checkpatch.pl
@@ -7,6 +7,9 @@
# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
# (c) 2010-2018 Joe Perches <joe@perches.com>
-+# Based on linux/scripts/checkpatch.pl v6.10-rc2-g061d1af7b0 with
++# Based on linux/scripts/checkpatch.pl v6.13-rc3-g231825b2e1ff with
+# some additional Lustre-specific checks.
+
use strict;
-my $chk_signoff = 1;
+my $tree = 0;
+my $chk_signoff = 0;
+ my $chk_fixes_tag = 1;
my $chk_patch = 1;
my $tst_only;
- my $emacs = 0;
-@@ -56,11 +59,12 @@ my %ignore_type = ();
+@@ -57,11 +60,12 @@ my %ignore_type = ();
my @ignore = ();
my $help = 0;
my $configuration_file = ".checkpatch.conf";
my $codespell = 0;
my $codespellfile = "/usr/share/codespell/dictionary.txt";
my $user_codespellfile = "";
-@@ -68,7 +72,7 @@ my $conststructsfile = "$D/const_structs.checkpatch";
+@@ -69,7 +73,7 @@ my $conststructsfile = "$D/const_structs.checkpatch";
my $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst";
my $typedefsfile;
my $color = "auto";
# git output parsing needs US English output, so first set backtick child process LANGUAGE
my $git_command ='export LANGUAGE=en_US.UTF-8; git';
my $tabsize = 8;
-@@ -596,9 +600,11 @@ our $logFunctions = qr{(?x:
+@@ -599,9 +603,12 @@ our $logFunctions = qr{(?x:
(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
TP_printk|
WARN(?:_RATELIMIT|_ONCE|)|
)};
our $allocFunctions = qr{(?x:
-@@ -977,6 +983,31 @@ if ($codespell) {
+@@ -980,6 +987,31 @@ if ($codespell) {
$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
sub read_words {
my ($wordsRef, $file) = @_;
-@@ -1974,6 +2005,7 @@ sub ctx_locate_comment {
+@@ -1978,6 +2010,7 @@ sub ctx_locate_comment {
for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
my $line = $rawlines[$linenr - 1];
#warn " $line\n";
if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
$in_comment = 1;
}
-@@ -2705,6 +2705,7 @@ sub process {
+@@ -2680,6 +2713,7 @@ sub process {
my $comment_edge = 0;
my $first_line = 0;
my $p1_prefix = '';
+ my $manfile = '';
-
+
my $prev_values = 'E';
-
-@@ -2905,6 +2906,17 @@ sub process {
+
+@@ -2880,6 +2914,17 @@ sub process {
$found_file = 1;
}
-
+
+#handle man pages
+ if ($line =~ /^diff --git.*?(\S+\.[1-8])$/ ||
+ $line =~ /^\+\+\+\s+(\S+\.[1-8])$/) {
#make up the handle for any error we report on this line
if ($showfile) {
$prefix = "$realfile:$realline: "
-@@ -3241,15 +3273,6 @@ sub process {
+@@ -3254,15 +3299,6 @@ sub process {
"A patch subject line should describe the change not the tool that found it\n" . $herecurr);
}
-# Check for Gerrit Change-Ids not in any patch context
- if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
- if (ERROR("GERRIT_CHANGE_ID",
-- "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
+- "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
- $fix) {
- fix_delete_line($fixlinenr, $rawline);
- }
# Check if the commit log is in a possible stack dump
if ($in_commit_log && !$commit_log_possible_stack_dump &&
($line =~ /^\s*(?:WARNING:|BUG:)/ ||
-@@ -3476,16 +3499,35 @@ sub process {
+@@ -3489,16 +3525,35 @@ sub process {
}
# Check for various typo / spelling mistakes
+ if (($realfile =~ m@^(lustre/utils/|lustre/tests/|lnet/utils/|libcfs/libcfs/util/)@) &&
+ defined($misspellings_user) && ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
+ while ($rawline =~ /(?:^|[^\w\-'`])($misspellings_user)(?:[^\w\-'`]|$)/g) {
- my $typo = $1;
- my $blank = copy_spacing($rawline);
- my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
- my $hereptr = "$hereline$ptr\n";
-- my $typo_fix = $spelling_fix{lc($typo)};
-- $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
-- $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
++ my $typo = $1;
++ my $blank = copy_spacing($rawline);
++ my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
++ my $hereptr = "$hereline$ptr\n";
+ my $typo_fix = $spelling_fix_user{$typo};
+ if (!defined($typo_fix)) {
+ $typo_fix = "CHECKPATCH ERROR";
+ }
+ } elsif (defined($misspellings) && ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
+ while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/g) {
-+ my $typo = $1;
-+ my $blank = copy_spacing($rawline);
-+ my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
-+ my $hereptr = "$hereline$ptr\n";
+ my $typo = $1;
+ my $blank = copy_spacing($rawline);
+ my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
+ my $hereptr = "$hereline$ptr\n";
+- my $typo_fix = $spelling_fix{lc($typo)};
+- $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
+- $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
+ my $typo_fix = $spelling_fix{$typo};
+ if (!defined($typo_fix)) {
+ $typo_fix = "CHECKPATCH ERROR";
my $msg_level = \&WARN;
$msg_level = \&CHK if ($file);
if (&{$msg_level}("TYPO_SPELLING",
-@@ -3829,6 +3871,11 @@ sub process {
+@@ -3842,6 +3897,11 @@ sub process {
length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
$msg_type = "";
# lines with only strings (w/ possible termination)
# #defines with only strings
} elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
-@@ -3999,7 +4046,7 @@ sub process {
-
- # Block comment styles
- # Networking with an initial /*
-- if ($realfile =~ m@^(drivers/net/|net/)@ &&
-+ if ($realfile =~ m@^(drivers/net/|net/|lnet/)@ &&
- $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
- $rawline =~ /^\+[ \t]*\*/ &&
- $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
-@@ -5609,6 +5656,8 @@ sub process {
+@@ -5612,6 +5672,8 @@ sub process {
# avoid cases like "foo + BAR < baz"
# only fix matches surrounded by parentheses to avoid incorrect
# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
if ($perl_version_ok &&
$line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
my $lead = $1;
-@@ -5618,6 +5667,7 @@ sub process {
+@@ -5621,6 +5683,7 @@ sub process {
my $newcomp = $comp;
if ($lead !~ /(?:$Operators|\.)\s*$/ &&
$to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
WARN("CONSTANT_COMPARISON",
"Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
$fix) {
-@@ -6231,6 +6281,47 @@ sub process {
+@@ -6234,6 +6297,47 @@ sub process {
}
}
# check for single line unbalanced braces
if ($sline =~ /^.\s*\}\s*else\s*$/ ||
$sline =~ /^.\s*else\s*\{\s*$/) {
-@@ -6913,13 +7004,6 @@ sub process {
+@@ -6916,13 +7020,6 @@ sub process {
$bad_specifier = $specifier;
last;
}
if ($bad_specifier ne "") {
my $stat_real = get_stat_real($linenr, $lc);
--
-2.27.0
+2.39.5
git://git.whamcloud.com / fs / lustre-release.git / commitdiff