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 selection (mutually exclusive):
60 -export Only output documentation for symbols that have been
61 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
62 in any input FILE or -export-file FILE.
63 -internal Only output documentation for symbols that have NOT been
64 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
65 in any input FILE or -export-file FILE.
66 -function NAME Only output documentation for the given function(s)
67 or DOC: section title(s). All other functions and DOC:
68 sections are ignored. May be specified multiple times.
69 -nofunction NAME Do NOT output documentation for the given function(s);
70 only output documentation for the other functions and
71 DOC: sections. May be specified multiple times.
73 Output selection modifiers:
74 -no-doc-sections Do not output DOC: sections.
75 -enable-lineno Enable output of #define LINENO lines. Only works with
76 reStructuredText format.
77 -export-file FILE Specify an additional FILE in which to look for
78 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
79 -export or -internal. May be specified multiple times.
82 -v Verbose output, more warnings and other information.
84 -Werror Treat warnings as errors.
93 # In the following table, (...)? signifies optional structure.
94 # (...)* signifies 0 or more structure elements
96 # * function_name(:)? (- short description)?
97 # (* @parameterx: (description of parameter x)?)*
99 # * (Description:)? (Description of function)?
100 # * (section header: (section description)? )*
103 # So .. the trivial example would be:
109 # If the Description: header tag is omitted, then there must be a blank line
110 # after the last parameter specification.
113 # * my_function - does my stuff
114 # * @my_arg: its mine damnit
116 # * Does my stuff explained.
119 # or, could also use:
121 # * my_function - does my stuff
122 # * @my_arg: its mine damnit
123 # * Description: Does my stuff explained.
127 # Besides functions you can also write documentation for structs, unions,
128 # enums and typedefs. Instead of the function name you must write the name
129 # of the declaration; the struct/union/enum/typedef must always precede
130 # the name. Nesting of declarations is not supported.
131 # Use the argument mechanism to document members or constants.
134 # * struct my_struct - short description
136 # * @b: second member
138 # * Longer description
147 # All descriptions can be multiline, except the short function description.
149 # For really longs structs, you can also describe arguments inside the
150 # body of the struct.
153 # * struct my_struct - short description
155 # * @b: second member
157 # * Longer description
163 # * @c: This is longer description of C
165 # * You can use paragraphs to describe arguments
166 # * using this method.
171 # This should be use only for struct/enum members.
173 # You can also add additional sections. When documenting kernel functions you
174 # should document the "Context:" of the function, e.g. whether the functions
175 # can be called form interrupts. Unlike other sections you can end it with an
177 # A non-void function should have a "Return:" section describing the return
179 # Example-sections should contain the string EXAMPLE so that they are marked
180 # appropriately in DocBook.
184 # * user_function - function that can only be called in user context
185 # * @a: some argument
186 # * Context: !in_interrupt()
190 # * user_function(22);
195 # All descriptive text is further processed, scanning for the following special
196 # patterns, which are highlighted appropriately.
198 # 'funcname()' - function
199 # '$ENVVAR' - environmental variable
200 # '&struct_name' - name of a structure (up to two words including 'struct')
201 # '&struct_name.member' - name of a structure member
202 # '@parameter' - name of a parameter
203 # '%CONST' - name of a constant.
204 # '``LITERAL``' - literal string without any spaces on it.
210 my $anon_struct_union = 0;
212 # match expressions used to find embedded type information
213 my $type_constant = '\b``([^\`]+)``\b';
214 my $type_constant2 = '\%([-_\w]+)';
215 my $type_func = '(\w+)\(\)';
216 my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
217 my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
218 my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
219 my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
220 my $type_env = '(\$\w+)';
221 my $type_enum = '\&(enum\s*([_\w]+))';
222 my $type_struct = '\&(struct\s*([_\w]+))';
223 my $type_typedef = '\&(typedef\s*([_\w]+))';
224 my $type_union = '\&(union\s*([_\w]+))';
225 my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
226 my $type_fallback = '\&([_\w]+)';
227 my $type_member_func = $type_member . '\(\)';
229 # Output conversion substitutions.
230 # One for each output format
232 # these are pretty rough
233 my @highlights_man = (
234 [$type_constant, "\$1"],
235 [$type_constant2, "\$1"],
236 [$type_func, "\\\\fB\$1\\\\fP"],
237 [$type_enum, "\\\\fI\$1\\\\fP"],
238 [$type_struct, "\\\\fI\$1\\\\fP"],
239 [$type_typedef, "\\\\fI\$1\\\\fP"],
240 [$type_union, "\\\\fI\$1\\\\fP"],
241 [$type_param, "\\\\fI\$1\\\\fP"],
242 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
243 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
244 [$type_fallback, "\\\\fI\$1\\\\fP"]
246 my $blankline_man = "";
249 my @highlights_rst = (
250 [$type_constant, "``\$1``"],
251 [$type_constant2, "``\$1``"],
252 # Note: need to escape () to avoid func matching later
253 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
254 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
255 [$type_fp_param, "**\$1\\\\(\\\\)**"],
256 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
257 [$type_func, "\$1()"],
258 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
259 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
260 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
261 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
262 # in rst this can refer to any type
263 [$type_fallback, "\\:c\\:type\\:`\$1`"],
264 [$type_param_ref, "**\$1\$2**"]
266 my $blankline_rst = "\n";
276 my $dohighlight = "";
280 my $output_mode = "rst";
281 my $output_preformatted = 0;
282 my $no_doc_sections = 0;
283 my $enable_lineno = 0;
284 my @highlights = @highlights_rst;
285 my $blankline = $blankline_rst;
286 my $modulename = "Kernel API";
289 OUTPUT_ALL => 0, # output all symbols and doc sections
290 OUTPUT_INCLUDE => 1, # output only specified symbols
291 OUTPUT_EXCLUDE => 2, # output everything except specified symbols
292 OUTPUT_EXPORTED => 3, # output exported symbols
293 OUTPUT_INTERNAL => 4, # output non-exported symbols
295 my $output_selection = OUTPUT_ALL;
296 my $show_not_found = 0; # No longer used
298 my @export_file_list;
301 if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
302 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
303 @build_time = gmtime($seconds);
305 @build_time = localtime;
308 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
309 'July', 'August', 'September', 'October',
310 'November', 'December')[$build_time[4]] .
311 " " . ($build_time[5]+1900);
313 # Essentially these are globals.
314 # They probably want to be tidied up, made more localised or something.
315 # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
316 # could cause "use of undefined value" or other bugs.
317 my ($function, %function_table, %parametertypes, $declaration_purpose);
318 my $declaration_start_line;
319 my ($type, $declaration_name, $return_type);
320 my ($newsection, $newcontents, $prototype, $brcount, %source_map);
322 if (defined($ENV{'KBUILD_VERBOSE'})) {
323 $verbose = "$ENV{'KBUILD_VERBOSE'}";
326 if (defined($ENV{'KDOC_WERROR'})) {
327 $Werror = "$ENV{'KDOC_WERROR'}";
330 if (defined($ENV{'KCFLAGS'})) {
331 my $kcflags = "$ENV{'KCFLAGS'}";
333 if ($kcflags =~ /Werror/) {
338 # Generated docbook code is inserted in a template at a point where
339 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
340 # https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
341 # We keep track of number of generated entries and generate a dummy
342 # if needs be to ensure the expanded template can be postprocessed
344 my $section_counter = 0;
350 STATE_NORMAL => 0, # normal code
351 STATE_NAME => 1, # looking for function name
352 STATE_BODY_MAYBE => 2, # body - or maybe more description
353 STATE_BODY => 3, # the body of the comment
354 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
355 STATE_PROTO => 5, # scanning prototype
356 STATE_DOCBLOCK => 6, # documentation block
357 STATE_INLINE => 7, # gathering doc outside main block
363 # Inline documentation state
365 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
366 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
367 STATE_INLINE_TEXT => 2, # looking for member documentation
368 STATE_INLINE_END => 3, # done
369 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
370 # Spit a warning as it's not
371 # proper kernel-doc and ignore the rest.
373 my $inline_doc_state;
375 #declaration types: can be
376 # 'function', 'struct', 'union', 'enum', 'typedef'
379 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
381 my $doc_com = '\s*\*\s*';
382 my $doc_com_body = '\s*\* ?';
383 my $doc_decl = $doc_com . '(\w+)';
384 # @params and a strictly limited set of supported section names
385 my $doc_sect = $doc_com .
386 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
387 my $doc_content = $doc_com_body . '(.*)';
388 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
389 my $doc_inline_start = '^\s*/\*\*\s*$';
390 my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
391 my $doc_inline_end = '^\s*\*/\s*$';
392 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
393 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
396 my %parameterdesc_start_lines;
400 my %section_start_lines;
405 my $new_start_line = 0;
407 # the canonical section names. see also $doc_sect above.
408 my $section_default = "Description"; # default section
409 my $section_intro = "Introduction";
410 my $section = $section_default;
411 my $section_context = "Context";
412 my $section_return = "Return";
414 my $undescribed = "-- undescribed --";
418 while ($ARGV[0] =~ m/^--?(.*)/) {
422 $output_mode = "man";
423 @highlights = @highlights_man;
424 $blankline = $blankline_man;
425 } elsif ($cmd eq "rst") {
426 $output_mode = "rst";
427 @highlights = @highlights_rst;
428 $blankline = $blankline_rst;
429 } elsif ($cmd eq "none") {
430 $output_mode = "none";
431 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
432 $modulename = shift @ARGV;
433 } elsif ($cmd eq "function") { # to only output specific functions
434 $output_selection = OUTPUT_INCLUDE;
435 $function = shift @ARGV;
436 $function_table{$function} = 1;
437 } elsif ($cmd eq "nofunction") { # output all except specific functions
438 $output_selection = OUTPUT_EXCLUDE;
439 $function = shift @ARGV;
440 $function_table{$function} = 1;
441 } elsif ($cmd eq "export") { # only exported symbols
442 $output_selection = OUTPUT_EXPORTED;
443 %function_table = ();
444 } elsif ($cmd eq "internal") { # only non-exported symbols
445 $output_selection = OUTPUT_INTERNAL;
446 %function_table = ();
447 } elsif ($cmd eq "export-file") {
448 my $file = shift @ARGV;
449 push(@export_file_list, $file);
450 } elsif ($cmd eq "v") {
452 } elsif ($cmd eq "Werror") {
454 } elsif (($cmd eq "h") || ($cmd eq "help")) {
456 } elsif ($cmd eq 'no-doc-sections') {
457 $no_doc_sections = 1;
458 } elsif ($cmd eq 'enable-lineno') {
460 } elsif ($cmd eq 'show-not-found') {
461 $show_not_found = 1; # A no-op but don't fail
468 # continue execution near EOF;
470 # The C domain dialect changed on Sphinx 3. So, we need to check the
471 # version in order to produce the right tags.
474 foreach(split(/:/, $ENV{PATH})) {
475 return "$_/$_[0]" if(-x "$_/$_[0]");
479 sub get_sphinx_version()
484 my $cmd = "sphinx-build";
485 if (!findprog($cmd)) {
486 my $cmd = "sphinx-build3";
487 return $major if (!findprog($cmd));
490 open IN, "$cmd --version 2>&1 |";
492 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
496 # Sphinx 1.2.x uses a different format
497 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
507 # get kernel version from env
508 sub get_kernel_version() {
509 my $version = 'unknown kernel version';
511 if (defined($ENV{'KERNELVERSION'})) {
512 $version = $ENV{'KERNELVERSION'};
520 if ($enable_lineno && defined($lineno)) {
521 print "#define LINENO " . $lineno . "\n";
525 # dumps section contents to arrays/hashes intended for that purpose.
530 my $contents = join "\n", @_;
532 if ($name =~ m/$type_param/) {
534 $parameterdescs{$name} = $contents;
535 $sectcheck = $sectcheck . $name . " ";
536 $parameterdesc_start_lines{$name} = $new_start_line;
538 } elsif ($name eq "@\.\.\.") {
540 $parameterdescs{$name} = $contents;
541 $sectcheck = $sectcheck . $name . " ";
542 $parameterdesc_start_lines{$name} = $new_start_line;
545 if (defined($sections{$name}) && ($sections{$name} ne "")) {
546 # Only warn on user specified duplicate section names.
547 if ($name ne $section_default) {
548 print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
551 $sections{$name} .= $contents;
553 $sections{$name} = $contents;
554 push @sectionlist, $name;
555 $section_start_lines{$name} = $new_start_line;
562 # dump DOC: section after checking that it should go out
564 sub dump_doc_section {
567 my $contents = join "\n", @_;
569 if ($no_doc_sections) {
573 if (($output_selection == OUTPUT_ALL) ||
574 ($output_selection == OUTPUT_INCLUDE &&
575 defined($function_table{$name})) ||
576 ($output_selection == OUTPUT_EXCLUDE &&
577 !defined($function_table{$name})))
579 dump_section($file, $name, $contents);
580 output_blockhead({'sectionlist' => \@sectionlist,
581 'sections' => \%sections,
582 'module' => $modulename,
583 'content-only' => ($output_selection != OUTPUT_ALL), });
590 # parameterdescs, a hash.
591 # function => "function name"
592 # parameterlist => @list of parameters
593 # parameterdescs => %parameter descriptions
594 # sectionlist => @list of sections
595 # sections => %section descriptions
598 sub output_highlight {
599 my $contents = join "\n",@_;
603 # if (!defined $contents) {
605 # confess "output_highlight got called with no args?\n";
608 # print STDERR "contents b4:$contents\n";
611 # print STDERR "contents af:$contents\n";
613 foreach $line (split "\n", $contents) {
614 if (! $output_preformatted) {
618 if (! $output_preformatted) {
619 print $lineprefix, $blankline;
622 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
625 print $lineprefix, $line;
633 # output function in man
634 sub output_function_man(%) {
636 my ($parameter, $section);
639 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
642 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
644 print ".SH SYNOPSIS\n";
645 if ($args{'functiontype'} ne "") {
646 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
648 print ".B \"" . $args{'function'} . "\n";
653 foreach my $parameter (@{$args{'parameterlist'}}) {
654 if ($count == $#{$args{'parameterlist'}}) {
657 $type = $args{'parametertypes'}{$parameter};
658 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
659 # pointer-to-function
660 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
662 $type =~ s/([^\*])$/$1 /;
663 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
669 print ".SH ARGUMENTS\n";
670 foreach $parameter (@{$args{'parameterlist'}}) {
671 my $parameter_name = $parameter;
672 $parameter_name =~ s/\[.*//;
674 print ".IP \"" . $parameter . "\" 12\n";
675 output_highlight($args{'parameterdescs'}{$parameter_name});
677 foreach $section (@{$args{'sectionlist'}}) {
678 print ".SH \"", uc $section, "\"\n";
679 output_highlight($args{'sections'}{$section});
685 sub output_enum_man(%) {
687 my ($parameter, $section);
690 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
693 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
695 print ".SH SYNOPSIS\n";
696 print "enum " . $args{'enum'} . " {\n";
698 foreach my $parameter (@{$args{'parameterlist'}}) {
699 print ".br\n.BI \" $parameter\"\n";
700 if ($count == $#{$args{'parameterlist'}}) {
710 print ".SH Constants\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 \"$section\"\n";
720 output_highlight($args{'sections'}{$section});
725 # output struct in man
726 sub output_struct_man(%) {
728 my ($parameter, $section);
730 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
733 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
735 my $declaration = $args{'definition'};
736 $declaration =~ s/\t/ /g;
737 $declaration =~ s/\n/"\n.br\n.BI \"/g;
738 print ".SH SYNOPSIS\n";
739 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
740 print ".BI \"$declaration\n};\n.br\n\n";
742 print ".SH Members\n";
743 foreach $parameter (@{$args{'parameterlist'}}) {
744 ($parameter =~ /^#/) && next;
746 my $parameter_name = $parameter;
747 $parameter_name =~ s/\[.*//;
749 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
750 print ".IP \"" . $parameter . "\" 12\n";
751 output_highlight($args{'parameterdescs'}{$parameter_name});
753 foreach $section (@{$args{'sectionlist'}}) {
754 print ".SH \"$section\"\n";
755 output_highlight($args{'sections'}{$section});
760 # output typedef in man
761 sub output_typedef_man(%) {
763 my ($parameter, $section);
765 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
768 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
770 foreach $section (@{$args{'sectionlist'}}) {
771 print ".SH \"$section\"\n";
772 output_highlight($args{'sections'}{$section});
776 sub output_blockhead_man(%) {
778 my ($parameter, $section);
781 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
783 foreach $section (@{$args{'sectionlist'}}) {
784 print ".SH \"$section\"\n";
785 output_highlight($args{'sections'}{$section});
790 # output in restructured text
794 # This could use some work; it's used to output the DOC: sections, and
795 # starts by putting out the name of the doc section itself, but that tends
796 # to duplicate a header already in the template file.
798 sub output_blockhead_rst(%) {
800 my ($parameter, $section);
802 foreach $section (@{$args{'sectionlist'}}) {
803 if ($output_selection != OUTPUT_INCLUDE) {
804 print "**$section**\n\n";
806 print_lineno($section_start_lines{$section});
807 output_highlight_rst($args{'sections'}{$section});
813 # Apply the RST highlights to a sub-block of text.
815 sub highlight_block($) {
816 # The dohighlight kludge requires the text be called $contents
817 my $contents = shift;
824 # Regexes used only here.
826 my $sphinx_literal = '^[^.].*::$';
827 my $sphinx_cblock = '^\.\.\ +code-block::';
829 sub output_highlight_rst {
830 my $input = join "\n",@_;
837 foreach $line (split "\n",$input) {
839 # If we're in a literal block, see if we should drop out
840 # of it. Otherwise pass the line straight through unmunged.
843 if (! ($line =~ /^\s*$/)) {
845 # If this is the first non-blank line in a literal
846 # block we need to figure out what the proper indent is.
848 if ($litprefix eq "") {
850 $litprefix = '^' . $1;
851 $output .= $line . "\n";
852 } elsif (! ($line =~ /$litprefix/)) {
855 $output .= $line . "\n";
858 $output .= $line . "\n";
862 # Not in a literal block (or just dropped out)
865 $block .= $line . "\n";
866 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
869 $output .= highlight_block($block);
876 $output .= highlight_block($block);
878 foreach $line (split "\n", $output) {
879 print $lineprefix . $line . "\n";
883 sub output_function_rst(%) {
885 my ($parameter, $section);
886 my $oldprefix = $lineprefix;
889 if ($sphinx_major < 3) {
890 if ($args{'typedef'}) {
891 print ".. c:type:: ". $args{'function'} . "\n\n";
892 print_lineno($declaration_start_line);
893 print " **Typedef**: ";
895 output_highlight_rst($args{'purpose'});
896 $start = "\n\n**Syntax**\n\n ``";
898 print ".. c:function:: ";
901 print ".. c:macro:: ". $args{'function'} . "\n\n";
903 if ($args{'typedef'}) {
904 print_lineno($declaration_start_line);
905 print " **Typedef**: ";
907 output_highlight_rst($args{'purpose'});
908 $start = "\n\n**Syntax**\n\n ``";
913 if ($args{'functiontype'} ne "") {
914 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
916 $start .= $args{'function'} . " (";
921 foreach my $parameter (@{$args{'parameterlist'}}) {
926 $type = $args{'parametertypes'}{$parameter};
928 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
929 # pointer-to-function
930 print $1 . $parameter . ") (" . $2 . ")";
932 print $type . " " . $parameter;
935 if ($args{'typedef'}) {
938 if ($sphinx_major < 3) {
943 print_lineno($declaration_start_line);
945 output_highlight_rst($args{'purpose'});
949 print "**Parameters**\n\n";
951 foreach $parameter (@{$args{'parameterlist'}}) {
952 my $parameter_name = $parameter;
953 $parameter_name =~ s/\[.*//;
954 $type = $args{'parametertypes'}{$parameter};
957 print "``$type $parameter``\n";
959 print "``$parameter``\n";
962 print_lineno($parameterdesc_start_lines{$parameter_name});
964 if (defined($args{'parameterdescs'}{$parameter_name}) &&
965 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
966 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
968 print " *undescribed*\n";
973 $lineprefix = $oldprefix;
974 output_section_rst(@_);
977 sub output_section_rst(%) {
980 my $oldprefix = $lineprefix;
983 foreach $section (@{$args{'sectionlist'}}) {
984 print "**$section**\n\n";
985 print_lineno($section_start_lines{$section});
986 output_highlight_rst($args{'sections'}{$section});
990 $lineprefix = $oldprefix;
993 sub output_enum_rst(%) {
996 my $oldprefix = $lineprefix;
999 if ($sphinx_major < 3) {
1000 my $name = "enum " . $args{'enum'};
1001 print "\n\n.. c:type:: " . $name . "\n\n";
1003 my $name = $args{'enum'};
1004 print "\n\n.. c:enum:: " . $name . "\n\n";
1006 print_lineno($declaration_start_line);
1008 output_highlight_rst($args{'purpose'});
1011 print "**Constants**\n\n";
1013 foreach $parameter (@{$args{'parameterlist'}}) {
1014 print "``$parameter``\n";
1015 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
1016 output_highlight_rst($args{'parameterdescs'}{$parameter});
1018 print " *undescribed*\n";
1023 $lineprefix = $oldprefix;
1024 output_section_rst(@_);
1027 sub output_typedef_rst(%) {
1028 my %args = %{$_[0]};
1030 my $oldprefix = $lineprefix;
1033 if ($sphinx_major < 3) {
1034 $name = "typedef " . $args{'typedef'};
1036 $name = $args{'typedef'};
1038 print "\n\n.. c:type:: " . $name . "\n\n";
1039 print_lineno($declaration_start_line);
1041 output_highlight_rst($args{'purpose'});
1044 $lineprefix = $oldprefix;
1045 output_section_rst(@_);
1048 sub output_struct_rst(%) {
1049 my %args = %{$_[0]};
1051 my $oldprefix = $lineprefix;
1053 if ($sphinx_major < 3) {
1054 my $name = $args{'type'} . " " . $args{'struct'};
1055 print "\n\n.. c:type:: " . $name . "\n\n";
1057 my $name = $args{'struct'};
1058 print "\n\n.. c:struct:: " . $name . "\n\n";
1060 print_lineno($declaration_start_line);
1062 output_highlight_rst($args{'purpose'});
1065 print "**Definition**\n\n";
1067 my $declaration = $args{'definition'};
1068 $declaration =~ s/\t/ /g;
1069 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n";
1071 print "**Members**\n\n";
1073 foreach $parameter (@{$args{'parameterlist'}}) {
1074 ($parameter =~ /^#/) && next;
1076 my $parameter_name = $parameter;
1077 $parameter_name =~ s/\[.*//;
1079 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1080 $type = $args{'parametertypes'}{$parameter};
1081 print_lineno($parameterdesc_start_lines{$parameter_name});
1082 print "``" . $parameter . "``\n";
1083 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1088 $lineprefix = $oldprefix;
1089 output_section_rst(@_);
1092 ## none mode output functions
1094 sub output_function_none(%) {
1097 sub output_enum_none(%) {
1100 sub output_typedef_none(%) {
1103 sub output_struct_none(%) {
1106 sub output_blockhead_none(%) {
1110 # generic output function for all types (function, struct/union, typedef, enum);
1111 # calls the generated, variable output_ function name based on
1112 # functype and output_mode
1113 sub output_declaration {
1116 my $functype = shift;
1117 my $func = "output_${functype}_$output_mode";
1118 if (($output_selection == OUTPUT_ALL) ||
1119 (($output_selection == OUTPUT_INCLUDE ||
1120 $output_selection == OUTPUT_EXPORTED) &&
1121 defined($function_table{$name})) ||
1122 (($output_selection == OUTPUT_EXCLUDE ||
1123 $output_selection == OUTPUT_INTERNAL) &&
1124 !($functype eq "function" && defined($function_table{$name}))))
1132 # generic output function - calls the right one based on current output mode.
1133 sub output_blockhead {
1135 my $func = "output_blockhead_" . $output_mode;
1141 # takes a declaration (struct, union, enum, typedef) and
1142 # invokes the right handler. NOT called for functions.
1143 sub dump_declaration($$) {
1145 my ($prototype, $file) = @_;
1146 my $func = "dump_" . $decl_type;
1150 sub dump_union($$) {
1154 sub dump_struct($$) {
1158 if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) {
1160 $declaration_name = $2;
1163 # ignore members marked private:
1164 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1165 $members =~ s/\/\*\s*private:.*//gosi;
1167 $members =~ s/\/\*.*?\*\///gos;
1169 $members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)/ /gi;
1170 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1171 $members =~ s/\s*__packed\s*/ /gos;
1172 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1173 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1174 $members =~ s/\s*____cacheline_aligned/ /gos;
1176 # replace DECLARE_BITMAP
1177 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1178 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1179 # replace DECLARE_HASHTABLE
1180 $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1181 # replace DECLARE_KFIFO
1182 $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1183 # replace DECLARE_KFIFO_PTR
1184 $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1186 my $declaration = $members;
1188 # Split nested struct/union elements as newer ones
1189 while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) {
1194 foreach my $id(split /,/, $ids) {
1195 $newmember .= "$maintype $id; ";
1198 $id =~ s/^\s*\**(\S+)\s*/$1/;
1199 foreach my $arg (split /;/, $content) {
1200 next if ($arg =~ m/^\s*$/);
1201 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1202 # pointer-to-function
1207 if ($id =~ m/^\s*$/) {
1208 # anonymous struct/union
1209 $newmember .= "$type$name$extra; ";
1211 $newmember .= "$type$id.$name$extra; ";
1219 $arg =~ s/:\s*\d+\s*//g;
1221 $arg =~ s/\[.*\]//g;
1222 # The type may have multiple words,
1223 # and multiple IDs can be defined, like:
1224 # const struct foo, *bar, foobar
1225 # So, we remove spaces when parsing the
1226 # names, in order to match just names
1227 # and commas for the names
1228 $arg =~ s/\s*,\s*/,/g;
1229 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1233 $newmember .= "$arg; ";
1236 foreach my $name (split /,/, $names) {
1237 $name =~ s/^\s*\**(\S+)\s*/$1/;
1238 next if (($name =~ m/^\s*$/));
1239 if ($id =~ m/^\s*$/) {
1240 # anonymous struct/union
1241 $newmember .= "$type $name; ";
1243 $newmember .= "$type $id.$name; ";
1249 $members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/;
1252 # Ignore other nested elements, like enums
1253 $members =~ s/(\{[^\{\}]*\})//g;
1255 create_parameterlist($members, ';', $file, $declaration_name);
1256 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1258 # Adjust declaration for better display
1259 $declaration =~ s/([\{;])/$1\n/g;
1260 $declaration =~ s/\}\s+;/};/g;
1261 # Better handle inlined enums
1262 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1264 my @def_args = split /\n/, $declaration;
1267 foreach my $clause (@def_args) {
1268 $clause =~ s/^\s+//;
1269 $clause =~ s/\s+$//;
1270 $clause =~ s/\s+/ /;
1272 $level-- if ($clause =~ m/(\})/ && $level > 1);
1273 if (!($clause =~ m/^\s*#/)) {
1274 $declaration .= "\t" x $level;
1276 $declaration .= "\t" . $clause . "\n";
1277 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1279 output_declaration($declaration_name,
1281 {'struct' => $declaration_name,
1282 'module' => $modulename,
1283 'definition' => $declaration,
1284 'parameterlist' => \@parameterlist,
1285 'parameterdescs' => \%parameterdescs,
1286 'parametertypes' => \%parametertypes,
1287 'sectionlist' => \@sectionlist,
1288 'sections' => \%sections,
1289 'purpose' => $declaration_purpose,
1290 'type' => $decl_type
1294 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1300 sub show_warnings($$) {
1301 my $functype = shift;
1304 return 1 if ($output_selection == OUTPUT_ALL);
1306 if ($output_selection == OUTPUT_EXPORTED) {
1307 if (defined($function_table{$name})) {
1313 if ($output_selection == OUTPUT_INTERNAL) {
1314 if (!($functype eq "function" && defined($function_table{$name}))) {
1320 if ($output_selection == OUTPUT_INCLUDE) {
1321 if (defined($function_table{$name})) {
1327 if ($output_selection == OUTPUT_EXCLUDE) {
1328 if (!defined($function_table{$name})) {
1334 die("Please add the new output type at show_warnings()");
1343 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1344 # strip #define macros inside enums
1345 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1347 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1348 $declaration_name = $2;
1350 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1351 $declaration_name = $1;
1355 if ($declaration_name) {
1358 $members =~ s/\s+$//;
1360 foreach my $arg (split ',', $members) {
1361 $arg =~ s/^\s*(\w+).*/$1/;
1362 push @parameterlist, $arg;
1363 if (!$parameterdescs{$arg}) {
1364 $parameterdescs{$arg} = $undescribed;
1365 if (show_warnings("enum", $declaration_name)) {
1366 print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1369 $_members{$arg} = 1;
1372 while (my ($k, $v) = each %parameterdescs) {
1373 if (!exists($_members{$k})) {
1374 if (show_warnings("enum", $declaration_name)) {
1375 print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1380 output_declaration($declaration_name,
1382 {'enum' => $declaration_name,
1383 'module' => $modulename,
1384 'parameterlist' => \@parameterlist,
1385 'parameterdescs' => \%parameterdescs,
1386 'sectionlist' => \@sectionlist,
1387 'sections' => \%sections,
1388 'purpose' => $declaration_purpose
1391 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1396 sub dump_typedef($$) {
1400 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1402 # Parse function prototypes
1403 if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
1404 $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {
1408 $declaration_name = $2;
1411 create_parameterlist($args, ',', $file, $declaration_name);
1413 output_declaration($declaration_name,
1415 {'function' => $declaration_name,
1417 'module' => $modulename,
1418 'functiontype' => $return_type,
1419 'parameterlist' => \@parameterlist,
1420 'parameterdescs' => \%parameterdescs,
1421 'parametertypes' => \%parametertypes,
1422 'sectionlist' => \@sectionlist,
1423 'sections' => \%sections,
1424 'purpose' => $declaration_purpose
1429 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1430 $x =~ s/\(*.\)\s*;$/;/;
1431 $x =~ s/\[*.\]\s*;$/;/;
1434 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1435 $declaration_name = $1;
1437 output_declaration($declaration_name,
1439 {'typedef' => $declaration_name,
1440 'module' => $modulename,
1441 'sectionlist' => \@sectionlist,
1442 'sections' => \%sections,
1443 'purpose' => $declaration_purpose
1447 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1452 sub save_struct_actual($) {
1455 # strip all spaces from the actual param so that it looks like one string item
1456 $actual =~ s/\s*//g;
1457 $struct_actual = $struct_actual . $actual . " ";
1460 sub create_parameterlist($$$$) {
1462 my $splitter = shift;
1464 my $declaration_name = shift;
1468 # temporarily replace commas inside function pointer definition
1469 while ($args =~ /(\([^\),]+),/) {
1470 $args =~ s/(\([^\),]+),/$1#/g;
1473 foreach my $arg (split($splitter, $args)) {
1475 $arg =~ s/\/\*.*\*\///;
1476 # strip leading/trailing spaces
1482 # Treat preprocessor directive as a typeless variable just to fill
1483 # corresponding data structures "correctly". Catch it later in
1485 push_parameter($arg, "", $file);
1486 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1487 # pointer-to-function
1489 $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/;
1492 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1493 save_struct_actual($param);
1494 push_parameter($param, $type, $file, $declaration_name);
1496 $arg =~ s/\s*:\s*/:/g;
1497 $arg =~ s/\s*\[/\[/g;
1499 my @args = split('\s*,\s*', $arg);
1500 if ($args[0] =~ m/\*/) {
1501 $args[0] =~ s/(\*+)\s*/ $1/;
1505 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1507 push(@first_arg, split('\s+', $1));
1508 push(@first_arg, $2);
1510 @first_arg = split('\s+', shift @args);
1513 unshift(@args, pop @first_arg);
1514 $type = join " ", @first_arg;
1516 foreach $param (@args) {
1517 if ($param =~ m/^(\*+)\s*(.*)/) {
1518 save_struct_actual($2);
1519 push_parameter($2, "$type $1", $file, $declaration_name);
1521 elsif ($param =~ m/(.*?):(\d+)/) {
1522 if ($type ne "") { # skip unnamed bit-fields
1523 save_struct_actual($1);
1524 push_parameter($1, "$type:$2", $file, $declaration_name)
1528 save_struct_actual($param);
1529 push_parameter($param, $type, $file, $declaration_name);
1536 sub push_parameter($$$$) {
1540 my $declaration_name = shift;
1542 if (($anon_struct_union == 1) && ($type eq "") &&
1544 return; # ignore the ending }; from anon. struct/union
1547 $anon_struct_union = 0;
1548 $param =~ s/[\[\)].*//;
1550 if ($type eq "" && $param =~ /\.\.\.$/)
1552 if (!$param =~ /\w\.\.\.$/) {
1553 # handles unnamed variable parameters
1556 elsif ($param =~ /\w\.\.\.$/) {
1557 # for named variable parameters of the form `x...`, remove the dots
1558 $param =~ s/\.\.\.$//;
1560 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1561 $parameterdescs{$param} = "variable arguments";
1564 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1567 $parameterdescs{void} = "no arguments";
1569 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1570 # handle unnamed (anonymous) union or struct:
1573 $param = "{unnamed_" . $param . "}";
1574 $parameterdescs{$param} = "anonymous\n";
1575 $anon_struct_union = 1;
1578 # warn if parameter has no description
1579 # (but ignore ones starting with # as these are not parameters
1580 # but inline preprocessor statements);
1581 # Note: It will also ignore void params and unnamed structs/unions
1582 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1583 $parameterdescs{$param} = $undescribed;
1585 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1587 "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1592 # strip spaces from $param so that it is one continuous string
1593 # on @parameterlist;
1594 # this fixes a problem where check_sections() cannot find
1595 # a parameter like "addr[6 + 2]" because it actually appears
1596 # as "addr[6", "+", "2]" on the parameter list;
1597 # but it's better to maintain the param string unchanged for output,
1598 # so just weaken the string compare in check_sections() to ignore
1599 # "[blah" in a parameter string;
1600 ###$param =~ s/\s*//g;
1601 push @parameterlist, $param;
1602 $type =~ s/\s\s+/ /g;
1603 $parametertypes{$param} = $type;
1606 sub check_sections($$$$$) {
1607 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1608 my @sects = split ' ', $sectcheck;
1609 my @prms = split ' ', $prmscheck;
1612 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1614 foreach $sx (0 .. $#sects) {
1616 foreach $px (0 .. $#prms) {
1617 $prm_clean = $prms[$px];
1618 $prm_clean =~ s/\[.*\]//;
1619 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1620 # ignore array size in a parameter string;
1621 # however, the original param string may contain
1622 # spaces, e.g.: addr[6 + 2]
1623 # and this appears in @prms as "addr[6" since the
1624 # parameter list is split at spaces;
1625 # hence just ignore "[..." for the sections check;
1626 $prm_clean =~ s/\[.*//;
1628 ##$prm_clean =~ s/^\**//;
1629 if ($prm_clean eq $sects[$sx]) {
1635 if ($decl_type eq "function") {
1636 print STDERR "${file}:$.: warning: " .
1637 "Excess function parameter " .
1639 "description in '$decl_name'\n";
1647 # Checks the section describing the return value of a function.
1648 sub check_return_section {
1650 my $declaration_name = shift;
1651 my $return_type = shift;
1653 # Ignore an empty return type (It's a macro)
1654 # Ignore functions with a "void" return type. (But don't ignore "void *")
1655 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1659 if (!defined($sections{$section_return}) ||
1660 $sections{$section_return} eq "") {
1661 print STDERR "${file}:$.: warning: " .
1662 "No description found for return value of " .
1663 "'$declaration_name'\n";
1669 # takes a function prototype and the name of the current file being
1670 # processed and spits out all the details stored in the global
1672 sub dump_function($$) {
1673 my $prototype = shift;
1679 $prototype =~ s/^static +//;
1680 $prototype =~ s/^extern +//;
1681 $prototype =~ s/^asmlinkage +//;
1682 $prototype =~ s/^inline +//;
1683 $prototype =~ s/^__inline__ +//;
1684 $prototype =~ s/^__inline +//;
1685 $prototype =~ s/^__always_inline +//;
1686 $prototype =~ s/^noinline +//;
1687 $prototype =~ s/__init +//;
1688 $prototype =~ s/__init_or_module +//;
1689 $prototype =~ s/__meminit +//;
1690 $prototype =~ s/__must_check +//;
1691 $prototype =~ s/__weak +//;
1692 $prototype =~ s/__sched +//;
1693 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1694 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1695 $prototype =~ s/__attribute__\s*\(\(
1697 [\w\s]++ # attribute name
1698 (?:\([^)]*+\))? # attribute arguments
1699 \s*+,? # optional comma at the end
1703 # Yes, this truly is vile. We are looking for:
1704 # 1. Return type (may be nothing if we're looking at a macro)
1706 # 3. Function parameters.
1708 # All the while we have to watch out for function pointer parameters
1709 # (which IIRC is what the two sections are for), C types (these
1710 # regexps don't even start to express all the possibilities), and
1713 # If you mess with these regexps, it's a good idea to check that
1714 # the following functions' documentation still comes out right:
1715 # - parport_register_device (function pointer parameters)
1716 # - atomic_set (macro)
1717 # - pci_match_device, __copy_to_user (long return type)
1719 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
1720 # This is an object-like macro, it has no return type and no parameter
1722 # Function-like macros are not allowed to have spaces between
1723 # declaration_name and opening parenthesis (notice the \s+).
1725 $declaration_name = $2;
1727 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1728 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1729 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1730 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1731 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1732 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1733 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1734 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1735 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1736 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1737 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1738 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1739 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1740 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1741 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1742 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1743 $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1745 $declaration_name = $2;
1748 create_parameterlist($args, ',', $file, $declaration_name);
1750 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
1754 my $prms = join " ", @parameterlist;
1755 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1757 # This check emits a lot of warnings at the moment, because many
1758 # functions don't have a 'Return' doc section. So until the number
1759 # of warnings goes sufficiently down, the check is only performed in
1761 # TODO: always perform the check.
1762 if ($verbose && !$noret) {
1763 check_return_section($file, $declaration_name, $return_type);
1766 output_declaration($declaration_name,
1768 {'function' => $declaration_name,
1769 'module' => $modulename,
1770 'functiontype' => $return_type,
1771 'parameterlist' => \@parameterlist,
1772 'parameterdescs' => \%parameterdescs,
1773 'parametertypes' => \%parametertypes,
1774 'sectionlist' => \@sectionlist,
1775 'sections' => \%sections,
1776 'purpose' => $declaration_purpose
1782 %parameterdescs = ();
1783 %parametertypes = ();
1784 @parameterlist = ();
1788 $struct_actual = "";
1791 $state = STATE_NORMAL;
1792 $inline_doc_state = STATE_INLINE_NA;
1795 sub tracepoint_munge($) {
1797 my $tracepointname = 0;
1798 my $tracepointargs = 0;
1800 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1801 $tracepointname = $1;
1803 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1804 $tracepointname = $1;
1806 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1807 $tracepointname = $2;
1809 $tracepointname =~ s/^\s+//; #strip leading whitespace
1810 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1811 $tracepointargs = $1;
1813 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1814 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
1817 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1821 sub syscall_munge() {
1824 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1825 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1826 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1828 ## $prototype = "long sys_$1(void)";
1831 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1832 if ($prototype =~ m/long (sys_.*?),/) {
1833 $prototype =~ s/,/\(/;
1835 $prototype =~ s/\)/\(void\)/;
1838 # now delete all of the odd-number commas in $prototype
1839 # so that arg types & arg names don't have a comma between them
1841 my $len = length($prototype);
1843 $len = 0; # skip the for-loop
1845 for (my $ix = 0; $ix < $len; $ix++) {
1846 if (substr($prototype, $ix, 1) eq ',') {
1848 if ($count % 2 == 1) {
1849 substr($prototype, $ix, 1) = ' ';
1855 sub process_proto_function($$) {
1859 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1861 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1864 elsif ($x =~ /([^\{]*)/) {
1868 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1869 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1870 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1871 $prototype =~ s@^\s+@@gos; # strip leading spaces
1873 # Handle prototypes for function pointers like:
1874 # int (*pcs_config)(struct foo)
1875 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1877 if ($prototype =~ /SYSCALL_DEFINE/) {
1880 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1881 $prototype =~ /DEFINE_SINGLE_EVENT/)
1883 tracepoint_munge($file);
1885 dump_function($prototype, $file);
1890 sub process_proto_type($$) {
1894 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1895 $x =~ s@^\s+@@gos; # strip leading spaces
1896 $x =~ s@\s+$@@gos; # strip trailing spaces
1897 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1900 # To distinguish preprocessor directive from regular declaration later.
1905 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1906 if( length $prototype ) {
1909 $prototype .= $1 . $2;
1910 ($2 eq '{') && $brcount++;
1911 ($2 eq '}') && $brcount--;
1912 if (($2 eq ';') && ($brcount == 0)) {
1913 dump_declaration($prototype, $file);
1926 sub map_filename($) {
1928 my ($orig_file) = @_;
1930 if (defined($ENV{'SRCTREE'})) {
1931 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1936 if (defined($source_map{$file})) {
1937 $file = $source_map{$file};
1943 sub process_export_file($) {
1944 my ($orig_file) = @_;
1945 my $file = map_filename($orig_file);
1947 if (!open(IN,"<$file")) {
1948 print STDERR "Error: Cannot open file $file\n";
1954 if (/$export_symbol/) {
1955 $function_table{$2} = 1;
1963 # Parsers for the various processing states.
1965 # STATE_NORMAL: looking for the /** to begin everything.
1967 sub process_normal() {
1968 if (/$doc_start/o) {
1969 $state = STATE_NAME; # next line is always the function name
1971 $declaration_start_line = $. + 1;
1976 # STATE_NAME: Looking for the "name - description" line
1978 sub process_name($$) {
1983 if (/$doc_block/o) {
1984 $state = STATE_DOCBLOCK;
1986 $new_start_line = $. + 1;
1989 $section = $section_intro;
1994 elsif (/$doc_decl/o) {
1996 if (/\s*([\w\s]+?)(\(\))?\s*-/) {
2000 $state = STATE_BODY;
2001 # if there's no @param blocks need to set up default section
2004 $section = $section_default;
2005 $new_start_line = $. + 1;
2007 # strip leading/trailing/multiple spaces
2011 $descr =~ s/\s+/ /g;
2012 $declaration_purpose = $descr;
2013 $state = STATE_BODY_MAYBE;
2015 $declaration_purpose = "";
2018 if (($declaration_purpose eq "") && $verbose) {
2019 print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2024 if ($identifier =~ m/^struct\b/) {
2025 $decl_type = 'struct';
2026 } elsif ($identifier =~ m/^union\b/) {
2027 $decl_type = 'union';
2028 } elsif ($identifier =~ m/^enum\b/) {
2029 $decl_type = 'enum';
2030 } elsif ($identifier =~ m/^typedef\b/) {
2031 $decl_type = 'typedef';
2033 $decl_type = 'function';
2037 print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
2040 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2041 " - I thought it was a doc line\n";
2043 $state = STATE_NORMAL;
2049 # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2051 sub process_body($$) {
2054 # Until all named variable macro parameters are
2055 # documented using the bare name (`x`) rather than with
2056 # dots (`x...`), strip the dots:
2057 if ($section =~ /\w\.\.\.$/) {
2058 $section =~ s/\.\.\.$//;
2061 print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n";
2066 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2067 dump_section($file, $section, $contents);
2068 $section = $section_default;
2072 if (/$doc_sect/i) { # case insensitive for supported section names
2076 # map the supported section names to the canonical names
2077 if ($newsection =~ m/^description$/i) {
2078 $newsection = $section_default;
2079 } elsif ($newsection =~ m/^context$/i) {
2080 $newsection = $section_context;
2081 } elsif ($newsection =~ m/^returns?$/i) {
2082 $newsection = $section_return;
2083 } elsif ($newsection =~ m/^\@return$/) {
2084 # special: @return is a section, not a param description
2085 $newsection = $section_return;
2088 if (($contents ne "") && ($contents ne "\n")) {
2089 if (!$in_doc_sect && $verbose) {
2090 print STDERR "${file}:$.: warning: contents before sections\n";
2093 dump_section($file, $section, $contents);
2094 $section = $section_default;
2098 $state = STATE_BODY;
2099 $contents = $newcontents;
2100 $new_start_line = $.;
2101 while (substr($contents, 0, 1) eq " ") {
2102 $contents = substr($contents, 1);
2104 if ($contents ne "") {
2107 $section = $newsection;
2108 $leading_space = undef;
2109 } elsif (/$doc_end/) {
2110 if (($contents ne "") && ($contents ne "\n")) {
2111 dump_section($file, $section, $contents);
2112 $section = $section_default;
2115 # look for doc_com + <text> + doc_end:
2116 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2117 print STDERR "${file}:$.: warning: suspicious ending line: $_";
2122 $state = STATE_PROTO;
2124 } elsif (/$doc_content/) {
2126 if ($section eq $section_context) {
2127 dump_section($file, $section, $contents);
2128 $section = $section_default;
2130 $new_start_line = $.;
2131 $state = STATE_BODY;
2133 if ($section ne $section_default) {
2134 $state = STATE_BODY_WITH_BLANK_LINE;
2136 $state = STATE_BODY;
2140 } elsif ($state == STATE_BODY_MAYBE) {
2141 # Continued declaration purpose
2142 chomp($declaration_purpose);
2143 $declaration_purpose .= " " . $1;
2144 $declaration_purpose =~ s/\s+/ /g;
2147 if ($section =~ m/^@/ || $section eq $section_context) {
2148 if (!defined $leading_space) {
2149 if ($cont =~ m/^(\s+)/) {
2150 $leading_space = $1;
2152 $leading_space = "";
2155 $cont =~ s/^$leading_space//;
2157 $contents .= $cont . "\n";
2160 # i dont know - bad line? ignore.
2161 print STDERR "${file}:$.: warning: bad line: $_";
2168 # STATE_PROTO: reading a function/whatever prototype.
2170 sub process_proto($$) {
2173 if (/$doc_inline_oneline/) {
2176 if ($contents ne "") {
2178 dump_section($file, $section, $contents);
2179 $section = $section_default;
2182 } elsif (/$doc_inline_start/) {
2183 $state = STATE_INLINE;
2184 $inline_doc_state = STATE_INLINE_NAME;
2185 } elsif ($decl_type eq 'function') {
2186 process_proto_function($_, $file);
2188 process_proto_type($_, $file);
2193 # STATE_DOCBLOCK: within a DOC: block.
2195 sub process_docblock($$) {
2199 dump_doc_section($file, $section, $contents);
2200 $section = $section_default;
2203 %parameterdescs = ();
2204 %parametertypes = ();
2205 @parameterlist = ();
2209 $state = STATE_NORMAL;
2210 } elsif (/$doc_content/) {
2212 $contents .= $blankline;
2214 $contents .= $1 . "\n";
2220 # STATE_INLINE: docbook comments within a prototype.
2222 sub process_inline($$) {
2225 # First line (state 1) needs to be a @parameter
2226 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2229 $new_start_line = $.;
2230 if ($contents ne "") {
2231 while (substr($contents, 0, 1) eq " ") {
2232 $contents = substr($contents, 1);
2236 $inline_doc_state = STATE_INLINE_TEXT;
2237 # Documentation block end */
2238 } elsif (/$doc_inline_end/) {
2239 if (($contents ne "") && ($contents ne "\n")) {
2240 dump_section($file, $section, $contents);
2241 $section = $section_default;
2244 $state = STATE_PROTO;
2245 $inline_doc_state = STATE_INLINE_NA;
2247 } elsif (/$doc_content/) {
2248 if ($inline_doc_state == STATE_INLINE_TEXT) {
2249 $contents .= $1 . "\n";
2250 # nuke leading blank lines
2251 if ($contents =~ /^\s*$/) {
2254 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2255 $inline_doc_state = STATE_INLINE_ERROR;
2256 print STDERR "${file}:$.: warning: ";
2257 print STDERR "Incorrect use of kernel-doc format: $_";
2264 sub process_file($) {
2266 my $initial_section_counter = $section_counter;
2267 my ($orig_file) = @_;
2269 $file = map_filename($orig_file);
2271 if (!open(IN,"<$file")) {
2272 print STDERR "Error: Cannot open file $file\n";
2279 $section_counter = 0;
2281 while (s/\\\s*$//) {
2284 # Replace tabs by spaces
2285 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2286 # Hand this line to the appropriate state handler
2287 if ($state == STATE_NORMAL) {
2289 } elsif ($state == STATE_NAME) {
2290 process_name($file, $_);
2291 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2292 $state == STATE_BODY_WITH_BLANK_LINE) {
2293 process_body($file, $_);
2294 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2295 process_inline($file, $_);
2296 } elsif ($state == STATE_PROTO) {
2297 process_proto($file, $_);
2298 } elsif ($state == STATE_DOCBLOCK) {
2299 process_docblock($file, $_);
2303 # Make sure we got something interesting.
2304 if ($initial_section_counter == $section_counter && $
2305 output_mode ne "none") {
2306 if ($output_selection == OUTPUT_INCLUDE) {
2307 print STDERR "${file}:1: warning: '$_' not found\n"
2308 for keys %function_table;
2311 print STDERR "${file}:1: warning: no structured comments found\n";
2317 $sphinx_major = get_sphinx_version();
2318 $kernelversion = get_kernel_version();
2320 # generate a sequence of code that will splice in highlighting information
2321 # using the s// operator.
2322 for (my $k = 0; $k < @highlights; $k++) {
2323 my $pattern = $highlights[$k][0];
2324 my $result = $highlights[$k][1];
2325 # print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2326 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2329 # Read the file that maps relative names to absolute names for
2330 # separate source and object directories and for shadow trees.
2331 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2332 my ($relname, $absname);
2333 while(<SOURCE_MAP>) {
2335 ($relname, $absname) = (split())[0..1];
2336 $relname =~ s:^/+::;
2337 $source_map{$relname} = $absname;
2342 if ($output_selection == OUTPUT_EXPORTED ||
2343 $output_selection == OUTPUT_INTERNAL) {
2345 push(@export_file_list, @ARGV);
2347 foreach (@export_file_list) {
2349 process_export_file($_);
2357 if ($verbose && $errors) {
2358 print STDERR "$errors errors\n";
2360 if ($verbose && $warnings) {
2361 print STDERR "$warnings warnings\n";
2364 if ($Werror && $warnings) {
2365 print STDERR "$warnings warnings as Errors\n";
2368 exit($output_mode eq "none" ? 0 : $errors)