]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - scripts/kernel-doc
2 # SPDX-License-Identifier: GPL-2.0
7 ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
8 ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
9 ## Copyright (C) 2001 Simon Huggins ##
10 ## Copyright (C) 2005-2012 Randy Dunlap ##
11 ## Copyright (C) 2012 Dan Luedtke ##
13 ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
14 ## Copyright (c) 2000 MontaVista Software, Inc. ##
16 ## This software falls under the GNU General Public License. ##
17 ## Please read the COPYING file for more information ##
19 # 18/01/2001 - Cleanups
20 # Functions prototyped as foo(void) same as foo()
21 # Stop eval'ing where we don't need to.
24 # 27/06/2001 - Allowed whitespace after initial "/**" and
25 # allowed comments before function declarations.
26 # -- Christian Kreibich <ck@whoop.org>
29 # - add perldoc documentation
30 # - Look more closely at some of the scarier bits :)
32 # 26/05/2001 - Support for separate source and object trees.
34 # Keith Owens <kaos@ocs.com.au>
36 # 23/09/2001 - Added support for typedefs, structs, enums and unions
37 # Support for Context section; can be terminated using empty line
38 # Small fixes (like spaces vs. \s in regex)
39 # -- Tim Jansen <tim@tjansen.de>
41 # 25/07/2012 - Added support for HTML5
42 # -- Dan Luedtke <mail@danrl.de>
45 my $message = <<"EOF";
46 Usage: $0 [OPTION ...] FILE ...
48 Read C language source or header FILEs, extract embedded documentation comments,
49 and print formatted documentation to standard output.
51 The documentation comments are identified by "/**" opening comment mark. See
52 Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
54 Output format selection (mutually exclusive):
55 -man Output troff manual page format. This is the default.
56 -rst Output reStructuredText format.
57 -none Do not output documentation, only warnings.
59 Output format selection modifier (affects only ReST output):
61 -sphinx-version Use the ReST C domain dialect compatible with an
62 specific Sphinx Version.
63 If not specified, kernel-doc will auto-detect using
64 the sphinx-build version found on PATH.
66 Output selection (mutually exclusive):
67 -export Only output documentation for symbols that have been
68 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
69 in any input FILE or -export-file FILE.
70 -internal Only output documentation for symbols that have NOT been
71 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
72 in any input FILE or -export-file FILE.
73 -function NAME Only output documentation for the given function(s)
74 or DOC: section title(s). All other functions and DOC:
75 sections are ignored. May be specified multiple times.
76 -nosymbol NAME Exclude the specified symbols from the output
77 documentation. May be specified multiple times.
79 Output selection modifiers:
80 -no-doc-sections Do not output DOC: sections.
81 -enable-lineno Enable output of #define LINENO lines. Only works with
82 reStructuredText format.
83 -export-file FILE Specify an additional FILE in which to look for
84 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
85 -export or -internal. May be specified multiple times.
88 -v Verbose output, more warnings and other information.
90 -Werror Treat warnings as errors.
99 # In the following table, (...)? signifies optional structure.
100 # (...)* signifies 0 or more structure elements
102 # * function_name(:)? (- short description)?
103 # (* @parameterx: (description of parameter x)?)*
105 # * (Description:)? (Description of function)?
106 # * (section header: (section description)? )*
109 # So .. the trivial example would be:
115 # If the Description: header tag is omitted, then there must be a blank line
116 # after the last parameter specification.
119 # * my_function - does my stuff
120 # * @my_arg: its mine damnit
122 # * Does my stuff explained.
125 # or, could also use:
127 # * my_function - does my stuff
128 # * @my_arg: its mine damnit
129 # * Description: Does my stuff explained.
133 # Besides functions you can also write documentation for structs, unions,
134 # enums and typedefs. Instead of the function name you must write the name
135 # of the declaration; the struct/union/enum/typedef must always precede
136 # the name. Nesting of declarations is not supported.
137 # Use the argument mechanism to document members or constants.
140 # * struct my_struct - short description
142 # * @b: second member
144 # * Longer description
153 # All descriptions can be multiline, except the short function description.
155 # For really longs structs, you can also describe arguments inside the
156 # body of the struct.
159 # * struct my_struct - short description
161 # * @b: second member
163 # * Longer description
169 # * @c: This is longer description of C
171 # * You can use paragraphs to describe arguments
172 # * using this method.
177 # This should be use only for struct/enum members.
179 # You can also add additional sections. When documenting kernel functions you
180 # should document the "Context:" of the function, e.g. whether the functions
181 # can be called form interrupts. Unlike other sections you can end it with an
183 # A non-void function should have a "Return:" section describing the return
185 # Example-sections should contain the string EXAMPLE so that they are marked
186 # appropriately in DocBook.
190 # * user_function - function that can only be called in user context
191 # * @a: some argument
192 # * Context: !in_interrupt()
196 # * user_function(22);
201 # All descriptive text is further processed, scanning for the following special
202 # patterns, which are highlighted appropriately.
204 # 'funcname()' - function
205 # '$ENVVAR' - environmental variable
206 # '&struct_name' - name of a structure (up to two words including 'struct')
207 # '&struct_name.member' - name of a structure member
208 # '@parameter' - name of a parameter
209 # '%CONST' - name of a constant.
210 # '``LITERAL``' - literal string without any spaces on it.
216 my $anon_struct_union = 0 ;
218 # match expressions used to find embedded type information
219 my $type_constant = ' \b ``([^\`]+)`` \b ' ;
220 my $type_constant2 = '\%([-_\w]+)' ;
221 my $type_func = '(\w+)\(\)' ;
222 my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)' ;
223 my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)' ;
224 my $type_fp_param = '\@(\w+)\(\)' ; # Special RST handling for func ptr params
225 my $type_fp_param2 = '\@(\w+->\S+)\(\)' ; # Special RST handling for structs with func ptr params
226 my $type_env = '(\ $\w+ )' ;
227 my $type_enum = '\&(enum\s*([_\w]+))' ;
228 my $type_struct = '\&(struct\s*([_\w]+))' ;
229 my $type_typedef = '\&(typedef\s*([_\w]+))' ;
230 my $type_union = '\&(union\s*([_\w]+))' ;
231 my $type_member = '\&([_\w]+)(\.|->)([_\w]+)' ;
232 my $type_fallback = '\&([_\w]+)' ;
233 my $type_member_func = $type_member . '\(\)' ;
235 # Output conversion substitutions.
236 # One for each output format
238 # these are pretty rough
239 my @highlights_man = (
240 [ $type_constant, "\ $1 " ],
241 [ $type_constant2, "\ $1 " ],
242 [ $type_func, " \\\\ fB\ $1\\\\fP " ],
243 [ $type_enum, " \\\\ fI\ $1\\\\fP " ],
244 [ $type_struct, " \\\\ fI\ $1\\\\fP " ],
245 [ $type_typedef, " \\\\ fI\ $1\\\\fP " ],
246 [ $type_union, " \\\\ fI\ $1\\\\fP " ],
247 [ $type_param, " \\\\ fI\ $1\\\\fP " ],
248 [ $type_param_ref, " \\\\ fI\ $1\$2\\\\fP " ],
249 [ $type_member, " \\\\ fI\ $1\$2\$3\\\\fP " ],
250 [ $type_fallback, " \\\\ fI\ $1\\\\fP " ]
252 my $blankline_man = "" ;
255 my @highlights_rst = (
256 [ $type_constant, "``\ $1`` " ],
257 [ $type_constant2, "``\ $1`` " ],
258 # Note: need to escape () to avoid func matching later
259 [ $type_member_func, " \\ :c \\ :type \\ :`\ $1\$2\$3\\\\ ( \\\\ ) <\ $1 >`" ],
260 [ $type_member, " \\ :c \\ :type \\ :`\ $1\$2\$3 <\ $1 >`" ],
261 [ $type_fp_param, "**\ $1\\\\ ( \\\\ )**" ],
262 [ $type_fp_param2, "**\ $1\\\\ ( \\\\ )**" ],
263 [ $type_func, "\ $1 ()" ],
264 [ $type_enum, " \\ :c \\ :type \\ :`\ $1 <\ $2 >`" ],
265 [ $type_struct, " \\ :c \\ :type \\ :`\ $1 <\ $2 >`" ],
266 [ $type_typedef, " \\ :c \\ :type \\ :`\ $1 <\ $2 >`" ],
267 [ $type_union, " \\ :c \\ :type \\ :`\ $1 <\ $2 >`" ],
268 # in rst this can refer to any type
269 [ $type_fallback, " \\ :c \\ :type \\ :`\ $1` " ],
270 [ $type_param_ref, "**\ $1\$2** " ]
272 my $blankline_rst = " \n " ;
280 my ( $sphinx_major, $sphinx_minor, $sphinx_patch );
282 my $dohighlight = "" ;
286 my $output_mode = "rst" ;
287 my $output_preformatted = 0 ;
288 my $no_doc_sections = 0 ;
289 my $enable_lineno = 0 ;
290 my @highlights = @highlights_rst ;
291 my $blankline = $blankline_rst ;
292 my $modulename = "Kernel API" ;
295 OUTPUT_ALL
=> 0 , # output all symbols and doc sections
296 OUTPUT_INCLUDE
=> 1 , # output only specified symbols
297 OUTPUT_EXPORTED
=> 2 , # output exported symbols
298 OUTPUT_INTERNAL
=> 3 , # output non-exported symbols
300 my $output_selection = OUTPUT_ALL
;
301 my $show_not_found = 0 ; # No longer used
303 my @export_file_list ;
306 if ( defined ( $ENV { 'KBUILD_BUILD_TIMESTAMP' }) &&
307 ( my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" + %s` ) ne '') {
308 @build_time = gmtime( $seconds );
310 @build_time = localtime;
313 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
314 'July', 'August', 'September', 'October',
315 'November', 'December')[ $build_time [4]] .
316 " " . ( $build_time [5]+1900);
318 # Essentially these are globals.
319 # They probably want to be tidied up, made more localised or something.
320 # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
321 # could cause "use of undefined value" or other bugs.
322 my ( $function, %function_table, %parametertypes, $declaration_purpose );
323 my %nosymbol_table = ();
324 my $declaration_start_line ;
325 my ( $type, $declaration_name, $return_type );
326 my ( $newsection, $newcontents, $prototype, $brcount, %source_map );
328 if (defined( $ENV {'KBUILD_VERBOSE'})) {
329 $verbose = " $ENV {'KBUILD_VERBOSE'}";
332 if (defined( $ENV {'KCFLAGS'})) {
333 my $kcflags = " $ENV {'KCFLAGS'}";
335 if ( $kcflags =~ /Werror/) {
340 if (defined( $ENV {'KDOC_WERROR'})) {
341 $Werror = " $ENV {'KDOC_WERROR'}";
344 # Generated docbook code is inserted in a template at a point where
345 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
346 # https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
347 # We keep track of number of generated entries and generate a dummy
348 # if needs be to ensure the expanded template can be postprocessed
350 my $section_counter = 0;
356 STATE_NORMAL => 0, # normal code
357 STATE_NAME => 1, # looking for function name
358 STATE_BODY_MAYBE => 2, # body - or maybe more description
359 STATE_BODY => 3, # the body of the comment
360 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
361 STATE_PROTO => 5, # scanning prototype
362 STATE_DOCBLOCK => 6, # documentation block
363 STATE_INLINE => 7, # gathering doc outside main block
369 # Inline documentation state
371 STATE_INLINE_NA => 0, # not applicable ( $state != STATE_INLINE)
372 STATE_INLINE_NAME => 1, # looking for member name ( @foo :)
373 STATE_INLINE_TEXT => 2, # looking for member documentation
374 STATE_INLINE_END => 3, # done
375 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
376 # Spit a warning as it's not
377 # proper kernel-doc and ignore the rest.
379 my $inline_doc_state ;
381 #declaration types: can be
382 # 'function', 'struct', 'union', 'enum', 'typedef'
385 # Name of the kernel-doc identifier for non-DOC markups
388 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
390 my $doc_com = '\s*\*\s*';
391 my $doc_com_body = '\s*\* ?';
392 my $doc_decl = $doc_com . '(\w+)';
393 # @params and a strictly limited set of supported section names
398 # while trying to not match literal block starts like "example::"
400 my $doc_sect = $doc_com .
401 '\s*(\@[.\w]+|\ @\ .\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
402 my $doc_content = $doc_com_body . '(.*)';
403 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
404 my $doc_inline_start = '^\s*/\*\*\s*$';
405 my $doc_inline_sect = '\s*\*\s*( @\s* [\w][\w\.]*\s*):(.*)';
406 my $doc_inline_end = '^\s*\*/\s*$';
407 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
408 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
409 my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
410 my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
413 my %parameterdesc_start_lines ;
417 my %section_start_lines ;
422 my $new_start_line = 0;
424 # the canonical section names. see also $doc_sect above.
425 my $section_default = "Description"; # default section
426 my $section_intro = "Introduction";
427 my $section = $section_default ;
428 my $section_context = "Context";
429 my $section_return = "Return";
431 my $undescribed = "-- undescribed --";
435 while ( $ARGV [0] =~ m/^--?(.*)/) {
439 $output_mode = "man";
440 @highlights = @highlights_man ;
441 $blankline = $blankline_man ;
442 } elsif ( $cmd eq "rst") {
443 $output_mode = "rst";
444 @highlights = @highlights_rst ;
445 $blankline = $blankline_rst ;
446 } elsif ( $cmd eq "none") {
447 $output_mode = "none";
448 } elsif ( $cmd eq "module") { # not needed for XML, inherits from calling document
449 $modulename = shift @ARGV ;
450 } elsif ( $cmd eq "function") { # to only output specific functions
451 $output_selection = OUTPUT_INCLUDE;
452 $function = shift @ARGV ;
453 $function_table { $function } = 1;
454 } elsif ( $cmd eq "nosymbol") { # Exclude specific symbols
455 my $symbol = shift @ARGV ;
456 $nosymbol_table { $symbol } = 1;
457 } elsif ( $cmd eq "export") { # only exported symbols
458 $output_selection = OUTPUT_EXPORTED;
459 %function_table = ();
460 } elsif ( $cmd eq "internal") { # only non-exported symbols
461 $output_selection = OUTPUT_INTERNAL;
462 %function_table = ();
463 } elsif ( $cmd eq "export-file") {
464 my $file = shift @ARGV ;
465 push( @export_file_list, $file );
466 } elsif ( $cmd eq "v") {
468 } elsif ( $cmd eq "Werror") {
470 } elsif (( $cmd eq "h") || ( $cmd eq "help")) {
472 } elsif ( $cmd eq 'no-doc-sections') {
473 $no_doc_sections = 1;
474 } elsif ( $cmd eq 'enable-lineno') {
476 } elsif ( $cmd eq 'show-not-found') {
477 $show_not_found = 1; # A no-op but don't fail
478 } elsif ( $cmd eq "sphinx-version") {
479 my $ver_string = shift @ARGV ;
480 if ( $ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
483 $sphinx_minor = substr( $2,1 );
488 $sphinx_patch = substr( $3,1 )
493 die "Sphinx version should either major.minor or major.minor.patch format \n ";
501 # continue execution near EOF;
503 # The C domain dialect changed on Sphinx 3. So, we need to check the
504 # version in order to produce the right tags.
507 foreach(split(/:/, $ENV {PATH})) {
508 return " $_/$_ [0]" if(-x " $_/$_ [0]");
512 sub get_sphinx_version()
516 my $cmd = "sphinx-build";
517 if (!findprog( $cmd )) {
518 my $cmd = "sphinx-build3";
519 if (!findprog( $cmd )) {
523 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d . %d . %d ) \n ",
524 $sphinx_major, $sphinx_minor, $sphinx_patch ;
529 open IN, " $cmd --version 2>&1 |";
531 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)? $/ ) {
537 # Sphinx 1.2.x uses a different format
538 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
548 # get kernel version from env
549 sub get_kernel_version() {
550 my $version = 'unknown kernel version';
552 if (defined( $ENV {'KERNELVERSION'})) {
553 $version = $ENV {'KERNELVERSION'};
561 if ( $enable_lineno && defined( $lineno )) {
562 print "#define LINENO " . $lineno . " \n ";
566 # dumps section contents to arrays/hashes intended for that purpose.
571 my $contents = join " \n ", @_ ;
573 if ( $name =~ m/$type_param/) {
575 $parameterdescs { $name } = $contents ;
576 $sectcheck = $sectcheck . $name . " ";
577 $parameterdesc_start_lines { $name } = $new_start_line ;
579 } elsif ( $name eq " @\ .\.\.") {
581 $parameterdescs { $name } = $contents ;
582 $sectcheck = $sectcheck . $name . " ";
583 $parameterdesc_start_lines { $name } = $new_start_line ;
586 if (defined( $sections { $name }) && ( $sections { $name } ne "")) {
587 # Only warn on user specified duplicate section names.
588 if ( $name ne $section_default ) {
589 print STDERR "${file}:$.: warning: duplicate section name ' $name ' \n ";
592 $sections { $name } .= $contents ;
594 $sections { $name } = $contents ;
595 push @sectionlist, $name ;
596 $section_start_lines { $name } = $new_start_line ;
603 # dump DOC: section after checking that it should go out
605 sub dump_doc_section {
608 my $contents = join " \n ", @_ ;
610 if ( $no_doc_sections ) {
614 return if (defined( $nosymbol_table { $name }));
616 if (( $output_selection == OUTPUT_ALL) ||
617 (( $output_selection == OUTPUT_INCLUDE) &&
618 defined( $function_table { $name })))
620 dump_section( $file, $name, $contents );
621 output_blockhead({'sectionlist' => \ @sectionlist,
622 'sections' => \ %sections,
623 'module' => $modulename,
624 'content-only' => ( $output_selection != OUTPUT_ALL), });
631 # parameterdescs, a hash.
632 # function => "function name"
633 # parameterlist => @list of parameters
634 # parameterdescs => %parameter descriptions
635 # sectionlist => @list of sections
636 # sections => %section descriptions
639 sub output_highlight {
640 my $contents = join " \n ", @_ ;
644 # if (!defined $contents ) {
646 # confess "output_highlight got called with no args? \n ";
649 # print STDERR "contents b4: $contents\n ";
652 # print STDERR "contents af: $contents\n ";
654 foreach $line (split " \n ", $contents ) {
655 if (! $output_preformatted ) {
659 if (! $output_preformatted ) {
660 print $lineprefix, $blankline ;
663 if ( $output_mode eq "man" && substr( $line, 0, 1) eq ".") {
666 print $lineprefix, $line ;
674 # output function in man
675 sub output_function_man(%) {
677 my ( $parameter, $section );
680 print ".TH \" $args {'function'} \" 9 \" $args {'function'} \" \" $man_date\ " \" Kernel Hacker's Manual \" LINUX \n ";
683 print $args {'function'} . " \\ - " . $args {'purpose'} . " \n ";
685 print ".SH SYNOPSIS \n ";
686 if ( $args {'functiontype'} ne "") {
687 print ".B \" " . $args {'functiontype'} . " \" " . $args {'function'} . " \n ";
689 print ".B \" " . $args {'function'} . " \n ";
694 foreach my $parameter (@{ $args {'parameterlist'}}) {
695 if ( $count == $# { $args {'parameterlist'}}) {
698 $type = $args {'parametertypes'}{ $parameter };
699 if ( $type =~ m/$function_pointer/) {
700 # pointer-to-function
701 print ".BI \" " . $parenth . $1 . " \" " . " \" ) (" . $2 . ")" . $post . " \"\n ";
703 $type =~ s/([^\*])$/$1 /;
704 print ".BI \" " . $parenth . $type . " \" " . " \" " . $post . " \"\n ";
710 print ".SH ARGUMENTS \n ";
711 foreach $parameter (@{ $args {'parameterlist'}}) {
712 my $parameter_name = $parameter ;
713 $parameter_name =~ s/\[.*//;
715 print ".IP \" " . $parameter . " \" 12 \n ";
716 output_highlight( $args {'parameterdescs'}{ $parameter_name });
718 foreach $section (@{ $args {'sectionlist'}}) {
719 print ".SH \" ", uc $section, " \"\n ";
720 output_highlight( $args {'sections'}{ $section });
726 sub output_enum_man(%) {
728 my ( $parameter, $section );
731 print ".TH \" $args {'module'} \" 9 \" enum $args {'enum'} \" \" $man_date\ " \" API Manual \" LINUX \n ";
734 print "enum " . $args {'enum'} . " \\ - " . $args {'purpose'} . " \n ";
736 print ".SH SYNOPSIS \n ";
737 print "enum " . $args {'enum'} . " { \n ";
739 foreach my $parameter (@{ $args {'parameterlist'}}) {
740 print ".br \n .BI \" $parameter\ " \n ";
741 if ( $count == $# { $args {'parameterlist'}}) {
751 print ".SH Constants \n ";
752 foreach $parameter (@{ $args {'parameterlist'}}) {
753 my $parameter_name = $parameter ;
754 $parameter_name =~ s/\[.*//;
756 print ".IP \" " . $parameter . " \" 12 \n ";
757 output_highlight( $args {'parameterdescs'}{ $parameter_name });
759 foreach $section (@{ $args {'sectionlist'}}) {
760 print ".SH \" $section\ " \n ";
761 output_highlight( $args {'sections'}{ $section });
766 # output struct in man
767 sub output_struct_man(%) {
769 my ( $parameter, $section );
771 print ".TH \" $args {'module'} \" 9 \" " . $args {'type'} . " " . $args {'struct'} . " \" \" $man_date\ " \" API Manual \" LINUX \n ";
774 print $args {'type'} . " " . $args {'struct'} . " \\ - " . $args {'purpose'} . " \n ";
776 my $declaration = $args {'definition'};
777 $declaration =~ s/\t/ /g;
778 $declaration =~ s/\n/"\n.br\n.BI \"/g;
779 print ".SH SYNOPSIS \n ";
780 print $args {'type'} . " " . $args {'struct'} . " { \n .br \n ";
781 print ".BI \" $declaration\n }; \n .br \n\n ";
783 print ".SH Members \n ";
784 foreach $parameter (@{ $args {'parameterlist'}}) {
785 ( $parameter =~ /^#/) && next;
787 my $parameter_name = $parameter ;
788 $parameter_name =~ s/\[.*//;
790 ( $args {'parameterdescs'}{ $parameter_name } ne $undescribed ) || next;
791 print ".IP \" " . $parameter . " \" 12 \n ";
792 output_highlight( $args {'parameterdescs'}{ $parameter_name });
794 foreach $section (@{ $args {'sectionlist'}}) {
795 print ".SH \" $section\ " \n ";
796 output_highlight( $args {'sections'}{ $section });
801 # output typedef in man
802 sub output_typedef_man(%) {
804 my ( $parameter, $section );
806 print ".TH \" $args {'module'} \" 9 \" $args {'typedef'} \" \" $man_date\ " \" API Manual \" LINUX \n ";
809 print "typedef " . $args {'typedef'} . " \\ - " . $args {'purpose'} . " \n ";
811 foreach $section (@{ $args {'sectionlist'}}) {
812 print ".SH \" $section\ " \n ";
813 output_highlight( $args {'sections'}{ $section });
817 sub output_blockhead_man(%) {
819 my ( $parameter, $section );
822 print ".TH \" $args {'module'} \" 9 \" $args {'module'} \" \" $man_date\ " \" API Manual \" LINUX \n ";
824 foreach $section (@{ $args {'sectionlist'}}) {
825 print ".SH \" $section\ " \n ";
826 output_highlight( $args {'sections'}{ $section });
831 # output in restructured text
835 # This could use some work; it's used to output the DOC: sections, and
836 # starts by putting out the name of the doc section itself, but that tends
837 # to duplicate a header already in the template file.
839 sub output_blockhead_rst(%) {
841 my ( $parameter, $section );
843 foreach $section (@{ $args {'sectionlist'}}) {
844 next if (defined( $nosymbol_table { $section }));
846 if ( $output_selection != OUTPUT_INCLUDE) {
847 print ".. _ $section : \n\n ";
848 print "** $section**\n\n ";
850 print_lineno( $section_start_lines { $section });
851 output_highlight_rst( $args {'sections'}{ $section });
857 # Apply the RST highlights to a sub-block of text.
859 sub highlight_block($) {
860 # The dohighlight kludge requires the text be called $contents
861 my $contents = shift;
868 # Regexes used only here.
870 my $sphinx_literal = '^[^.].*::$';
871 my $sphinx_cblock = '^\.\.\ +code-block::';
873 sub output_highlight_rst {
874 my $input = join " \n ", @_ ;
881 foreach $line (split " \n ", $input ) {
883 # If we're in a literal block, see if we should drop out
884 # of it. Otherwise pass the line straight through unmunged.
887 if (! ( $line =~ /^\s* $/ )) {
889 # If this is the first non-blank line in a literal
890 # block we need to figure out what the proper indent is.
892 if ( $litprefix eq "") {
894 $litprefix = '^' . $1 ;
895 $output .= $line . " \n ";
896 } elsif (! ( $line =~ / $litprefix/ )) {
899 $output .= $line . " \n ";
902 $output .= $line . " \n ";
906 # Not in a literal block (or just dropped out)
909 $block .= $line . " \n ";
910 if (( $line =~ / $sphinx_literal/ ) || ( $line =~ / $sphinx_cblock/ )) {
913 $output .= highlight_block( $block );
920 $output .= highlight_block( $block );
922 foreach $line (split " \n ", $output ) {
923 print $lineprefix . $line . " \n ";
927 sub output_function_rst(%) {
929 my ( $parameter, $section );
930 my $oldprefix = $lineprefix ;
934 if ( $sphinx_major < 3) {
935 if ( $args {'typedef'}) {
936 print ".. c:type:: ". $args {'function'} . " \n\n ";
937 print_lineno( $declaration_start_line );
938 print " **Typedef**: ";
940 output_highlight_rst( $args {'purpose'});
941 $start = " \n\n **Syntax** \n\n ` `";
944 print ".. c:function:: ";
947 if ( $args {'typedef'} || $args {'functiontype'} eq "") {
949 print ".. c:macro:: ". $args {'function'} . " \n\n ";
951 print ".. c:function:: ";
954 if ( $args {'typedef'}) {
955 print_lineno( $declaration_start_line );
956 print " **Typedef**: ";
958 output_highlight_rst( $args {'purpose'});
959 $start = " \n\n **Syntax** \n\n ` `";
961 print "` `" if ( $is_macro );
964 if ( $args {'functiontype'} ne "") {
965 $start .= $args {'functiontype'} . " " . $args {'function'} . " (";
967 $start .= $args {'function'} . " (";
972 foreach my $parameter (@{ $args {'parameterlist'}}) {
977 $type = $args {'parametertypes'}{ $parameter };
979 if ( $type =~ m/$function_pointer/) {
980 # pointer-to-function
981 print $1 . $parameter . ") (" . $2 . ")";
991 if (! $args {'typedef'}) {
992 print_lineno( $declaration_start_line );
994 output_highlight_rst( $args {'purpose'});
998 print "**Parameters** \n\n ";
1000 foreach $parameter (@{ $args {'parameterlist'}}) {
1001 my $parameter_name = $parameter ;
1002 $parameter_name =~ s/\[.*//;
1003 $type = $args {'parametertypes'}{ $parameter };
1006 print "` ` $type``\n ";
1008 print "` ` $parameter``\n ";
1011 print_lineno( $parameterdesc_start_lines { $parameter_name });
1013 if (defined( $args {'parameterdescs'}{ $parameter_name }) &&
1014 $args {'parameterdescs'}{ $parameter_name } ne $undescribed ) {
1015 output_highlight_rst( $args {'parameterdescs'}{ $parameter_name });
1017 print " *undescribed* \n ";
1022 $lineprefix = $oldprefix ;
1023 output_section_rst( @_ );
1026 sub output_section_rst(%) {
1027 my %args = %{ $_ [0]};
1029 my $oldprefix = $lineprefix ;
1032 foreach $section (@{ $args {'sectionlist'}}) {
1033 print "** $section**\n\n ";
1034 print_lineno( $section_start_lines { $section });
1035 output_highlight_rst( $args {'sections'}{ $section });
1039 $lineprefix = $oldprefix ;
1042 sub output_enum_rst(%) {
1043 my %args = %{ $_ [0]};
1045 my $oldprefix = $lineprefix ;
1048 if ( $sphinx_major < 3) {
1049 my $name = "enum " . $args {'enum'};
1050 print " \n\n .. c:type:: " . $name . " \n\n ";
1052 my $name = $args {'enum'};
1053 print " \n\n .. c:enum:: " . $name . " \n\n ";
1055 print_lineno( $declaration_start_line );
1057 output_highlight_rst( $args {'purpose'});
1060 print "**Constants** \n\n ";
1062 foreach $parameter (@{ $args {'parameterlist'}}) {
1063 print "` ` $parameter``\n ";
1064 if ( $args {'parameterdescs'}{ $parameter } ne $undescribed ) {
1065 output_highlight_rst( $args {'parameterdescs'}{ $parameter });
1067 print " *undescribed* \n ";
1072 $lineprefix = $oldprefix ;
1073 output_section_rst( @_ );
1076 sub output_typedef_rst(%) {
1077 my %args = %{ $_ [0]};
1079 my $oldprefix = $lineprefix ;
1082 if ( $sphinx_major < 3) {
1083 $name = "typedef " . $args {'typedef'};
1085 $name = $args {'typedef'};
1087 print " \n\n .. c:type:: " . $name . " \n\n ";
1088 print_lineno( $declaration_start_line );
1090 output_highlight_rst( $args {'purpose'});
1093 $lineprefix = $oldprefix ;
1094 output_section_rst( @_ );
1097 sub output_struct_rst(%) {
1098 my %args = %{ $_ [0]};
1100 my $oldprefix = $lineprefix ;
1102 if ( $sphinx_major < 3) {
1103 my $name = $args {'type'} . " " . $args {'struct'};
1104 print " \n\n .. c:type:: " . $name . " \n\n ";
1106 my $name = $args {'struct'};
1107 if ( $args {'type'} eq 'union') {
1108 print " \n\n .. c:union:: " . $name . " \n\n ";
1110 print " \n\n .. c:struct:: " . $name . " \n\n ";
1113 print_lineno( $declaration_start_line );
1115 output_highlight_rst( $args {'purpose'});
1118 print "**Definition** \n\n ";
1120 my $declaration = $args {'definition'};
1121 $declaration =~ s/\t/ /g;
1122 print " " . $args {'type'} . " " . $args {'struct'} . " { \n $declaration }; \n\n ";
1124 print "**Members** \n\n ";
1126 foreach $parameter (@{ $args {'parameterlist'}}) {
1127 ( $parameter =~ /^#/) && next;
1129 my $parameter_name = $parameter ;
1130 $parameter_name =~ s/\[.*//;
1132 ( $args {'parameterdescs'}{ $parameter_name } ne $undescribed ) || next;
1133 $type = $args {'parametertypes'}{ $parameter };
1134 print_lineno( $parameterdesc_start_lines { $parameter_name });
1135 print "` `" . $parameter . "` ` \n ";
1136 output_highlight_rst( $args {'parameterdescs'}{ $parameter_name });
1141 $lineprefix = $oldprefix ;
1142 output_section_rst( @_ );
1145 ## none mode output functions
1147 sub output_function_none(%) {
1150 sub output_enum_none(%) {
1153 sub output_typedef_none(%) {
1156 sub output_struct_none(%) {
1159 sub output_blockhead_none(%) {
1163 # generic output function for all types (function, struct/union, typedef, enum);
1164 # calls the generated, variable output_ function name based on
1165 # functype and output_mode
1166 sub output_declaration {
1169 my $functype = shift;
1170 my $func = "output_${functype}_ $output_mode ";
1172 return if (defined( $nosymbol_table { $name }));
1174 if (( $output_selection == OUTPUT_ALL) ||
1175 (( $output_selection == OUTPUT_INCLUDE ||
1176 $output_selection == OUTPUT_EXPORTED) &&
1177 defined( $function_table { $name })) ||
1178 ( $output_selection == OUTPUT_INTERNAL &&
1179 !( $functype eq "function" && defined( $function_table { $name }))))
1187 # generic output function - calls the right one based on current output mode.
1188 sub output_blockhead {
1190 my $func = "output_blockhead_" . $output_mode ;
1196 # takes a declaration (struct, union, enum, typedef) and
1197 # invokes the right handler. NOT called for functions.
1198 sub dump_declaration( $$ ) {
1200 my ( $prototype, $file ) = @_ ;
1201 my $func = "dump_" . $decl_type ;
1205 sub dump_union( $$ ) {
1209 sub dump_struct( $$ ) {
1214 my $type = qr{struct|union};
1215 # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
1216 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned};
1217 my $definition_body = qr{\{(.*)\}\s* $qualifiers* };
1218 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1220 if ( $x =~ /( $type )\s+(\w+)\s* $definition_body/ ) {
1222 $declaration_name = $2 ;
1224 } elsif ( $x =~ /typedef\s+( $type )\s* $definition_body\s* (\w+)\s*;/) {
1226 $declaration_name = $3 ;
1231 if ( $identifier ne $declaration_name ) {
1232 print STDERR "${file}:$.: warning: expecting prototype for $decl_type $identifier . Prototype was for $decl_type $declaration_name instead \n ";
1236 # ignore members marked private:
1237 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1238 $members =~ s/\/\*\s*private:.*//gosi;
1240 $members =~ s/\/\*.*?\*\///gos;
1242 $members =~ s/\s*$attribute/ /gi;
1243 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1244 $members =~ s/\s*__packed\s*/ /gos;
1245 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1246 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1247 $members =~ s/\s*____cacheline_aligned/ /gos;
1248 # unwrap struct_group():
1249 # - first eat non-declaration parameters and rewrite for final match
1250 # - then remove macro, outer parens, and trailing semicolon
1251 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
1252 $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1253 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1254 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
1256 my $args = qr{([^,)]+)};
1257 # replace DECLARE_BITMAP
1258 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1259 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1260 # replace DECLARE_HASHTABLE
1261 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1262 # replace DECLARE_KFIFO
1263 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1264 # replace DECLARE_KFIFO_PTR
1265 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1266 # replace DECLARE_FLEX_ARRAY
1267 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
1268 my $declaration = $members ;
1270 # Split nested struct/union elements as newer ones
1271 while ( $members =~ m/$struct_members/) {
1276 foreach my $id (split /,/, $ids ) {
1277 $newmember .= " $maintype $id ; ";
1280 $id =~ s/^\s*\**(\S+)\s*/$1/;
1281 foreach my $arg (split /;/, $content ) {
1282 next if ( $arg =~ m/^\s*$/);
1283 if ( $arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1284 # pointer-to-function
1289 if ( $id =~ m/^\s*$/) {
1290 # anonymous struct/union
1291 $newmember .= " $type$name$extra ; ";
1293 $newmember .= " $type$id . $name$extra ; ";
1301 $arg =~ s/:\s*\d+\s*//g;
1303 $arg =~ s/\[.*\]//g;
1304 # The type may have multiple words,
1305 # and multiple IDs can be defined, like:
1306 # const struct foo, *bar, foobar
1307 # So, we remove spaces when parsing the
1308 # names, in order to match just names
1309 # and commas for the names
1310 $arg =~ s/\s*,\s*/,/g;
1311 if ( $arg =~ m/(.*)\s+([\S+,]+)/) {
1315 $newmember .= " $arg ; ";
1318 foreach my $name (split /,/, $names ) {
1319 $name =~ s/^\s*\**(\S+)\s*/$1/;
1320 next if (( $name =~ m/^\s*$/));
1321 if ( $id =~ m/^\s*$/) {
1322 # anonymous struct/union
1323 $newmember .= " $type $name ; ";
1325 $newmember .= " $type $id . $name ; ";
1331 $members =~ s/$struct_members/$newmember/;
1334 # Ignore other nested elements, like enums
1335 $members =~ s/(\{[^\{\}]*\})//g;
1337 create_parameterlist( $members, ';', $file, $declaration_name );
1338 check_sections( $file, $declaration_name, $decl_type, $sectcheck, $struct_actual );
1340 # Adjust declaration for better display
1341 $declaration =~ s/([\{;])/$1\n/g;
1342 $declaration =~ s/\}\s+;/};/g;
1343 # Better handle inlined enums
1344 do {} while ( $declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1346 my @def_args = split / \n /, $declaration ;
1349 foreach my $clause ( @def_args ) {
1350 $clause =~ s/^\s+//;
1351 $clause =~ s/\s+$//;
1352 $clause =~ s/\s+/ /;
1354 $level -- if ( $clause =~ m/(\})/ && $level > 1);
1355 if (!( $clause =~ m/^\s*#/)) {
1356 $declaration .= " \t " x $level ;
1358 $declaration .= " \t " . $clause . " \n ";
1359 $level++ if ( $clause =~ m/(\{)/ && !( $clause =~m/\}/));
1361 output_declaration( $declaration_name,
1363 {'struct' => $declaration_name,
1364 'module' => $modulename,
1365 'definition' => $declaration,
1366 'parameterlist' => \ @parameterlist,
1367 'parameterdescs' => \ %parameterdescs,
1368 'parametertypes' => \ %parametertypes,
1369 'sectionlist' => \ @sectionlist,
1370 'sections' => \ %sections,
1371 'purpose' => $declaration_purpose,
1372 'type' => $decl_type
1376 print STDERR "${file}:$.: error: Cannot parse struct or union! \n ";
1382 sub show_warnings( $$ ) {
1383 my $functype = shift;
1386 return 0 if (defined( $nosymbol_table { $name }));
1388 return 1 if ( $output_selection == OUTPUT_ALL);
1390 if ( $output_selection == OUTPUT_EXPORTED) {
1391 if (defined( $function_table { $name })) {
1397 if ( $output_selection == OUTPUT_INTERNAL) {
1398 if (!( $functype eq "function" && defined( $function_table { $name }))) {
1404 if ( $output_selection == OUTPUT_INCLUDE) {
1405 if (defined( $function_table { $name })) {
1411 die("Please add the new output type at show_warnings()");
1420 $x =~ s @/\* .*?\*/ @@gos ; # strip comments.
1421 # strip #define macros inside enums
1422 $x =~ s @#\s* ((define|ifdef)\s+|endif)[^;]*; @@gos ;
1424 if ( $x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1425 $declaration_name = $2 ;
1427 } elsif ( $x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1428 $declaration_name = $1 ;
1433 if ( $identifier ne $declaration_name ) {
1434 if ( $identifier eq "") {
1435 print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line: \n ";
1437 print STDERR "${file}:$.: warning: expecting prototype for enum $identifier . Prototype was for enum $declaration_name instead \n ";
1441 $declaration_name = "(anonymous)" if ( $declaration_name eq "");
1445 $members =~ s/\s+$//;
1447 foreach my $arg (split ',', $members ) {
1448 $arg =~ s/^\s*(\w+).*/$1/;
1449 push @parameterlist, $arg ;
1450 if (! $parameterdescs { $arg }) {
1451 $parameterdescs { $arg } = $undescribed ;
1452 if (show_warnings("enum", $declaration_name )) {
1453 print STDERR "${file}:$.: warning: Enum value ' $arg ' not described in enum ' $declaration_name ' \n ";
1456 $_members { $arg } = 1;
1459 while (my ( $k, $v ) = each %parameterdescs ) {
1460 if (!exists( $_members { $k })) {
1461 if (show_warnings("enum", $declaration_name )) {
1462 print STDERR "${file}:$.: warning: Excess enum value ' $k ' description in ' $declaration_name ' \n ";
1467 output_declaration( $declaration_name,
1469 {'enum' => $declaration_name,
1470 'module' => $modulename,
1471 'parameterlist' => \ @parameterlist,
1472 'parameterdescs' => \ %parameterdescs,
1473 'sectionlist' => \ @sectionlist,
1474 'sections' => \ %sections,
1475 'purpose' => $declaration_purpose
1478 print STDERR "${file}:$.: error: Cannot parse enum! \n ";
1483 my $typedef_type = qr { ((?:\s+[\w\*]+ \b ){1,8})\s* }x;
1484 my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1485 my $typedef_args = qr { \s*\((.*)\); }x;
1487 my $typedef1 = qr { typedef $typedef_type\ ( $typedef_ident\ ) $typedef_args }x;
1488 my $typedef2 = qr { typedef $typedef_type$typedef_ident$typedef_args }x;
1490 sub dump_typedef( $$ ) {
1494 $x =~ s @/\* .*?\*/ @@gos ; # strip comments.
1496 # Parse function typedef prototypes
1497 if ( $x =~ $typedef1 || $x =~ $typedef2 ) {
1499 $declaration_name = $2 ;
1501 $return_type =~ s/^\s+//;
1503 if ( $identifier ne $declaration_name ) {
1504 print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier . Prototype was for typedef $declaration_name instead \n ";
1508 create_parameterlist( $args, ',', $file, $declaration_name );
1510 output_declaration( $declaration_name,
1512 {'function' => $declaration_name,
1514 'module' => $modulename,
1515 'functiontype' => $return_type,
1516 'parameterlist' => \ @parameterlist,
1517 'parameterdescs' => \ %parameterdescs,
1518 'parametertypes' => \ %parametertypes,
1519 'sectionlist' => \ @sectionlist,
1520 'sections' => \ %sections,
1521 'purpose' => $declaration_purpose
1526 while (( $x =~ /\(*.\)\s*; $/ ) || ( $x =~ /\[*.\]\s*; $/ )) {
1527 $x =~ s/\(*.\)\s*;$/;/;
1528 $x =~ s/\[*.\]\s*;$/;/;
1531 if ( $x =~ /typedef.*\s+(\w+)\s*;/) {
1532 $declaration_name = $1 ;
1534 if ( $identifier ne $declaration_name ) {
1535 print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier . Prototype was for typedef $declaration_name instead \n ";
1539 output_declaration( $declaration_name,
1541 {'typedef' => $declaration_name,
1542 'module' => $modulename,
1543 'sectionlist' => \ @sectionlist,
1544 'sections' => \ %sections,
1545 'purpose' => $declaration_purpose
1549 print STDERR "${file}:$.: error: Cannot parse typedef! \n ";
1554 sub save_struct_actual($) {
1557 # strip all spaces from the actual param so that it looks like one string item
1558 $actual =~ s/\s*//g;
1559 $struct_actual = $struct_actual . $actual . " ";
1562 sub create_parameterlist( $$$$ ) {
1564 my $splitter = shift;
1566 my $declaration_name = shift;
1570 # temporarily replace commas inside function pointer definition
1571 my $arg_expr = qr{\([^\),]+};
1572 while ( $args =~ / $arg_expr,/ ) {
1573 $args =~ s/($arg_expr),/$1#/g;
1576 foreach my $arg (split( $splitter, $args )) {
1578 $arg =~ s/\/\*.*\*\///;
1579 # strip leading/trailing spaces
1585 # Treat preprocessor directive as a typeless variable just to fill
1586 # corresponding data structures "correctly". Catch it later in
1588 push_parameter( $arg, "", "", $file );
1589 } elsif ( $arg =~ m/\(.+\)\s*\(/) {
1590 # pointer-to-function
1592 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1595 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1596 save_struct_actual( $param );
1597 push_parameter( $param, $type, $arg, $file, $declaration_name );
1599 $arg =~ s/\s*:\s*/:/g;
1600 $arg =~ s/\s*\[/\[/g;
1602 my @args = split('\s*,\s*', $arg );
1603 if ( $args [0] =~ m/\*/) {
1604 $args [0] =~ s/(\*+)\s*/ $1/;
1608 if ( $args [0] =~ /^(.*\s+)(.*?\[.*\].*) $/ ) {
1610 push( @first_arg, split('\s+', $1 ));
1611 push( @first_arg, $2 );
1613 @first_arg = split('\s+', shift @args );
1616 unshift( @args, pop @first_arg );
1617 $type = join " ", @first_arg ;
1619 foreach $param ( @args ) {
1620 if ( $param =~ m/^(\*+)\s*(.*)/) {
1621 save_struct_actual( $2 );
1623 push_parameter( $2, " $type $1 ", $arg, $file, $declaration_name );
1625 elsif ( $param =~ m/(.*?):(\d+)/) {
1626 if ( $type ne "") { # skip unnamed bit-fields
1627 save_struct_actual( $1 );
1628 push_parameter( $1, " $type : $2 ", $arg, $file, $declaration_name )
1632 save_struct_actual( $param );
1633 push_parameter( $param, $type, $arg, $file, $declaration_name );
1640 sub push_parameter( $$$$$ ) {
1643 my $org_arg = shift;
1645 my $declaration_name = shift;
1647 if (( $anon_struct_union == 1) && ( $type eq "") &&
1649 return; # ignore the ending }; from anon. struct/union
1652 $anon_struct_union = 0;
1653 $param =~ s/[\[\)].*//;
1655 if ( $type eq "" && $param =~ /\.\.\. $/ )
1657 if (! $param =~ /\w\.\.\. $/ ) {
1658 # handles unnamed variable parameters
1661 elsif ( $param =~ /\w\.\.\. $/ ) {
1662 # for named variable parameters of the form ` x
... `, remove the dots
1663 $param =~ s/\.\.\.$//;
1665 if (!defined $parameterdescs { $param } || $parameterdescs { $param } eq "") {
1666 $parameterdescs { $param } = "variable arguments";
1669 elsif ( $type eq "" && ( $param eq "" or $param eq "void"))
1672 $parameterdescs {void} = "no arguments";
1674 elsif ( $type eq "" && ( $param eq "struct" or $param eq "union"))
1675 # handle unnamed (anonymous) union or struct:
1678 $param = "{unnamed_" . $param . "}";
1679 $parameterdescs { $param } = "anonymous \n ";
1680 $anon_struct_union = 1;
1683 # warn if parameter has no description
1684 # (but ignore ones starting with # as these are not parameters
1685 # but inline preprocessor statements);
1686 # Note: It will also ignore void params and unnamed structs/unions
1687 if (!defined $parameterdescs { $param } && $param !~ /^#/) {
1688 $parameterdescs { $param } = $undescribed ;
1690 if (show_warnings( $type, $declaration_name ) && $param !~ /\./) {
1692 "${file}:$.: warning: Function parameter or member ' $param ' not described in ' $declaration_name ' \n ";
1697 # strip spaces from $param so that it is one continuous string
1698 # on @parameterlist ;
1699 # this fixes a problem where check_sections() cannot find
1700 # a parameter like "addr[6 + 2]" because it actually appears
1701 # as "addr[6", "+", "2]" on the parameter list;
1702 # but it's better to maintain the param string unchanged for output,
1703 # so just weaken the string compare in check_sections() to ignore
1704 # "[blah" in a parameter string;
1705 ### $param =~ s/\s*//g;
1706 push @parameterlist, $param ;
1707 $org_arg =~ s/\s\s+/ /g;
1708 $parametertypes { $param } = $org_arg ;
1711 sub check_sections( $$$$$ ) {
1712 my ( $file, $decl_name, $decl_type, $sectcheck, $prmscheck ) = @_ ;
1713 my @sects = split ' ', $sectcheck ;
1714 my @prms = split ' ', $prmscheck ;
1717 my $prm_clean ; # strip trailing "[array size]" and/or beginning "*"
1719 foreach $sx (0 .. $#sects ) {
1721 foreach $px (0 .. $#prms ) {
1722 $prm_clean = $prms [ $px ];
1723 $prm_clean =~ s/\[.*\]//;
1724 $prm_clean =~ s/$attribute//i;
1725 # ignore array size in a parameter string;
1726 # however, the original param string may contain
1727 # spaces, e.g.: addr[6 + 2]
1728 # and this appears in @prms as "addr[6" since the
1729 # parameter list is split at spaces;
1730 # hence just ignore "[..." for the sections check;
1731 $prm_clean =~ s/\[.*//;
1733 ## $prm_clean =~ s/^\**//;
1734 if ( $prm_clean eq $sects [ $sx ]) {
1740 if ( $decl_type eq "function") {
1741 print STDERR "${file}:$.: warning: " .
1742 "Excess function parameter " .
1744 "description in ' $decl_name ' \n ";
1752 # Checks the section describing the return value of a function.
1753 sub check_return_section {
1755 my $declaration_name = shift;
1756 my $return_type = shift;
1758 # Ignore an empty return type (It's a macro)
1759 # Ignore functions with a "void" return type. (But don't ignore "void *")
1760 if (( $return_type eq "") || ( $return_type =~ /void\s*\w*\s* $/ )) {
1764 if (!defined( $sections { $section_return }) ||
1765 $sections { $section_return } eq "") {
1766 print STDERR "${file}:$.: warning: " .
1767 "No description found for return value of " .
1768 "' $declaration_name ' \n ";
1774 # takes a function prototype and the name of the current file being
1775 # processed and spits out all the details stored in the global
1777 sub dump_function( $$ ) {
1778 my $prototype = shift;
1782 print_lineno( $new_start_line );
1784 $prototype =~ s/^static +//;
1785 $prototype =~ s/^extern +//;
1786 $prototype =~ s/^asmlinkage +//;
1787 $prototype =~ s/^inline +//;
1788 $prototype =~ s/^__inline__ +//;
1789 $prototype =~ s/^__inline +//;
1790 $prototype =~ s/^__always_inline +//;
1791 $prototype =~ s/^noinline +//;
1792 $prototype =~ s/__init +//;
1793 $prototype =~ s/__init_or_module +//;
1794 $prototype =~ s/__deprecated +//;
1795 $prototype =~ s/__flatten +//;
1796 $prototype =~ s/__meminit +//;
1797 $prototype =~ s/__must_check +//;
1798 $prototype =~ s/__weak +//;
1799 $prototype =~ s/__sched +//;
1800 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1801 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1802 $prototype =~ s/__attribute_const__ +//;
1803 $prototype =~ s/__attribute__\s*\(\(
1805 [\w\s]++ # attribute name
1806 (?:\([^)]*+\))? # attribute arguments
1807 \s*+,? # optional comma at the end
1811 # Yes, this truly is vile. We are looking for:
1812 # 1. Return type (may be nothing if we're looking at a macro)
1814 # 3. Function parameters.
1816 # All the while we have to watch out for function pointer parameters
1817 # (which IIRC is what the two sections are for), C types (these
1818 # regexps don't even start to express all the possibilities), and
1821 # If you mess with these regexps, it's a good idea to check that
1822 # the following functions' documentation still comes out right:
1823 # - parport_register_device (function pointer parameters)
1824 # - atomic_set (macro)
1825 # - pci_match_device, __copy_to_user (long return type)
1826 my $name = qr{[a-zA-Z0-9_~:]+};
1827 my $prototype_end1 = qr{[^\(]*};
1828 my $prototype_end2 = qr{[^\{]*};
1829 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1830 my $type1 = qr{[\w\s]+};
1831 my $type2 = qr{$type1\*+};
1833 if ( $define && $prototype =~ m/^()($name)\s+/) {
1834 # This is an object-like macro, it has no return type and no parameter
1836 # Function-like macros are not allowed to have spaces between
1837 # declaration_name and opening parenthesis (notice the \s+).
1839 $declaration_name = $2 ;
1841 } elsif ( $prototype =~ m/^()($name)\s*$prototype_end/ ||
1842 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1843 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1845 $declaration_name = $2 ;
1848 create_parameterlist( $args, ',', $file, $declaration_name );
1850 print STDERR "${file}:$.: warning: cannot understand function prototype: ' $prototype ' \n ";
1854 if ( $identifier ne $declaration_name ) {
1855 print STDERR "${file}:$.: warning: expecting prototype for $identifier (). Prototype was for $declaration_name () instead \n ";
1859 my $prms = join " ", @parameterlist ;
1860 check_sections( $file, $declaration_name, "function", $sectcheck, $prms );
1862 # This check emits a lot of warnings at the moment, because many
1863 # functions don't have a 'Return' doc section. So until the number
1864 # of warnings goes sufficiently down, the check is only performed in
1866 # TODO: always perform the check.
1867 if ( $verbose && ! $noret ) {
1868 check_return_section( $file, $declaration_name, $return_type );
1871 # The function parser can be called with a typedef parameter.
1873 if ( $return_type =~ /typedef/) {
1874 output_declaration( $declaration_name,
1876 {'function' => $declaration_name,
1878 'module' => $modulename,
1879 'functiontype' => $return_type,
1880 'parameterlist' => \ @parameterlist,
1881 'parameterdescs' => \ %parameterdescs,
1882 'parametertypes' => \ %parametertypes,
1883 'sectionlist' => \ @sectionlist,
1884 'sections' => \ %sections,
1885 'purpose' => $declaration_purpose
1888 output_declaration( $declaration_name,
1890 {'function' => $declaration_name,
1891 'module' => $modulename,
1892 'functiontype' => $return_type,
1893 'parameterlist' => \ @parameterlist,
1894 'parameterdescs' => \ %parameterdescs,
1895 'parametertypes' => \ %parametertypes,
1896 'sectionlist' => \ @sectionlist,
1897 'sections' => \ %sections,
1898 'purpose' => $declaration_purpose
1905 %parameterdescs = ();
1906 %parametertypes = ();
1907 @parameterlist = ();
1911 $struct_actual = "";
1914 $state = STATE_NORMAL;
1915 $inline_doc_state = STATE_INLINE_NA;
1918 sub tracepoint_munge($) {
1920 my $tracepointname = 0;
1921 my $tracepointargs = 0;
1923 if ( $prototype =~ m/TRACE_EVENT\((.*?),/) {
1924 $tracepointname = $1 ;
1926 if ( $prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1927 $tracepointname = $1 ;
1929 if ( $prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1930 $tracepointname = $2 ;
1932 $tracepointname =~ s/^\s+//; #strip leading whitespace
1933 if ( $prototype =~ m/TP_PROTO\((.*?)\)/) {
1934 $tracepointargs = $1 ;
1936 if (( $tracepointname eq 0) || ( $tracepointargs eq 0)) {
1937 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n ".
1940 $prototype = "static inline void trace_ $tracepointname ( $tracepointargs )";
1941 $identifier = "trace_ $identifier ";
1945 sub syscall_munge() {
1948 $prototype =~ s@[ \r\n ]+@ @gos ; # strip newlines/CR's
1949 ## if ( $prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1950 if ( $prototype =~ m/SYSCALL_DEFINE0/) {
1952 ## $prototype = "long sys_ $1 (void)";
1955 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1956 if ( $prototype =~ m/long (sys_.*?),/) {
1957 $prototype =~ s/,/\(/;
1959 $prototype =~ s/\)/\(void\)/;
1962 # now delete all of the odd-number commas in $prototype
1963 # so that arg types & arg names don't have a comma between them
1965 my $len = length( $prototype );
1967 $len = 0; # skip the for-loop
1969 for (my $ix = 0; $ix < $len ; $ix++ ) {
1970 if (substr( $prototype, $ix, 1) eq ',') {
1972 if ( $count % 2 == 1) {
1973 substr( $prototype, $ix, 1) = ' ';
1979 sub process_proto_function( $$ ) {
1983 $x =~ s @\/\/ .* $@@gos ; # strip C99-style comments to end of line
1985 if ( $x =~ m#\s*/\*\s+MACDOC\s*#io || ( $x =~ /^#/ && $x !~ /^#\s*define/)) {
1988 elsif ( $x =~ /([^\{]*)/) {
1992 if (( $x =~ /\{/) || ( $x =~ /\#\s*define/) || ( $x =~ /;/)) {
1993 $prototype =~ s @/\* .*?\*/ @@gos ; # strip comments.
1994 $prototype =~ s@[ \r\n ]+@ @gos ; # strip newlines/cr's.
1995 $prototype =~ s @^\s+@@gos ; # strip leading spaces
1997 # Handle prototypes for function pointers like:
1998 # int (*pcs_config)(struct foo)
1999 $prototype =~ s @^ (\S+\s+)\(\s*\*(\S+)\) @$1$2@gos ;
2001 if ( $prototype =~ /SYSCALL_DEFINE/) {
2004 if ( $prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
2005 $prototype =~ /DEFINE_SINGLE_EVENT/)
2007 tracepoint_munge( $file );
2009 dump_function( $prototype, $file );
2014 sub process_proto_type( $$ ) {
2018 $x =~ s@[ \r\n ]+@ @gos ; # strip newlines/cr's.
2019 $x =~ s @^\s+@@gos ; # strip leading spaces
2020 $x =~ s @\s+$@@gos ; # strip trailing spaces
2021 $x =~ s @\/\/ .* $@@gos ; # strip C99-style comments to end of line
2024 # To distinguish preprocessor directive from regular declaration later.
2029 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
2030 if( length $prototype ) {
2033 $prototype .= $1 . $2 ;
2034 ( $2 eq '{') && $brcount++ ;
2035 ( $2 eq '}') && $brcount --;
2036 if (( $2 eq ';') && ( $brcount == 0)) {
2037 dump_declaration( $prototype, $file );
2050 sub map_filename($) {
2052 my ( $orig_file ) = @_ ;
2054 if (defined( $ENV {'SRCTREE'})) {
2055 $file = " $ENV {'SRCTREE'}" . "/" . $orig_file ;
2060 if (defined( $source_map { $file })) {
2061 $file = $source_map { $file };
2067 sub process_export_file($) {
2068 my ( $orig_file ) = @_ ;
2069 my $file = map_filename( $orig_file );
2071 if (!open(IN,"< $file ")) {
2072 print STDERR "Error: Cannot open file $file\n ";
2078 if (/ $export_symbol/ ) {
2079 next if (defined( $nosymbol_table { $2 }));
2080 $function_table { $2 } = 1;
2088 # Parsers for the various processing states.
2090 # STATE_NORMAL: looking for the /** to begin everything.
2092 sub process_normal() {
2093 if (/ $doc_start/o ) {
2094 $state = STATE_NAME; # next line is always the function name
2096 $declaration_start_line = $. + 1;
2101 # STATE_NAME: Looking for the "name - description" line
2103 sub process_name( $$ ) {
2107 if (/ $doc_block/o ) {
2108 $state = STATE_DOCBLOCK;
2110 $new_start_line = $.;
2113 $section = $section_intro ;
2117 } elsif (/ $doc_decl/o ) {
2119 my $is_kernel_comment = 0;
2120 my $decl_start = qr{$doc_com};
2121 # test for pointer declaration type, foo * bar() - desc
2122 my $fn_type = qr{\w+\s*\*\s*};
2123 my $parenthesis = qr{\(\w*\)};
2124 my $decl_end = qr{[-:].*};
2125 if (/^ $decl_start ([\w\s]+?) $parenthesis?\s*$decl_end?$/ ) {
2128 if ( $identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2131 $is_kernel_comment = 1;
2133 # Look for foo() or static void foo() - description; or misspelt
2135 elsif (/^ $decl_start$fn_type? (\w+)\s* $parenthesis?\s*$decl_end?$/ ||
2136 /^ $decl_start$fn_type? (\w+.*) $parenthesis?\s*$decl_end$/ ) {
2138 $decl_type = 'function';
2139 $identifier =~ s/^define\s+//;
2140 $is_kernel_comment = 1;
2142 $identifier =~ s/\s+$//;
2144 $state = STATE_BODY;
2145 # if there's no @param blocks need to set up default section
2148 $section = $section_default ;
2149 $new_start_line = $. + 1;
2151 # strip leading/trailing/multiple spaces
2155 $descr =~ s/\s+/ /g;
2156 $declaration_purpose = $descr ;
2157 $state = STATE_BODY_MAYBE;
2159 $declaration_purpose = "";
2162 if (! $is_kernel_comment ) {
2163 print STDERR "${file}:$.: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst \n ";
2166 $state = STATE_NORMAL;
2169 if (( $declaration_purpose eq "") && $verbose ) {
2170 print STDERR "${file}:$.: warning: missing initial short description on line: \n ";
2175 if ( $identifier eq "" && $decl_type ne "enum") {
2176 print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line: \n ";
2179 $state = STATE_NORMAL;
2183 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n ";
2186 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2187 " - I thought it was a doc line \n ";
2189 $state = STATE_NORMAL;
2195 # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2197 sub process_body( $$ ) {
2200 # Until all named variable macro parameters are
2201 # documented using the bare name (` x
`) rather than with
2202 # dots (` x
... `), strip the dots:
2203 if ( $section =~ /\w\.\.\. $/ ) {
2204 $section =~ s/\.\.\.$//;
2207 print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots \n ";
2212 if ( $state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2213 dump_section( $file, $section, $contents );
2214 $section = $section_default ;
2215 $new_start_line = $.;
2219 if (/ $doc_sect/i ) { # case insensitive for supported section names
2223 # map the supported section names to the canonical names
2224 if ( $newsection =~ m/^description$/i) {
2225 $newsection = $section_default ;
2226 } elsif ( $newsection =~ m/^context$/i) {
2227 $newsection = $section_context ;
2228 } elsif ( $newsection =~ m/^returns?$/i) {
2229 $newsection = $section_return ;
2230 } elsif ( $newsection =~ m/^\@return$/) {
2231 # special: @return is a section, not a param description
2232 $newsection = $section_return ;
2235 if (( $contents ne "") && ( $contents ne " \n ")) {
2236 if (! $in_doc_sect && $verbose ) {
2237 print STDERR "${file}:$.: warning: contents before sections \n ";
2240 dump_section( $file, $section, $contents );
2241 $section = $section_default ;
2245 $state = STATE_BODY;
2246 $contents = $newcontents ;
2247 $new_start_line = $.;
2248 while (substr( $contents, 0, 1) eq " ") {
2249 $contents = substr( $contents, 1);
2251 if ( $contents ne "") {
2254 $section = $newsection ;
2255 $leading_space = undef;
2256 } elsif (/ $doc_end/ ) {
2257 if (( $contents ne "") && ( $contents ne " \n ")) {
2258 dump_section( $file, $section, $contents );
2259 $section = $section_default ;
2262 # look for doc_com + <text> + doc_end:
2263 if ( $_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2264 print STDERR "${file}:$.: warning: suspicious ending line: $_ ";
2269 $state = STATE_PROTO;
2271 $new_start_line = $. + 1;
2272 } elsif (/ $doc_content/ ) {
2274 if ( $section eq $section_context ) {
2275 dump_section( $file, $section, $contents );
2276 $section = $section_default ;
2278 $new_start_line = $.;
2279 $state = STATE_BODY;
2281 if ( $section ne $section_default ) {
2282 $state = STATE_BODY_WITH_BLANK_LINE;
2284 $state = STATE_BODY;
2288 } elsif ( $state == STATE_BODY_MAYBE) {
2289 # Continued declaration purpose
2290 chomp( $declaration_purpose );
2291 $declaration_purpose .= " " . $1 ;
2292 $declaration_purpose =~ s/\s+/ /g;
2295 if ( $section =~ m/^@/ || $section eq $section_context ) {
2296 if (!defined $leading_space ) {
2297 if ( $cont =~ m/^(\s+)/) {
2298 $leading_space = $1 ;
2300 $leading_space = "";
2303 $cont =~ s/^$leading_space//;
2305 $contents .= $cont . " \n ";
2308 # i dont know - bad line? ignore.
2309 print STDERR "${file}:$.: warning: bad line: $_ ";
2316 # STATE_PROTO: reading a function/whatever prototype.
2318 sub process_proto( $$ ) {
2321 if (/ $doc_inline_oneline/ ) {
2324 if ( $contents ne "") {
2326 dump_section( $file, $section, $contents );
2327 $section = $section_default ;
2330 } elsif (/ $doc_inline_start/ ) {
2331 $state = STATE_INLINE;
2332 $inline_doc_state = STATE_INLINE_NAME;
2333 } elsif ( $decl_type eq 'function') {
2334 process_proto_function( $_, $file );
2336 process_proto_type( $_, $file );
2341 # STATE_DOCBLOCK: within a DOC: block.
2343 sub process_docblock( $$ ) {
2347 dump_doc_section( $file, $section, $contents );
2348 $section = $section_default ;
2351 %parameterdescs = ();
2352 %parametertypes = ();
2353 @parameterlist = ();
2357 $state = STATE_NORMAL;
2358 } elsif (/ $doc_content/ ) {
2360 $contents .= $blankline ;
2362 $contents .= $1 . " \n ";
2368 # STATE_INLINE: docbook comments within a prototype.
2370 sub process_inline( $$ ) {
2373 # First line (state 1) needs to be a @parameter
2374 if ( $inline_doc_state == STATE_INLINE_NAME && / $doc_inline_sect/o ) {
2377 $new_start_line = $.;
2378 if ( $contents ne "") {
2379 while (substr( $contents, 0, 1) eq " ") {
2380 $contents = substr( $contents, 1);
2384 $inline_doc_state = STATE_INLINE_TEXT;
2385 # Documentation block end */
2386 } elsif (/ $doc_inline_end/ ) {
2387 if (( $contents ne "") && ( $contents ne " \n ")) {
2388 dump_section( $file, $section, $contents );
2389 $section = $section_default ;
2392 $state = STATE_PROTO;
2393 $inline_doc_state = STATE_INLINE_NA;
2395 } elsif (/ $doc_content/ ) {
2396 if ( $inline_doc_state == STATE_INLINE_TEXT) {
2397 $contents .= $1 . " \n ";
2398 # nuke leading blank lines
2399 if ( $contents =~ /^\s* $/ ) {
2402 } elsif ( $inline_doc_state == STATE_INLINE_NAME) {
2403 $inline_doc_state = STATE_INLINE_ERROR;
2404 print STDERR "${file}:$.: warning: ";
2405 print STDERR "Incorrect use of kernel-doc format: $_ ";
2412 sub process_file($) {
2414 my $initial_section_counter = $section_counter ;
2415 my ( $orig_file ) = @_ ;
2417 $file = map_filename( $orig_file );
2419 if (!open(IN_FILE,"< $file ")) {
2420 print STDERR "Error: Cannot open file $file\n ";
2427 $section_counter = 0;
2429 while (s/\\\s*$//) {
2432 # Replace tabs by spaces
2433 while ( $_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2434 # Hand this line to the appropriate state handler
2435 if ( $state == STATE_NORMAL) {
2437 } elsif ( $state == STATE_NAME) {
2438 process_name( $file, $_ );
2439 } elsif ( $state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2440 $state == STATE_BODY_WITH_BLANK_LINE) {
2441 process_body( $file, $_ );
2442 } elsif ( $state == STATE_INLINE) { # scanning for inline parameters
2443 process_inline( $file, $_ );
2444 } elsif ( $state == STATE_PROTO) {
2445 process_proto( $file, $_ );
2446 } elsif ( $state == STATE_DOCBLOCK) {
2447 process_docblock( $file, $_ );
2451 # Make sure we got something interesting.
2452 if ( $initial_section_counter == $section_counter && $
2453 output_mode ne "none") {
2454 if ( $output_selection == OUTPUT_INCLUDE) {
2455 print STDERR "${file}:1: warning: ' $_ ' not found \n "
2456 for keys %function_table ;
2459 print STDERR "${file}:1: warning: no structured comments found \n ";
2466 if ( $output_mode eq "rst") {
2467 get_sphinx_version() if (! $sphinx_major );
2470 $kernelversion = get_kernel_version();
2472 # generate a sequence of code that will splice in highlighting information
2473 # using the s// operator.
2474 for (my $k = 0; $k < @highlights ; $k++ ) {
2475 my $pattern = $highlights [ $k ][0];
2476 my $result = $highlights [ $k ][1];
2477 # print STDERR "scanning pattern: $pattern, highlight:( $result ) \n ";
2478 $dohighlight .= "\ $contents =~ s: $pattern : $result :gs; \n ";
2481 # Read the file that maps relative names to absolute names for
2482 # separate source and object directories and for shadow trees.
2483 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2484 my ( $relname, $absname );
2485 while(<SOURCE_MAP>) {
2487 ( $relname, $absname ) = (split())[0..1];
2488 $relname =~ s:^/+::;
2489 $source_map { $relname } = $absname ;
2494 if ( $output_selection == OUTPUT_EXPORTED ||
2495 $output_selection == OUTPUT_INTERNAL) {
2497 push( @export_file_list, @ARGV );
2499 foreach ( @export_file_list ) {
2501 process_export_file( $_ );
2509 if ( $verbose && $errors ) {
2510 print STDERR " $errors errors \n ";
2512 if ( $verbose && $warnings ) {
2513 print STDERR " $warnings warnings \n ";
2516 if ( $Werror && $warnings ) {
2517 print STDERR " $warnings warnings as Errors \n ";
2520 exit( $output_mode eq "none" ? 0 : $errors )