hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Johannes Berg 2007-10-24 15:08:48 -07:00 committed by Sam Ravnborg
parent b112e0f73f
commit 4b44595a7b
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
scripts/kernel-doc
View File

@ -46,13 +46,16 @@ use strict;
# Note: This only supports 'c'. # Note: This only supports 'c'.
# usage: # 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 # [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
# or # or
# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile # [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
# #
# Set output format using one of -docbook -html -text or -man. Default is man. # Set output format using one of -docbook -html -text or -man. Default is man.
# #
# -no-doc-sections
# Do not output DOC: sections
#
# -function funcname # -function funcname
# If set, then only generate documentation for the given function(s) or # If set, then only generate documentation for the given function(s) or
# DOC: section titles. All other functions and DOC: sections are ignored. # DOC: section titles. All other functions and DOC: sections are ignored.
@ -211,7 +214,7 @@ my $blankline_text = "";
sub usage { 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 " [ -function funcname [ -function funcname ...] ]\n";
print " [ -nofunction funcname [ -nofunction funcname ...] ]\n"; print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
print " c source file(s) > outputfile\n"; print " c source file(s) > outputfile\n";
@ -225,6 +228,7 @@ if ($#ARGV==-1) {
my $verbose = 0; my $verbose = 0;
my $output_mode = "man"; my $output_mode = "man";
my $no_doc_sections = 0;
my %highlights = %highlights_man; my %highlights = %highlights_man;
my $blankline = $blankline_man; my $blankline = $blankline_man;
my $modulename = "Kernel API"; my $modulename = "Kernel API";
@ -329,6 +333,8 @@ while ($ARGV[0] =~ m/^-(.*)/) {
usage(); usage();
} elsif ($cmd eq '-filelist') { } elsif ($cmd eq '-filelist') {
$filelist = shift @ARGV; $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 $name = shift;
my $contents = join "\n", @_; my $contents = join "\n", @_;
if ($no_doc_sections) {
return;
}
if (($function_only == 0) || if (($function_only == 0) ||
( $function_only == 1 && defined($function_table{$name})) || ( $function_only == 1 && defined($function_table{$name})) ||
( $function_only == 2 && !defined($function_table{$name}))) ( $function_only == 2 && !defined($function_table{$name})))