diff options
author | Randy Dunlap <rdunlap@xenotime.net> | 2006-07-01 04:36:36 -0700 |
---|---|---|
committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-07-01 09:56:04 -0700 |
commit | f47634b276db6956998350e5fc26a0673fdb125c (patch) | |
tree | 7e74f91dd554882041d51cfe9e67ee64abdfcd1e | |
parent | faab17ba06d86adf5568f3e9ff914e124546d19e (diff) | |
download | linux-3.10-f47634b276db6956998350e5fc26a0673fdb125c.tar.gz linux-3.10-f47634b276db6956998350e5fc26a0673fdb125c.tar.bz2 linux-3.10-f47634b276db6956998350e5fc26a0673fdb125c.zip |
[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>
-rwxr-xr-x | scripts/kernel-doc | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 0514e2505f7..f9460a6218d 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; |