public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH 1/2] kernel-doc: prevent duplicate description: output
@ 2008-01-31  0:43 Randy Dunlap
  0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2008-01-31  0:43 UTC (permalink / raw)
  To: lkml; +Cc: akpm, samr

From: Randy Dunlap <randy.dunlap@oracle.com>

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

 scripts/kernel-doc |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-2.6.24-git8.orig/scripts/kernel-doc
+++ linux-2.6.24-git8/scripts/kernel-doc
@@ -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;

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2008-01-31  0:45 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-01-31  0:43 [PATCH 1/2] kernel-doc: prevent duplicate description: output Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox