Commit 792aa2f2 authored Feb 07, 2008 by Randy Dunlap Committed by Linus Torvalds Feb 07, 2008

kernel-doc: prevent duplicate description: output



Prevent duplicate output of a Description: section when there is a "blank"
("*") line between the initial function name/description line and the
"Description:" header.

Test case:  drivers/scsi/scsi_devinfo.c::scsi_init_devinfo().

Rob Landley hit this while he was producing SCSI kernel-doc.

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>

parent 3ab32df7

scripts/kernel-doc

+1 −1

Original line number	Diff line number	Diff line
		@@ -1907,7 +1907,7 @@ sub process_file($) {
		$newsection = $1;
		$newcontents = $2;

		if ($contents ne "") {
		if (($contents ne "") && ($contents ne "\n")) {
		if (!$in_doc_sect && $verbose) {
		print STDERR "Warning(${file}:$.): contents before sections\n";
		++$warnings;

Admin message