[PATCH] scripts/kernel-doc: fix empty function description section

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

scripts/kernel-doc mishandles a function that has a multi-line
function short description and no function parameters.  The
observed problem was from drivers/scsi/scsi_netlink.c:

/**
 * scsi_netlink_init - Called by SCSI subsystem to intialize
 * 	the SCSI transport netlink interface
 *
 **/

kernel-doc treated the " * " line as a Description: section with
only a newline character in the Description contents.  This caused
output_highlight() to complain:
output_highlight got called with no args?
plus produce a perl call stack backtrace.

The fix is just to ignore Description sections if they only
contain "\n".

Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
---
 scripts/kernel-doc |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-2.6.33-git13.orig/scripts/kernel-doc
+++ linux-2.6.33-git13/scripts/kernel-doc
@@ -2105,7 +2105,7 @@ sub process_file($) {
 		$section = $newsection;
 	    } elsif (/$doc_end/) {
 
-		if ($contents ne "") {
+		if (($contents ne "") && ($contents ne "\n")) {
 		    dump_section($file, $section, xml_escape($contents));
 		    $section = $section_default;
 		    $contents = "";
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/