| Message ID | 1347410853.2456.7.camel@joe2Laptop |
|---|---|
| State | Not Applicable, archived |
| Delegated to: | David Miller |
| Headers | show |
> -----Original Message----- > From: netdev-owner@vger.kernel.org [mailto:netdev- > owner@vger.kernel.org] On Behalf Of Joe Perches > Sent: Tuesday, September 11, 2012 5:48 PM > To: Andrew Morton > Cc: Andy Whitcroft; David Miller; LKML; netdev > Subject: [PATCH] checkpatch: Check networking specific block comment > style > > In an effort to get fewer checkpatch reviewer corrections, > add a networking specific style test for the preferred > networking comment style. > > /* The preferred style for block comments in > * drivers/net/... and net/... is like this > */ > > These tests are only used in net/ and drivers/net/ > > Tested with: > > $ cat drivers/net/t.c > > /* foo */ > > /* > * foo > */ > > /* foo > */ > > /* foo > * bar */ > $ ./scripts/checkpatch.pl -f drivers/net/t.c > WARNING: networking block comments don't use an empty /* line, use /* Comment... This conflicts with the preferred style for long (multi-line) comments documented in ./Documentation/CodingStyle. If this is the way comments should be done in the networking code this patch should also include an update to Chapter 8 in CodingStyle documenting the networking specific style to avoid confusion.
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index ca05ba2..7165516 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -1873,6 +1873,20 @@ sub process { "No space is necessary after a cast\n" . $hereprev); } + if ($realfile =~ m@^(drivers/net/|net/)@ && + $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ && + $prevrawline =~ /^\+[ \t]*$/) { + WARN("NETWORKING_BLOCK_COMMENT_STYLE", + "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); + } + + if ($realfile =~ m@^(drivers/net/|net/)@ && + $rawline !~ m@^\+[ \t]*(\/\*|\*\/)@ && + $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { + WARN("NETWORKING_BLOCK_COMMENT_STYLE", + "networking block comments put the trailing */ on a separate line\n" . $herecurr); + } + # check for spaces at the beginning of a line. # Exceptions: # 1) within comments
In an effort to get fewer checkpatch reviewer corrections, add a networking specific style test for the preferred networking comment style. /* The preferred style for block comments in * drivers/net/... and net/... is like this */ These tests are only used in net/ and drivers/net/ Tested with: $ cat drivers/net/t.c /* foo */ /* * foo */ /* foo */ /* foo * bar */ $ ./scripts/checkpatch.pl -f drivers/net/t.c WARNING: networking block comments don't use an empty /* line, use /* Comment... #4: FILE: net/t.c:4: + +/* WARNING: networking block comments put the trailing */ on a separate line #12: FILE: net/t.c:12: + * bar */ total: 0 errors, 2 warnings, 12 lines checked Signed-off-by: Joe Perches <joe@perches.com> --- scripts/checkpatch.pl | 14 ++++++++++++++ 1 files changed, 14 insertions(+), 0 deletions(-) -- To unsubscribe from this list: send the line "unsubscribe netdev" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html