From: Randy Dunlap <rdunlap@xenotime.net>
Date: Sat, 1 Jul 2006 11:36:36 +0000 (-0700)
Subject: [PATCH] kernel-doc: make man/text mode function output same
X-Git-Tag: v2.6.18-rc1~195
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f47634b276db6956998350e5fc26a0673fdb125c;p=linux-2.6

[PATCH] kernel-doc: make man/text mode function output same

Make output of function descriptions in text mode match contents of 'man'
mode by adding Name: plus function-short-description ("purpose") and
changing Function: to Synopsis:.

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 0514e2505f..f9460a6218 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1119,7 +1119,10 @@ sub output_function_text(%) {
     my %args = %{$_[0]};
     my ($parameter, $section);
 
-    print "Function:\n\n";
+    print "Name:\n\n";
+    print $args{'function'}." - ".$args{'purpose'}."\n";
+
+    print "\nSynopsis:\n\n";
     my $start=$args{'functiontype'}." ".$args{'function'}." (";
     print $start;
     my $count = 0;