From: Joe Perches <joe@perches.com>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: Kalle Valo <kvalo@qca.qualcomm.com>,
Andy Whitcroft <apw@shadowen.org>,
David Miller <davem@davemloft.net>,
"John W. Linville" <linville@tuxdriver.com>,
Ilan Elias <ilane@ti.com>, Samuel Ortiz <sameo@linux.intel.com>,
Amitkumar Karwar <akarwar@marvell.com>,
LKML <linux-kernel@vger.kernel.org>,
netdev <netdev@vger.kernel.org>,
"Bruce W. Allen" <bruce.w.allan@intel.com>,
Bing Zhao <bzhao@marvell.com>
Subject: [PATCH v3] checkpatch: Add some --strict coding style checks
Date: Wed, 29 Feb 2012 20:24:03 -0800 [thread overview]
Message-ID: <1330575843.23314.52.camel@joe2Laptop> (raw)
In-Reply-To: <477F20668A386D41ADCC57781B1F70430836762D6C@SC-VEXCH1.marvell.com>
Argument alignment across multiple lines should
match the open parenthesis.
Logical continuations should be at the end of
the previous line, not the start of a new line.
These are not required by CodingStyle so make the
tests active only when using --strict.
Improved_by_examples_from: "Bruce W. Allen" <bruce.w.allan@intel.com>
Signed-off-by: Joe Perches <joe@perches.com>
---
V3: Use perl 5.10 features
Use a runtime check of perl version so $balanced_parens
is not used in perl versions that don't support it.
Update memset and min_t checks for newer $balanced_parens
test.
Improve alignment position test.
Add message suggesting perl upgrade.
V2: Scan the entire line for balanced parentheses,
use the position of the last non-balanced open parenthesis.
Allow all space indentation too, checkpatch will complain
in a different message about that if it's too long.
scripts/checkpatch.pl | 94 +++++++++++++++++++++++++++++++++++++++++++-----
1 files changed, 84 insertions(+), 10 deletions(-)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 89d24b3..308e401 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -330,10 +330,15 @@ sub build_types {
}
build_types();
-our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
-our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
+
+# Using $balanced_parens, $LvalOrFunc, or $FuncArg
+# requires at least perl version v5.10.0
+# Any use must be runtime checked with $^V
+
+our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
+our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
sub deparenthesize {
@@ -1330,6 +1335,36 @@ sub check_absolute_file {
}
}
+sub pos_last_openparen {
+ my ($line) = @_;
+
+ my $pos = 0;
+
+ my $opens = $line =~ tr/\(/\(/;
+ my $closes = $line =~ tr/\)/\)/;
+
+ my $last_openparen = 0;
+
+ if (($opens == 0) || ($closes >= $opens)) {
+ return -1;
+ }
+
+ my $len = length($line);
+
+ for ($pos = 0; $pos < $len; $pos++) {
+ my $string = substr($line, $pos);
+ if ($string =~ /^($FuncArg|$balanced_parens)/) {
+ $pos += length($1) - 1;
+ } elsif (substr($line, $pos, 1) eq '(') {
+ $last_openparen = $pos;
+ } elsif (index($string, '(') == -1) {
+ last;
+ }
+ }
+
+ return $last_openparen + 1;
+}
+
sub process {
my $filename = shift;
@@ -1783,6 +1818,37 @@ sub process {
"please, no space before tabs\n" . $herevet);
}
+# check for && or || at the start of a line
+ if ($rawline =~ /^\+\s*(&&|\|\|)/) {
+ CHK("LOGICAL_CONTINUATIONS",
+ "Logical continuations should be on the previous line\n" . $hereprev);
+ }
+
+# check multi-line statement indentation matches previous line
+ if ($^V && $^V ge 5.10.0 &&
+ $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
+ $prevline =~ /^\+(\t*)(.*)$/;
+ my $oldindent = $1;
+ my $rest = $2;
+
+ my $pos = pos_last_openparen($rest);
+ if ($pos >= 0) {
+ $line =~ /^\+([ \t]*)/;
+ my $newindent = $1;
+
+ my $goodtabindent = $oldindent .
+ "\t" x ($pos / 8) .
+ " " x ($pos % 8);
+ my $goodspaceindent = $oldindent . " " x $pos;
+
+ if ($newindent ne $goodtabindent &&
+ $newindent ne $goodspaceindent) {
+ CHK("PARENTHESIS_ALIGNMENT",
+ "Alignment should match open parenthesis\n" . $hereprev);
+ }
+ }
+ }
+
# check for spaces at the beginning of a line.
# Exceptions:
# 1) within comments
@@ -3142,12 +3208,13 @@ sub process {
}
# Check for misused memsets
- if (defined $stat &&
+ if ($^V && $^V ge 5.10.0 &&
+ defined $stat &&
$stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
my $ms_addr = $2;
- my $ms_val = $8;
- my $ms_size = $14;
+ my $ms_val = $7;
+ my $ms_size = $12;
if ($ms_size =~ /^(0x|)0$/i) {
ERROR("MEMSET",
@@ -3159,17 +3226,18 @@ sub process {
}
# typecasts on min/max could be min_t/max_t
- if (defined $stat &&
+ if ($^V && $^V ge 5.10.0 &&
+ defined $stat &&
$stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
- if (defined $2 || defined $8) {
+ if (defined $2 || defined $7) {
my $call = $1;
my $cast1 = deparenthesize($2);
my $arg1 = $3;
- my $cast2 = deparenthesize($8);
- my $arg2 = $9;
+ my $cast2 = deparenthesize($7);
+ my $arg2 = $8;
my $cast;
- if ($cast1 ne "" && $cast2 ne "") {
+ if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
$cast = "$cast1 or $cast2";
} elsif ($cast1 ne "") {
$cast = $cast1;
@@ -3391,6 +3459,12 @@ sub process {
}
if ($quiet == 0) {
+
+ if ($^V lt 5.10.0) {
+ print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
+ print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
+ }
+
# If there were whitespace errors which cleanpatch can fix
# then suggest that.
if ($rpt_cleaners) {
next prev parent reply other threads:[~2012-03-01 4:24 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20120229173421.GA13733@tuxdriver.com>
[not found] ` <477F20668A386D41ADCC57781B1F70430836762D55@SC-VEXCH1.marvell.com>
2012-02-29 19:13 ` coding style issues -- [davem@davemloft.net: Re: pull request: wireless-next 2012-02-06] Joe Perches
2012-02-29 19:22 ` Bing Zhao
2012-03-01 4:24 ` Joe Perches [this message]
2012-03-01 5:10 ` [PATCH v3] checkpatch: Add some --strict coding style checks Joe Perches
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1330575843.23314.52.camel@joe2Laptop \
--to=joe@perches.com \
--cc=akarwar@marvell.com \
--cc=akpm@linux-foundation.org \
--cc=apw@shadowen.org \
--cc=bruce.w.allan@intel.com \
--cc=bzhao@marvell.com \
--cc=davem@davemloft.net \
--cc=ilane@ti.com \
--cc=kvalo@qca.qualcomm.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linville@tuxdriver.com \
--cc=netdev@vger.kernel.org \
--cc=sameo@linux.intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).