lkml.org 
[lkml]   [2010]   [Mar]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[PATCH] scripts/kernel-doc: fix empty function description section
From: Randy Dunlap <randy.dunlap@oracle.com>

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@oracle.com>
---
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 = "";

\
 
 \ /
  Last update: 2010-03-08 06:41    [from the cache]
©2003-2011 Jasper Spaans