Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 792aa2f2 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 3ab32df7

scripts/kernel-doc

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

		$newsection = $1;

		$newcontents = $2;

		$newcontents = $2;





		if ($contents ne "") {

		if (($contents ne "") && ($contents ne "\n")) {

		    if (!$in_doc_sect && $verbose) {

		    if (!$in_doc_sect && $verbose) {

			print STDERR "Warning(${file}:$.): contents before sections\n";

			print STDERR "Warning(${file}:$.): contents before sections\n";

			++$warnings;

			++$warnings;