Thread (3 messages) 3 messages, 2 authors, 2012-09-12

RE: [PATCH] checkpatch: Check networking specific block comment style

From: Allan, Bruce W <hidden>
Date: 2012-09-12 01:19:54
Also in: lkml

-----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.

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help