From: Randy Dunlap <randy.dunlap@oracle.com>
Date: Mon, 28 Apr 2008 09:16:35 +0000 (-0700)
Subject: kernel-doc: detect trailing kernel-doc line trash
X-Git-Tag: MMI-PSA29.97-13-9~35188
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=46b958eb808b73a232efc962e730faffe7cff5c5;p=GitHub%2FMotorolaMobilityLLC%2Fkernel-slsi.git

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

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 99364a5e77f2..83cee18a02e9 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;