From 85b91a45cf7388a891b0f42ddc065ca4f8bb31b3 Mon Sep 17 00:00:00 2001 From: Joe Perches Date: Thu, 4 Oct 2012 17:13:36 -0700 Subject: [PATCH] CodingStyle: add networking specific block comment style The block comment style in net/ and drivers/net is non-standard. Document it. Signed-off-by: Joe Perches Cc: "Allan, Bruce W" Cc: Andy Whitcroft Cc: David Miller Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/CodingStyle | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index cb9258b8fd35b..495e5ba1634ca 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle @@ -454,6 +454,16 @@ The preferred style for long (multi-line) comments is: * with beginning and ending almost-blank lines. */ +For files in net/ and drivers/net/ the preferred style for long (multi-line) +comments is a little different. + + /* The preferred comment style for files in net/ and drivers/net + * looks like this. + * + * It is nearly the same as the generally preferred comment style, + * but there is no initial almost-blank line. + */ + 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 -- 2.39.5