From: Joe Perches <joe@perches.com>
To: Andrew Morton <akpm@linux-foundation.org>,
Andy Whitcroft <apw@canonical.com>
Cc: Sudip Mukherjee <sudipm.mukherjee@gmail.com>,
linux-kernel@vger.kernel.org
Subject: [PATCH] checkpatch: Test multiple line block comment alignment
Date: Fri, 26 Aug 2016 18:29:43 -0700 [thread overview]
Message-ID: <edb57bd330adfe024b95ec2a807d4aa7f0c8b112.1472261299.git.joe@perches.com> (raw)
Warn when block comments are not aligned on the *
/*
* block comment, no warning
*/
/*
* block comment, emit warning
*/
Reported-by: Sudip Mukherjee <sudipm.mukherjee@gmail.com>
Signed-off-by: Joe Perches <joe@perches.com>
---
scripts/checkpatch.pl | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 4de3cc4..a16e0e2 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2939,6 +2939,25 @@ sub process {
"Block comments use a trailing */ on a separate line\n" . $herecurr);
}
+# Block comment * alignment
+ if ($prevline =~ /$;[ \t]*$/ && #ends in comment
+ (($prevrawline =~ /^\+.*?\/\*/ && #starting /*
+ $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
+ $prevrawline =~ /^\+[ \t]*\*/) && #starting *
+ $rawline =~ /^\+[ \t]*\*/) { #rawline *
+ $prevrawline =~ m@^\+([ \t]*/?)\*@;
+ my $oldindent = expand_tabs($1);
+ $rawline =~ m@^\+([ \t]*)\*@;
+ my $newindent = $1;
+ my $test_comment = '^\\+' . "$;" x (length($newindent) + 1);
+ $newindent = expand_tabs($newindent);
+ if ($line =~ /$test_comment/ &&
+ length($oldindent) ne length($newindent)) {
+ WARN("BLOCK_COMMENT_STYLE",
+ "Block comments should align the * on each line\n" . $hereprev);
+ }
+ }
+
# check for missing blank lines after struct/union declarations
# with exceptions for various attributes and macros
if ($prevline =~ /^[\+ ]};?\s*$/ &&
--
2.8.0.rc4.16.g56331f8
reply other threads:[~2016-08-27 1:29 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=edb57bd330adfe024b95ec2a807d4aa7f0c8b112.1472261299.git.joe@perches.com \
--to=joe@perches.com \
--cc=akpm@linux-foundation.org \
--cc=apw@canonical.com \
--cc=linux-kernel@vger.kernel.org \
--cc=sudipm.mukherjee@gmail.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
all inboxes | Powered by JetHome®