The patch titled
kernel-doc: make parameter description indentation uniform
has been added to the -mm tree. Its filename is
kernel-doc-make-parameter-description-indentation-uniform.patch
See http://www.zip.com.au/~akpm/linux/patches/stuff/added-to-mm.txt to find
out what to do about this
------------------------------------------------------
Subject: kernel-doc: make parameter description indentation uniform
From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
- In parameter descriptions, strip all whitespace between the parameter
name (e.g., @len) and its description so that the description is
indented uniformly in text and man page modes. Previously, spaces
or tabs (which are used for cleaner source code viewing) affected
the produced output in a negative way.
Before (man mode):
to Destination address, in user space.
from Source address, in kernel space.
n Number of bytes to copy.
After (man mode):
to Destination address, in user space.
from Source address, in kernel space.
n Number of bytes to copy.
- Fix/clarify a few function description comments.
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxx>
---
scripts/kernel-doc | 12 +++++++-----
1 files changed, 7 insertions(+), 5 deletions(-)
diff -puN scripts/kernel-doc~kernel-doc-make-parameter-description-indentation-uniform scripts/kernel-doc
--- a/scripts/kernel-doc~kernel-doc-make-parameter-description-indentation-uniform
+++ a/scripts/kernel-doc
@@ -1262,7 +1262,9 @@ sub output_intro_text(%) {
}
##
-# generic output function for typedefs
+# generic output function for all types (function, struct/union, typedef, enum);
+# calls the generated, variable output_ function name based on
+# functype and output_mode
sub output_declaration {
no strict 'refs';
my $name = shift;
@@ -1278,8 +1280,7 @@ sub output_declaration {
}
##
-# generic output function - calls the right one based
-# on current output mode.
+# generic output function - calls the right one based on current output mode.
sub output_intro {
no strict 'refs';
my $func = "output_intro_".$output_mode;
@@ -1781,8 +1782,9 @@ sub process_file($) {
$in_doc_sect = 1;
$contents = $newcontents;
if ($contents ne "") {
- if (substr($contents, 0, 1) eq " ") {
- $contents = substr($contents, 1);
+ while ((substr($contents, 0, 1) eq " ") ||
+ substr($contents, 0, 1) eq "\t") {
+ $contents = substr($contents, 1);
}
$contents .= "\n";
}
_
Patches currently in -mm which might be from rdunlap@xxxxxxxxxxxx are
origin.patch
ext4-enable.patch
jbd2-enable.patch
extents_comment_fix.patch
git-acpi.patch
acpi-fix-printk-format-warnings.patch
w1-kconfig-fix.patch
pcmcia-ds-must_check-fixes.patch
i386-math-emu-fix-must_checks.patch
acx1xx-wireless-driver.patch
fix-module-taint-flags-listing-in-oops-panic.patch
kernel-doc-fix-function-name-in-usercopyc.patch
uaccessh-match-kernel-doc-and-function-names.patch
kernel-doc-drop-various-inline-qualifiers.patch
kernel-doc-make-parameter-description-indentation-uniform.patch
fs-cache-cachefiles-a-cache-that-backs-onto-a-mounted-filesystem-cachefiles-printk-format-warning.patch
-
To unsubscribe from this list: send the line "unsubscribe mm-commits" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
