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

f47634b2 · Randy Dunlap <[email protected]> · 2006-07-01 04:36:36 -07:00

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 <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>

Commit: f47634b276db6956998350e5fc26a0673fdb125c
Parents: faab17ba

Changes

1 files changed · +4 −1

File	Status	Add	Del	Content
scripts/kernel-doc	modified	+4	−1	View file

scripts/kernel-doc

View file

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 0514e25..f9460a6 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;