From: Randy Dunlap <rdunlap@xenotime.net>
Date: Sun, 25 Jun 2006 12:47:47 +0000 (-0700)
Subject: [PATCH] kernel-doc: drop leading space in sections
X-Git-Tag: v2.6.18-rc1~991
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=05189497d10c715bf41c05fb2fd89aa2cf7602f1;p=linux-2.6

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

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 99fe4b7fb2..fc0835bf65 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -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;