Commit 05189497 authored Jun 25, 2006 by Randy Dunlap Committed by Linus Torvalds Jun 25, 2006

[PATCH] kernel-doc: drop leading space in sections



Drop leading space of kernel-doc section contents.

"Section" data (contents) are split from the section header
(e.g., Note: below is a section header:
 * Note: list_empty on entry does not return true after this, the entry is
 * in an undefined state.
).

Currently the data/contents begins with a space and is left that way, which
causes it to look bad when printed (in text mode; see example below), so
just remove the leading space.

Note:

list_empty on entry does not return true after this, the entry is in an
undefined state.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

parent 5d18639a

scripts/kernel-doc

+3 −0

Original line number	Diff line number	Diff line
		@@ -1762,6 +1762,9 @@ sub process_file($) {

		$contents = $newcontents;
		if ($contents ne "") {
		if (substr($contents, 0, 1) eq " ") {
		$contents = substr($contents, 1);
		}
		$contents .= "\n";
		}
		$section = $newsection;