]> git.karo-electronics.de Git - karo-tx-linux.git/commit
checkpatch: check networking specific block comment style
authorJoe Perches <joe@perches.com>
Fri, 21 Sep 2012 01:02:13 +0000 (11:02 +1000)
committerStephen Rothwell <sfr@canb.auug.org.au>
Fri, 21 Sep 2012 05:59:16 +0000 (15:59 +1000)
commit5015642d4d1ea4dfed43721c1a43a2a9a5a16b96
tree3b37f9c0eb6317c7e5ad3c414afa8fc957fcb5fd
parent47e7f0ed6e4a89a283f70eb037be38420c284705
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...
#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>
Cc: "Allan, Bruce W" <bruce.w.allan@intel.com>
Cc: Andy Whitcroft <apw@canonical.com>
Cc: David Miller <davem@davemloft.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
scripts/checkpatch.pl