iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

checkpatch: create an EXPERIMENTAL --fix option to correct patches

Browse Source 
Some patches have simple defects in whitespace and formatting that
checkpatch could correct automatically.  Attempt to do so.

Add a --fix option to create a "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
file that tries to use normal kernel style for some of these formatting
errors.

Add warnings against using this file without verifying the changes.

Signed-off-by: Joe Perches <joe@perches.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Joe Perches 2013-07-03 15:05:31 -07:00 committed by Linus Torvalds
parent 23f780c904
commit 3705ce5bcc
1 changed files with 354 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

440
scripts/checkpatch.pl
View File

@ -27,6 +27,7 @@ my $summary = 1;
my $mailback = 0; my $mailback = 0;
my $summary_file = 0; my $summary_file = 0;
my $show_types = 0; my $show_types = 0;
my $fix = 0;
my $root; my $root;
my %debug; my %debug;
my %ignore_type = (); my %ignore_type = ();
@ -63,6 +64,11 @@ Options:
is all off) is all off)
--test-only=WORD report only warnings/errors containing WORD --test-only=WORD report only warnings/errors containing WORD
literally literally
--fix EXPERIMENTAL - may create horrible results
If correctable single-line errors exist, create
"<inputfile>.EXPERIMENTAL-checkpatch-fixes"
with potential errors corrected to the preferred
checkpatch style
-h, --help, --version display this help and exit -h, --help, --version display this help and exit
When FILE is - read standard input. When FILE is - read standard input.
@ -114,7 +120,7 @@ GetOptions(
'summary!' => \$summary, 'summary!' => \$summary,
'mailback!' => \$mailback, 'mailback!' => \$mailback,
'summary-file!' => \$summary_file, 'summary-file!' => \$summary_file,
'fix!' => \$fix,
'debug=s' => \%debug, 'debug=s' => \%debug,
'test-only=s' => \$tst_only, 'test-only=s' => \$tst_only,
'h|help' => \$help, 'h|help' => \$help,
@ -367,6 +373,7 @@ $chk_signoff = 0 if ($file);
my @rawlines = (); my @rawlines = ();
my @lines = (); my @lines = ();
my @fixed = ();
my $vname; my $vname;
for my $filename (@ARGV) { for my $filename (@ARGV) {
my $FILE; my $FILE;
@ -394,6 +401,7 @@ for my $filename (@ARGV) {
} }
@rawlines = (); @rawlines = ();
@lines = (); @lines = ();
@fixed = ();
} }
exit($exit); exit($exit);
@ -434,7 +442,7 @@ sub parse_email {
$comment = $2 if defined $2; $comment = $2 if defined $2;
$formatted_email =~ s/$address.*$//; $formatted_email =~ s/$address.*$//;
$name = $formatted_email; $name = $formatted_email;
$name =~ s/^\s+|\s+$//g; $name = trim($name);
$name =~ s/^\"|\"$//g; $name =~ s/^\"|\"$//g;
# If there's a name left after stripping spaces and # If there's a name left after stripping spaces and
# leading quotes, and the address doesn't have both # leading quotes, and the address doesn't have both
@ -449,9 +457,9 @@ sub parse_email {
} }
} }
$name =~ s/^\s+|\s+$//g; $name = trim($name);
$name =~ s/^\"|\"$//g; $name =~ s/^\"|\"$//g;
$address =~ s/^\s+|\s+$//g; $address = trim($address);
$address =~ s/^\<|\>$//g; $address =~ s/^\<|\>$//g;
if ($name =~ /[^\w \-]/i) { ##has "must quote" chars if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
@ -467,9 +475,9 @@ sub format_email {
my $formatted_email; my $formatted_email;
$name =~ s/^\s+|\s+$//g; $name = trim($name);
$name =~ s/^\"|\"$//g; $name =~ s/^\"|\"$//g;
$address =~ s/^\s+|\s+$//g; $address = trim($address);
if ($name =~ /[^\w \-]/i) { ##has "must quote" chars if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
$name =~ s/(?<!\\)"/\\"/g; ##escape quotes $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
@ -1291,19 +1299,25 @@ sub ERROR {
if (report("ERROR", $_[0], $_[1])) { if (report("ERROR", $_[0], $_[1])) {
our $clean = 0; our $clean = 0;
our $cnt_error++; our $cnt_error++;
return 1;
} }
return 0;
} }
sub WARN { sub WARN {
if (report("WARNING", $_[0], $_[1])) { if (report("WARNING", $_[0], $_[1])) {
our $clean = 0; our $clean = 0;
our $cnt_warn++; our $cnt_warn++;
return 1;
} }
return 0;
} }
sub CHK { sub CHK {
if ($check && report("CHECK", $_[0], $_[1])) { if ($check && report("CHECK", $_[0], $_[1])) {
our $clean = 0; our $clean = 0;
our $cnt_chk++; our $cnt_chk++;
return 1;
} }
return 0;
} }
sub check_absolute_file { sub check_absolute_file {
@ -1334,6 +1348,29 @@ sub check_absolute_file {
} }
} }
sub trim {
my ($string) = @_;
$string =~ s/(^\s+|\s+$)//g;
return $string;
}
sub tabify {
my ($leading) = @_;
my $source_indent = 8;
my $max_spaces_before_tab = $source_indent - 1;
my $spaces_to_tab = " " x $source_indent;
#convert leading spaces to tabs
1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
#Remove spaces before a tab
1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
return "$leading";
}
sub pos_last_openparen { sub pos_last_openparen {
my ($line) = @_; my ($line) = @_;
@ -1425,6 +1462,8 @@ sub process {
$linenr++; $linenr++;
$line = $rawline; $line = $rawline;
push(@fixed, $rawline) if ($fix);
if ($rawline=~/^\+\+\+\s+(\S+)/) { if ($rawline=~/^\+\+\+\s+(\S+)/) {
$setup_docs = 0; $setup_docs = 0;
if ($1 =~ m@Documentation/kernel-parameters.txt$@) { if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
@ -1616,16 +1655,29 @@ sub process {
"Non-standard signature: $sign_off\n" . $herecurr); "Non-standard signature: $sign_off\n" . $herecurr);
} }
if (defined $space_before && $space_before ne "") { if (defined $space_before && $space_before ne "") {
WARN("BAD_SIGN_OFF", if (WARN("BAD_SIGN_OFF",
"Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =
"$ucfirst_sign_off $email";
}
} }
if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
WARN("BAD_SIGN_OFF", if (WARN("BAD_SIGN_OFF",
"'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =
"$ucfirst_sign_off $email";
}
} }
if (!defined $space_after || $space_after ne " ") { if (!defined $space_after || $space_after ne " ") {
WARN("BAD_SIGN_OFF", if (WARN("BAD_SIGN_OFF",
"Use a single space after $ucfirst_sign_off\n" . $herecurr); "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =
"$ucfirst_sign_off $email";
}
} }
my ($email_name, $email_address, $comment) = parse_email($email); my ($email_name, $email_address, $comment) = parse_email($email);
@ -1715,8 +1767,12 @@ sub process {
} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
my $herevet = "$here\n" . cat_vet($rawline) . "\n"; my $herevet = "$here\n" . cat_vet($rawline) . "\n";
ERROR("TRAILING_WHITESPACE", if (ERROR("TRAILING_WHITESPACE",
"trailing whitespace\n" . $herevet); "trailing whitespace\n" . $herevet) &&
$fix) {
$fixed[$linenr - 1] =~ s/^(\+.*?)\s+$/$1/;
}
$rpt_cleaners = 1; $rpt_cleaners = 1;
} }
@ -1811,8 +1867,12 @@ sub process {
# check for spaces before a quoted newline # check for spaces before a quoted newline
if ($rawline =~ /^.*\".*\s\\n/) { if ($rawline =~ /^.*\".*\s\\n/) {
WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
"unnecessary whitespace before a quoted newline\n" . $herecurr); "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
}
} }
# check for adding lines without a newline. # check for adding lines without a newline.
@ -1843,16 +1903,23 @@ sub process {
if ($rawline =~ /^\+\s* \t\s*\S/ || if ($rawline =~ /^\+\s* \t\s*\S/ ||
$rawline =~ /^\+\s* \s*/) { $rawline =~ /^\+\s* \s*/) {
my $herevet = "$here\n" . cat_vet($rawline) . "\n"; my $herevet = "$here\n" . cat_vet($rawline) . "\n";
ERROR("CODE_INDENT",
"code indent should use tabs where possible\n" . $herevet);
$rpt_cleaners = 1; $rpt_cleaners = 1;
if (ERROR("CODE_INDENT",
"code indent should use tabs where possible\n" . $herevet) &&
$fix) {
$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
}
} }
# check for space before tabs. # check for space before tabs.
if ($rawline =~ /^\+/ && $rawline =~ / \t/) { if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
my $herevet = "$here\n" . cat_vet($rawline) . "\n"; my $herevet = "$here\n" . cat_vet($rawline) . "\n";
WARN("SPACE_BEFORE_TAB", if (WARN("SPACE_BEFORE_TAB",
"please, no space before tabs\n" . $herevet); "please, no space before tabs\n" . $herevet) &&
$fix) {
$fixed[$linenr - 1] =~
s/(^\+.*) +\t/$1\t/;
}
} }
# check for && or || at the start of a line # check for && or || at the start of a line
@ -1880,15 +1947,24 @@ sub process {
if ($newindent ne $goodtabindent && if ($newindent ne $goodtabindent &&
$newindent ne $goodspaceindent) { $newindent ne $goodspaceindent) {
CHK("PARENTHESIS_ALIGNMENT",
"Alignment should match open parenthesis\n" . $hereprev); if (CHK("PARENTHESIS_ALIGNMENT",
"Alignment should match open parenthesis\n" . $hereprev) &&
$fix && $line =~ /^\+/) {
$fixed[$linenr - 1] =~
s/^\+[ \t]*/\+$goodtabindent/;
}
} }
} }
} }
if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
CHK("SPACING", if (CHK("SPACING",
"No space is necessary after a cast\n" . $hereprev); "No space is necessary after a cast\n" . $hereprev) &&
$fix) {
$fixed[$linenr - 1] =~
s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
}
} }
if ($realfile =~ m@^(drivers/net/|net/)@ && if ($realfile =~ m@^(drivers/net/|net/)@ &&
@ -1920,10 +1996,13 @@ sub process {
# 1) within comments # 1) within comments
# 2) indented preprocessor commands # 2) indented preprocessor commands
# 3) hanging labels # 3) hanging labels
if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
my $herevet = "$here\n" . cat_vet($rawline) . "\n"; my $herevet = "$here\n" . cat_vet($rawline) . "\n";
WARN("LEADING_SPACE", if (WARN("LEADING_SPACE",
"please, no spaces at the start of a line\n" . $herevet); "please, no spaces at the start of a line\n" . $herevet) &&
$fix) {
$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
}
} }
# check we are in a valid C source file if not then ignore this hunk # check we are in a valid C source file if not then ignore this hunk
@ -2213,7 +2292,7 @@ sub process {
$prev_values = substr($curr_values, -1); $prev_values = substr($curr_values, -1);
#ignore lines not being added #ignore lines not being added
if ($line=~/^[^\+]/) {next;} next if ($line =~ /^[^\+]/);
# TEST: allow direct testing of the type matcher. # TEST: allow direct testing of the type matcher.
if ($dbg_type) { if ($dbg_type) {
@ -2264,8 +2343,15 @@ sub process {
# no C99 // comments # no C99 // comments
if ($line =~ m{//}) { if ($line =~ m{//}) {
ERROR("C99_COMMENTS", if (ERROR("C99_COMMENTS",
"do not use C99 // comments\n" . $herecurr); "do not use C99 // comments\n" . $herecurr) &&
$fix) {
my $line = $fixed[$linenr - 1];
if ($line =~ /\/\/(.*)$/) {
my $comment = trim($1);
$fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
}
}
} }
# Remove C99 comments. # Remove C99 comments.
$line =~ s@//.*@@; $line =~ s@//.*@@;
@ -2364,7 +2450,7 @@ sub process {
# (char*[ const]) # (char*[ const])
while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
#print "AA<$1>\n"; #print "AA<$1>\n";
my ($from, $to) = ($2, $2); my ($ident, $from, $to) = ($1, $2, $2);
# Should start with a space. # Should start with a space.
$to =~ s/^(\S)/ $1/; $to =~ s/^(\S)/ $1/;
@ -2374,15 +2460,22 @@ sub process {
while ($to =~ s/\*\s+\*/\*\*/) { while ($to =~ s/\*\s+\*/\*\*/) {
} }
#print "from<$from> to<$to>\n"; ## print "1: from<$from> to<$to> ident<$ident>\n";
if ($from ne $to) { if ($from ne $to) {
ERROR("POINTER_LOCATION", if (ERROR("POINTER_LOCATION",
"\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
$fix) {
my $sub_from = $ident;
my $sub_to = $ident;
$sub_to =~ s/\Q$from\E/$to/;
$fixed[$linenr - 1] =~
s@\Q$sub_from\E@$sub_to@;
}
} }
} }
while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
#print "BB<$1>\n"; #print "BB<$1>\n";
my ($from, $to, $ident) = ($2, $2, $3); my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
# Should start with a space. # Should start with a space.
$to =~ s/^(\S)/ $1/; $to =~ s/^(\S)/ $1/;
@ -2394,10 +2487,18 @@ sub process {
# Modifiers should have spaces. # Modifiers should have spaces.
$to =~ s/(\b$Modifier$)/$1 /; $to =~ s/(\b$Modifier$)/$1 /;
#print "from<$from> to<$to> ident<$ident>\n"; ## print "2: from<$from> to<$to> ident<$ident>\n";
if ($from ne $to && $ident !~ /^$Modifier$/) { if ($from ne $to && $ident !~ /^$Modifier$/) {
ERROR("POINTER_LOCATION", if (ERROR("POINTER_LOCATION",
"\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
$fix) {
my $sub_from = $match;
my $sub_to = $match;
$sub_to =~ s/\Q$from\E/$to/;
$fixed[$linenr - 1] =~
s@\Q$sub_from\E@$sub_to@;
}
} }
} }
@ -2483,9 +2584,13 @@ sub process {
} }
# missing space after union, struct or enum definition # missing space after union, struct or enum definition
if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
WARN("SPACING", if (WARN("SPACING",
"missing space after $1 definition\n" . $herecurr); "missing space after $1 definition\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
}
} }
# check for spacing round square brackets; allowed: # check for spacing round square brackets; allowed:
@ -2497,8 +2602,12 @@ sub process {
if ($prefix !~ /$Type\s+$/ && if ($prefix !~ /$Type\s+$/ &&
($where != 0 || $prefix !~ /^.\s+$/) && ($where != 0 || $prefix !~ /^.\s+$/) &&
$prefix !~ /[{,]\s+$/) { $prefix !~ /[{,]\s+$/) {
ERROR("BRACKET_SPACE", if (ERROR("BRACKET_SPACE",
"space prohibited before open square bracket '['\n" . $herecurr); "space prohibited before open square bracket '['\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/^(\+.*?)\s+\[/$1\[/;
}
} }
} }
@ -2515,7 +2624,6 @@ sub process {
__attribute__|format|__extension__| __attribute__|format|__extension__|
asm|__asm__)$/x) asm|__asm__)$/x)
{ {
# cpp #define statements have non-optional spaces, ie # cpp #define statements have non-optional spaces, ie
# if there is a space between the name and the open # if there is a space between the name and the open
# parenthesis it is simply not a parameter group. # parenthesis it is simply not a parameter group.
@ -2529,19 +2637,30 @@ sub process {
} elsif ($ctx =~ /$Type$/) { } elsif ($ctx =~ /$Type$/) {
} else { } else {
WARN("SPACING", if (WARN("SPACING",
"space prohibited between function name and open parenthesis '('\n" . $herecurr); "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/\b$name\s+\(/$name\(/;
}
} }
} }
# check for whitespace before a non-naked semicolon # check for whitespace before a non-naked semicolon
if ($line =~ /^\+.*\S\s+;/) { if ($line =~ /^\+.*\S\s+;/) {
WARN("SPACING", if (WARN("SPACING",
"space prohibited before semicolon\n" . $herecurr); "space prohibited before semicolon\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/^(\+.*\S)\s+;/$1;/;
}
} }
# Check operator spacing. # Check operator spacing.
if (!($line=~/\#\s*include/)) { if (!($line=~/\#\s*include/)) {
my $fixed_line = "";
my $line_fixed = 0;
my $ops = qr{ my $ops = qr{
<<=|>>=|<=|>=|==|!=| <<=|>>=|<=|>=|==|!=|
\+=|-=|\*=|\/=|%=|\^=|\|=|&=| \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
@ -2550,11 +2669,30 @@ sub process {
\?|: \?|:
}x; }x;
my @elements = split(/($ops|;)/, $opline); my @elements = split(/($ops|;)/, $opline);
## print("element count: <" . $#elements . ">\n");
## foreach my $el (@elements) {
## print("el: <$el>\n");
## }
my @fix_elements = ();
my $off = 0; my $off = 0;
foreach my $el (@elements) {
push(@fix_elements, substr($rawline, $off, length($el)));
$off += length($el);
}
$off = 0;
my $blank = copy_spacing($opline); my $blank = copy_spacing($opline);
for (my $n = 0; $n < $#elements; $n += 2) { for (my $n = 0; $n < $#elements; $n += 2) {
my $good = $fix_elements[$n] . $fix_elements[$n + 1];
## print("n: <$n> good: <$good>\n");
$off += length($elements[$n]); $off += length($elements[$n]);
# Pick up the preceding and succeeding characters. # Pick up the preceding and succeeding characters.
@ -2611,8 +2749,11 @@ sub process {
} elsif ($op eq ';') { } elsif ($op eq ';') {
if ($ctx !~ /.x[WEBC]/ && if ($ctx !~ /.x[WEBC]/ &&
$cc !~ /^\\/ && $cc !~ /^;/) { $cc !~ /^\\/ && $cc !~ /^;/) {
ERROR("SPACING", if (ERROR("SPACING",
"space required after that '$op' $at\n" . $hereptr); "space required after that '$op' $at\n" . $hereptr)) {
$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
$line_fixed = 1;
}
} }
# // is a comment # // is a comment
@ -2623,15 +2764,24 @@ sub process {
# : when part of a bitfield # : when part of a bitfield
} elsif ($op eq '->' || $opv eq ':B') { } elsif ($op eq '->' || $opv eq ':B') {
if ($ctx =~ /Wx.|.xW/) { if ($ctx =~ /Wx.|.xW/) {
ERROR("SPACING", if (ERROR("SPACING",
"spaces prohibited around that '$op' $at\n" . $hereptr); "spaces prohibited around that '$op' $at\n" . $hereptr)) {
$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
$line_fixed = 1;
if (defined $fix_elements[$n + 2]) {
$fix_elements[$n + 2] =~ s/^\s+//;
}
}
} }
# , must have a space on the right. # , must have a space on the right.
} elsif ($op eq ',') { } elsif ($op eq ',') {
if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
ERROR("SPACING", if (ERROR("SPACING",
"space required after that '$op' $at\n" . $hereptr); "space required after that '$op' $at\n" . $hereptr)) {
$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
$line_fixed = 1;
}
} }
# '*' as part of a type definition -- reported already. # '*' as part of a type definition -- reported already.
@ -2645,33 +2795,57 @@ sub process {
$opv eq '*U' || $opv eq '-U' || $opv eq '*U' || $opv eq '-U' ||
$opv eq '&U' || $opv eq '&&U') { $opv eq '&U' || $opv eq '&&U') {
if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
ERROR("SPACING", if (ERROR("SPACING",
"space required before that '$op' $at\n" . $hereptr); "space required before that '$op' $at\n" . $hereptr)) {
$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
$line_fixed = 1;
}
} }
if ($op eq '*' && $cc =~/\s*$Modifier\b/) { if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
# A unary '*' may be const # A unary '*' may be const
} elsif ($ctx =~ /.xW/) { } elsif ($ctx =~ /.xW/) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited after that '$op' $at\n" . $hereptr); "space prohibited after that '$op' $at\n" . $hereptr)) {
$fixed_line =~ s/\s+$//;
$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
$line_fixed = 1;
if (defined $fix_elements[$n + 2]) {
$fix_elements[$n + 2] =~ s/^\s+//;
}
}
} }
# unary ++ and unary -- are allowed no space on one side. # unary ++ and unary -- are allowed no space on one side.
} elsif ($op eq '++' or $op eq '--') { } elsif ($op eq '++' or $op eq '--') {
if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
ERROR("SPACING", if (ERROR("SPACING",
"space required one side of that '$op' $at\n" . $hereptr); "space required one side of that '$op' $at\n" . $hereptr)) {
$fixed_line =~ s/\s+$//;
$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
$line_fixed = 1;
}
} }
if ($ctx =~ /Wx[BE]/ || if ($ctx =~ /Wx[BE]/ ||
($ctx =~ /Wx./ && $cc =~ /^;/)) { ($ctx =~ /Wx./ && $cc =~ /^;/)) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited before that '$op' $at\n" . $hereptr); "space prohibited before that '$op' $at\n" . $hereptr)) {
$fixed_line =~ s/\s+$//;
$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
$line_fixed = 1;
}
} }
if ($ctx =~ /ExW/) { if ($ctx =~ /ExW/) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited after that '$op' $at\n" . $hereptr); "space prohibited after that '$op' $at\n" . $hereptr)) {
$fixed_line =~ s/\s+$//;
$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
$line_fixed = 1;
if (defined $fix_elements[$n + 2]) {
$fix_elements[$n + 2] =~ s/^\s+//;
}
}
} }
# << and >> may either have or not have spaces both sides # << and >> may either have or not have spaces both sides
} elsif ($op eq '<<' or $op eq '>>' or } elsif ($op eq '<<' or $op eq '>>' or
@ -2681,17 +2855,23 @@ sub process {
$op eq '%') $op eq '%')
{ {
if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
ERROR("SPACING", if (ERROR("SPACING",
"need consistent spacing around '$op' $at\n" . "need consistent spacing around '$op' $at\n" . $hereptr)) {
$hereptr); $fixed_line =~ s/\s+$//;
$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
$line_fixed = 1;
}
} }
# A colon needs no spaces before when it is # A colon needs no spaces before when it is
# terminating a case value or a label. # terminating a case value or a label.
} elsif ($opv eq ':C' || $opv eq ':L') { } elsif ($opv eq ':C' || $opv eq ':L') {
if ($ctx =~ /Wx./) { if ($ctx =~ /Wx./) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited before that '$op' $at\n" . $hereptr); "space prohibited before that '$op' $at\n" . $hereptr)) {
$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
$line_fixed = 1;
}
} }
# All the others need spaces both sides. # All the others need spaces both sides.
@ -2714,12 +2894,30 @@ sub process {
} }
if ($ok == 0) { if ($ok == 0) {
ERROR("SPACING", if (ERROR("SPACING",
"spaces required around that '$op' $at\n" . $hereptr); "spaces required around that '$op' $at\n" . $hereptr)) {
$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
$good = $fix_elements[$n] . " " . trim($fix_elements[$n + 1]) . " ";
$line_fixed = 1;
}
} }
} }
$off += length($elements[$n + 1]); $off += length($elements[$n + 1]);
## print("n: <$n> GOOD: <$good>\n");
$fixed_line = $fixed_line . $good;
} }
if (($#elements % 2) == 0) {
$fixed_line = $fixed_line . $fix_elements[$#elements];
}
if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
$fixed[$linenr - 1] = $fixed_line;
}
} }
# check for multiple assignments # check for multiple assignments
@ -2747,8 +2945,12 @@ sub process {
#need space before brace following if, while, etc #need space before brace following if, while, etc
if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
$line =~ /do{/) { $line =~ /do{/) {
ERROR("SPACING", if (ERROR("SPACING",
"space required before the open brace '{'\n" . $herecurr); "space required before the open brace '{'\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/^(\+.*(?:do|\))){/$1 {/;
}
} }
## # check for blank lines before declarations ## # check for blank lines before declarations
@ -2768,32 +2970,52 @@ sub process {
# check spacing on square brackets # check spacing on square brackets
if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited after that open square bracket '['\n" . $herecurr); "space prohibited after that open square bracket '['\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/\[\s+/\[/;
}
} }
if ($line =~ /\s\]/) { if ($line =~ /\s\]/) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited before that close square bracket ']'\n" . $herecurr); "space prohibited before that close square bracket ']'\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/\s+\]/\]/;
}
} }
# check spacing on parentheses # check spacing on parentheses
if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
$line !~ /for\s*\(\s+;/) { $line !~ /for\s*\(\s+;/) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited after that open parenthesis '('\n" . $herecurr); "space prohibited after that open parenthesis '('\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/\(\s+/\(/;
}
} }
if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
$line !~ /for\s*\(.*;\s+\)/ && $line !~ /for\s*\(.*;\s+\)/ &&
$line !~ /:\s+\)/) { $line !~ /:\s+\)/) {
ERROR("SPACING", if (ERROR("SPACING",
"space prohibited before that close parenthesis ')'\n" . $herecurr); "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/\s+\)/\)/;
}
} }
#goto labels aren't indented, allow a single space however #goto labels aren't indented, allow a single space however
if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
!($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
WARN("INDENTED_LABEL", if (WARN("INDENTED_LABEL",
"labels should not be indented\n" . $herecurr); "labels should not be indented\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/^(.)\s+/$1/;
}
} }
# Return is not a function. # Return is not a function.
@ -2831,7 +3053,12 @@ sub process {
# Need a space before open parenthesis after if, while etc # Need a space before open parenthesis after if, while etc
if ($line =~ /\b(if|while|for|switch)\(/) { if ($line =~ /\b(if|while|for|switch)\(/) {
ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); if (ERROR("SPACING",
"space required before the open parenthesis '('\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/\b(if|while|for|switch)\(/$1 \(/;
}
} }
# Check for illegal assignment in if conditional -- and check for trailing # Check for illegal assignment in if conditional -- and check for trailing
@ -3329,8 +3556,13 @@ sub process {
# warn about spacing in #ifdefs # warn about spacing in #ifdefs
if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
ERROR("SPACING", if (ERROR("SPACING",
"exactly one space required after that #$1\n" . $herecurr); "exactly one space required after that #$1\n" . $herecurr) &&
$fix) {
$fixed[$linenr - 1] =~
s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
}
} }
# check for spinlock_t definitions without a comment. # check for spinlock_t definitions without a comment.
@ -3793,6 +4025,40 @@ sub process {
print "\n\n"; print "\n\n";
} }
if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
my $linecount = 0;
my $f;
open($f, '>', $newfile)
or die "$P: Can't open $newfile for write\n";
foreach my $fixed_line (@fixed) {
$linecount++;
if ($file) {
if ($linecount > 3) {
$fixed_line =~ s/^\+//;
print $f $fixed_line. "\n";
}
} else {
print $f $fixed_line . "\n";
}
}
close($f);
if (!$quiet) {
print << "EOM";
Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
Do _NOT_ trust the results written to this file.
Do _NOT_ submit these changes without inspecting them for correctness.
This EXPERIMENTAL file is simply a convenience to help rewrite patches.
No warranties, expressed or implied...
EOM
}
}
if ($clean == 1 && $quiet == 0) { if ($clean == 1 && $quiet == 0) {
print "$vname has no obvious style problems and is ready for submission.\n" print "$vname has no obvious style problems and is ready for submission.\n"
} }