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

Commit 4c98ecaf authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

scripts/kernel-doc: fix empty function description section 



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

scripts/kernel-doc

+1 −1
Original line number Diff line number Diff line
@@ -2103,7 +2103,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 = "";