2 # SPDX-License-Identifier: GPL-2.0
8 ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
9 ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
10 ## Copyright (C) 2001 Simon Huggins ##
11 ## Copyright (C) 2005-2012 Randy Dunlap ##
12 ## Copyright (C) 2012 Dan Luedtke ##
14 ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
15 ## Copyright (c) 2000 MontaVista Software, Inc. ##
17 # Copyright (C) 2022 Tomasz Warniełło (POD)
19 use Pod::Usage qw/pod2usage/;
23 kernel-doc - Print formatted kernel documentation to stdout
27 kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]] [-Wcontents-before-sections]
29 -rst [-sphinx-version VERSION] [-enable-lineno] |
35 [-function NAME] ... |
39 [-export-file FILE] ...
42 Run `kernel-doc -h` for details.
46 Read C language source or header FILEs, extract embedded documentation comments,
47 and print formatted documentation to standard output.
49 The documentation comments are identified by the "/**" opening comment mark.
51 See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
55 # more perldoc at the end of the file
61 my $anon_struct_union = 0;
63 # match expressions used to find embedded type information
64 my $type_constant = '\b``([^\`]+)``\b';
65 my $type_constant2 = '\%([-_*\w]+)';
66 my $type_func = '(\w+)\(\)';
67 my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
68 my $type_param_ref = '([\!~\*]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
69 my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
70 my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
71 my $type_env = '(\$\w+)';
72 my $type_enum = '\&(enum\s*([_\w]+))';
73 my $type_struct = '\&(struct\s*([_\w]+))';
74 my $type_typedef = '\&(typedef\s*([_\w]+))';
75 my $type_union = '\&(union\s*([_\w]+))';
76 my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
77 my $type_fallback = '\&([_\w]+)';
78 my $type_member_func = $type_member . '\(\)';
80 # Output conversion substitutions.
81 # One for each output format
83 # these are pretty rough
84 my @highlights_man = (
85 [$type_constant, "\$1"],
86 [$type_constant2, "\$1"],
87 [$type_func, "\\\\fB\$1\\\\fP"],
88 [$type_enum, "\\\\fI\$1\\\\fP"],
89 [$type_struct, "\\\\fI\$1\\\\fP"],
90 [$type_typedef, "\\\\fI\$1\\\\fP"],
91 [$type_union, "\\\\fI\$1\\\\fP"],
92 [$type_param, "\\\\fI\$1\\\\fP"],
93 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
94 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
95 [$type_fallback, "\\\\fI\$1\\\\fP"]
97 my $blankline_man = "";
100 my @highlights_rst = (
101 [$type_constant, "``\$1``"],
102 [$type_constant2, "``\$1``"],
104 # Note: need to escape () to avoid func matching later
105 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
106 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
107 [$type_fp_param, "**\$1\\\\(\\\\)**"],
108 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
109 [$type_func, "\$1()"],
110 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
111 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
112 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
113 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
115 # in rst this can refer to any type
116 [$type_fallback, "\\:c\\:type\\:`\$1`"],
117 [$type_param_ref, "**\$1\$2**"]
119 my $blankline_rst = "\n";
124 -message => "No arguments!\n",
127 -sections => 'SYNOPSIS',
133 my ($sphinx_major, $sphinx_minor, $sphinx_patch);
135 my $dohighlight = "";
141 my $Wcontents_before_sections = 0;
142 my $output_mode = "rst";
143 my $output_preformatted = 0;
144 my $no_doc_sections = 0;
145 my $enable_lineno = 0;
146 my @highlights = @highlights_rst;
147 my $blankline = $blankline_rst;
148 my $modulename = "Kernel API";
151 OUTPUT_ALL => 0, # output all symbols and doc sections
152 OUTPUT_INCLUDE => 1, # output only specified symbols
153 OUTPUT_EXPORTED => 2, # output exported symbols
154 OUTPUT_INTERNAL => 3, # output non-exported symbols
156 my $output_selection = OUTPUT_ALL;
157 my $show_not_found = 0; # No longer used
159 my @export_file_list;
162 if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
163 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
164 @build_time = gmtime($seconds);
166 @build_time = localtime;
169 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
170 'July', 'August', 'September', 'October',
171 'November', 'December')[$build_time[4]] .
172 " " . ($build_time[5]+1900);
174 # Essentially these are globals.
175 # They probably want to be tidied up, made more localised or something.
176 # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
177 # could cause "use of undefined value" or other bugs.
178 my ($function, %function_table, %parametertypes, $declaration_purpose);
179 my %nosymbol_table = ();
180 my $declaration_start_line;
181 my ($type, $declaration_name, $return_type);
182 my ($newsection, $newcontents, $prototype, $brcount, %source_map);
184 if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =~ '1') {
188 if (defined($ENV{'KCFLAGS'})) {
189 my $kcflags = "$ENV{'KCFLAGS'}";
191 if ($kcflags =~ /(\s|^)-Werror(\s|$)/) {
196 # reading this variable is for backwards compat just in case
197 # someone was calling it with the variable from outside the
198 # kernel's build system
199 if (defined($ENV{'KDOC_WERROR'})) {
200 $Werror = "$ENV{'KDOC_WERROR'}";
202 # other environment variables are converted to command-line
203 # arguments in cmd_checkdoc in the build system
205 # Generated docbook code is inserted in a template at a point where
206 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
207 # https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
208 # We keep track of number of generated entries and generate a dummy
209 # if needs be to ensure the expanded template can be postprocessed
211 my $section_counter = 0;
217 STATE_NORMAL => 0, # normal code
218 STATE_NAME => 1, # looking for function name
219 STATE_BODY_MAYBE => 2, # body - or maybe more description
220 STATE_BODY => 3, # the body of the comment
221 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
222 STATE_PROTO => 5, # scanning prototype
223 STATE_DOCBLOCK => 6, # documentation block
224 STATE_INLINE => 7, # gathering doc outside main block
230 # Inline documentation state
232 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
233 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
234 STATE_INLINE_TEXT => 2, # looking for member documentation
235 STATE_INLINE_END => 3, # done
236 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
237 # Spit a warning as it's not
238 # proper kernel-doc and ignore the rest.
240 my $inline_doc_state;
242 #declaration types: can be
243 # 'function', 'struct', 'union', 'enum', 'typedef'
246 # Name of the kernel-doc identifier for non-DOC markups
249 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
251 my $doc_com = '\s*\*\s*';
252 my $doc_com_body = '\s*\* ?';
253 my $doc_decl = $doc_com . '(\w+)';
254 # @params and a strictly limited set of supported section names
259 # while trying to not match literal block starts like "example::"
261 my $doc_sect = $doc_com .
262 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
263 my $doc_content = $doc_com_body . '(.*)';
264 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
265 my $doc_inline_start = '^\s*/\*\*\s*$';
266 my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
267 my $doc_inline_end = '^\s*\*/\s*$';
268 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
269 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
270 my $export_symbol_ns = '^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,\s*\w+\)\s*;';
271 my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
272 my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
275 my %parameterdesc_start_lines;
279 my %section_start_lines;
284 my $new_start_line = 0;
286 # the canonical section names. see also $doc_sect above.
287 my $section_default = "Description"; # default section
288 my $section_intro = "Introduction";
289 my $section = $section_default;
290 my $section_context = "Context";
291 my $section_return = "Return";
293 my $undescribed = "-- undescribed --";
297 while ($ARGV[0] =~ m/^--?(.*)/) {
301 $output_mode = "man";
302 @highlights = @highlights_man;
303 $blankline = $blankline_man;
304 } elsif ($cmd eq "rst") {
305 $output_mode = "rst";
306 @highlights = @highlights_rst;
307 $blankline = $blankline_rst;
308 } elsif ($cmd eq "none") {
309 $output_mode = "none";
310 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
311 $modulename = shift @ARGV;
312 } elsif ($cmd eq "function") { # to only output specific functions
313 $output_selection = OUTPUT_INCLUDE;
314 $function = shift @ARGV;
315 $function_table{$function} = 1;
316 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
317 my $symbol = shift @ARGV;
318 $nosymbol_table{$symbol} = 1;
319 } elsif ($cmd eq "export") { # only exported symbols
320 $output_selection = OUTPUT_EXPORTED;
321 %function_table = ();
322 } elsif ($cmd eq "internal") { # only non-exported symbols
323 $output_selection = OUTPUT_INTERNAL;
324 %function_table = ();
325 } elsif ($cmd eq "export-file") {
326 my $file = shift @ARGV;
327 push(@export_file_list, $file);
328 } elsif ($cmd eq "v") {
330 } elsif ($cmd eq "Werror") {
332 } elsif ($cmd eq "Wreturn") {
334 } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") {
336 } elsif ($cmd eq "Wcontents-before-sections") {
337 $Wcontents_before_sections = 1;
338 } elsif ($cmd eq "Wall") {
341 $Wcontents_before_sections = 1;
342 } elsif (($cmd eq "h") || ($cmd eq "help")) {
343 pod2usage(-exitval => 0, -verbose => 2);
344 } elsif ($cmd eq 'no-doc-sections') {
345 $no_doc_sections = 1;
346 } elsif ($cmd eq 'enable-lineno') {
348 } elsif ($cmd eq 'show-not-found') {
349 $show_not_found = 1; # A no-op but don't fail
350 } elsif ($cmd eq "sphinx-version") {
351 my $ver_string = shift @ARGV;
352 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
355 $sphinx_minor = substr($2,1);
360 $sphinx_patch = substr($3,1)
365 die "Sphinx version should either major.minor or major.minor.patch format\n";
370 -message => "Argument unknown!\n",
373 -sections => 'SYNOPSIS',
379 -message => "FILE argument missing\n",
382 -sections => 'SYNOPSIS',
388 # continue execution near EOF;
390 # The C domain dialect changed on Sphinx 3. So, we need to check the
391 # version in order to produce the right tags.
394 foreach(split(/:/, $ENV{PATH})) {
395 return "$_/$_[0]" if(-x "$_/$_[0]");
399 sub get_sphinx_version()
403 my $cmd = "sphinx-build";
404 if (!findprog($cmd)) {
405 my $cmd = "sphinx-build3";
406 if (!findprog($cmd)) {
410 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
411 $sphinx_major, $sphinx_minor, $sphinx_patch;
416 open IN, "$cmd --version 2>&1 |";
418 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
424 # Sphinx 1.2.x uses a different format
425 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
435 # get kernel version from env
436 sub get_kernel_version() {
437 my $version = 'unknown kernel version';
439 if (defined($ENV{'KERNELVERSION'})) {
440 $version = $ENV{'KERNELVERSION'};
448 if ($enable_lineno && defined($lineno)) {
449 print ".. LINENO " . $lineno . "\n";
454 my $location = shift;
456 print STDERR "$location: warning: $msg";
460 # dumps section contents to arrays/hashes intended for that purpose.
465 my $contents = join "\n", @_;
467 if ($name =~ m/$type_param/) {
469 $parameterdescs{$name} = $contents;
470 $sectcheck = $sectcheck . $name . " ";
471 $parameterdesc_start_lines{$name} = $new_start_line;
473 } elsif ($name eq "@\.\.\.") {
475 $parameterdescs{$name} = $contents;
476 $sectcheck = $sectcheck . $name . " ";
477 $parameterdesc_start_lines{$name} = $new_start_line;
480 if (defined($sections{$name}) && ($sections{$name} ne "")) {
481 # Only warn on user specified duplicate section names.
482 if ($name ne $section_default) {
483 emit_warning("${file}:$.", "duplicate section name '$name'\n");
485 $sections{$name} .= $contents;
487 $sections{$name} = $contents;
488 push @sectionlist, $name;
489 $section_start_lines{$name} = $new_start_line;
496 # dump DOC: section after checking that it should go out
498 sub dump_doc_section {
501 my $contents = join "\n", @_;
503 if ($no_doc_sections) {
507 return if (defined($nosymbol_table{$name}));
509 if (($output_selection == OUTPUT_ALL) ||
510 (($output_selection == OUTPUT_INCLUDE) &&
511 defined($function_table{$name})))
513 dump_section($file, $name, $contents);
514 output_blockhead({'sectionlist' => \@sectionlist,
515 'sections' => \%sections,
516 'module' => $modulename,
517 'content-only' => ($output_selection != OUTPUT_ALL), });
524 # parameterdescs, a hash.
525 # function => "function name"
526 # parameterlist => @list of parameters
527 # parameterdescs => %parameter descriptions
528 # sectionlist => @list of sections
529 # sections => %section descriptions
532 sub output_highlight {
533 my $contents = join "\n",@_;
537 # if (!defined $contents) {
539 # confess "output_highlight got called with no args?\n";
542 # print STDERR "contents b4:$contents\n";
545 # print STDERR "contents af:$contents\n";
547 foreach $line (split "\n", $contents) {
548 if (! $output_preformatted) {
552 if (! $output_preformatted) {
553 print $lineprefix, $blankline;
556 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
559 print $lineprefix, $line;
567 # output function in man
568 sub output_function_man(%) {
570 my ($parameter, $section);
573 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
576 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
578 print ".SH SYNOPSIS\n";
579 if ($args{'functiontype'} ne "") {
580 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
582 print ".B \"" . $args{'function'} . "\n";
587 foreach my $parameter (@{$args{'parameterlist'}}) {
588 if ($count == $#{$args{'parameterlist'}}) {
591 $type = $args{'parametertypes'}{$parameter};
592 if ($type =~ m/$function_pointer/) {
593 # pointer-to-function
594 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
596 $type =~ s/([^\*])$/$1 /;
597 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
603 print ".SH ARGUMENTS\n";
604 foreach $parameter (@{$args{'parameterlist'}}) {
605 my $parameter_name = $parameter;
606 $parameter_name =~ s/\[.*//;
608 print ".IP \"" . $parameter . "\" 12\n";
609 output_highlight($args{'parameterdescs'}{$parameter_name});
611 foreach $section (@{$args{'sectionlist'}}) {
612 print ".SH \"", uc $section, "\"\n";
613 output_highlight($args{'sections'}{$section});
619 sub output_enum_man(%) {
621 my ($parameter, $section);
624 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
627 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
629 print ".SH SYNOPSIS\n";
630 print "enum " . $args{'enum'} . " {\n";
632 foreach my $parameter (@{$args{'parameterlist'}}) {
633 print ".br\n.BI \" $parameter\"\n";
634 if ($count == $#{$args{'parameterlist'}}) {
643 print ".SH Constants\n";
644 foreach $parameter (@{$args{'parameterlist'}}) {
645 my $parameter_name = $parameter;
646 $parameter_name =~ s/\[.*//;
648 print ".IP \"" . $parameter . "\" 12\n";
649 output_highlight($args{'parameterdescs'}{$parameter_name});
651 foreach $section (@{$args{'sectionlist'}}) {
652 print ".SH \"$section\"\n";
653 output_highlight($args{'sections'}{$section});
658 # output struct in man
659 sub output_struct_man(%) {
661 my ($parameter, $section);
663 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
666 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
668 my $declaration = $args{'definition'};
669 $declaration =~ s/\t/ /g;
670 $declaration =~ s/\n/"\n.br\n.BI \"/g;
671 print ".SH SYNOPSIS\n";
672 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
673 print ".BI \"$declaration\n};\n.br\n\n";
675 print ".SH Members\n";
676 foreach $parameter (@{$args{'parameterlist'}}) {
677 ($parameter =~ /^#/) && next;
679 my $parameter_name = $parameter;
680 $parameter_name =~ s/\[.*//;
682 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
683 print ".IP \"" . $parameter . "\" 12\n";
684 output_highlight($args{'parameterdescs'}{$parameter_name});
686 foreach $section (@{$args{'sectionlist'}}) {
687 print ".SH \"$section\"\n";
688 output_highlight($args{'sections'}{$section});
693 # output typedef in man
694 sub output_typedef_man(%) {
696 my ($parameter, $section);
698 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
701 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
703 foreach $section (@{$args{'sectionlist'}}) {
704 print ".SH \"$section\"\n";
705 output_highlight($args{'sections'}{$section});
709 sub output_blockhead_man(%) {
711 my ($parameter, $section);
714 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
716 foreach $section (@{$args{'sectionlist'}}) {
717 print ".SH \"$section\"\n";
718 output_highlight($args{'sections'}{$section});
723 # output in restructured text
727 # This could use some work; it's used to output the DOC: sections, and
728 # starts by putting out the name of the doc section itself, but that tends
729 # to duplicate a header already in the template file.
731 sub output_blockhead_rst(%) {
733 my ($parameter, $section);
735 foreach $section (@{$args{'sectionlist'}}) {
736 next if (defined($nosymbol_table{$section}));
738 if ($output_selection != OUTPUT_INCLUDE) {
739 print ".. _$section:\n\n";
740 print "**$section**\n\n";
742 print_lineno($section_start_lines{$section});
743 output_highlight_rst($args{'sections'}{$section});
749 # Apply the RST highlights to a sub-block of text.
751 sub highlight_block($) {
752 # The dohighlight kludge requires the text be called $contents
753 my $contents = shift;
760 # Regexes used only here.
762 my $sphinx_literal = '^[^.].*::$';
763 my $sphinx_cblock = '^\.\.\ +code-block::';
765 sub output_highlight_rst {
766 my $input = join "\n",@_;
773 foreach $line (split "\n",$input) {
775 # If we're in a literal block, see if we should drop out
776 # of it. Otherwise pass the line straight through unmunged.
779 if (! ($line =~ /^\s*$/)) {
781 # If this is the first non-blank line in a literal
782 # block we need to figure out what the proper indent is.
784 if ($litprefix eq "") {
786 $litprefix = '^' . $1;
787 $output .= $line . "\n";
788 } elsif (! ($line =~ /$litprefix/)) {
791 $output .= $line . "\n";
794 $output .= $line . "\n";
798 # Not in a literal block (or just dropped out)
801 $block .= $line . "\n";
802 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
805 $output .= highlight_block($block);
812 $output .= highlight_block($block);
814 foreach $line (split "\n", $output) {
815 print $lineprefix . $line . "\n";
819 sub output_function_rst(%) {
821 my ($parameter, $section);
822 my $oldprefix = $lineprefix;
825 if ($args{'functiontype'} ne "") {
826 $signature = $args{'functiontype'} . " " . $args{'function'} . " (";
828 $signature = $args{'function'} . " (";
832 foreach my $parameter (@{$args{'parameterlist'}}) {
837 $type = $args{'parametertypes'}{$parameter};
839 if ($type =~ m/$function_pointer/) {
840 # pointer-to-function
841 $signature .= $1 . $parameter . ") (" . $2 . ")";
849 if ($sphinx_major < 3) {
850 if ($args{'typedef'}) {
851 print ".. c:type:: ". $args{'function'} . "\n\n";
852 print_lineno($declaration_start_line);
853 print " **Typedef**: ";
855 output_highlight_rst($args{'purpose'});
856 print "\n\n**Syntax**\n\n";
857 print " ``$signature``\n\n";
859 print ".. c:function:: $signature\n\n";
862 if ($args{'typedef'} || $args{'functiontype'} eq "") {
863 print ".. c:macro:: ". $args{'function'} . "\n\n";
865 if ($args{'typedef'}) {
866 print_lineno($declaration_start_line);
867 print " **Typedef**: ";
869 output_highlight_rst($args{'purpose'});
870 print "\n\n**Syntax**\n\n";
871 print " ``$signature``\n\n";
873 print "``$signature``\n\n";
876 print ".. c:function:: $signature\n\n";
880 if (!$args{'typedef'}) {
881 print_lineno($declaration_start_line);
883 output_highlight_rst($args{'purpose'});
888 # Put our descriptive text into a container (thus an HTML <div>) to help
889 # set the function prototypes apart.
891 print ".. container:: kernelindent\n\n";
893 print $lineprefix . "**Parameters**\n\n";
894 foreach $parameter (@{$args{'parameterlist'}}) {
895 my $parameter_name = $parameter;
896 $parameter_name =~ s/\[.*//;
897 $type = $args{'parametertypes'}{$parameter};
900 print $lineprefix . "``$type``\n";
902 print $lineprefix . "``$parameter``\n";
905 print_lineno($parameterdesc_start_lines{$parameter_name});
908 if (defined($args{'parameterdescs'}{$parameter_name}) &&
909 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
910 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
912 print $lineprefix . "*undescribed*\n";
918 output_section_rst(@_);
919 $lineprefix = $oldprefix;
922 sub output_section_rst(%) {
925 my $oldprefix = $lineprefix;
927 foreach $section (@{$args{'sectionlist'}}) {
928 print $lineprefix . "**$section**\n\n";
929 print_lineno($section_start_lines{$section});
930 output_highlight_rst($args{'sections'}{$section});
936 sub output_enum_rst(%) {
939 my $oldprefix = $lineprefix;
943 if ($sphinx_major < 3) {
944 my $name = "enum " . $args{'enum'};
945 print "\n\n.. c:type:: " . $name . "\n\n";
947 my $name = $args{'enum'};
948 print "\n\n.. c:enum:: " . $name . "\n\n";
950 print_lineno($declaration_start_line);
952 output_highlight_rst($args{'purpose'});
955 print ".. container:: kernelindent\n\n";
956 $outer = $lineprefix . " ";
957 $lineprefix = $outer . " ";
958 print $outer . "**Constants**\n\n";
959 foreach $parameter (@{$args{'parameterlist'}}) {
960 print $outer . "``$parameter``\n";
962 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
963 output_highlight_rst($args{'parameterdescs'}{$parameter});
965 print $lineprefix . "*undescribed*\n";
970 $lineprefix = $oldprefix;
971 output_section_rst(@_);
974 sub output_typedef_rst(%) {
977 my $oldprefix = $lineprefix;
980 if ($sphinx_major < 3) {
981 $name = "typedef " . $args{'typedef'};
983 $name = $args{'typedef'};
985 print "\n\n.. c:type:: " . $name . "\n\n";
986 print_lineno($declaration_start_line);
988 output_highlight_rst($args{'purpose'});
991 $lineprefix = $oldprefix;
992 output_section_rst(@_);
995 sub output_struct_rst(%) {
998 my $oldprefix = $lineprefix;
1000 if ($sphinx_major < 3) {
1001 my $name = $args{'type'} . " " . $args{'struct'};
1002 print "\n\n.. c:type:: " . $name . "\n\n";
1004 my $name = $args{'struct'};
1005 if ($args{'type'} eq 'union') {
1006 print "\n\n.. c:union:: " . $name . "\n\n";
1008 print "\n\n.. c:struct:: " . $name . "\n\n";
1011 print_lineno($declaration_start_line);
1013 output_highlight_rst($args{'purpose'});
1016 print ".. container:: kernelindent\n\n";
1017 print $lineprefix . "**Definition**::\n\n";
1018 my $declaration = $args{'definition'};
1019 $lineprefix = $lineprefix . " ";
1020 $declaration =~ s/\t/$lineprefix/g;
1021 print $lineprefix . $args{'type'} . " " . $args{'struct'} . " {\n$declaration" . $lineprefix . "};\n\n";
1024 print $lineprefix . "**Members**\n\n";
1025 foreach $parameter (@{$args{'parameterlist'}}) {
1026 ($parameter =~ /^#/) && next;
1028 my $parameter_name = $parameter;
1029 $parameter_name =~ s/\[.*//;
1031 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1032 $type = $args{'parametertypes'}{$parameter};
1033 print_lineno($parameterdesc_start_lines{$parameter_name});
1034 print $lineprefix . "``" . $parameter . "``\n";
1036 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1042 $lineprefix = $oldprefix;
1043 output_section_rst(@_);
1046 ## none mode output functions
1048 sub output_function_none(%) {
1051 sub output_enum_none(%) {
1054 sub output_typedef_none(%) {
1057 sub output_struct_none(%) {
1060 sub output_blockhead_none(%) {
1064 # generic output function for all types (function, struct/union, typedef, enum);
1065 # calls the generated, variable output_ function name based on
1066 # functype and output_mode
1067 sub output_declaration {
1070 my $functype = shift;
1071 my $func = "output_${functype}_$output_mode";
1073 return if (defined($nosymbol_table{$name}));
1075 if (($output_selection == OUTPUT_ALL) ||
1076 (($output_selection == OUTPUT_INCLUDE ||
1077 $output_selection == OUTPUT_EXPORTED) &&
1078 defined($function_table{$name})) ||
1079 ($output_selection == OUTPUT_INTERNAL &&
1080 !($functype eq "function" && defined($function_table{$name}))))
1088 # generic output function - calls the right one based on current output mode.
1089 sub output_blockhead {
1091 my $func = "output_blockhead_" . $output_mode;
1097 # takes a declaration (struct, union, enum, typedef) and
1098 # invokes the right handler. NOT called for functions.
1099 sub dump_declaration($$) {
1101 my ($prototype, $file) = @_;
1102 my $func = "dump_" . $decl_type;
1106 sub dump_union($$) {
1110 sub dump_struct($$) {
1115 my $type = qr{struct|union};
1116 # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
1117 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned};
1118 my $definition_body = qr{\{(.*)\}\s*$qualifiers*};
1119 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1121 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1123 $declaration_name = $2;
1125 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1127 $declaration_name = $3;
1132 if ($identifier ne $declaration_name) {
1133 emit_warning("${file}:$.", "expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n");
1137 # ignore members marked private:
1138 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1139 $members =~ s/\/\*\s*private:.*//gosi;
1141 $members =~ s/\/\*.*?\*\///gos;
1143 $members =~ s/\s*$attribute/ /gi;
1144 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1145 $members =~ s/\s*__counted_by\s*\([^;]*\)/ /gos;
1146 $members =~ s/\s*__packed\s*/ /gos;
1147 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1148 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1149 $members =~ s/\s*____cacheline_aligned/ /gos;
1150 # unwrap struct_group():
1151 # - first eat non-declaration parameters and rewrite for final match
1152 # - then remove macro, outer parens, and trailing semicolon
1153 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
1154 $members =~ s/\bstruct_group_attr\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1155 $members =~ s/\bstruct_group_tagged\s*\(([^,]*),([^,]*),/struct $1 $2; STRUCT_GROUP(/gos;
1156 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1157 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
1159 my $args = qr{([^,)]+)};
1160 # replace DECLARE_BITMAP
1161 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1162 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos;
1163 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1164 # replace DECLARE_HASHTABLE
1165 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1166 # replace DECLARE_KFIFO
1167 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1168 # replace DECLARE_KFIFO_PTR
1169 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1170 # replace DECLARE_FLEX_ARRAY
1171 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
1172 #replace DEFINE_DMA_UNMAP_ADDR
1173 $members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos;
1174 #replace DEFINE_DMA_UNMAP_LEN
1175 $members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos;
1176 my $declaration = $members;
1178 # Split nested struct/union elements as newer ones
1179 while ($members =~ m/$struct_members/) {
1184 foreach my $id(split /,/, $ids) {
1185 $newmember .= "$maintype $id; ";
1188 $id =~ s/^\s*\**(\S+)\s*/$1/;
1189 foreach my $arg (split /;/, $content) {
1190 next if ($arg =~ m/^\s*$/);
1191 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1192 # pointer-to-function
1197 if ($id =~ m/^\s*$/) {
1198 # anonymous struct/union
1199 $newmember .= "$type$name$extra; ";
1201 $newmember .= "$type$id.$name$extra; ";
1209 $arg =~ s/:\s*\d+\s*//g;
1211 $arg =~ s/\[.*\]//g;
1212 # The type may have multiple words,
1213 # and multiple IDs can be defined, like:
1214 # const struct foo, *bar, foobar
1215 # So, we remove spaces when parsing the
1216 # names, in order to match just names
1217 # and commas for the names
1218 $arg =~ s/\s*,\s*/,/g;
1219 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1223 $newmember .= "$arg; ";
1226 foreach my $name (split /,/, $names) {
1227 $name =~ s/^\s*\**(\S+)\s*/$1/;
1228 next if (($name =~ m/^\s*$/));
1229 if ($id =~ m/^\s*$/) {
1230 # anonymous struct/union
1231 $newmember .= "$type $name; ";
1233 $newmember .= "$type $id.$name; ";
1239 $members =~ s/$struct_members/$newmember/;
1242 # Ignore other nested elements, like enums
1243 $members =~ s/(\{[^\{\}]*\})//g;
1245 create_parameterlist($members, ';', $file, $declaration_name);
1246 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1248 # Adjust declaration for better display
1249 $declaration =~ s/([\{;])/$1\n/g;
1250 $declaration =~ s/\}\s+;/};/g;
1251 # Better handle inlined enums
1252 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1254 my @def_args = split /\n/, $declaration;
1257 foreach my $clause (@def_args) {
1258 $clause =~ s/^\s+//;
1259 $clause =~ s/\s+$//;
1260 $clause =~ s/\s+/ /;
1262 $level-- if ($clause =~ m/(\})/ && $level > 1);
1263 if (!($clause =~ m/^\s*#/)) {
1264 $declaration .= "\t" x $level;
1266 $declaration .= "\t" . $clause . "\n";
1267 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1269 output_declaration($declaration_name,
1271 {'struct' => $declaration_name,
1272 'module' => $modulename,
1273 'definition' => $declaration,
1274 'parameterlist' => \@parameterlist,
1275 'parameterdescs' => \%parameterdescs,
1276 'parametertypes' => \%parametertypes,
1277 'sectionlist' => \@sectionlist,
1278 'sections' => \%sections,
1279 'purpose' => $declaration_purpose,
1280 'type' => $decl_type
1283 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1289 sub show_warnings($$) {
1290 my $functype = shift;
1293 return 0 if (defined($nosymbol_table{$name}));
1295 return 1 if ($output_selection == OUTPUT_ALL);
1297 if ($output_selection == OUTPUT_EXPORTED) {
1298 if (defined($function_table{$name})) {
1304 if ($output_selection == OUTPUT_INTERNAL) {
1305 if (!($functype eq "function" && defined($function_table{$name}))) {
1311 if ($output_selection == OUTPUT_INCLUDE) {
1312 if (defined($function_table{$name})) {
1318 die("Please add the new output type at show_warnings()");
1326 # ignore members marked private:
1327 $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1328 $x =~ s/\/\*\s*private:.*}/}/gosi;
1330 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1331 # strip #define macros inside enums
1332 $x =~ s@#\s*((define|ifdef|if)\s+|endif)[^;]*;@@gos;
1334 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1335 $declaration_name = $2;
1337 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1338 $declaration_name = $1;
1343 if ($identifier ne $declaration_name) {
1344 if ($identifier eq "") {
1345 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n");
1347 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n");
1351 $declaration_name = "(anonymous)" if ($declaration_name eq "");
1355 $members =~ s/\s+$//;
1356 $members =~ s/\([^;]*?[\)]//g;
1358 foreach my $arg (split ',', $members) {
1359 $arg =~ s/^\s*(\w+).*/$1/;
1360 push @parameterlist, $arg;
1361 if (!$parameterdescs{$arg}) {
1362 $parameterdescs{$arg} = $undescribed;
1363 if (show_warnings("enum", $declaration_name)) {
1364 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n");
1367 $_members{$arg} = 1;
1370 while (my ($k, $v) = each %parameterdescs) {
1371 if (!exists($_members{$k})) {
1372 if (show_warnings("enum", $declaration_name)) {
1373 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n");
1378 output_declaration($declaration_name,
1380 {'enum' => $declaration_name,
1381 'module' => $modulename,
1382 'parameterlist' => \@parameterlist,
1383 'parameterdescs' => \%parameterdescs,
1384 'sectionlist' => \@sectionlist,
1385 'sections' => \%sections,
1386 'purpose' => $declaration_purpose
1389 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1394 my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1395 my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1396 my $typedef_args = qr { \s*\((.*)\); }x;
1398 my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1399 my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1401 sub dump_typedef($$) {
1405 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1407 # Parse function typedef prototypes
1408 if ($x =~ $typedef1 || $x =~ $typedef2) {
1410 $declaration_name = $2;
1412 $return_type =~ s/^\s+//;
1414 if ($identifier ne $declaration_name) {
1415 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1419 create_parameterlist($args, ',', $file, $declaration_name);
1421 output_declaration($declaration_name,
1423 {'function' => $declaration_name,
1425 'module' => $modulename,
1426 'functiontype' => $return_type,
1427 'parameterlist' => \@parameterlist,
1428 'parameterdescs' => \%parameterdescs,
1429 'parametertypes' => \%parametertypes,
1430 'sectionlist' => \@sectionlist,
1431 'sections' => \%sections,
1432 'purpose' => $declaration_purpose
1437 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1438 $x =~ s/\(*.\)\s*;$/;/;
1439 $x =~ s/\[*.\]\s*;$/;/;
1442 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1443 $declaration_name = $1;
1445 if ($identifier ne $declaration_name) {
1446 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1450 output_declaration($declaration_name,
1452 {'typedef' => $declaration_name,
1453 'module' => $modulename,
1454 'sectionlist' => \@sectionlist,
1455 'sections' => \%sections,
1456 'purpose' => $declaration_purpose
1459 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1464 sub save_struct_actual($) {
1467 # strip all spaces from the actual param so that it looks like one string item
1468 $actual =~ s/\s*//g;
1469 $struct_actual = $struct_actual . $actual . " ";
1472 sub create_parameterlist($$$$) {
1474 my $splitter = shift;
1476 my $declaration_name = shift;
1480 # temporarily replace commas inside function pointer definition
1481 my $arg_expr = qr{\([^\),]+};
1482 while ($args =~ /$arg_expr,/) {
1483 $args =~ s/($arg_expr),/$1#/g;
1486 foreach my $arg (split($splitter, $args)) {
1488 $arg =~ s/\/\*.*\*\///;
1489 # ignore argument attributes
1490 $arg =~ s/\sPOS0?\s/ /;
1491 # strip leading/trailing spaces
1497 # Treat preprocessor directive as a typeless variable just to fill
1498 # corresponding data structures "correctly". Catch it later in
1500 push_parameter($arg, "", "", $file);
1501 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1502 # pointer-to-function
1504 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1507 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1508 save_struct_actual($param);
1509 push_parameter($param, $type, $arg, $file, $declaration_name);
1510 } elsif ($arg =~ m/\(.+\)\s*\[/) {
1513 $arg =~ m/[^\(]+\(\s*\*\s*([\w\[\]\.]*?)\s*(\s*\[\s*[\w]+\s*\]\s*)*\)/;
1516 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1517 save_struct_actual($param);
1518 push_parameter($param, $type, $arg, $file, $declaration_name);
1520 $arg =~ s/\s*:\s*/:/g;
1521 $arg =~ s/\s*\[/\[/g;
1523 my @args = split('\s*,\s*', $arg);
1524 if ($args[0] =~ m/\*/) {
1525 $args[0] =~ s/(\*+)\s*/ $1/;
1529 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1531 push(@first_arg, split('\s+', $1));
1532 push(@first_arg, $2);
1534 @first_arg = split('\s+', shift @args);
1537 unshift(@args, pop @first_arg);
1538 $type = join " ", @first_arg;
1540 foreach $param (@args) {
1541 if ($param =~ m/^(\*+)\s*(.*)/) {
1542 save_struct_actual($2);
1544 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1545 } elsif ($param =~ m/(.*?):(\w+)/) {
1546 if ($type ne "") { # skip unnamed bit-fields
1547 save_struct_actual($1);
1548 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1551 save_struct_actual($param);
1552 push_parameter($param, $type, $arg, $file, $declaration_name);
1559 sub push_parameter($$$$$) {
1562 my $org_arg = shift;
1564 my $declaration_name = shift;
1566 if (($anon_struct_union == 1) && ($type eq "") &&
1568 return; # ignore the ending }; from anon. struct/union
1571 $anon_struct_union = 0;
1572 $param =~ s/[\[\)].*//;
1574 if ($type eq "" && $param =~ /\.\.\.$/)
1576 if (!$param =~ /\w\.\.\.$/) {
1577 # handles unnamed variable parameters
1579 } elsif ($param =~ /\w\.\.\.$/) {
1580 # for named variable parameters of the form `x...`, remove the dots
1581 $param =~ s/\.\.\.$//;
1583 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1584 $parameterdescs{$param} = "variable arguments";
1587 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1590 $parameterdescs{void} = "no arguments";
1592 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1593 # handle unnamed (anonymous) union or struct:
1596 $param = "{unnamed_" . $param . "}";
1597 $parameterdescs{$param} = "anonymous\n";
1598 $anon_struct_union = 1;
1600 elsif ($param =~ "__cacheline_group" )
1601 # handle cache group enforcing variables: they do not need be described in header files
1603 return; # ignore __cacheline_group_begin and __cacheline_group_end
1606 # warn if parameter has no description
1607 # (but ignore ones starting with # as these are not parameters
1608 # but inline preprocessor statements);
1609 # Note: It will also ignore void params and unnamed structs/unions
1610 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1611 $parameterdescs{$param} = $undescribed;
1613 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1614 emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
1618 # strip spaces from $param so that it is one continuous string
1619 # on @parameterlist;
1620 # this fixes a problem where check_sections() cannot find
1621 # a parameter like "addr[6 + 2]" because it actually appears
1622 # as "addr[6", "+", "2]" on the parameter list;
1623 # but it's better to maintain the param string unchanged for output,
1624 # so just weaken the string compare in check_sections() to ignore
1625 # "[blah" in a parameter string;
1626 ###$param =~ s/\s*//g;
1627 push @parameterlist, $param;
1628 $org_arg =~ s/\s\s+/ /g;
1629 $parametertypes{$param} = $org_arg;
1632 sub check_sections($$$$$) {
1633 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1634 my @sects = split ' ', $sectcheck;
1635 my @prms = split ' ', $prmscheck;
1638 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1640 foreach $sx (0 .. $#sects) {
1642 foreach $px (0 .. $#prms) {
1643 $prm_clean = $prms[$px];
1644 $prm_clean =~ s/\[.*\]//;
1645 $prm_clean =~ s/$attribute//i;
1646 # ignore array size in a parameter string;
1647 # however, the original param string may contain
1648 # spaces, e.g.: addr[6 + 2]
1649 # and this appears in @prms as "addr[6" since the
1650 # parameter list is split at spaces;
1651 # hence just ignore "[..." for the sections check;
1652 $prm_clean =~ s/\[.*//;
1654 ##$prm_clean =~ s/^\**//;
1655 if ($prm_clean eq $sects[$sx]) {
1661 if ($decl_type eq "function") {
1662 emit_warning("${file}:$.",
1663 "Excess function parameter " .
1665 "description in '$decl_name'\n");
1666 } elsif (($decl_type eq "struct") or
1667 ($decl_type eq "union")) {
1668 emit_warning("${file}:$.",
1669 "Excess $decl_type member " .
1671 "description in '$decl_name'\n");
1678 # Checks the section describing the return value of a function.
1679 sub check_return_section {
1681 my $declaration_name = shift;
1682 my $return_type = shift;
1684 # Ignore an empty return type (It's a macro)
1685 # Ignore functions with a "void" return type. (But don't ignore "void *")
1686 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1690 if (!defined($sections{$section_return}) ||
1691 $sections{$section_return} eq "")
1693 emit_warning("${file}:$.",
1694 "No description found for return value of " .
1695 "'$declaration_name'\n");
1700 # takes a function prototype and the name of the current file being
1701 # processed and spits out all the details stored in the global
1703 sub dump_function($$) {
1704 my $prototype = shift;
1708 print_lineno($new_start_line);
1710 $prototype =~ s/^static +//;
1711 $prototype =~ s/^extern +//;
1712 $prototype =~ s/^asmlinkage +//;
1713 $prototype =~ s/^inline +//;
1714 $prototype =~ s/^__inline__ +//;
1715 $prototype =~ s/^__inline +//;
1716 $prototype =~ s/^__always_inline +//;
1717 $prototype =~ s/^noinline +//;
1718 $prototype =~ s/^__FORTIFY_INLINE +//;
1719 $prototype =~ s/__init +//;
1720 $prototype =~ s/__init_or_module +//;
1721 $prototype =~ s/__deprecated +//;
1722 $prototype =~ s/__flatten +//;
1723 $prototype =~ s/__meminit +//;
1724 $prototype =~ s/__must_check +//;
1725 $prototype =~ s/__weak +//;
1726 $prototype =~ s/__sched +//;
1727 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1728 $prototype =~ s/__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//;
1729 $prototype =~ s/__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +//;
1730 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1731 $prototype =~ s/__attribute_const__ +//;
1732 $prototype =~ s/__attribute__\s*\(\(
1734 [\w\s]++ # attribute name
1735 (?:\([^)]*+\))? # attribute arguments
1736 \s*+,? # optional comma at the end
1740 # Yes, this truly is vile. We are looking for:
1741 # 1. Return type (may be nothing if we're looking at a macro)
1743 # 3. Function parameters.
1745 # All the while we have to watch out for function pointer parameters
1746 # (which IIRC is what the two sections are for), C types (these
1747 # regexps don't even start to express all the possibilities), and
1750 # If you mess with these regexps, it's a good idea to check that
1751 # the following functions' documentation still comes out right:
1752 # - parport_register_device (function pointer parameters)
1753 # - atomic_set (macro)
1754 # - pci_match_device, __copy_to_user (long return type)
1755 my $name = qr{[a-zA-Z0-9_~:]+};
1756 my $prototype_end1 = qr{[^\(]*};
1757 my $prototype_end2 = qr{[^\{]*};
1758 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1759 my $type1 = qr{[\w\s]+};
1760 my $type2 = qr{$type1\*+};
1762 if ($define && $prototype =~ m/^()($name)\s+/) {
1763 # This is an object-like macro, it has no return type and no parameter
1765 # Function-like macros are not allowed to have spaces between
1766 # declaration_name and opening parenthesis (notice the \s+).
1768 $declaration_name = $2;
1770 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1771 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1772 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1774 $declaration_name = $2;
1777 create_parameterlist($args, ',', $file, $declaration_name);
1779 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n");
1783 if ($identifier ne $declaration_name) {
1784 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n");
1788 my $prms = join " ", @parameterlist;
1789 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1791 # This check emits a lot of warnings at the moment, because many
1792 # functions don't have a 'Return' doc section. So until the number
1793 # of warnings goes sufficiently down, the check is only performed in
1795 # TODO: always perform the check.
1796 if ($Wreturn && !$noret) {
1797 check_return_section($file, $declaration_name, $return_type);
1800 # The function parser can be called with a typedef parameter.
1802 if ($return_type =~ /typedef/) {
1803 output_declaration($declaration_name,
1805 {'function' => $declaration_name,
1807 'module' => $modulename,
1808 'functiontype' => $return_type,
1809 'parameterlist' => \@parameterlist,
1810 'parameterdescs' => \%parameterdescs,
1811 'parametertypes' => \%parametertypes,
1812 'sectionlist' => \@sectionlist,
1813 'sections' => \%sections,
1814 'purpose' => $declaration_purpose
1817 output_declaration($declaration_name,
1819 {'function' => $declaration_name,
1820 'module' => $modulename,
1821 'functiontype' => $return_type,
1822 'parameterlist' => \@parameterlist,
1823 'parameterdescs' => \%parameterdescs,
1824 'parametertypes' => \%parametertypes,
1825 'sectionlist' => \@sectionlist,
1826 'sections' => \%sections,
1827 'purpose' => $declaration_purpose
1834 %parameterdescs = ();
1835 %parametertypes = ();
1836 @parameterlist = ();
1840 $struct_actual = "";
1843 $state = STATE_NORMAL;
1844 $inline_doc_state = STATE_INLINE_NA;
1847 sub tracepoint_munge($) {
1849 my $tracepointname = 0;
1850 my $tracepointargs = 0;
1852 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1853 $tracepointname = $1;
1855 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1856 $tracepointname = $1;
1858 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1859 $tracepointname = $2;
1861 $tracepointname =~ s/^\s+//; #strip leading whitespace
1862 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1863 $tracepointargs = $1;
1865 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1866 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n".
1869 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1870 $identifier = "trace_$identifier";
1874 sub syscall_munge() {
1877 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1878 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1879 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1881 ## $prototype = "long sys_$1(void)";
1884 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1885 if ($prototype =~ m/long (sys_.*?),/) {
1886 $prototype =~ s/,/\(/;
1888 $prototype =~ s/\)/\(void\)/;
1891 # now delete all of the odd-number commas in $prototype
1892 # so that arg types & arg names don't have a comma between them
1894 my $len = length($prototype);
1896 $len = 0; # skip the for-loop
1898 for (my $ix = 0; $ix < $len; $ix++) {
1899 if (substr($prototype, $ix, 1) eq ',') {
1901 if ($count % 2 == 1) {
1902 substr($prototype, $ix, 1) = ' ';
1908 sub process_proto_function($$) {
1912 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1914 if ($x =~ /^#/ && $x !~ /^#\s*define/) {
1916 } elsif ($x =~ /([^\{]*)/) {
1920 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1921 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1922 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1923 $prototype =~ s@^\s+@@gos; # strip leading spaces
1925 # Handle prototypes for function pointers like:
1926 # int (*pcs_config)(struct foo)
1927 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1929 if ($prototype =~ /SYSCALL_DEFINE/) {
1932 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1933 $prototype =~ /DEFINE_SINGLE_EVENT/)
1935 tracepoint_munge($file);
1937 dump_function($prototype, $file);
1942 sub process_proto_type($$) {
1946 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1947 $x =~ s@^\s+@@gos; # strip leading spaces
1948 $x =~ s@\s+$@@gos; # strip trailing spaces
1949 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1952 # To distinguish preprocessor directive from regular declaration later.
1957 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1958 if( length $prototype ) {
1961 $prototype .= $1 . $2;
1962 ($2 eq '{') && $brcount++;
1963 ($2 eq '}') && $brcount--;
1964 if (($2 eq ';') && ($brcount == 0)) {
1965 dump_declaration($prototype, $file);
1978 sub map_filename($) {
1980 my ($orig_file) = @_;
1982 if (defined($ENV{'SRCTREE'})) {
1983 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1988 if (defined($source_map{$file})) {
1989 $file = $source_map{$file};
1995 sub process_export_file($) {
1996 my ($orig_file) = @_;
1997 my $file = map_filename($orig_file);
1999 if (!open(IN,"<$file")) {
2000 print STDERR "Error: Cannot open file $file\n";
2006 if (/$export_symbol/) {
2007 next if (defined($nosymbol_table{$2}));
2008 $function_table{$2} = 1;
2010 if (/$export_symbol_ns/) {
2011 next if (defined($nosymbol_table{$2}));
2012 $function_table{$2} = 1;
2020 # Parsers for the various processing states.
2022 # STATE_NORMAL: looking for the /** to begin everything.
2024 sub process_normal() {
2025 if (/$doc_start/o) {
2026 $state = STATE_NAME; # next line is always the function name
2028 $declaration_start_line = $. + 1;
2033 # STATE_NAME: Looking for the "name - description" line
2035 sub process_name($$) {
2039 if (/$doc_block/o) {
2040 $state = STATE_DOCBLOCK;
2042 $new_start_line = $.;
2045 $section = $section_intro;
2049 } elsif (/$doc_decl/o) {
2051 my $is_kernel_comment = 0;
2052 my $decl_start = qr{$doc_com};
2053 # test for pointer declaration type, foo * bar() - desc
2054 my $fn_type = qr{\w+\s*\*\s*};
2055 my $parenthesis = qr{\(\w*\)};
2056 my $decl_end = qr{[-:].*};
2057 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2060 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2063 $is_kernel_comment = 1;
2065 # Look for foo() or static void foo() - description; or misspelt
2067 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2068 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2070 $decl_type = 'function';
2071 $identifier =~ s/^define\s+//;
2072 $is_kernel_comment = 1;
2074 $identifier =~ s/\s+$//;
2076 $state = STATE_BODY;
2077 # if there's no @param blocks need to set up default section
2080 $section = $section_default;
2081 $new_start_line = $. + 1;
2083 # strip leading/trailing/multiple spaces
2087 $descr =~ s/\s+/ /g;
2088 $declaration_purpose = $descr;
2089 $state = STATE_BODY_MAYBE;
2091 $declaration_purpose = "";
2094 if (!$is_kernel_comment) {
2095 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_");
2096 $state = STATE_NORMAL;
2099 if (($declaration_purpose eq "") && $Wshort_desc) {
2100 emit_warning("${file}:$.", "missing initial short description on line:\n$_");
2103 if ($identifier eq "" && $decl_type ne "enum") {
2104 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_");
2105 $state = STATE_NORMAL;
2109 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2112 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n");
2113 $state = STATE_NORMAL;
2119 # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2121 sub process_body($$) {
2124 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2125 dump_section($file, $section, $contents);
2126 $section = $section_default;
2127 $new_start_line = $.;
2131 if (/$doc_sect/i) { # case insensitive for supported section names
2136 # map the supported section names to the canonical names
2137 if ($newsection =~ m/^description$/i) {
2138 $newsection = $section_default;
2139 } elsif ($newsection =~ m/^context$/i) {
2140 $newsection = $section_context;
2141 } elsif ($newsection =~ m/^returns?$/i) {
2142 $newsection = $section_return;
2143 } elsif ($newsection =~ m/^\@return$/) {
2144 # special: @return is a section, not a param description
2145 $newsection = $section_return;
2148 if (($contents ne "") && ($contents ne "\n")) {
2149 if (!$in_doc_sect && $Wcontents_before_sections) {
2150 emit_warning("${file}:$.", "contents before sections\n");
2152 dump_section($file, $section, $contents);
2153 $section = $section_default;
2157 $state = STATE_BODY;
2158 $contents = $newcontents;
2159 $new_start_line = $.;
2160 while (substr($contents, 0, 1) eq " ") {
2161 $contents = substr($contents, 1);
2163 if ($contents ne "") {
2166 $section = $newsection;
2167 $leading_space = undef;
2168 } elsif (/$doc_end/) {
2169 if (($contents ne "") && ($contents ne "\n")) {
2170 dump_section($file, $section, $contents);
2171 $section = $section_default;
2174 # look for doc_com + <text> + doc_end:
2175 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2176 emit_warning("${file}:$.", "suspicious ending line: $_");
2180 $state = STATE_PROTO;
2182 $new_start_line = $. + 1;
2183 } elsif (/$doc_content/) {
2185 if ($section eq $section_context) {
2186 dump_section($file, $section, $contents);
2187 $section = $section_default;
2189 $new_start_line = $.;
2190 $state = STATE_BODY;
2192 if ($section ne $section_default) {
2193 $state = STATE_BODY_WITH_BLANK_LINE;
2195 $state = STATE_BODY;
2199 } elsif ($state == STATE_BODY_MAYBE) {
2200 # Continued declaration purpose
2201 chomp($declaration_purpose);
2202 $declaration_purpose .= " " . $1;
2203 $declaration_purpose =~ s/\s+/ /g;
2206 if ($section =~ m/^@/ || $section eq $section_context) {
2207 if (!defined $leading_space) {
2208 if ($cont =~ m/^(\s+)/) {
2209 $leading_space = $1;
2211 $leading_space = "";
2214 $cont =~ s/^$leading_space//;
2216 $contents .= $cont . "\n";
2219 # i dont know - bad line? ignore.
2220 emit_warning("${file}:$.", "bad line: $_");
2226 # STATE_PROTO: reading a function/whatever prototype.
2228 sub process_proto($$) {
2231 if (/$doc_inline_oneline/) {
2234 if ($contents ne "") {
2236 dump_section($file, $section, $contents);
2237 $section = $section_default;
2240 } elsif (/$doc_inline_start/) {
2241 $state = STATE_INLINE;
2242 $inline_doc_state = STATE_INLINE_NAME;
2243 } elsif ($decl_type eq 'function') {
2244 process_proto_function($_, $file);
2246 process_proto_type($_, $file);
2251 # STATE_DOCBLOCK: within a DOC: block.
2253 sub process_docblock($$) {
2257 dump_doc_section($file, $section, $contents);
2258 $section = $section_default;
2261 %parameterdescs = ();
2262 %parametertypes = ();
2263 @parameterlist = ();
2267 $state = STATE_NORMAL;
2268 } elsif (/$doc_content/) {
2270 $contents .= $blankline;
2272 $contents .= $1 . "\n";
2278 # STATE_INLINE: docbook comments within a prototype.
2280 sub process_inline($$) {
2283 # First line (state 1) needs to be a @parameter
2284 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2287 $new_start_line = $.;
2288 if ($contents ne "") {
2289 while (substr($contents, 0, 1) eq " ") {
2290 $contents = substr($contents, 1);
2294 $inline_doc_state = STATE_INLINE_TEXT;
2295 # Documentation block end */
2296 } elsif (/$doc_inline_end/) {
2297 if (($contents ne "") && ($contents ne "\n")) {
2298 dump_section($file, $section, $contents);
2299 $section = $section_default;
2302 $state = STATE_PROTO;
2303 $inline_doc_state = STATE_INLINE_NA;
2305 } elsif (/$doc_content/) {
2306 if ($inline_doc_state == STATE_INLINE_TEXT) {
2307 $contents .= $1 . "\n";
2308 # nuke leading blank lines
2309 if ($contents =~ /^\s*$/) {
2312 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2313 $inline_doc_state = STATE_INLINE_ERROR;
2314 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_");
2320 sub process_file($) {
2322 my $initial_section_counter = $section_counter;
2323 my ($orig_file) = @_;
2325 $file = map_filename($orig_file);
2327 if (!open(IN_FILE,"<$file")) {
2328 print STDERR "Error: Cannot open file $file\n";
2335 $section_counter = 0;
2337 while (!/^ \*/ && s/\\\s*$//) {
2340 # Replace tabs by spaces
2341 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2342 # Hand this line to the appropriate state handler
2343 if ($state == STATE_NORMAL) {
2345 } elsif ($state == STATE_NAME) {
2346 process_name($file, $_);
2347 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2348 $state == STATE_BODY_WITH_BLANK_LINE) {
2349 process_body($file, $_);
2350 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2351 process_inline($file, $_);
2352 } elsif ($state == STATE_PROTO) {
2353 process_proto($file, $_);
2354 } elsif ($state == STATE_DOCBLOCK) {
2355 process_docblock($file, $_);
2359 # Make sure we got something interesting.
2360 if ($initial_section_counter == $section_counter && $
2361 output_mode ne "none") {
2362 if ($output_selection == OUTPUT_INCLUDE) {
2363 emit_warning("${file}:1", "'$_' not found\n")
2364 for keys %function_table;
2366 emit_warning("${file}:1", "no structured comments found\n");
2373 if ($output_mode eq "rst") {
2374 get_sphinx_version() if (!$sphinx_major);
2377 $kernelversion = get_kernel_version();
2379 # generate a sequence of code that will splice in highlighting information
2380 # using the s// operator.
2381 for (my $k = 0; $k < @highlights; $k++) {
2382 my $pattern = $highlights[$k][0];
2383 my $result = $highlights[$k][1];
2384 # print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2385 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2388 # Read the file that maps relative names to absolute names for
2389 # separate source and object directories and for shadow trees.
2390 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2391 my ($relname, $absname);
2392 while(<SOURCE_MAP>) {
2394 ($relname, $absname) = (split())[0..1];
2395 $relname =~ s:^/+::;
2396 $source_map{$relname} = $absname;
2401 if ($output_selection == OUTPUT_EXPORTED ||
2402 $output_selection == OUTPUT_INTERNAL) {
2404 push(@export_file_list, @ARGV);
2406 foreach (@export_file_list) {
2408 process_export_file($_);
2416 if ($verbose && $errors) {
2417 print STDERR "$errors errors\n";
2419 if ($verbose && $warnings) {
2420 print STDERR "$warnings warnings\n";
2423 if ($Werror && $warnings) {
2424 print STDERR "$warnings warnings as Errors\n";
2427 exit($output_mode eq "none" ? 0 : $errors)
2434 =head2 Output format selection (mutually exclusive):
2440 Output troff manual page format.
2444 Output reStructuredText format. This is the default.
2448 Do not output documentation, only warnings.
2452 =head2 Output format modifiers
2454 =head3 reStructuredText only
2458 =item -sphinx-version VERSION
2460 Use the ReST C domain dialect compatible with a specific Sphinx Version.
2462 If not specified, kernel-doc will auto-detect using the sphinx-build version
2467 =head2 Output selection (mutually exclusive):
2473 Only output documentation for the symbols that have been exported using
2474 EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2478 Only output documentation for the symbols that have NOT been exported using
2479 EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2481 =item -function NAME
2483 Only output documentation for the given function or DOC: section title.
2484 All other functions and DOC: sections are ignored.
2486 May be specified multiple times.
2488 =item -nosymbol NAME
2490 Exclude the specified symbol from the output documentation.
2492 May be specified multiple times.
2496 =head2 Output selection modifiers:
2500 =item -no-doc-sections
2502 Do not output DOC: sections.
2504 =item -export-file FILE
2506 Specify an additional FILE in which to look for EXPORT_SYMBOL information.
2508 To be used with -export or -internal.
2510 May be specified multiple times.
2514 =head3 reStructuredText only
2518 =item -enable-lineno
2520 Enable output of .. LINENO lines.
2524 =head2 Other parameters:
2534 Verbose output, more warnings and other information.
2538 Treat warnings as errors.