Skip to contentSkip to conversation

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

PATCH New Randy.Dunlap 1 participant 1 message Jun 30, 2006

lore
Share & tools
lore
#0 lore raw

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

From: Randy Dunlap <[email protected]>

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:.

---
 scripts/kernel-doc |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletion(-)
scripts/kernel-doc +4 -1
@@ -1118,7 +1118,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;

---