Skip to content

Commit

Permalink
[PATCH] kernel-doc: make man/text mode function output same
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
rddunlap authored and Linus Torvalds committed Jul 1, 2006
1 parent faab17b commit f47634b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit f47634b

Please sign in to comment.