+ kernel-doc-consistent-text-man-mode-output.patch added to -mm tree

[akpm@xxxxxxxx]

The patch titled

     kernel-doc: consistent text/man mode output

has been added to the -mm tree.  Its filename is

     kernel-doc-consistent-text-man-mode-output.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: consistent text/man mode output
From: "Randy.Dunlap" <rdunlap@xxxxxxxxxxxx>

Add a space between data type and struct field name in man-mode
bitfield struct output so that they don't run together.

For text-mode struct output, print the struct 'purpose' or
short description (as done in man-mode output).

For text-mode enum output, print the enum 'purpose' or
short description (as done in man-mode output).

For text-mode typedfe output, print the typedef 'purpose' or
short description (as done in man-mode output).

Signed-off-by: Andrew Morton <akpm@xxxxxxxx>
---

 scripts/kernel-doc |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diff -puN scripts/kernel-doc~kernel-doc-consistent-text-man-mode-output scripts/kernel-doc
--- a/scripts/kernel-doc~kernel-doc-consistent-text-man-mode-output
+++ a/scripts/kernel-doc
@@ -1056,7 +1056,8 @@ sub output_struct_man(%) {
 	    # pointer-to-function
 	    print ".BI \"    ".$1."\" ".$parameter." \") (".$2.")"."\"\n;\n";
 	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
-	    print ".BI \"    ".$1."\" ".$parameter.$2." \""."\"\n;\n";
+	    # bitfield
+	    print ".BI \"    ".$1."\ \" ".$parameter.$2." \""."\"\n;\n";
 	} else {
 	    $type =~ s/([^\*])$/$1 /;
 	    print ".BI \"    ".$type."\" ".$parameter." \""."\"\n;\n";
@@ -1169,6 +1170,7 @@ sub output_enum_text(%) {
     my $count;
     print "Enum:\n\n";
 
+    print "enum ".$args{'enum'}." - ".$args{'purpose'}."\n\n";
     print "enum ".$args{'enum'}." {\n";
     $count = 0;
     foreach $parameter (@{$args{'parameterlist'}}) {
@@ -1197,7 +1199,7 @@ sub output_typedef_text(%) {
     my $count;
     print "Typedef:\n\n";
 
-    print "typedef ".$args{'typedef'}."\n";
+    print "typedef ".$args{'typedef'}." - ".$args{'purpose'}."\n";
     output_section_text(@_);
 }
 
@@ -1206,7 +1208,7 @@ sub output_struct_text(%) {
     my %args = %{$_[0]};
     my ($parameter);
 
-    print $args{'type'}." ".$args{'struct'}.":\n\n";
+    print $args{'type'}." ".$args{'struct'}." - ".$args{'purpose'}."\n\n";
     print $args{'type'}." ".$args{'struct'}." {\n";
     foreach $parameter (@{$args{'parameterlist'}}) {
 	if ($parameter =~ /^#/) {
_

Patches currently in -mm which might be from rdunlap@xxxxxxxxxxxx are

origin.patch
git-acpi.patch
acpi-identify-which-device-is-not-power-manageable.patch
git-dvb.patch
git-mtd.patch
ioat-fix-sparse-ulong-warning.patch
git-pcmcia.patch
git-scsi-misc.patch
aic7-cleanup-module_parm_desc-strings.patch
qla1280-fix-section-mismatch-warnings.patch
dc395x-fix-printk-format-warning.patch
areca-raid-linux-scsi-driver.patch
kernel-doc-consistent-text-man-mode-output.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