From: Joe Perches <joe@perches.com>
To: David Miller <davem@davemloft.net>
Cc: shawn.lu@ericsson.com, eric.dumazet@gmail.com,
netdev@vger.kernel.org, xiaoclu@gmail.com,
Randy Dunlap <rdunlap@xenotime.net>
Subject: [PATCH] CodingStyle: Add net and drivers/net preferred commenting style
Date: Sat, 04 Feb 2012 13:34:43 -0800 [thread overview]
Message-ID: <1328391283.7008.17.camel@joe2Laptop> (raw)
In-Reply-To: <20120204.162602.1922697409850241775.davem@davemloft.net>
Perhaps adding something to CodingStyle is useful?
---
Documentation/CodingStyle | 8 ++++++++
1 files changed, 8 insertions(+), 0 deletions(-)
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 2b90d32..65e82e4 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -454,6 +454,14 @@ The preferred style for long (multi-line) comments is:
* with beginning and ending almost-blank lines.
*/
+Unless the files are in net or drivers/net where David Miller
+prefers the vertically shorter:
+
+ /* This is the preferred style for multi-line
+ * comments in the net and drivers/net directories.
+ * Please use it consistently.
+ */
+
It's also important to comment data, whether they are basic types or derived
types. To this end, use just one data declaration per line (no commas for
multiple data declarations). This leaves you room for a small comment on each
next prev parent reply other threads:[~2012-02-04 21:34 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <RE: [PATCH] tcp: RST: binding oif to iif for tcp v4>
2012-02-04 21:22 ` [PATCH] tcp_v4_send_reset: binding oif to iif in no sock case Shawn Lu
2012-02-04 21:26 ` David Miller
2012-02-04 21:30 ` Shawn Lu
2012-02-04 21:34 ` Joe Perches [this message]
2012-02-04 21:40 ` [PATCH] CodingStyle: Add net and drivers/net preferred commenting style David Miller
2012-02-04 21:50 ` Joe Perches
2012-02-04 21:53 ` David Miller
2012-02-04 22:02 ` Joe Perches
2012-02-05 1:52 ` [PATCH] tcp_v4_send_reset: binding oif to iif in no sock case Ben Greear
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=1328391283.7008.17.camel@joe2Laptop \
--to=joe@perches.com \
--cc=davem@davemloft.net \
--cc=eric.dumazet@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=rdunlap@xenotime.net \
--cc=shawn.lu@ericsson.com \
--cc=xiaoclu@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