2006-05-20 04:45:18

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH 1/2] kernel-doc: drop leading space in sections

From: Randy Dunlap <[email protected]>

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 <[email protected]>
---
scripts/kernel-doc | 3 +++
1 files changed, 3 insertions(+)

--- linux-2617-rc4.orig/scripts/kernel-doc
+++ linux-2617-rc4/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;


---