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

From: Randy.Dunlap
Date: Fri Jun 30 2006 - 14:00:40 EST


From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>

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

--- linux-2617-g13.orig/scripts/kernel-doc
+++ linux-2617-g13/scripts/kernel-doc
@@ -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;


---
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/