diff options
author | Johannes Berg <johannes@sipsolutions.net> | 2007-10-24 15:08:48 -0700 |
---|---|---|
committer | Sam Ravnborg <sam@ravnborg.org> | 2008-01-28 23:14:35 +0100 |
commit | 4b44595a7b8e0ebf3fce108df65d8cd6a6cf4910 (patch) | |
tree | 82a204d545bb50b910ddb6780ad17d8d1f8d14af /scripts/kernel-doc | |
parent | b112e0f73fe8e9e69e60bc9d6d16217795259c3c (diff) | |
download | lwn-4b44595a7b8e0ebf3fce108df65d8cd6a6cf4910.tar.gz lwn-4b44595a7b8e0ebf3fce108df65d8cd6a6cf4910.zip |
kernel-doc: process functions, not DOC:
This flag is necessary for the next patch for docproc to output
only the functions and not DOC: sections when a function list
is requested.
Signed-off-by: Johannes Berg <johannes@sipsolutions.net>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-x | scripts/kernel-doc | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 8255f723b7e8..ec54f12f57b0 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -46,13 +46,16 @@ use strict; # Note: This only supports 'c'. # usage: -# kernel-doc [ -docbook | -html | -text | -man ] +# kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ] # [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile # or # [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile # # Set output format using one of -docbook -html -text or -man. Default is man. # +# -no-doc-sections +# Do not output DOC: sections +# # -function funcname # If set, then only generate documentation for the given function(s) or # DOC: section titles. All other functions and DOC: sections are ignored. @@ -211,7 +214,7 @@ my $blankline_text = ""; sub usage { - print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ]\n"; + print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ]\n"; print " [ -function funcname [ -function funcname ...] ]\n"; print " [ -nofunction funcname [ -nofunction funcname ...] ]\n"; print " c source file(s) > outputfile\n"; @@ -225,6 +228,7 @@ if ($#ARGV==-1) { my $verbose = 0; my $output_mode = "man"; +my $no_doc_sections = 0; my %highlights = %highlights_man; my $blankline = $blankline_man; my $modulename = "Kernel API"; @@ -329,6 +333,8 @@ while ($ARGV[0] =~ m/^-(.*)/) { usage(); } elsif ($cmd eq '-filelist') { $filelist = shift @ARGV; + } elsif ($cmd eq '-no-doc-sections') { + $no_doc_sections = 1; } } @@ -380,6 +386,10 @@ sub dump_doc_section { my $name = shift; my $contents = join "\n", @_; + if ($no_doc_sections) { + return; + } + if (($function_only == 0) || ( $function_only == 1 && defined($function_table{$name})) || ( $function_only == 2 && !defined($function_table{$name}))) |