浏览代码

[PATCH] kernel-doc: make parameter description indentation uniform

- 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@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Randy Dunlap 18 年之前
父节点
当前提交
272057447f
共有 1 个文件被更改,包括 7 次插入5 次删除
  1. 7 5
      scripts/kernel-doc

+ 7 - 5
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 {
 sub output_declaration {
     no strict 'refs';
     no strict 'refs';
     my $name = shift;
     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 {
 sub output_intro {
     no strict 'refs';
     no strict 'refs';
     my $func = "output_intro_".$output_mode;
     my $func = "output_intro_".$output_mode;
@@ -1781,8 +1782,9 @@ sub process_file($) {
 		$in_doc_sect = 1;
 		$in_doc_sect = 1;
 		$contents = $newcontents;
 		$contents = $newcontents;
 		if ($contents ne "") {
 		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";
 		    $contents .= "\n";
 		}
 		}