Skip to content

Commit

Permalink
kernel-doc: process functions, not DOC:
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Johannes Berg authored and Sam Ravnborg committed Jan 28, 2008
1 parent b112e0f commit 4b44595
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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";
Expand All @@ -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";
Expand Down Expand Up @@ -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;
}
}

Expand Down Expand Up @@ -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})))
Expand Down

0 comments on commit 4b44595

Please sign in to comment.