summaryrefslogtreecommitdiff
path: root/scripts/kernel-doc
diff options
context:
space:
mode:
authorRandy Dunlap <randy.dunlap@oracle.com>2008-04-28 02:16:35 -0700
committerLinus Torvalds <torvalds@linux-foundation.org>2008-04-28 08:58:48 -0700
commit46b958eb808b73a232efc962e730faffe7cff5c5 (patch)
treea2957b555a3c9dd38f86d595241026f5360c5f55 /scripts/kernel-doc
parent94dc7ad5502e7d74e2fd74651743f5f1773aa1fe (diff)
downloadlinux-3.10-46b958eb808b73a232efc962e730faffe7cff5c5.tar.gz
linux-3.10-46b958eb808b73a232efc962e730faffe7cff5c5.tar.bz2
linux-3.10-46b958eb808b73a232efc962e730faffe7cff5c5.zip
kernel-doc: detect trailing kernel-doc line trash
Print a warning when a kernel-doc comment block ends with text on the same line as the ending comment characters, e.g.: * this text is lost. */ Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-xscripts/kernel-doc5
1 files changed, 5 insertions, 0 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 99364a5e77f..83cee18a02e 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1950,6 +1950,11 @@ sub process_file($) {
$section = $section_default;
$contents = "";
}
+ # look for doc_com + <text> + doc_end:
+ if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
+ print STDERR "Warning(${file}:$.): suspicious ending line: $_";
+ ++$warnings;
+ }
$prototype = "";
$state = 3;