lkml.org 
[lkml]   [2017]   [Apr]   [3]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH v1] checkpatch: test missing initial blank line in block comment
Date
Warn when block comments are not starting with blank comment:

/* multiple lines
* block comment,
* => warning
*/

/*
* multiple lines
* block comment,
* => no warning
*/

Exception made for networking files where rule is the
exact opposite.

Signed-off-by: Hugues Fruchet <hugues.fruchet@st.com>
---
scripts/checkpatch.pl | 11 +++++++++++
1 file changed, 11 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index baa3c7b..8754c9d 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3000,6 +3000,17 @@ sub process {
"networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
}

+# Block comment styles
+# Missing initial /*
+ if ($realfile !~ m@^(drivers/net/|net/)@ && #networking exception
+ $prevrawline =~ /^\+[ \t]\/\**.+[ \t]/ && #start with /*...
+ $prevrawline !~ /^\+.*\/\*.*\*\/[ \t]*/ && #no inline /*...*/
+ $rawline =~ /^\+[ \t]*\*/ &&
+ $realline > 2) {
+ WARN("BLOCK_COMMENT_STYLE",
+ "Block comments starts with an empty /*\n" . $hereprev);
+ }
+
# Block comments use * on subsequent lines
if ($prevline =~ /$;[ \t]*$/ && #ends in comment
$prevrawline =~ /^\+.*?\/\*/ && #starting /*
--
1.9.1
\
 
 \ /
  Last update: 2017-04-03 10:10    [W:0.076 / U:0.308 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site