checkpatch: fix multiple const * types
PATCH 1/4 checkpatch: fix multiple const * types
Commit 1574a29f8e76 ("checkpatch: allow multiple const * types") claims to support repetition of pattern "const *", but it actually allows only one extra instance.
Check the following lines
int a(char const * const x[]); int b(char const * const *x); int c(char const * const * const x[]); int d(char const * const * const *x); with command ./scripts/checkpatch.pl --show-types -f filename
to find that only the first line passes the test, while a warning is triggered by the other 3 lines:
WARNING:FUNCTION_ARGUMENTS: function definition argument 'char const * const' should also have an identifier name
The reason is that the pattern match halts at the second asterisk in the line, thus the remaining text starting with asterisk fails to match a valid name for a variable.
Fixed by replacing "?" (Match 1 or 0 times) with "*" (Match 0 or more times) in the regular expression.
Fix also the similar test for types in unusual order.
--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +2 -2
@@ -802,12 +802,12 @@ sub build_types { }x; $Type = qr{ $NonptrType - (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? + (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)* (?:\s+$Inline|\s+$Modifier)* }x; $TypeMisordered = qr{ $NonptrTypeMisordered - (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? + (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)* (?:\s+$Inline|\s+$Modifier)* }x; $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Signature · 1 line
2.21.0
PATCH 2/4 checkpatch: add --fix for warning LINE_CONTINUATIONS
The warning LINE_CONTINUATIONS does not offer a --fix.
Add the trivial --fix.
In case of consecutive lines with the same issue, this will fix only the first line.
--- scripts/checkpatch.pl | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +5 -2
@@ -5207,8 +5207,11 @@ sub process { $line !~ /^\+\s*\#.*\\$/ && # preprocessor $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm $line =~ /^\+.*\\$/) { - WARN("LINE_CONTINUATIONS", - "Avoid unnecessary line continuations\n" . $herecurr); + if (WARN("LINE_CONTINUATIONS", + "Avoid unnecessary line continuations\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\s*\\$//; + } } }
Signature · 1 line
2.21.0
Joe Perches
maintainerRe: [PATCH 2/4] checkpatch: add --fix for warning LINE_CONTINUATIONS
Quoted 5 lines · Antonio Borneo
The warning
LINE_CONTINUATIONSdoes not offer a --fix.Add the trivial --fix.
In case of consecutive lines with the same issue, this will fix only the first line.
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0
[]
scripts/checkpatch.pl sub process { · line 5211
Quoted 8 lines
scripts/checkpatch.pl +2
-2@@ -5207,8 +5207,11 @@ sub process { $line !~ /^\+\s*\#.*\\$/ && # preprocessor $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm $line =~ /^\+.*\\$/) { - WARN("LINE_CONTINUATIONS", - "Avoid unnecessary line continuations\n" . $herecurr); + if (WARN("LINE_CONTINUATIONS", + "Avoid unnecessary line continuations\n" . $herecurr) &&
I prefer to not apply this.
Problem here is that these should generally be fixed by hand as the automated fix isn't very good style either.
Quoted 6 lines
scripts/checkpatch.pl +3
-0+ $fix) { + $fixed[$fixlinenr] =~ s/\s*\\$//; + } } }
PATCH 3/4 checkpatch: fix minor typo and mixed space+tab in indentation
In reply to Antonio BorneoFix spelling of "concatenation".
Don't use tab after space in indentation.
--- scripts/checkpatch.pl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
scripts/checkpatch.pl +4 -4
@@ -4546,7 +4546,7 @@ sub process { ($op eq '>' && $ca =~ /<\S+\@\S+$/)) { - $ok = 1; + $ok = 1; } # for asm volatile statements
@@ -4881,7 +4881,7 @@ sub process { # conditional. substr($s, 0, length($c), ''); $s =~ s/\n.*//g; - $s =~ s/$;//g; # Remove any comments + $s =~ s/$;//g; # Remove any comments if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && $c !~ /}\s*while\s*/) {
@@ -4920,7 +4920,7 @@ sub process { # if and else should not have general statements after it if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { my $s = $1; - $s =~ s/$;//g; # Remove any comments + $s =~ s/$;//g; # Remove any comments if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { ERROR("TRAILING_STATEMENTS", "trailing statements should be on next line\n" . $herecurr);
@@ -5095,7 +5095,7 @@ sub process { { } - # Flatten any obvious string concatentation. + # Flatten any obvious string concatenation. while ($dstat =~ s/($String)\s*$Ident/$1/ || $dstat =~ s/$Ident\s*($String)/$1/) {
Signature · 1 line
2.21.0
PATCH v2 1/1 checkpatch: fix minor typo and mixed space+tab in indentation
Fix spelling of "concatenation".
Don't use tab after space in indentation.
---
v1 -> v2
rebased
--- scripts/checkpatch.pl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
scripts/checkpatch.pl +4 -4
@@ -4582,7 +4582,7 @@ sub process { ($op eq '>' && $ca =~ /<\S+\@\S+$/)) { - $ok = 1; + $ok = 1; } # for asm volatile statements
@@ -4917,7 +4917,7 @@ sub process { # conditional. substr($s, 0, length($c), ''); $s =~ s/\n.*//g; - $s =~ s/$;//g; # Remove any comments + $s =~ s/$;//g; # Remove any comments if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && $c !~ /}\s*while\s*/) {
@@ -4956,7 +4956,7 @@ sub process { # if and else should not have general statements after it if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { my $s = $1; - $s =~ s/$;//g; # Remove any comments + $s =~ s/$;//g; # Remove any comments if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { ERROR("TRAILING_STATEMENTS", "trailing statements should be on next line\n" . $herecurr);
@@ -5132,7 +5132,7 @@ sub process { { } - # Flatten any obvious string concatentation. + # Flatten any obvious string concatenation. while ($dstat =~ s/($String)\s*$Ident/$1/ || $dstat =~ s/$Ident\s*($String)/$1/) {
Signature · 1 line
2.25.0
Joe Perches
maintainerRe: [PATCH V2] checkpatch: fix minor typo and mixed space+tab in indentation
Quoted 4 lines · Antonio Borneo
Fix spelling of "concatenation".
Don't use tab after space in indentation.Signed-off-by Antonio Borneo <[email protected]>
I've no objection to any of these 3 patches.
Andrew, might you pick them up please?
https://lore.kernel.org/patchwork/patch/1183806/
https://lore.kernel.org/patchwork/patch/1183805/
https://lore.kernel.org/patchwork/patch/1183804/
Quoted 49 lines
---
v1 -> v2
rebased--- scripts/checkpatch.pl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)scripts/checkpatch.pl +4
-4@@ -4582,7 +4582,7 @@ sub process { ($op eq '>' && $ca =~ /<\S+\@\S+$/)) { - $ok = 1; + $ok = 1; } # for asm volatile statements@@ -4917,7 +4917,7 @@ sub process { # conditional. substr($s, 0, length($c), ''); $s =~ s/\n.*//g; - $s =~ s/$;//g; # Remove any comments + $s =~ s/$;//g; # Remove any comments if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && $c !~ /}\s*while\s*/) {@@ -4956,7 +4956,7 @@ sub process { # if and else should not have general statements after it if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { my $s = $1; - $s =~ s/$;//g; # Remove any comments + $s =~ s/$;//g; # Remove any comments if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { ERROR("TRAILING_STATEMENTS", "trailing statements should be on next line\n" . $herecurr);@@ -5132,7 +5132,7 @@ sub process { { } - # Flatten any obvious string concatentation. + # Flatten any obvious string concatenation. while ($dstat =~ s/($String)\s*$Ident/$1/ || $dstat =~ s/$Ident\s*($String)/$1/) {
PATCH 4/4 checkpatch: replace magic value for TAB size
In reply to Antonio BorneoThe size of 8 characters used for both TAB and indentation is embedded as magic value allover the checkpatch script, and this makes the script less readable.
Replace the magic value 8 with the perl variable "$tabsize". From the context of the code it's clear if it is used for indentation or tabulation, so no need to use two separate variables.
As side benefit of this change, it makes easy to replace the TAB size when this script is used by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
In these cases the script will be probably modified and adapted, so there is no need (at least for the moment) to expose this setting on the script's command line.
[1] http://openocd.org/
[2] http://openocd.org/doc/doxygen/html/stylec.html#styleformat
--- scripts/checkpatch.pl | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-)
scripts/checkpatch.pl +11 -10
@@ -62,6 +62,7 @@ my $conststructsfile = "$D/const_structs.checkpatch"; my $typedefsfile = ""; my $color = "auto"; my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE +my $tabsize = 8; sub help { my ($exitcode) = @_;
@@ -1211,7 +1212,7 @@ sub expand_tabs { if ($c eq "\t") { $res .= ' '; $n++; - for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) { $res .= ' '; } next;
@@ -2224,7 +2225,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1; my $spaces_to_tab = " " x $source_indent;
@@ -3153,7 +3154,7 @@ sub process { next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); # at the beginning of a line any tabs must come first and anything -# more than 8 must use tabs. +# more than $tabsize must use tabs. if ($rawline =~ /^\+\s* \t\s*\S/ || $rawline =~ /^\+\s* \s*/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";
@@ -3172,7 +3173,7 @@ sub process { "please, no space before tabs\n" . $herevet) && $fix) { while ($fixed[$fixlinenr] =~ - s/(^\+.*) {8,8}\t/$1\t\t/) {} + s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} while ($fixed[$fixlinenr] =~ s/(^\+.*) +\t/$1\t/) {} }
@@ -3194,11 +3195,11 @@ sub process { if ($perl_version_ok && $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { my $indent = length($1); - if ($indent % 8) { + if ($indent % $tabsize) { if (WARN("TABSTOP", "Statements should start on a tabstop\n" . $herecurr) && $fix) { - $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; + $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; } } }
@@ -3216,8 +3217,8 @@ sub process { my $newindent = $2; my $goodtabindent = $oldindent . - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize); my $goodspaceindent = $oldindent . " " x $pos; if ($newindent ne $goodtabindent &&
@@ -3688,11 +3689,11 @@ sub process { #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; if ($check && $s ne '' && - (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 || ($sindent < $indent) || ($sindent == $indent && ($s !~ /^\s*(?:\}|\{|else\b)/)) || - ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) { WARN("SUSPECT_CODE_INDENT", "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); }
Signature · 1 line
2.21.0
Joe Perches
maintainerRe: [PATCH 4/4] checkpatch: replace magic value for TAB size
Quoted 9 lines · Antonio Borneo
The size of 8 characters used for both TAB and indentation is embedded as magic value allover the checkpatch script, and this makes the script less readable.
Replace the magic value 8 with the perl variable "$tabsize". From the context of the code it's clear if it is used for indentation or tabulation, so no need to use two separate variables.
Quoted 7 lines
As side benefit of this change, it makes easy to replace the TAB size when this script is used by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
In these cases the script will be probably modified and adapted, so there is no need (at least for the moment) to expose this setting on the script's command line.
Disagree. Probably getter to add a --tabsize=<foo> option now.
Re: [PATCH 4/4] checkpatch: replace magic value for TAB size
On Wed, May 8, 2019 at 4:52 PM Joe Perches <[email protected]> wrote:
...
Quoted 5 lines
Quoted 3 lines
In these cases the script will be probably modified and adapted, so there is no need (at least for the moment) to expose this setting on the script's command line.
Disagree. Probably getter to add a --tabsize=<foo> option now.
Ok, will send a V2 including the command line option. Exposing TAB size, makes the option name relevant; should I keep "--tabsize" or is "--tab-stop" more appropriate?
Antonio
Joe Perches
maintainerRe: [PATCH 4/4] checkpatch: replace magic value for TAB size
Quoted 11 lines · Antonio Borneo
On Wed, May 8, 2019 at 4:52 PM Joe Perches <[email protected]> wrote:
...Quoted 5 lines
Quoted 3 lines
In these cases the script will be probably modified and adapted, so there is no need (at least for the moment) to expose this setting on the script's command line.
Disagree. Probably getter to add a --tabsize=<foo> option now.
Ok, will send a V2 including the command line option. Exposing TAB size, makes the option name relevant; should I keep "--tabsize" or is "--tab-stop" more appropriate?
--tabsize is probably more appropriate as tab stops are not always a multiple of a single number.
Unless you really want to get funky and support something like --tab-stops=7,13,17,...
I don't suggest that.
PATCH v6 1/1 checkpatch: add command-line option for TAB size
In reply to Antonio BorneoLinux kernel coding style requires a size of 8 characters for both TAB and indentation, and such value is embedded as magic value allover the checkpatch script.
This makes hard to reuse the script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
Replace the magic value 8 with a variable.
Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
[1] http://openocd.org/
[2] http://openocd.org/doc/doxygen/html/stylec.html#styleformat
---
v1 -> v2
add the command line option
v2 -> v3
rewrite commit msg to remove script readability issue
v3 -> v4
check for command line value positive
v4 -> v5
exclude --tab-size=1
v5 -> v6
rebased
--- scripts/checkpatch.pl | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-)
scripts/checkpatch.pl +16 -10
@@ -64,6 +64,7 @@ my $color = "auto"; my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE # 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; sub help { my ($exitcode) = @_;
@@ -98,6 +99,7 @@ Options: --show-types show the specific message type in the output --max-line-length=n set the maximum line length, if exceeded, warn --min-conf-desc-length=n set the min description length, if shorter, warn + --tab-size=n set the number of spaces for tab (default 8) --root=PATH PATH to the kernel tree root --no-summary suppress the per-file summary --mailback only produce a report in case of warnings/errors
@@ -215,6 +217,7 @@ GetOptions( 'list-types!' => \$list_types, 'max-line-length=i' => \$max_line_length, 'min-conf-desc-length=i' => \$min_conf_desc_length, + 'tab-size=i' => \$tabsize, 'root=s' => \$root, 'summary!' => \$summary, 'mailback!' => \$mailback,
@@ -267,6 +270,9 @@ if ($color =~ /^[01]$/) { die "Invalid color mode: $color\n"; } +# skip TAB size 1 to avoid additional checks on $tabsize - 1 +die "Invalid TAB size: $tabsize\n" if ($tabsize < 2); + sub hash_save_array_words { my ($hashRef, $arrayRef) = @_;
@@ -1217,7 +1223,7 @@ sub expand_tabs { if ($c eq "\t") { $res .= ' '; $n++; - for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) { $res .= ' '; } next;
@@ -2230,7 +2236,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1; my $spaces_to_tab = " " x $source_indent;
@@ -3198,7 +3204,7 @@ sub process { next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); # at the beginning of a line any tabs must come first and anything -# more than 8 must use tabs. +# more than $tabsize must use tabs. if ($rawline =~ /^\+\s* \t\s*\S/ || $rawline =~ /^\+\s* \s*/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";
@@ -3217,7 +3223,7 @@ sub process { "please, no space before tabs\n" . $herevet) && $fix) { while ($fixed[$fixlinenr] =~ - s/(^\+.*) {8,8}\t/$1\t\t/) {} + s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} while ($fixed[$fixlinenr] =~ s/(^\+.*) +\t/$1\t/) {} }
@@ -3239,11 +3245,11 @@ sub process { if ($perl_version_ok && $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { my $indent = length($1); - if ($indent % 8) { + if ($indent % $tabsize) { if (WARN("TABSTOP", "Statements should start on a tabstop\n" . $herecurr) && $fix) { - $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; + $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; } } }
@@ -3261,8 +3267,8 @@ sub process { my $newindent = $2; my $goodtabindent = $oldindent . - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize); my $goodspaceindent = $oldindent . " " x $pos; if ($newindent ne $goodtabindent &&
@@ -3733,11 +3739,11 @@ sub process { #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; if ($check && $s ne '' && - (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 || ($sindent < $indent) || ($sindent == $indent && ($s !~ /^\s*(?:\}|\{|else\b)/)) || - ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) { WARN("SUSPECT_CODE_INDENT", "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); }
Signature · 1 line
2.25.0
Joe Perches
maintainerQuoted 18 lines · Antonio Borneo
Commit
1574a29f8e76("checkpatch: allow multiple const * types") claims to support repetition of pattern "const *", but it actually allows only one extra instance.
Check the following linesint a(char const * const x[]); int b(char const * const *x); int c(char const * const * const x[]); int d(char const * const * const *x); with command ./scripts/checkpatch.pl --show-types -f filenameto find that only the first line passes the test, while a warning is triggered by the other 3 lines:
WARNING:FUNCTION_ARGUMENTS: function definition argument 'char const * const' should also have an identifier name
The reason is that the pattern match halts at the second asterisk in the line, thus the remaining text starting with asterisk fails to match a valid name for a variable.
Quoted 3 lines
Fixed by replacing "?" (Match 1 or 0 times) with "*" (Match 0 or more times) in the regular expression.
Fix also the similar test for types in unusual order.
It might be better to use a max match like {0,4} instead of *
perl is pretty memory intensive at multiple unrestricted matches of somewhat complex patterns.
On Wed, May 8, 2019 at 4:51 PM Joe Perches <[email protected]> wrote:
...
Quoted 4 lines
It might be better to use a max match like {0,4} instead of *
perl is pretty memory intensive at multiple unrestricted matches of somewhat complex patterns.
Agree! Will send a V2!
Thanks for the review!
Antonio
PATCH v3 1/1 checkpatch: fix multiple const * types
In reply to Antonio BorneoCommit 1574a29f8e76 ("checkpatch: allow multiple const * types") claims to support repetition of pattern "const *", but it actually allows only one extra instance.
Check the following lines
int a(char const * const x[]); int b(char const * const *x); int c(char const * const * const x[]); int d(char const * const * const *x); with command ./scripts/checkpatch.pl --show-types -f filename
to find that only the first line passes the test, while a warning is triggered by the other 3 lines:
WARNING:FUNCTION_ARGUMENTS: function definition argument 'char const * const' should also have an identifier name
The reason is that the pattern match halts at the second asterisk in the line, thus the remaining text starting with asterisk fails to match a valid name for a variable.
Fixed by replacing "?" (Match 1 or 0 times) with "{0,4}" (Match no more than 4 times) in the regular expression.
Fix also the similar test for types in unusual order.
---
V1->V2
use a max match {0,4} instead of *, to limit the memory used by perl
V2->V3
rebased
--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +2 -2
@@ -804,12 +804,12 @@ sub build_types { }x; $Type = qr{ $NonptrType - (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? + (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} (?:\s+$Inline|\s+$Modifier)* }x; $TypeMisordered = qr{ $NonptrTypeMisordered - (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? + (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} (?:\s+$Inline|\s+$Modifier)* }x; $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Signature · 1 line
2.25.0
PATCH v2 1/1 checkpatch: fix multiple const * types
Commit 1574a29f8e76 ("checkpatch: allow multiple const * types") claims to support repetition of pattern "const *", but it actually allows only one extra instance.
Check the following lines
int a(char const * const x[]); int b(char const * const *x); int c(char const * const * const x[]); int d(char const * const * const *x); with command ./scripts/checkpatch.pl --show-types -f filename
to find that only the first line passes the test, while a warning is triggered by the other 3 lines:
WARNING:FUNCTION_ARGUMENTS: function definition argument 'char const * const' should also have an identifier name
The reason is that the pattern match halts at the second asterisk in the line, thus the remaining text starting with asterisk fails to match a valid name for a variable.
Fixed by replacing "?" (Match 1 or 0 times) with "{0,4}" (Match no more than 4 times) in the regular expression.
Fix also the similar test for types in unusual order.
---v1->v2
use a max match {0,4} instead of *, to limit the memory used by perl
scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +2 -2
@@ -802,12 +802,12 @@ sub build_types { }x; $Type = qr{ $NonptrType - (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? + (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} (?:\s+$Inline|\s+$Modifier)* }x; $TypeMisordered = qr{ $NonptrTypeMisordered - (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)? + (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} (?:\s+$Inline|\s+$Modifier)* }x; $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Signature · 1 line
2.21.0
Hi Joe,
can this series be queued for merge ?
I just found I mess-up the mail thread references, so here are the latest versions:
[1/4 V2] https://lore.kernel.org/lkml/[email protected]/
[2/4] dropped
[3/4] https://lore.kernel.org/lkml/[email protected]/
[4/4 V5] https://lore.kernel.org/lkml/[email protected]/
Thanks,
Antonio
PATCH v2 1/1 checkpatch: add command-line option for TAB size
The size of 8 characters used for both TAB and indentation is embedded as magic value allover the checkpatch script, and this makes the script less readable.
Replace the magic value 8 with a variable.
From the context of the code it's clear if it is used for indentation or tabulation, so no need to use two separate variables.
Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
This makes easy to reuse this script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
[1] http://openocd.org/
[2] http://openocd.org/doc/doxygen/html/stylec.html#styleformat
---
V1 -> V2
add the command line option
scripts/checkpatch.pl | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-)
scripts/checkpatch.pl +13 -10
@@ -62,6 +62,7 @@ my $conststructsfile = "$D/const_structs.checkpatch"; my $typedefsfile = ""; my $color = "auto"; my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE +my $tabsize = 8; sub help { my ($exitcode) = @_;
@@ -96,6 +97,7 @@ Options: --show-types show the specific message type in the output --max-line-length=n set the maximum line length, if exceeded, warn --min-conf-desc-length=n set the min description length, if shorter, warn + --tab-size=n set the number of spaces for tab (default 8) --root=PATH PATH to the kernel tree root --no-summary suppress the per-file summary --mailback only produce a report in case of warnings/errors
@@ -213,6 +215,7 @@ GetOptions( 'list-types!' => \$list_types, 'max-line-length=i' => \$max_line_length, 'min-conf-desc-length=i' => \$min_conf_desc_length, + 'tab-size=i' => \$tabsize, 'root=s' => \$root, 'summary!' => \$summary, 'mailback!' => \$mailback,
@@ -1211,7 +1214,7 @@ sub expand_tabs { if ($c eq "\t") { $res .= ' '; $n++; - for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) { $res .= ' '; } next;
@@ -2224,7 +2227,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1; my $spaces_to_tab = " " x $source_indent;
@@ -3153,7 +3156,7 @@ sub process { next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); # at the beginning of a line any tabs must come first and anything -# more than 8 must use tabs. +# more than $tabsize must use tabs. if ($rawline =~ /^\+\s* \t\s*\S/ || $rawline =~ /^\+\s* \s*/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";
@@ -3172,7 +3175,7 @@ sub process { "please, no space before tabs\n" . $herevet) && $fix) { while ($fixed[$fixlinenr] =~ - s/(^\+.*) {8,8}\t/$1\t\t/) {} + s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} while ($fixed[$fixlinenr] =~ s/(^\+.*) +\t/$1\t/) {} }
@@ -3194,11 +3197,11 @@ sub process { if ($perl_version_ok && $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { my $indent = length($1); - if ($indent % 8) { + if ($indent % $tabsize) { if (WARN("TABSTOP", "Statements should start on a tabstop\n" . $herecurr) && $fix) { - $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; + $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; } } }
@@ -3216,8 +3219,8 @@ sub process { my $newindent = $2; my $goodtabindent = $oldindent . - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize); my $goodspaceindent = $oldindent . " " x $pos; if ($newindent ne $goodtabindent &&
@@ -3688,11 +3691,11 @@ sub process { #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; if ($check && $s ne '' && - (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 || ($sindent < $indent) || ($sindent == $indent && ($s !~ /^\s*(?:\}|\{|else\b)/)) || - ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) { WARN("SUSPECT_CODE_INDENT", "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); }
Signature · 1 line
2.21.0
Joe Perches
maintainerRe: [PATCH v2] checkpatch: add command-line option for TAB size
Quoted 3 lines · Antonio Borneo
The size of 8 characters used for both TAB and indentation is embedded as magic value allover the checkpatch script, and this makes the script less readable.
I doubt this bit of the commit message is proper.
Tabs _are_ 8 in the linux-kernel sources and checkpatch was written for the linux-kernel.
Using a variable _could_ reasonably be described as an improvement, but readability wasn't and isn't really an issue here.
Other than that, the patch seems fine.
thanks, Joe
Quoted 127 lines
Replace the magic value 8 with a variable.
From the context of the code it's clear if it is used for indentation or tabulation, so no need to use two separate variables.Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
This makes easy to reuse this script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).[1] http://openocd.org/
[2] http://openocd.org/doc/doxygen/html/stylec.html#styleformatSigned-off-by Antonio Borneo <[email protected]>Signed-off-by Erik Ahlén <[email protected]>Signed-off-by Spencer Oliver <[email protected]>---
V1 -> V2
add the command line optionscripts/checkpatch.pl | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-)scripts/checkpatch.pl +13
-10@@ -62,6 +62,7 @@ my $conststructsfile = "$D/const_structs.checkpatch"; my $typedefsfile = ""; my $color = "auto"; my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE +my $tabsize = 8; sub help { my ($exitcode) = @_;@@ -96,6 +97,7 @@ Options: --show-types show the specific message type in the output --max-line-length=n set the maximum line length, if exceeded, warn --min-conf-desc-length=n set the min description length, if shorter, warn + --tab-size=n set the number of spaces for tab (default 8) --root=PATH PATH to the kernel tree root --no-summary suppress the per-file summary --mailback only produce a report in case of warnings/errors@@ -213,6 +215,7 @@ GetOptions( 'list-types!' => \$list_types, 'max-line-length=i' => \$max_line_length, 'min-conf-desc-length=i' => \$min_conf_desc_length, + 'tab-size=i' => \$tabsize, 'root=s' => \$root, 'summary!' => \$summary, 'mailback!' => \$mailback,@@ -1211,7 +1214,7 @@ sub expand_tabs { if ($c eq "\t") { $res .= ' '; $n++; - for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) { $res .= ' '; } next;@@ -2224,7 +2227,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1; my $spaces_to_tab = " " x $source_indent;@@ -3153,7 +3156,7 @@ sub process { next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); # at the beginning of a line any tabs must come first and anything -# more than 8 must use tabs. +# more than $tabsize must use tabs. if ($rawline =~ /^\+\s* \t\s*\S/ || $rawline =~ /^\+\s* \s*/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";@@ -3172,7 +3175,7 @@ sub process { "please, no space before tabs\n" . $herevet) && $fix) { while ($fixed[$fixlinenr] =~ - s/(^\+.*) {8,8}\t/$1\t\t/) {} + s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} while ($fixed[$fixlinenr] =~ s/(^\+.*) +\t/$1\t/) {} }@@ -3194,11 +3197,11 @@ sub process { if ($perl_version_ok && $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { my $indent = length($1); - if ($indent % 8) { + if ($indent % $tabsize) { if (WARN("TABSTOP", "Statements should start on a tabstop\n" . $herecurr) && $fix) { - $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; + $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; } } }@@ -3216,8 +3219,8 @@ sub process { my $newindent = $2; my $goodtabindent = $oldindent . - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize); my $goodspaceindent = $oldindent . " " x $pos; if ($newindent ne $goodtabindent &&@@ -3688,11 +3691,11 @@ sub process { #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; if ($check && $s ne '' && - (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 || ($sindent < $indent) || ($sindent == $indent && ($s !~ /^\s*(?:\}|\{|else\b)/)) || - ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) { WARN("SUSPECT_CODE_INDENT", "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); }
Re: [PATCH v2] checkpatch: add command-line option for TAB size
Quoted 6 lines · Joe Perches
Quoted 3 lines · Antonio Borneo
The size of 8 characters used for both TAB and indentation is embedded as magic value allover the checkpatch script, and this makes the script less readable.
Quoted 8 lines
I doubt this bit of the commit message is proper.
Tabs _are_ 8 in the linux-kernel sources and checkpatch was written for the linux-kernel.
Using a variable _could_ reasonably be described as an improvement, but readability wasn't and isn't really an issue here.
Well, it depends on own skill with regular expressions in perl :-)
I will change the commit message focusing on the new command line flag and drop this part.
Thanks
Antonio
RE: [PATCH v2] checkpatch: add command-line option for TAB size
In reply to Antonio BorneoQuoted 7 lines
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Antonio Borneo
Sent: Wednesday, May 8, 2019 12:44 PM
Subject: [PATCH v2] checkpatch: add command-line option for TAB size
...
Quoted 5 lines
Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
This makes easy to reuse this script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
...
Quoted 1 line
+ --tab-size=n set the number of spaces for tab (default 8)
...
Quoted 1 line
scripts/checkpatch.pl +1
-0+ 'tab-size=i' => \$tabsize,
...
Quoted 2 lines
scripts/checkpatch.pl +1
-1- for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) {
...
Quoted 6 lines
scripts/checkpatch.pl +3
-3- if ($indent % 8) { + if ($indent % $tabsize) { - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize);
...
Quoted 2 lines
scripts/checkpatch.pl +1
-1- (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 ||
...
scripts/checkpatch.pl sub process { · line 3698
Quoted 2 lines
scripts/checkpatch.pl +1
-1- ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) {
Checking for 0 before using the value in division and modulo operations would be prudent.
Joe Perches
maintainerRe: [PATCH v2] checkpatch: add command-line option for TAB size
Quoted 26 lines · Robert (Servers)
Quoted 5 lines
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Antonio Borneo
Sent: Wednesday, May 8, 2019 12:44 PM
Subject: [PATCH v2] checkpatch: add command-line option for TAB size...
Quoted 5 lines
Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
This makes easy to reuse this script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2])....
Quoted 1 line
+ --tab-size=n set the number of spaces for tab (default 8)
...
Quoted 1 line
scripts/checkpatch.pl +1
-0+ 'tab-size=i' => \$tabsize,...
Quoted 2 lines
scripts/checkpatch.pl +1
-1- for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) {...
Quoted 6 lines
scripts/checkpatch.pl +3
-3- if ($indent % 8) { + if ($indent % $tabsize) { - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize);...
Quoted 8 lines
Quoted 2 lines
scripts/checkpatch.pl +1
-1- (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 ||...
scripts/checkpatch.pl sub process { · line 3698
Quoted 2 lines
scripts/checkpatch.pl +1
-1- ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) {Checking for 0 before using the value in division and modulo operations would be prudent.
true.
Maybe test $tabsize for <= 0 after GetOptions and error out if so.
Re: [PATCH v2] checkpatch: add command-line option for TAB size
In reply to Elliott, Robert (Servers)On Wed, May 8, 2019 at 11:14 PM Elliott, Robert (Servers) <[email protected]> wrote:
...
Quoted 2 lines
Checking for 0 before using the value in division and modulo operations would be prudent.
True!
From command line, $tabsize is parsed as integer so I should sort out any non-positive value.
Will add a check after GetOptions(...)
die "Invalid TAB size: $tabsize\n" if ($tabsize <= 0);
PATCH v3 1/1 checkpatch: add command-line option for TAB size
Linux kernel coding style requires a size of 8 characters for both TAB and indentation, and such value is embedded as magic value allover the checkpatch script.
This makes hard to reuse the script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
Replace the magic value 8 with a variable.
Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
[1] http://openocd.org/
[2] http://openocd.org/doc/doxygen/html/stylec.html#styleformat
---
v1 -> v2
add the command line option
v2 -> v3
rewrite commit msg to remove script readability issue
scripts/checkpatch.pl | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-)
scripts/checkpatch.pl +13 -10
@@ -62,6 +62,7 @@ my $conststructsfile = "$D/const_structs.checkpatch"; my $typedefsfile = ""; my $color = "auto"; my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE +my $tabsize = 8; sub help { my ($exitcode) = @_;
@@ -96,6 +97,7 @@ Options: --show-types show the specific message type in the output --max-line-length=n set the maximum line length, if exceeded, warn --min-conf-desc-length=n set the min description length, if shorter, warn + --tab-size=n set the number of spaces for tab (default 8) --root=PATH PATH to the kernel tree root --no-summary suppress the per-file summary --mailback only produce a report in case of warnings/errors
@@ -213,6 +215,7 @@ GetOptions( 'list-types!' => \$list_types, 'max-line-length=i' => \$max_line_length, 'min-conf-desc-length=i' => \$min_conf_desc_length, + 'tab-size=i' => \$tabsize, 'root=s' => \$root, 'summary!' => \$summary, 'mailback!' => \$mailback,
@@ -1211,7 +1214,7 @@ sub expand_tabs { if ($c eq "\t") { $res .= ' '; $n++; - for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) { $res .= ' '; } next;
@@ -2224,7 +2227,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1; my $spaces_to_tab = " " x $source_indent;
@@ -3153,7 +3156,7 @@ sub process { next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); # at the beginning of a line any tabs must come first and anything -# more than 8 must use tabs. +# more than $tabsize must use tabs. if ($rawline =~ /^\+\s* \t\s*\S/ || $rawline =~ /^\+\s* \s*/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";
@@ -3172,7 +3175,7 @@ sub process { "please, no space before tabs\n" . $herevet) && $fix) { while ($fixed[$fixlinenr] =~ - s/(^\+.*) {8,8}\t/$1\t\t/) {} + s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} while ($fixed[$fixlinenr] =~ s/(^\+.*) +\t/$1\t/) {} }
@@ -3194,11 +3197,11 @@ sub process { if ($perl_version_ok && $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { my $indent = length($1); - if ($indent % 8) { + if ($indent % $tabsize) { if (WARN("TABSTOP", "Statements should start on a tabstop\n" . $herecurr) && $fix) { - $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; + $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; } } }
@@ -3216,8 +3219,8 @@ sub process { my $newindent = $2; my $goodtabindent = $oldindent . - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize); my $goodspaceindent = $oldindent . " " x $pos; if ($newindent ne $goodtabindent &&
@@ -3688,11 +3691,11 @@ sub process { #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; if ($check && $s ne '' && - (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 || ($sindent < $indent) || ($sindent == $indent && ($s !~ /^\s*(?:\}|\{|else\b)/)) || - ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) { WARN("SUSPECT_CODE_INDENT", "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); }
Signature · 1 line
2.21.0
PATCH v4 1/1 checkpatch: add command-line option for TAB size
Linux kernel coding style requires a size of 8 characters for both TAB and indentation, and such value is embedded as magic value allover the checkpatch script.
This makes hard to reuse the script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
Replace the magic value 8 with a variable.
Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
[1] http://openocd.org/
[2] http://openocd.org/doc/doxygen/html/stylec.html#styleformat
---
v1 -> v2
add the command line option
v2 -> v3
rewrite commit msg to remove script readability issue
v3 -> v4
check for command line value positive
--- scripts/checkpatch.pl | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-)
scripts/checkpatch.pl +15 -10
@@ -62,6 +62,7 @@ my $conststructsfile = "$D/const_structs.checkpatch"; my $typedefsfile = ""; my $color = "auto"; my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE +my $tabsize = 8; sub help { my ($exitcode) = @_;
@@ -96,6 +97,7 @@ Options: --show-types show the specific message type in the output --max-line-length=n set the maximum line length, if exceeded, warn --min-conf-desc-length=n set the min description length, if shorter, warn + --tab-size=n set the number of spaces for tab (default 8) --root=PATH PATH to the kernel tree root --no-summary suppress the per-file summary --mailback only produce a report in case of warnings/errors
@@ -213,6 +215,7 @@ GetOptions( 'list-types!' => \$list_types, 'max-line-length=i' => \$max_line_length, 'min-conf-desc-length=i' => \$min_conf_desc_length, + 'tab-size=i' => \$tabsize, 'root=s' => \$root, 'summary!' => \$summary, 'mailback!' => \$mailback,
@@ -265,6 +268,8 @@ if ($color =~ /^[01]$/) { die "Invalid color mode: $color\n"; } +die "Invalid TAB size: $tabsize\n" if ($tabsize <= 0); + sub hash_save_array_words { my ($hashRef, $arrayRef) = @_;
@@ -1211,7 +1216,7 @@ sub expand_tabs { if ($c eq "\t") { $res .= ' '; $n++; - for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) { $res .= ' '; } next;
@@ -2224,7 +2229,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1; my $spaces_to_tab = " " x $source_indent;
@@ -3153,7 +3158,7 @@ sub process { next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); # at the beginning of a line any tabs must come first and anything -# more than 8 must use tabs. +# more than $tabsize must use tabs. if ($rawline =~ /^\+\s* \t\s*\S/ || $rawline =~ /^\+\s* \s*/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";
@@ -3172,7 +3177,7 @@ sub process { "please, no space before tabs\n" . $herevet) && $fix) { while ($fixed[$fixlinenr] =~ - s/(^\+.*) {8,8}\t/$1\t\t/) {} + s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} while ($fixed[$fixlinenr] =~ s/(^\+.*) +\t/$1\t/) {} }
@@ -3194,11 +3199,11 @@ sub process { if ($perl_version_ok && $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { my $indent = length($1); - if ($indent % 8) { + if ($indent % $tabsize) { if (WARN("TABSTOP", "Statements should start on a tabstop\n" . $herecurr) && $fix) { - $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; + $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; } } }
@@ -3216,8 +3221,8 @@ sub process { my $newindent = $2; my $goodtabindent = $oldindent . - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize); my $goodspaceindent = $oldindent . " " x $pos; if ($newindent ne $goodtabindent &&
@@ -3688,11 +3693,11 @@ sub process { #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; if ($check && $s ne '' && - (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 || ($sindent < $indent) || ($sindent == $indent && ($s !~ /^\s*(?:\}|\{|else\b)/)) || - ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) { WARN("SUSPECT_CODE_INDENT", "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); }
Signature · 1 line
2.21.0
Joe Perches
maintainerRe: [PATCH v4] checkpatch: add command-line option for TAB size
scripts/checkpatch.pl
Quoted 1 line · Antonio Borneo
scripts/checkpatch.pl +0
-0
[]
scripts/checkpatch.pl sub string_find_replace { · line 2233
Quoted 7 lines
scripts/checkpatch.pl +1
-1@@ -2224,7 +2229,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1;
I didn't test this.
Does this work properly if --tab-size=1 ?
Maybe die if ($tabsize < 2); is necessary?
Re: [PATCH v4] checkpatch: add command-line option for TAB size
Quoted 8 lines · Joe Perches
scripts/checkpatch.pl
Quoted 1 line · Antonio Borneo
scripts/checkpatch.pl +0
-0[]
Quoted 4 lines
scripts/checkpatch.pl +0
-0@@ -2224,7 +2229,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_;
Quoted 8 lines
scripts/checkpatch.pl sub string_find_replace { · line 2233
Quoted 3 lines
scripts/checkpatch.pl +1
-1- my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1;I didn't test this.
Does this work properly if --tab-size=1 ?
Maybe die if ($tabsize < 2); is necessary?
I have tested it and it works fine, but now that you point it, I rechecked the code. There is already this in checkpatch sub tabify {
...
my $source_indent = $tabsize;
my $max_spaces_before_tab = $source_indent - 1;...
#Remove spaces before a tab
1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
that works fine.
But we could have in the future some other test in checkpatch that uses "$tabsize - 1" and does not get the proper validation for --tab-size=1
Maybe it's safer to put die if ($tabsize < 2) right now, and avoid future headaches. With a comment to explains this choice.
Antonio
PATCH v5 1/1 checkpatch: add command-line option for TAB size
Linux kernel coding style requires a size of 8 characters for both TAB and indentation, and such value is embedded as magic value allover the checkpatch script.
This makes hard to reuse the script by other projects with different requirements in their coding style (e.g. OpenOCD [1] requires TAB size of 4 characters [2]).
Replace the magic value 8 with a variable.
Add a command-line option "--tab-size" to let the user select a TAB size value other than 8.
[1] http://openocd.org/
[2] http://openocd.org/doc/doxygen/html/stylec.html#styleformat
---
v1 -> v2
add the command line option
v2 -> v3
rewrite commit msg to remove script readability issue
v3 -> v4
check for command line value positive
v4 -> v5
exclude --tab-size=1 --- scripts/checkpatch.pl | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-)
scripts/checkpatch.pl +16 -10
@@ -62,6 +62,7 @@ my $conststructsfile = "$D/const_structs.checkpatch"; my $typedefsfile = ""; my $color = "auto"; my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE +my $tabsize = 8; sub help { my ($exitcode) = @_;
@@ -96,6 +97,7 @@ Options: --show-types show the specific message type in the output --max-line-length=n set the maximum line length, if exceeded, warn --min-conf-desc-length=n set the min description length, if shorter, warn + --tab-size=n set the number of spaces for tab (default 8) --root=PATH PATH to the kernel tree root --no-summary suppress the per-file summary --mailback only produce a report in case of warnings/errors
@@ -213,6 +215,7 @@ GetOptions( 'list-types!' => \$list_types, 'max-line-length=i' => \$max_line_length, 'min-conf-desc-length=i' => \$min_conf_desc_length, + 'tab-size=i' => \$tabsize, 'root=s' => \$root, 'summary!' => \$summary, 'mailback!' => \$mailback,
@@ -265,6 +268,9 @@ if ($color =~ /^[01]$/) { die "Invalid color mode: $color\n"; } +# skip TAB size 1 to avoid additional checks on $tabsize - 1 +die "Invalid TAB size: $tabsize\n" if ($tabsize < 2); + sub hash_save_array_words { my ($hashRef, $arrayRef) = @_;
@@ -1211,7 +1217,7 @@ sub expand_tabs { if ($c eq "\t") { $res .= ' '; $n++; - for (; ($n % 8) != 0; $n++) { + for (; ($n % $tabsize) != 0; $n++) { $res .= ' '; } next;
@@ -2224,7 +2230,7 @@ sub string_find_replace { sub tabify { my ($leading) = @_; - my $source_indent = 8; + my $source_indent = $tabsize; my $max_spaces_before_tab = $source_indent - 1; my $spaces_to_tab = " " x $source_indent;
@@ -3153,7 +3159,7 @@ sub process { next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); # at the beginning of a line any tabs must come first and anything -# more than 8 must use tabs. +# more than $tabsize must use tabs. if ($rawline =~ /^\+\s* \t\s*\S/ || $rawline =~ /^\+\s* \s*/) { my $herevet = "$here\n" . cat_vet($rawline) . "\n";
@@ -3172,7 +3178,7 @@ sub process { "please, no space before tabs\n" . $herevet) && $fix) { while ($fixed[$fixlinenr] =~ - s/(^\+.*) {8,8}\t/$1\t\t/) {} + s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} while ($fixed[$fixlinenr] =~ s/(^\+.*) +\t/$1\t/) {} }
@@ -3194,11 +3200,11 @@ sub process { if ($perl_version_ok && $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { my $indent = length($1); - if ($indent % 8) { + if ($indent % $tabsize) { if (WARN("TABSTOP", "Statements should start on a tabstop\n" . $herecurr) && $fix) { - $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e; + $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; } } }
@@ -3216,8 +3222,8 @@ sub process { my $newindent = $2; my $goodtabindent = $oldindent . - "\t" x ($pos / 8) . - " " x ($pos % 8); + "\t" x ($pos / $tabsize) . + " " x ($pos % $tabsize); my $goodspaceindent = $oldindent . " " x $pos; if ($newindent ne $goodtabindent &&
@@ -3688,11 +3694,11 @@ sub process { #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; if ($check && $s ne '' && - (($sindent % 8) != 0 || + (($sindent % $tabsize) != 0 || ($sindent < $indent) || ($sindent == $indent && ($s !~ /^\s*(?:\}|\{|else\b)/)) || - ($sindent > $indent + 8))) { + ($sindent > $indent + $tabsize))) { WARN("SUSPECT_CODE_INDENT", "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); }
Signature · 1 line
2.21.0