Loading...
1#!/usr/bin/perl -w
2
3use strict;
4
5## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
6## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
7## Copyright (C) 2001 Simon Huggins ##
8## Copyright (C) 2005-2012 Randy Dunlap ##
9## ##
10## #define enhancements by Armin Kuster <akuster@mvista.com> ##
11## Copyright (c) 2000 MontaVista Software, Inc. ##
12## ##
13## This software falls under the GNU General Public License. ##
14## Please read the COPYING file for more information ##
15
16# 18/01/2001 - Cleanups
17# Functions prototyped as foo(void) same as foo()
18# Stop eval'ing where we don't need to.
19# -- huggie@earth.li
20
21# 27/06/2001 - Allowed whitespace after initial "/**" and
22# allowed comments before function declarations.
23# -- Christian Kreibich <ck@whoop.org>
24
25# Still to do:
26# - add perldoc documentation
27# - Look more closely at some of the scarier bits :)
28
29# 26/05/2001 - Support for separate source and object trees.
30# Return error code.
31# Keith Owens <kaos@ocs.com.au>
32
33# 23/09/2001 - Added support for typedefs, structs, enums and unions
34# Support for Context section; can be terminated using empty line
35# Small fixes (like spaces vs. \s in regex)
36# -- Tim Jansen <tim@tjansen.de>
37
38
39#
40# This will read a 'c' file and scan for embedded comments in the
41# style of gnome comments (+minor extensions - see below).
42#
43
44# Note: This only supports 'c'.
45
46# usage:
47# kernel-doc [ -docbook | -html | -text | -man | -list ] [ -no-doc-sections ]
48# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
49# or
50# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
51#
52# Set output format using one of -docbook -html -text or -man. Default is man.
53# The -list format is for internal use by docproc.
54#
55# -no-doc-sections
56# Do not output DOC: sections
57#
58# -function funcname
59# If set, then only generate documentation for the given function(s) or
60# DOC: section titles. All other functions and DOC: sections are ignored.
61#
62# -nofunction funcname
63# If set, then only generate documentation for the other function(s)/DOC:
64# sections. Cannot be used together with -function (yes, that's a bug --
65# perl hackers can fix it 8))
66#
67# c files - list of 'c' files to process
68#
69# All output goes to stdout, with errors to stderr.
70
71#
72# format of comments.
73# In the following table, (...)? signifies optional structure.
74# (...)* signifies 0 or more structure elements
75# /**
76# * function_name(:)? (- short description)?
77# (* @parameterx: (description of parameter x)?)*
78# (* a blank line)?
79# * (Description:)? (Description of function)?
80# * (section header: (section description)? )*
81# (*)?*/
82#
83# So .. the trivial example would be:
84#
85# /**
86# * my_function
87# */
88#
89# If the Description: header tag is omitted, then there must be a blank line
90# after the last parameter specification.
91# e.g.
92# /**
93# * my_function - does my stuff
94# * @my_arg: its mine damnit
95# *
96# * Does my stuff explained.
97# */
98#
99# or, could also use:
100# /**
101# * my_function - does my stuff
102# * @my_arg: its mine damnit
103# * Description: Does my stuff explained.
104# */
105# etc.
106#
107# Besides functions you can also write documentation for structs, unions,
108# enums and typedefs. Instead of the function name you must write the name
109# of the declaration; the struct/union/enum/typedef must always precede
110# the name. Nesting of declarations is not supported.
111# Use the argument mechanism to document members or constants.
112# e.g.
113# /**
114# * struct my_struct - short description
115# * @a: first member
116# * @b: second member
117# *
118# * Longer description
119# */
120# struct my_struct {
121# int a;
122# int b;
123# /* private: */
124# int c;
125# };
126#
127# All descriptions can be multiline, except the short function description.
128#
129# You can also add additional sections. When documenting kernel functions you
130# should document the "Context:" of the function, e.g. whether the functions
131# can be called form interrupts. Unlike other sections you can end it with an
132# empty line.
133# Example-sections should contain the string EXAMPLE so that they are marked
134# appropriately in DocBook.
135#
136# Example:
137# /**
138# * user_function - function that can only be called in user context
139# * @a: some argument
140# * Context: !in_interrupt()
141# *
142# * Some description
143# * Example:
144# * user_function(22);
145# */
146# ...
147#
148#
149# All descriptive text is further processed, scanning for the following special
150# patterns, which are highlighted appropriately.
151#
152# 'funcname()' - function
153# '$ENVVAR' - environmental variable
154# '&struct_name' - name of a structure (up to two words including 'struct')
155# '@parameter' - name of a parameter
156# '%CONST' - name of a constant.
157
158## init lots of data
159
160my $errors = 0;
161my $warnings = 0;
162my $anon_struct_union = 0;
163
164# match expressions used to find embedded type information
165my $type_constant = '\%([-_\w]+)';
166my $type_func = '(\w+)\(\)';
167my $type_param = '\@(\w+)';
168my $type_struct = '\&((struct\s*)*[_\w]+)';
169my $type_struct_xml = '\\&((struct\s*)*[_\w]+)';
170my $type_env = '(\$\w+)';
171
172# Output conversion substitutions.
173# One for each output format
174
175# these work fairly well
176my %highlights_html = ( $type_constant, "<i>\$1</i>",
177 $type_func, "<b>\$1</b>",
178 $type_struct_xml, "<i>\$1</i>",
179 $type_env, "<b><i>\$1</i></b>",
180 $type_param, "<tt><b>\$1</b></tt>" );
181my $local_lt = "\\\\\\\\lt:";
182my $local_gt = "\\\\\\\\gt:";
183my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>"
184
185# XML, docbook format
186my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
187 $type_constant, "<constant>\$1</constant>",
188 $type_func, "<function>\$1</function>",
189 $type_struct_xml, "<structname>\$1</structname>",
190 $type_env, "<envar>\$1</envar>",
191 $type_param, "<parameter>\$1</parameter>" );
192my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
193
194# gnome, docbook format
195my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
196 $type_func, "<function>\$1</function>",
197 $type_struct, "<structname>\$1</structname>",
198 $type_env, "<envar>\$1</envar>",
199 $type_param, "<parameter>\$1</parameter>" );
200my $blankline_gnome = "</para><para>\n";
201
202# these are pretty rough
203my %highlights_man = ( $type_constant, "\$1",
204 $type_func, "\\\\fB\$1\\\\fP",
205 $type_struct, "\\\\fI\$1\\\\fP",
206 $type_param, "\\\\fI\$1\\\\fP" );
207my $blankline_man = "";
208
209# text-mode
210my %highlights_text = ( $type_constant, "\$1",
211 $type_func, "\$1",
212 $type_struct, "\$1",
213 $type_param, "\$1" );
214my $blankline_text = "";
215
216# list mode
217my %highlights_list = ( $type_constant, "\$1",
218 $type_func, "\$1",
219 $type_struct, "\$1",
220 $type_param, "\$1" );
221my $blankline_list = "";
222
223# read arguments
224if ($#ARGV == -1) {
225 usage();
226}
227
228my $kernelversion;
229my $dohighlight = "";
230
231my $verbose = 0;
232my $output_mode = "man";
233my $no_doc_sections = 0;
234my %highlights = %highlights_man;
235my $blankline = $blankline_man;
236my $modulename = "Kernel API";
237my $function_only = 0;
238my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
239 'July', 'August', 'September', 'October',
240 'November', 'December')[(localtime)[4]] .
241 " " . ((localtime)[5]+1900);
242
243# Essentially these are globals.
244# They probably want to be tidied up, made more localised or something.
245# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
246# could cause "use of undefined value" or other bugs.
247my ($function, %function_table, %parametertypes, $declaration_purpose);
248my ($type, $declaration_name, $return_type);
249my ($newsection, $newcontents, $prototype, $brcount, %source_map);
250
251if (defined($ENV{'KBUILD_VERBOSE'})) {
252 $verbose = "$ENV{'KBUILD_VERBOSE'}";
253}
254
255# Generated docbook code is inserted in a template at a point where
256# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
257# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
258# We keep track of number of generated entries and generate a dummy
259# if needs be to ensure the expanded template can be postprocessed
260# into html.
261my $section_counter = 0;
262
263my $lineprefix="";
264
265# states
266# 0 - normal code
267# 1 - looking for function name
268# 2 - scanning field start.
269# 3 - scanning prototype.
270# 4 - documentation block
271my $state;
272my $in_doc_sect;
273
274#declaration types: can be
275# 'function', 'struct', 'union', 'enum', 'typedef'
276my $decl_type;
277
278my $doc_special = "\@\%\$\&";
279
280my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
281my $doc_end = '\*/';
282my $doc_com = '\s*\*\s*';
283my $doc_decl = $doc_com . '(\w+)';
284my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
285my $doc_content = $doc_com . '(.*)';
286my $doc_block = $doc_com . 'DOC:\s*(.*)?';
287
288my %constants;
289my %parameterdescs;
290my @parameterlist;
291my %sections;
292my @sectionlist;
293my $sectcheck;
294my $struct_actual;
295
296my $contents = "";
297my $section_default = "Description"; # default section
298my $section_intro = "Introduction";
299my $section = $section_default;
300my $section_context = "Context";
301
302my $undescribed = "-- undescribed --";
303
304reset_state();
305
306while ($ARGV[0] =~ m/^-(.*)/) {
307 my $cmd = shift @ARGV;
308 if ($cmd eq "-html") {
309 $output_mode = "html";
310 %highlights = %highlights_html;
311 $blankline = $blankline_html;
312 } elsif ($cmd eq "-man") {
313 $output_mode = "man";
314 %highlights = %highlights_man;
315 $blankline = $blankline_man;
316 } elsif ($cmd eq "-text") {
317 $output_mode = "text";
318 %highlights = %highlights_text;
319 $blankline = $blankline_text;
320 } elsif ($cmd eq "-docbook") {
321 $output_mode = "xml";
322 %highlights = %highlights_xml;
323 $blankline = $blankline_xml;
324 } elsif ($cmd eq "-list") {
325 $output_mode = "list";
326 %highlights = %highlights_list;
327 $blankline = $blankline_list;
328 } elsif ($cmd eq "-gnome") {
329 $output_mode = "gnome";
330 %highlights = %highlights_gnome;
331 $blankline = $blankline_gnome;
332 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
333 $modulename = shift @ARGV;
334 } elsif ($cmd eq "-function") { # to only output specific functions
335 $function_only = 1;
336 $function = shift @ARGV;
337 $function_table{$function} = 1;
338 } elsif ($cmd eq "-nofunction") { # to only output specific functions
339 $function_only = 2;
340 $function = shift @ARGV;
341 $function_table{$function} = 1;
342 } elsif ($cmd eq "-v") {
343 $verbose = 1;
344 } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
345 usage();
346 } elsif ($cmd eq '-no-doc-sections') {
347 $no_doc_sections = 1;
348 }
349}
350
351# continue execution near EOF;
352
353sub usage {
354 print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -list ]\n";
355 print " [ -no-doc-sections ]\n";
356 print " [ -function funcname [ -function funcname ...] ]\n";
357 print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
358 print " c source file(s) > outputfile\n";
359 print " -v : verbose output, more warnings & other info listed\n";
360 exit 1;
361}
362
363# get kernel version from env
364sub get_kernel_version() {
365 my $version = 'unknown kernel version';
366
367 if (defined($ENV{'KERNELVERSION'})) {
368 $version = $ENV{'KERNELVERSION'};
369 }
370 return $version;
371}
372
373##
374# dumps section contents to arrays/hashes intended for that purpose.
375#
376sub dump_section {
377 my $file = shift;
378 my $name = shift;
379 my $contents = join "\n", @_;
380
381 if ($name =~ m/$type_constant/) {
382 $name = $1;
383# print STDERR "constant section '$1' = '$contents'\n";
384 $constants{$name} = $contents;
385 } elsif ($name =~ m/$type_param/) {
386# print STDERR "parameter def '$1' = '$contents'\n";
387 $name = $1;
388 $parameterdescs{$name} = $contents;
389 $sectcheck = $sectcheck . $name . " ";
390 } elsif ($name eq "@\.\.\.") {
391# print STDERR "parameter def '...' = '$contents'\n";
392 $name = "...";
393 $parameterdescs{$name} = $contents;
394 $sectcheck = $sectcheck . $name . " ";
395 } else {
396# print STDERR "other section '$name' = '$contents'\n";
397 if (defined($sections{$name}) && ($sections{$name} ne "")) {
398 print STDERR "Error(${file}:$.): duplicate section name '$name'\n";
399 ++$errors;
400 }
401 $sections{$name} = $contents;
402 push @sectionlist, $name;
403 }
404}
405
406##
407# dump DOC: section after checking that it should go out
408#
409sub dump_doc_section {
410 my $file = shift;
411 my $name = shift;
412 my $contents = join "\n", @_;
413
414 if ($no_doc_sections) {
415 return;
416 }
417
418 if (($function_only == 0) ||
419 ( $function_only == 1 && defined($function_table{$name})) ||
420 ( $function_only == 2 && !defined($function_table{$name})))
421 {
422 dump_section($file, $name, $contents);
423 output_blockhead({'sectionlist' => \@sectionlist,
424 'sections' => \%sections,
425 'module' => $modulename,
426 'content-only' => ($function_only != 0), });
427 }
428}
429
430##
431# output function
432#
433# parameterdescs, a hash.
434# function => "function name"
435# parameterlist => @list of parameters
436# parameterdescs => %parameter descriptions
437# sectionlist => @list of sections
438# sections => %section descriptions
439#
440
441sub output_highlight {
442 my $contents = join "\n",@_;
443 my $line;
444
445# DEBUG
446# if (!defined $contents) {
447# use Carp;
448# confess "output_highlight got called with no args?\n";
449# }
450
451 if ($output_mode eq "html" || $output_mode eq "xml") {
452 $contents = local_unescape($contents);
453 # convert data read & converted thru xml_escape() into &xyz; format:
454 $contents =~ s/\\\\\\/\&/g;
455 }
456# print STDERR "contents b4:$contents\n";
457 eval $dohighlight;
458 die $@ if $@;
459# print STDERR "contents af:$contents\n";
460
461 foreach $line (split "\n", $contents) {
462 if ($line eq ""){
463 print $lineprefix, local_unescape($blankline);
464 } else {
465 $line =~ s/\\\\\\/\&/g;
466 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
467 print "\\&$line";
468 } else {
469 print $lineprefix, $line;
470 }
471 }
472 print "\n";
473 }
474}
475
476#output sections in html
477sub output_section_html(%) {
478 my %args = %{$_[0]};
479 my $section;
480
481 foreach $section (@{$args{'sectionlist'}}) {
482 print "<h3>$section</h3>\n";
483 print "<blockquote>\n";
484 output_highlight($args{'sections'}{$section});
485 print "</blockquote>\n";
486 }
487}
488
489# output enum in html
490sub output_enum_html(%) {
491 my %args = %{$_[0]};
492 my ($parameter);
493 my $count;
494 print "<h2>enum " . $args{'enum'} . "</h2>\n";
495
496 print "<b>enum " . $args{'enum'} . "</b> {<br>\n";
497 $count = 0;
498 foreach $parameter (@{$args{'parameterlist'}}) {
499 print " <b>" . $parameter . "</b>";
500 if ($count != $#{$args{'parameterlist'}}) {
501 $count++;
502 print ",\n";
503 }
504 print "<br>";
505 }
506 print "};<br>\n";
507
508 print "<h3>Constants</h3>\n";
509 print "<dl>\n";
510 foreach $parameter (@{$args{'parameterlist'}}) {
511 print "<dt><b>" . $parameter . "</b>\n";
512 print "<dd>";
513 output_highlight($args{'parameterdescs'}{$parameter});
514 }
515 print "</dl>\n";
516 output_section_html(@_);
517 print "<hr>\n";
518}
519
520# output typedef in html
521sub output_typedef_html(%) {
522 my %args = %{$_[0]};
523 my ($parameter);
524 my $count;
525 print "<h2>typedef " . $args{'typedef'} . "</h2>\n";
526
527 print "<b>typedef " . $args{'typedef'} . "</b>\n";
528 output_section_html(@_);
529 print "<hr>\n";
530}
531
532# output struct in html
533sub output_struct_html(%) {
534 my %args = %{$_[0]};
535 my ($parameter);
536
537 print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>\n";
538 print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>\n";
539 foreach $parameter (@{$args{'parameterlist'}}) {
540 if ($parameter =~ /^#/) {
541 print "$parameter<br>\n";
542 next;
543 }
544 my $parameter_name = $parameter;
545 $parameter_name =~ s/\[.*//;
546
547 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
548 $type = $args{'parametertypes'}{$parameter};
549 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
550 # pointer-to-function
551 print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
552 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
553 # bitfield
554 print " <i>$1</i> <b>$parameter</b>$2;<br>\n";
555 } else {
556 print " <i>$type</i> <b>$parameter</b>;<br>\n";
557 }
558 }
559 print "};<br>\n";
560
561 print "<h3>Members</h3>\n";
562 print "<dl>\n";
563 foreach $parameter (@{$args{'parameterlist'}}) {
564 ($parameter =~ /^#/) && next;
565
566 my $parameter_name = $parameter;
567 $parameter_name =~ s/\[.*//;
568
569 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
570 print "<dt><b>" . $parameter . "</b>\n";
571 print "<dd>";
572 output_highlight($args{'parameterdescs'}{$parameter_name});
573 }
574 print "</dl>\n";
575 output_section_html(@_);
576 print "<hr>\n";
577}
578
579# output function in html
580sub output_function_html(%) {
581 my %args = %{$_[0]};
582 my ($parameter, $section);
583 my $count;
584
585 print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>\n";
586 print "<i>" . $args{'functiontype'} . "</i>\n";
587 print "<b>" . $args{'function'} . "</b>\n";
588 print "(";
589 $count = 0;
590 foreach $parameter (@{$args{'parameterlist'}}) {
591 $type = $args{'parametertypes'}{$parameter};
592 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
593 # pointer-to-function
594 print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
595 } else {
596 print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
597 }
598 if ($count != $#{$args{'parameterlist'}}) {
599 $count++;
600 print ",\n";
601 }
602 }
603 print ")\n";
604
605 print "<h3>Arguments</h3>\n";
606 print "<dl>\n";
607 foreach $parameter (@{$args{'parameterlist'}}) {
608 my $parameter_name = $parameter;
609 $parameter_name =~ s/\[.*//;
610
611 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
612 print "<dt><b>" . $parameter . "</b>\n";
613 print "<dd>";
614 output_highlight($args{'parameterdescs'}{$parameter_name});
615 }
616 print "</dl>\n";
617 output_section_html(@_);
618 print "<hr>\n";
619}
620
621# output DOC: block header in html
622sub output_blockhead_html(%) {
623 my %args = %{$_[0]};
624 my ($parameter, $section);
625 my $count;
626
627 foreach $section (@{$args{'sectionlist'}}) {
628 print "<h3>$section</h3>\n";
629 print "<ul>\n";
630 output_highlight($args{'sections'}{$section});
631 print "</ul>\n";
632 }
633 print "<hr>\n";
634}
635
636sub output_section_xml(%) {
637 my %args = %{$_[0]};
638 my $section;
639 # print out each section
640 $lineprefix=" ";
641 foreach $section (@{$args{'sectionlist'}}) {
642 print "<refsect1>\n";
643 print "<title>$section</title>\n";
644 if ($section =~ m/EXAMPLE/i) {
645 print "<informalexample><programlisting>\n";
646 } else {
647 print "<para>\n";
648 }
649 output_highlight($args{'sections'}{$section});
650 if ($section =~ m/EXAMPLE/i) {
651 print "</programlisting></informalexample>\n";
652 } else {
653 print "</para>\n";
654 }
655 print "</refsect1>\n";
656 }
657}
658
659# output function in XML DocBook
660sub output_function_xml(%) {
661 my %args = %{$_[0]};
662 my ($parameter, $section);
663 my $count;
664 my $id;
665
666 $id = "API-" . $args{'function'};
667 $id =~ s/[^A-Za-z0-9]/-/g;
668
669 print "<refentry id=\"$id\">\n";
670 print "<refentryinfo>\n";
671 print " <title>LINUX</title>\n";
672 print " <productname>Kernel Hackers Manual</productname>\n";
673 print " <date>$man_date</date>\n";
674 print "</refentryinfo>\n";
675 print "<refmeta>\n";
676 print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>\n";
677 print " <manvolnum>9</manvolnum>\n";
678 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
679 print "</refmeta>\n";
680 print "<refnamediv>\n";
681 print " <refname>" . $args{'function'} . "</refname>\n";
682 print " <refpurpose>\n";
683 print " ";
684 output_highlight ($args{'purpose'});
685 print " </refpurpose>\n";
686 print "</refnamediv>\n";
687
688 print "<refsynopsisdiv>\n";
689 print " <title>Synopsis</title>\n";
690 print " <funcsynopsis><funcprototype>\n";
691 print " <funcdef>" . $args{'functiontype'} . " ";
692 print "<function>" . $args{'function'} . " </function></funcdef>\n";
693
694 $count = 0;
695 if ($#{$args{'parameterlist'}} >= 0) {
696 foreach $parameter (@{$args{'parameterlist'}}) {
697 $type = $args{'parametertypes'}{$parameter};
698 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
699 # pointer-to-function
700 print " <paramdef>$1<parameter>$parameter</parameter>)\n";
701 print " <funcparams>$2</funcparams></paramdef>\n";
702 } else {
703 print " <paramdef>" . $type;
704 print " <parameter>$parameter</parameter></paramdef>\n";
705 }
706 }
707 } else {
708 print " <void/>\n";
709 }
710 print " </funcprototype></funcsynopsis>\n";
711 print "</refsynopsisdiv>\n";
712
713 # print parameters
714 print "<refsect1>\n <title>Arguments</title>\n";
715 if ($#{$args{'parameterlist'}} >= 0) {
716 print " <variablelist>\n";
717 foreach $parameter (@{$args{'parameterlist'}}) {
718 my $parameter_name = $parameter;
719 $parameter_name =~ s/\[.*//;
720
721 print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
722 print " <listitem>\n <para>\n";
723 $lineprefix=" ";
724 output_highlight($args{'parameterdescs'}{$parameter_name});
725 print " </para>\n </listitem>\n </varlistentry>\n";
726 }
727 print " </variablelist>\n";
728 } else {
729 print " <para>\n None\n </para>\n";
730 }
731 print "</refsect1>\n";
732
733 output_section_xml(@_);
734 print "</refentry>\n\n";
735}
736
737# output struct in XML DocBook
738sub output_struct_xml(%) {
739 my %args = %{$_[0]};
740 my ($parameter, $section);
741 my $id;
742
743 $id = "API-struct-" . $args{'struct'};
744 $id =~ s/[^A-Za-z0-9]/-/g;
745
746 print "<refentry id=\"$id\">\n";
747 print "<refentryinfo>\n";
748 print " <title>LINUX</title>\n";
749 print " <productname>Kernel Hackers Manual</productname>\n";
750 print " <date>$man_date</date>\n";
751 print "</refentryinfo>\n";
752 print "<refmeta>\n";
753 print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>\n";
754 print " <manvolnum>9</manvolnum>\n";
755 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
756 print "</refmeta>\n";
757 print "<refnamediv>\n";
758 print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>\n";
759 print " <refpurpose>\n";
760 print " ";
761 output_highlight ($args{'purpose'});
762 print " </refpurpose>\n";
763 print "</refnamediv>\n";
764
765 print "<refsynopsisdiv>\n";
766 print " <title>Synopsis</title>\n";
767 print " <programlisting>\n";
768 print $args{'type'} . " " . $args{'struct'} . " {\n";
769 foreach $parameter (@{$args{'parameterlist'}}) {
770 if ($parameter =~ /^#/) {
771 my $prm = $parameter;
772 # convert data read & converted thru xml_escape() into &xyz; format:
773 # This allows us to have #define macros interspersed in a struct.
774 $prm =~ s/\\\\\\/\&/g;
775 print "$prm\n";
776 next;
777 }
778
779 my $parameter_name = $parameter;
780 $parameter_name =~ s/\[.*//;
781
782 defined($args{'parameterdescs'}{$parameter_name}) || next;
783 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
784 $type = $args{'parametertypes'}{$parameter};
785 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
786 # pointer-to-function
787 print " $1 $parameter) ($2);\n";
788 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
789 # bitfield
790 print " $1 $parameter$2;\n";
791 } else {
792 print " " . $type . " " . $parameter . ";\n";
793 }
794 }
795 print "};";
796 print " </programlisting>\n";
797 print "</refsynopsisdiv>\n";
798
799 print " <refsect1>\n";
800 print " <title>Members</title>\n";
801
802 if ($#{$args{'parameterlist'}} >= 0) {
803 print " <variablelist>\n";
804 foreach $parameter (@{$args{'parameterlist'}}) {
805 ($parameter =~ /^#/) && next;
806
807 my $parameter_name = $parameter;
808 $parameter_name =~ s/\[.*//;
809
810 defined($args{'parameterdescs'}{$parameter_name}) || next;
811 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
812 print " <varlistentry>";
813 print " <term>$parameter</term>\n";
814 print " <listitem><para>\n";
815 output_highlight($args{'parameterdescs'}{$parameter_name});
816 print " </para></listitem>\n";
817 print " </varlistentry>\n";
818 }
819 print " </variablelist>\n";
820 } else {
821 print " <para>\n None\n </para>\n";
822 }
823 print " </refsect1>\n";
824
825 output_section_xml(@_);
826
827 print "</refentry>\n\n";
828}
829
830# output enum in XML DocBook
831sub output_enum_xml(%) {
832 my %args = %{$_[0]};
833 my ($parameter, $section);
834 my $count;
835 my $id;
836
837 $id = "API-enum-" . $args{'enum'};
838 $id =~ s/[^A-Za-z0-9]/-/g;
839
840 print "<refentry id=\"$id\">\n";
841 print "<refentryinfo>\n";
842 print " <title>LINUX</title>\n";
843 print " <productname>Kernel Hackers Manual</productname>\n";
844 print " <date>$man_date</date>\n";
845 print "</refentryinfo>\n";
846 print "<refmeta>\n";
847 print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>\n";
848 print " <manvolnum>9</manvolnum>\n";
849 print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
850 print "</refmeta>\n";
851 print "<refnamediv>\n";
852 print " <refname>enum " . $args{'enum'} . "</refname>\n";
853 print " <refpurpose>\n";
854 print " ";
855 output_highlight ($args{'purpose'});
856 print " </refpurpose>\n";
857 print "</refnamediv>\n";
858
859 print "<refsynopsisdiv>\n";
860 print " <title>Synopsis</title>\n";
861 print " <programlisting>\n";
862 print "enum " . $args{'enum'} . " {\n";
863 $count = 0;
864 foreach $parameter (@{$args{'parameterlist'}}) {
865 print " $parameter";
866 if ($count != $#{$args{'parameterlist'}}) {
867 $count++;
868 print ",";
869 }
870 print "\n";
871 }
872 print "};";
873 print " </programlisting>\n";
874 print "</refsynopsisdiv>\n";
875
876 print "<refsect1>\n";
877 print " <title>Constants</title>\n";
878 print " <variablelist>\n";
879 foreach $parameter (@{$args{'parameterlist'}}) {
880 my $parameter_name = $parameter;
881 $parameter_name =~ s/\[.*//;
882
883 print " <varlistentry>";
884 print " <term>$parameter</term>\n";
885 print " <listitem><para>\n";
886 output_highlight($args{'parameterdescs'}{$parameter_name});
887 print " </para></listitem>\n";
888 print " </varlistentry>\n";
889 }
890 print " </variablelist>\n";
891 print "</refsect1>\n";
892
893 output_section_xml(@_);
894
895 print "</refentry>\n\n";
896}
897
898# output typedef in XML DocBook
899sub output_typedef_xml(%) {
900 my %args = %{$_[0]};
901 my ($parameter, $section);
902 my $id;
903
904 $id = "API-typedef-" . $args{'typedef'};
905 $id =~ s/[^A-Za-z0-9]/-/g;
906
907 print "<refentry id=\"$id\">\n";
908 print "<refentryinfo>\n";
909 print " <title>LINUX</title>\n";
910 print " <productname>Kernel Hackers Manual</productname>\n";
911 print " <date>$man_date</date>\n";
912 print "</refentryinfo>\n";
913 print "<refmeta>\n";
914 print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>\n";
915 print " <manvolnum>9</manvolnum>\n";
916 print "</refmeta>\n";
917 print "<refnamediv>\n";
918 print " <refname>typedef " . $args{'typedef'} . "</refname>\n";
919 print " <refpurpose>\n";
920 print " ";
921 output_highlight ($args{'purpose'});
922 print " </refpurpose>\n";
923 print "</refnamediv>\n";
924
925 print "<refsynopsisdiv>\n";
926 print " <title>Synopsis</title>\n";
927 print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis>\n";
928 print "</refsynopsisdiv>\n";
929
930 output_section_xml(@_);
931
932 print "</refentry>\n\n";
933}
934
935# output in XML DocBook
936sub output_blockhead_xml(%) {
937 my %args = %{$_[0]};
938 my ($parameter, $section);
939 my $count;
940
941 my $id = $args{'module'};
942 $id =~ s/[^A-Za-z0-9]/-/g;
943
944 # print out each section
945 $lineprefix=" ";
946 foreach $section (@{$args{'sectionlist'}}) {
947 if (!$args{'content-only'}) {
948 print "<refsect1>\n <title>$section</title>\n";
949 }
950 if ($section =~ m/EXAMPLE/i) {
951 print "<example><para>\n";
952 } else {
953 print "<para>\n";
954 }
955 output_highlight($args{'sections'}{$section});
956 if ($section =~ m/EXAMPLE/i) {
957 print "</para></example>\n";
958 } else {
959 print "</para>";
960 }
961 if (!$args{'content-only'}) {
962 print "\n</refsect1>\n";
963 }
964 }
965
966 print "\n\n";
967}
968
969# output in XML DocBook
970sub output_function_gnome {
971 my %args = %{$_[0]};
972 my ($parameter, $section);
973 my $count;
974 my $id;
975
976 $id = $args{'module'} . "-" . $args{'function'};
977 $id =~ s/[^A-Za-z0-9]/-/g;
978
979 print "<sect2>\n";
980 print " <title id=\"$id\">" . $args{'function'} . "</title>\n";
981
982 print " <funcsynopsis>\n";
983 print " <funcdef>" . $args{'functiontype'} . " ";
984 print "<function>" . $args{'function'} . " ";
985 print "</function></funcdef>\n";
986
987 $count = 0;
988 if ($#{$args{'parameterlist'}} >= 0) {
989 foreach $parameter (@{$args{'parameterlist'}}) {
990 $type = $args{'parametertypes'}{$parameter};
991 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
992 # pointer-to-function
993 print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
994 print " <funcparams>$2</funcparams></paramdef>\n";
995 } else {
996 print " <paramdef>" . $type;
997 print " <parameter>$parameter</parameter></paramdef>\n";
998 }
999 }
1000 } else {
1001 print " <void>\n";
1002 }
1003 print " </funcsynopsis>\n";
1004 if ($#{$args{'parameterlist'}} >= 0) {
1005 print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
1006 print "<tgroup cols=\"2\">\n";
1007 print "<colspec colwidth=\"2*\">\n";
1008 print "<colspec colwidth=\"8*\">\n";
1009 print "<tbody>\n";
1010 foreach $parameter (@{$args{'parameterlist'}}) {
1011 my $parameter_name = $parameter;
1012 $parameter_name =~ s/\[.*//;
1013
1014 print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1015 print " <entry>\n";
1016 $lineprefix=" ";
1017 output_highlight($args{'parameterdescs'}{$parameter_name});
1018 print " </entry></row>\n";
1019 }
1020 print " </tbody></tgroup></informaltable>\n";
1021 } else {
1022 print " <para>\n None\n </para>\n";
1023 }
1024
1025 # print out each section
1026 $lineprefix=" ";
1027 foreach $section (@{$args{'sectionlist'}}) {
1028 print "<simplesect>\n <title>$section</title>\n";
1029 if ($section =~ m/EXAMPLE/i) {
1030 print "<example><programlisting>\n";
1031 } else {
1032 }
1033 print "<para>\n";
1034 output_highlight($args{'sections'}{$section});
1035 print "</para>\n";
1036 if ($section =~ m/EXAMPLE/i) {
1037 print "</programlisting></example>\n";
1038 } else {
1039 }
1040 print " </simplesect>\n";
1041 }
1042
1043 print "</sect2>\n\n";
1044}
1045
1046##
1047# output function in man
1048sub output_function_man(%) {
1049 my %args = %{$_[0]};
1050 my ($parameter, $section);
1051 my $count;
1052
1053 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1054
1055 print ".SH NAME\n";
1056 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
1057
1058 print ".SH SYNOPSIS\n";
1059 if ($args{'functiontype'} ne "") {
1060 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
1061 } else {
1062 print ".B \"" . $args{'function'} . "\n";
1063 }
1064 $count = 0;
1065 my $parenth = "(";
1066 my $post = ",";
1067 foreach my $parameter (@{$args{'parameterlist'}}) {
1068 if ($count == $#{$args{'parameterlist'}}) {
1069 $post = ");";
1070 }
1071 $type = $args{'parametertypes'}{$parameter};
1072 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1073 # pointer-to-function
1074 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1075 } else {
1076 $type =~ s/([^\*])$/$1 /;
1077 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1078 }
1079 $count++;
1080 $parenth = "";
1081 }
1082
1083 print ".SH ARGUMENTS\n";
1084 foreach $parameter (@{$args{'parameterlist'}}) {
1085 my $parameter_name = $parameter;
1086 $parameter_name =~ s/\[.*//;
1087
1088 print ".IP \"" . $parameter . "\" 12\n";
1089 output_highlight($args{'parameterdescs'}{$parameter_name});
1090 }
1091 foreach $section (@{$args{'sectionlist'}}) {
1092 print ".SH \"", uc $section, "\"\n";
1093 output_highlight($args{'sections'}{$section});
1094 }
1095}
1096
1097##
1098# output enum in man
1099sub output_enum_man(%) {
1100 my %args = %{$_[0]};
1101 my ($parameter, $section);
1102 my $count;
1103
1104 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1105
1106 print ".SH NAME\n";
1107 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
1108
1109 print ".SH SYNOPSIS\n";
1110 print "enum " . $args{'enum'} . " {\n";
1111 $count = 0;
1112 foreach my $parameter (@{$args{'parameterlist'}}) {
1113 print ".br\n.BI \" $parameter\"\n";
1114 if ($count == $#{$args{'parameterlist'}}) {
1115 print "\n};\n";
1116 last;
1117 }
1118 else {
1119 print ", \n.br\n";
1120 }
1121 $count++;
1122 }
1123
1124 print ".SH Constants\n";
1125 foreach $parameter (@{$args{'parameterlist'}}) {
1126 my $parameter_name = $parameter;
1127 $parameter_name =~ s/\[.*//;
1128
1129 print ".IP \"" . $parameter . "\" 12\n";
1130 output_highlight($args{'parameterdescs'}{$parameter_name});
1131 }
1132 foreach $section (@{$args{'sectionlist'}}) {
1133 print ".SH \"$section\"\n";
1134 output_highlight($args{'sections'}{$section});
1135 }
1136}
1137
1138##
1139# output struct in man
1140sub output_struct_man(%) {
1141 my %args = %{$_[0]};
1142 my ($parameter, $section);
1143
1144 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
1145
1146 print ".SH NAME\n";
1147 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
1148
1149 print ".SH SYNOPSIS\n";
1150 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
1151
1152 foreach my $parameter (@{$args{'parameterlist'}}) {
1153 if ($parameter =~ /^#/) {
1154 print ".BI \"$parameter\"\n.br\n";
1155 next;
1156 }
1157 my $parameter_name = $parameter;
1158 $parameter_name =~ s/\[.*//;
1159
1160 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1161 $type = $args{'parametertypes'}{$parameter};
1162 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1163 # pointer-to-function
1164 print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1165 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1166 # bitfield
1167 print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1168 } else {
1169 $type =~ s/([^\*])$/$1 /;
1170 print ".BI \" " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1171 }
1172 print "\n.br\n";
1173 }
1174 print "};\n.br\n";
1175
1176 print ".SH Members\n";
1177 foreach $parameter (@{$args{'parameterlist'}}) {
1178 ($parameter =~ /^#/) && next;
1179
1180 my $parameter_name = $parameter;
1181 $parameter_name =~ s/\[.*//;
1182
1183 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1184 print ".IP \"" . $parameter . "\" 12\n";
1185 output_highlight($args{'parameterdescs'}{$parameter_name});
1186 }
1187 foreach $section (@{$args{'sectionlist'}}) {
1188 print ".SH \"$section\"\n";
1189 output_highlight($args{'sections'}{$section});
1190 }
1191}
1192
1193##
1194# output typedef in man
1195sub output_typedef_man(%) {
1196 my %args = %{$_[0]};
1197 my ($parameter, $section);
1198
1199 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1200
1201 print ".SH NAME\n";
1202 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
1203
1204 foreach $section (@{$args{'sectionlist'}}) {
1205 print ".SH \"$section\"\n";
1206 output_highlight($args{'sections'}{$section});
1207 }
1208}
1209
1210sub output_blockhead_man(%) {
1211 my %args = %{$_[0]};
1212 my ($parameter, $section);
1213 my $count;
1214
1215 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1216
1217 foreach $section (@{$args{'sectionlist'}}) {
1218 print ".SH \"$section\"\n";
1219 output_highlight($args{'sections'}{$section});
1220 }
1221}
1222
1223##
1224# output in text
1225sub output_function_text(%) {
1226 my %args = %{$_[0]};
1227 my ($parameter, $section);
1228 my $start;
1229
1230 print "Name:\n\n";
1231 print $args{'function'} . " - " . $args{'purpose'} . "\n";
1232
1233 print "\nSynopsis:\n\n";
1234 if ($args{'functiontype'} ne "") {
1235 $start = $args{'functiontype'} . " " . $args{'function'} . " (";
1236 } else {
1237 $start = $args{'function'} . " (";
1238 }
1239 print $start;
1240
1241 my $count = 0;
1242 foreach my $parameter (@{$args{'parameterlist'}}) {
1243 $type = $args{'parametertypes'}{$parameter};
1244 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1245 # pointer-to-function
1246 print $1 . $parameter . ") (" . $2;
1247 } else {
1248 print $type . " " . $parameter;
1249 }
1250 if ($count != $#{$args{'parameterlist'}}) {
1251 $count++;
1252 print ",\n";
1253 print " " x length($start);
1254 } else {
1255 print ");\n\n";
1256 }
1257 }
1258
1259 print "Arguments:\n\n";
1260 foreach $parameter (@{$args{'parameterlist'}}) {
1261 my $parameter_name = $parameter;
1262 $parameter_name =~ s/\[.*//;
1263
1264 print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1265 }
1266 output_section_text(@_);
1267}
1268
1269#output sections in text
1270sub output_section_text(%) {
1271 my %args = %{$_[0]};
1272 my $section;
1273
1274 print "\n";
1275 foreach $section (@{$args{'sectionlist'}}) {
1276 print "$section:\n\n";
1277 output_highlight($args{'sections'}{$section});
1278 }
1279 print "\n\n";
1280}
1281
1282# output enum in text
1283sub output_enum_text(%) {
1284 my %args = %{$_[0]};
1285 my ($parameter);
1286 my $count;
1287 print "Enum:\n\n";
1288
1289 print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "\n\n";
1290 print "enum " . $args{'enum'} . " {\n";
1291 $count = 0;
1292 foreach $parameter (@{$args{'parameterlist'}}) {
1293 print "\t$parameter";
1294 if ($count != $#{$args{'parameterlist'}}) {
1295 $count++;
1296 print ",";
1297 }
1298 print "\n";
1299 }
1300 print "};\n\n";
1301
1302 print "Constants:\n\n";
1303 foreach $parameter (@{$args{'parameterlist'}}) {
1304 print "$parameter\n\t";
1305 print $args{'parameterdescs'}{$parameter} . "\n";
1306 }
1307
1308 output_section_text(@_);
1309}
1310
1311# output typedef in text
1312sub output_typedef_text(%) {
1313 my %args = %{$_[0]};
1314 my ($parameter);
1315 my $count;
1316 print "Typedef:\n\n";
1317
1318 print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "\n";
1319 output_section_text(@_);
1320}
1321
1322# output struct as text
1323sub output_struct_text(%) {
1324 my %args = %{$_[0]};
1325 my ($parameter);
1326
1327 print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "\n\n";
1328 print $args{'type'} . " " . $args{'struct'} . " {\n";
1329 foreach $parameter (@{$args{'parameterlist'}}) {
1330 if ($parameter =~ /^#/) {
1331 print "$parameter\n";
1332 next;
1333 }
1334
1335 my $parameter_name = $parameter;
1336 $parameter_name =~ s/\[.*//;
1337
1338 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1339 $type = $args{'parametertypes'}{$parameter};
1340 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1341 # pointer-to-function
1342 print "\t$1 $parameter) ($2);\n";
1343 } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1344 # bitfield
1345 print "\t$1 $parameter$2;\n";
1346 } else {
1347 print "\t" . $type . " " . $parameter . ";\n";
1348 }
1349 }
1350 print "};\n\n";
1351
1352 print "Members:\n\n";
1353 foreach $parameter (@{$args{'parameterlist'}}) {
1354 ($parameter =~ /^#/) && next;
1355
1356 my $parameter_name = $parameter;
1357 $parameter_name =~ s/\[.*//;
1358
1359 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1360 print "$parameter\n\t";
1361 print $args{'parameterdescs'}{$parameter_name} . "\n";
1362 }
1363 print "\n";
1364 output_section_text(@_);
1365}
1366
1367sub output_blockhead_text(%) {
1368 my %args = %{$_[0]};
1369 my ($parameter, $section);
1370
1371 foreach $section (@{$args{'sectionlist'}}) {
1372 print " $section:\n";
1373 print " -> ";
1374 output_highlight($args{'sections'}{$section});
1375 }
1376}
1377
1378## list mode output functions
1379
1380sub output_function_list(%) {
1381 my %args = %{$_[0]};
1382
1383 print $args{'function'} . "\n";
1384}
1385
1386# output enum in list
1387sub output_enum_list(%) {
1388 my %args = %{$_[0]};
1389 print $args{'enum'} . "\n";
1390}
1391
1392# output typedef in list
1393sub output_typedef_list(%) {
1394 my %args = %{$_[0]};
1395 print $args{'typedef'} . "\n";
1396}
1397
1398# output struct as list
1399sub output_struct_list(%) {
1400 my %args = %{$_[0]};
1401
1402 print $args{'struct'} . "\n";
1403}
1404
1405sub output_blockhead_list(%) {
1406 my %args = %{$_[0]};
1407 my ($parameter, $section);
1408
1409 foreach $section (@{$args{'sectionlist'}}) {
1410 print "DOC: $section\n";
1411 }
1412}
1413
1414##
1415# generic output function for all types (function, struct/union, typedef, enum);
1416# calls the generated, variable output_ function name based on
1417# functype and output_mode
1418sub output_declaration {
1419 no strict 'refs';
1420 my $name = shift;
1421 my $functype = shift;
1422 my $func = "output_${functype}_$output_mode";
1423 if (($function_only==0) ||
1424 ( $function_only == 1 && defined($function_table{$name})) ||
1425 ( $function_only == 2 && !defined($function_table{$name})))
1426 {
1427 &$func(@_);
1428 $section_counter++;
1429 }
1430}
1431
1432##
1433# generic output function - calls the right one based on current output mode.
1434sub output_blockhead {
1435 no strict 'refs';
1436 my $func = "output_blockhead_" . $output_mode;
1437 &$func(@_);
1438 $section_counter++;
1439}
1440
1441##
1442# takes a declaration (struct, union, enum, typedef) and
1443# invokes the right handler. NOT called for functions.
1444sub dump_declaration($$) {
1445 no strict 'refs';
1446 my ($prototype, $file) = @_;
1447 my $func = "dump_" . $decl_type;
1448 &$func(@_);
1449}
1450
1451sub dump_union($$) {
1452 dump_struct(@_);
1453}
1454
1455sub dump_struct($$) {
1456 my $x = shift;
1457 my $file = shift;
1458 my $nested;
1459
1460 if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
1461 #my $decl_type = $1;
1462 $declaration_name = $2;
1463 my $members = $3;
1464
1465 # ignore embedded structs or unions
1466 $members =~ s/({.*})//g;
1467 $nested = $1;
1468
1469 # ignore members marked private:
1470 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos;
1471 $members =~ s/\/\*\s*private:.*//gos;
1472 # strip comments:
1473 $members =~ s/\/\*.*?\*\///gos;
1474 $nested =~ s/\/\*.*?\*\///gos;
1475 # strip kmemcheck_bitfield_{begin,end}.*;
1476 $members =~ s/kmemcheck_bitfield_.*?;//gos;
1477 # strip attributes
1478 $members =~ s/__aligned\s*\(\d+\)//gos;
1479
1480 create_parameterlist($members, ';', $file);
1481 check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
1482
1483 output_declaration($declaration_name,
1484 'struct',
1485 {'struct' => $declaration_name,
1486 'module' => $modulename,
1487 'parameterlist' => \@parameterlist,
1488 'parameterdescs' => \%parameterdescs,
1489 'parametertypes' => \%parametertypes,
1490 'sectionlist' => \@sectionlist,
1491 'sections' => \%sections,
1492 'purpose' => $declaration_purpose,
1493 'type' => $decl_type
1494 });
1495 }
1496 else {
1497 print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
1498 ++$errors;
1499 }
1500}
1501
1502sub dump_enum($$) {
1503 my $x = shift;
1504 my $file = shift;
1505
1506 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1507 $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
1508
1509 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1510 $declaration_name = $1;
1511 my $members = $2;
1512
1513 foreach my $arg (split ',', $members) {
1514 $arg =~ s/^\s*(\w+).*/$1/;
1515 push @parameterlist, $arg;
1516 if (!$parameterdescs{$arg}) {
1517 $parameterdescs{$arg} = $undescribed;
1518 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
1519 "not described in enum '$declaration_name'\n";
1520 }
1521
1522 }
1523
1524 output_declaration($declaration_name,
1525 'enum',
1526 {'enum' => $declaration_name,
1527 'module' => $modulename,
1528 'parameterlist' => \@parameterlist,
1529 'parameterdescs' => \%parameterdescs,
1530 'sectionlist' => \@sectionlist,
1531 'sections' => \%sections,
1532 'purpose' => $declaration_purpose
1533 });
1534 }
1535 else {
1536 print STDERR "Error(${file}:$.): Cannot parse enum!\n";
1537 ++$errors;
1538 }
1539}
1540
1541sub dump_typedef($$) {
1542 my $x = shift;
1543 my $file = shift;
1544
1545 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1546 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1547 $x =~ s/\(*.\)\s*;$/;/;
1548 $x =~ s/\[*.\]\s*;$/;/;
1549 }
1550
1551 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1552 $declaration_name = $1;
1553
1554 output_declaration($declaration_name,
1555 'typedef',
1556 {'typedef' => $declaration_name,
1557 'module' => $modulename,
1558 'sectionlist' => \@sectionlist,
1559 'sections' => \%sections,
1560 'purpose' => $declaration_purpose
1561 });
1562 }
1563 else {
1564 print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
1565 ++$errors;
1566 }
1567}
1568
1569sub save_struct_actual($) {
1570 my $actual = shift;
1571
1572 # strip all spaces from the actual param so that it looks like one string item
1573 $actual =~ s/\s*//g;
1574 $struct_actual = $struct_actual . $actual . " ";
1575}
1576
1577sub create_parameterlist($$$) {
1578 my $args = shift;
1579 my $splitter = shift;
1580 my $file = shift;
1581 my $type;
1582 my $param;
1583
1584 # temporarily replace commas inside function pointer definition
1585 while ($args =~ /(\([^\),]+),/) {
1586 $args =~ s/(\([^\),]+),/$1#/g;
1587 }
1588
1589 foreach my $arg (split($splitter, $args)) {
1590 # strip comments
1591 $arg =~ s/\/\*.*\*\///;
1592 # strip leading/trailing spaces
1593 $arg =~ s/^\s*//;
1594 $arg =~ s/\s*$//;
1595 $arg =~ s/\s+/ /;
1596
1597 if ($arg =~ /^#/) {
1598 # Treat preprocessor directive as a typeless variable just to fill
1599 # corresponding data structures "correctly". Catch it later in
1600 # output_* subs.
1601 push_parameter($arg, "", $file);
1602 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1603 # pointer-to-function
1604 $arg =~ tr/#/,/;
1605 $arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/;
1606 $param = $1;
1607 $type = $arg;
1608 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1609 save_struct_actual($param);
1610 push_parameter($param, $type, $file);
1611 } elsif ($arg) {
1612 $arg =~ s/\s*:\s*/:/g;
1613 $arg =~ s/\s*\[/\[/g;
1614
1615 my @args = split('\s*,\s*', $arg);
1616 if ($args[0] =~ m/\*/) {
1617 $args[0] =~ s/(\*+)\s*/ $1/;
1618 }
1619
1620 my @first_arg;
1621 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1622 shift @args;
1623 push(@first_arg, split('\s+', $1));
1624 push(@first_arg, $2);
1625 } else {
1626 @first_arg = split('\s+', shift @args);
1627 }
1628
1629 unshift(@args, pop @first_arg);
1630 $type = join " ", @first_arg;
1631
1632 foreach $param (@args) {
1633 if ($param =~ m/^(\*+)\s*(.*)/) {
1634 save_struct_actual($2);
1635 push_parameter($2, "$type $1", $file);
1636 }
1637 elsif ($param =~ m/(.*?):(\d+)/) {
1638 if ($type ne "") { # skip unnamed bit-fields
1639 save_struct_actual($1);
1640 push_parameter($1, "$type:$2", $file)
1641 }
1642 }
1643 else {
1644 save_struct_actual($param);
1645 push_parameter($param, $type, $file);
1646 }
1647 }
1648 }
1649 }
1650}
1651
1652sub push_parameter($$$) {
1653 my $param = shift;
1654 my $type = shift;
1655 my $file = shift;
1656
1657 if (($anon_struct_union == 1) && ($type eq "") &&
1658 ($param eq "}")) {
1659 return; # ignore the ending }; from anon. struct/union
1660 }
1661
1662 $anon_struct_union = 0;
1663 my $param_name = $param;
1664 $param_name =~ s/\[.*//;
1665
1666 if ($type eq "" && $param =~ /\.\.\.$/)
1667 {
1668 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1669 $parameterdescs{$param} = "variable arguments";
1670 }
1671 }
1672 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1673 {
1674 $param="void";
1675 $parameterdescs{void} = "no arguments";
1676 }
1677 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1678 # handle unnamed (anonymous) union or struct:
1679 {
1680 $type = $param;
1681 $param = "{unnamed_" . $param . "}";
1682 $parameterdescs{$param} = "anonymous\n";
1683 $anon_struct_union = 1;
1684 }
1685
1686 # warn if parameter has no description
1687 # (but ignore ones starting with # as these are not parameters
1688 # but inline preprocessor statements);
1689 # also ignore unnamed structs/unions;
1690 if (!$anon_struct_union) {
1691 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1692
1693 $parameterdescs{$param_name} = $undescribed;
1694
1695 if (($type eq 'function') || ($type eq 'enum')) {
1696 print STDERR "Warning(${file}:$.): Function parameter ".
1697 "or member '$param' not " .
1698 "described in '$declaration_name'\n";
1699 }
1700 print STDERR "Warning(${file}:$.):" .
1701 " No description found for parameter '$param'\n";
1702 ++$warnings;
1703 }
1704 }
1705
1706 $param = xml_escape($param);
1707
1708 # strip spaces from $param so that it is one continuous string
1709 # on @parameterlist;
1710 # this fixes a problem where check_sections() cannot find
1711 # a parameter like "addr[6 + 2]" because it actually appears
1712 # as "addr[6", "+", "2]" on the parameter list;
1713 # but it's better to maintain the param string unchanged for output,
1714 # so just weaken the string compare in check_sections() to ignore
1715 # "[blah" in a parameter string;
1716 ###$param =~ s/\s*//g;
1717 push @parameterlist, $param;
1718 $parametertypes{$param} = $type;
1719}
1720
1721sub check_sections($$$$$$) {
1722 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_;
1723 my @sects = split ' ', $sectcheck;
1724 my @prms = split ' ', $prmscheck;
1725 my $err;
1726 my ($px, $sx);
1727 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1728
1729 foreach $sx (0 .. $#sects) {
1730 $err = 1;
1731 foreach $px (0 .. $#prms) {
1732 $prm_clean = $prms[$px];
1733 $prm_clean =~ s/\[.*\]//;
1734 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1735 # ignore array size in a parameter string;
1736 # however, the original param string may contain
1737 # spaces, e.g.: addr[6 + 2]
1738 # and this appears in @prms as "addr[6" since the
1739 # parameter list is split at spaces;
1740 # hence just ignore "[..." for the sections check;
1741 $prm_clean =~ s/\[.*//;
1742
1743 ##$prm_clean =~ s/^\**//;
1744 if ($prm_clean eq $sects[$sx]) {
1745 $err = 0;
1746 last;
1747 }
1748 }
1749 if ($err) {
1750 if ($decl_type eq "function") {
1751 print STDERR "Warning(${file}:$.): " .
1752 "Excess function parameter " .
1753 "'$sects[$sx]' " .
1754 "description in '$decl_name'\n";
1755 ++$warnings;
1756 } else {
1757 if ($nested !~ m/\Q$sects[$sx]\E/) {
1758 print STDERR "Warning(${file}:$.): " .
1759 "Excess struct/union/enum/typedef member " .
1760 "'$sects[$sx]' " .
1761 "description in '$decl_name'\n";
1762 ++$warnings;
1763 }
1764 }
1765 }
1766 }
1767}
1768
1769##
1770# takes a function prototype and the name of the current file being
1771# processed and spits out all the details stored in the global
1772# arrays/hashes.
1773sub dump_function($$) {
1774 my $prototype = shift;
1775 my $file = shift;
1776
1777 $prototype =~ s/^static +//;
1778 $prototype =~ s/^extern +//;
1779 $prototype =~ s/^asmlinkage +//;
1780 $prototype =~ s/^inline +//;
1781 $prototype =~ s/^__inline__ +//;
1782 $prototype =~ s/^__inline +//;
1783 $prototype =~ s/^__always_inline +//;
1784 $prototype =~ s/^noinline +//;
1785 $prototype =~ s/__devinit +//;
1786 $prototype =~ s/__init +//;
1787 $prototype =~ s/__init_or_module +//;
1788 $prototype =~ s/__must_check +//;
1789 $prototype =~ s/^#\s*define\s+//; #ak added
1790 $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1791
1792 # Yes, this truly is vile. We are looking for:
1793 # 1. Return type (may be nothing if we're looking at a macro)
1794 # 2. Function name
1795 # 3. Function parameters.
1796 #
1797 # All the while we have to watch out for function pointer parameters
1798 # (which IIRC is what the two sections are for), C types (these
1799 # regexps don't even start to express all the possibilities), and
1800 # so on.
1801 #
1802 # If you mess with these regexps, it's a good idea to check that
1803 # the following functions' documentation still comes out right:
1804 # - parport_register_device (function pointer parameters)
1805 # - atomic_set (macro)
1806 # - pci_match_device, __copy_to_user (long return type)
1807
1808 if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1809 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1810 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1811 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1812 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1813 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1814 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1815 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1816 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1817 $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1818 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1819 $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1820 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1821 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1822 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1823 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1824 $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1825 $return_type = $1;
1826 $declaration_name = $2;
1827 my $args = $3;
1828
1829 create_parameterlist($args, ',', $file);
1830 } else {
1831 print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1832 ++$errors;
1833 return;
1834 }
1835
1836 my $prms = join " ", @parameterlist;
1837 check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
1838
1839 output_declaration($declaration_name,
1840 'function',
1841 {'function' => $declaration_name,
1842 'module' => $modulename,
1843 'functiontype' => $return_type,
1844 'parameterlist' => \@parameterlist,
1845 'parameterdescs' => \%parameterdescs,
1846 'parametertypes' => \%parametertypes,
1847 'sectionlist' => \@sectionlist,
1848 'sections' => \%sections,
1849 'purpose' => $declaration_purpose
1850 });
1851}
1852
1853sub reset_state {
1854 $function = "";
1855 %constants = ();
1856 %parameterdescs = ();
1857 %parametertypes = ();
1858 @parameterlist = ();
1859 %sections = ();
1860 @sectionlist = ();
1861 $sectcheck = "";
1862 $struct_actual = "";
1863 $prototype = "";
1864
1865 $state = 0;
1866}
1867
1868sub tracepoint_munge($) {
1869 my $file = shift;
1870 my $tracepointname = 0;
1871 my $tracepointargs = 0;
1872
1873 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1874 $tracepointname = $1;
1875 }
1876 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1877 $tracepointname = $1;
1878 }
1879 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1880 $tracepointname = $2;
1881 }
1882 $tracepointname =~ s/^\s+//; #strip leading whitespace
1883 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1884 $tracepointargs = $1;
1885 }
1886 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1887 print STDERR "Warning(${file}:$.): Unrecognized tracepoint format: \n".
1888 "$prototype\n";
1889 } else {
1890 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1891 }
1892}
1893
1894sub syscall_munge() {
1895 my $void = 0;
1896
1897 $prototype =~ s@[\r\n\t]+@ @gos; # strip newlines/CR's/tabs
1898## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1899 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1900 $void = 1;
1901## $prototype = "long sys_$1(void)";
1902 }
1903
1904 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1905 if ($prototype =~ m/long (sys_.*?),/) {
1906 $prototype =~ s/,/\(/;
1907 } elsif ($void) {
1908 $prototype =~ s/\)/\(void\)/;
1909 }
1910
1911 # now delete all of the odd-number commas in $prototype
1912 # so that arg types & arg names don't have a comma between them
1913 my $count = 0;
1914 my $len = length($prototype);
1915 if ($void) {
1916 $len = 0; # skip the for-loop
1917 }
1918 for (my $ix = 0; $ix < $len; $ix++) {
1919 if (substr($prototype, $ix, 1) eq ',') {
1920 $count++;
1921 if ($count % 2 == 1) {
1922 substr($prototype, $ix, 1) = ' ';
1923 }
1924 }
1925 }
1926}
1927
1928sub process_state3_function($$) {
1929 my $x = shift;
1930 my $file = shift;
1931
1932 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1933
1934 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1935 # do nothing
1936 }
1937 elsif ($x =~ /([^\{]*)/) {
1938 $prototype .= $1;
1939 }
1940
1941 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1942 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1943 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1944 $prototype =~ s@^\s+@@gos; # strip leading spaces
1945 if ($prototype =~ /SYSCALL_DEFINE/) {
1946 syscall_munge();
1947 }
1948 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1949 $prototype =~ /DEFINE_SINGLE_EVENT/)
1950 {
1951 tracepoint_munge($file);
1952 }
1953 dump_function($prototype, $file);
1954 reset_state();
1955 }
1956}
1957
1958sub process_state3_type($$) {
1959 my $x = shift;
1960 my $file = shift;
1961
1962 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1963 $x =~ s@^\s+@@gos; # strip leading spaces
1964 $x =~ s@\s+$@@gos; # strip trailing spaces
1965 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1966
1967 if ($x =~ /^#/) {
1968 # To distinguish preprocessor directive from regular declaration later.
1969 $x .= ";";
1970 }
1971
1972 while (1) {
1973 if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1974 $prototype .= $1 . $2;
1975 ($2 eq '{') && $brcount++;
1976 ($2 eq '}') && $brcount--;
1977 if (($2 eq ';') && ($brcount == 0)) {
1978 dump_declaration($prototype, $file);
1979 reset_state();
1980 last;
1981 }
1982 $x = $3;
1983 } else {
1984 $prototype .= $x;
1985 last;
1986 }
1987 }
1988}
1989
1990# xml_escape: replace <, >, and & in the text stream;
1991#
1992# however, formatting controls that are generated internally/locally in the
1993# kernel-doc script are not escaped here; instead, they begin life like
1994# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1995# are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1996# just before actual output; (this is done by local_unescape())
1997sub xml_escape($) {
1998 my $text = shift;
1999 if (($output_mode eq "text") || ($output_mode eq "man")) {
2000 return $text;
2001 }
2002 $text =~ s/\&/\\\\\\amp;/g;
2003 $text =~ s/\</\\\\\\lt;/g;
2004 $text =~ s/\>/\\\\\\gt;/g;
2005 return $text;
2006}
2007
2008# convert local escape strings to html
2009# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes)
2010sub local_unescape($) {
2011 my $text = shift;
2012 if (($output_mode eq "text") || ($output_mode eq "man")) {
2013 return $text;
2014 }
2015 $text =~ s/\\\\\\\\lt:/</g;
2016 $text =~ s/\\\\\\\\gt:/>/g;
2017 return $text;
2018}
2019
2020sub process_file($) {
2021 my $file;
2022 my $identifier;
2023 my $func;
2024 my $descr;
2025 my $in_purpose = 0;
2026 my $initial_section_counter = $section_counter;
2027
2028 if (defined($ENV{'SRCTREE'})) {
2029 $file = "$ENV{'SRCTREE'}" . "/" . "@_";
2030 }
2031 else {
2032 $file = "@_";
2033 }
2034 if (defined($source_map{$file})) {
2035 $file = $source_map{$file};
2036 }
2037
2038 if (!open(IN,"<$file")) {
2039 print STDERR "Error: Cannot open file $file\n";
2040 ++$errors;
2041 return;
2042 }
2043
2044 $. = 1;
2045
2046 $section_counter = 0;
2047 while (<IN>) {
2048 if ($state == 0) {
2049 if (/$doc_start/o) {
2050 $state = 1; # next line is always the function name
2051 $in_doc_sect = 0;
2052 }
2053 } elsif ($state == 1) { # this line is the function name (always)
2054 if (/$doc_block/o) {
2055 $state = 4;
2056 $contents = "";
2057 if ( $1 eq "" ) {
2058 $section = $section_intro;
2059 } else {
2060 $section = $1;
2061 }
2062 }
2063 elsif (/$doc_decl/o) {
2064 $identifier = $1;
2065 if (/\s*([\w\s]+?)\s*-/) {
2066 $identifier = $1;
2067 }
2068
2069 $state = 2;
2070 if (/-(.*)/) {
2071 # strip leading/trailing/multiple spaces
2072 $descr= $1;
2073 $descr =~ s/^\s*//;
2074 $descr =~ s/\s*$//;
2075 $descr =~ s/\s+/ /;
2076 $declaration_purpose = xml_escape($descr);
2077 $in_purpose = 1;
2078 } else {
2079 $declaration_purpose = "";
2080 }
2081
2082 if (($declaration_purpose eq "") && $verbose) {
2083 print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
2084 print STDERR $_;
2085 ++$warnings;
2086 }
2087
2088 if ($identifier =~ m/^struct/) {
2089 $decl_type = 'struct';
2090 } elsif ($identifier =~ m/^union/) {
2091 $decl_type = 'union';
2092 } elsif ($identifier =~ m/^enum/) {
2093 $decl_type = 'enum';
2094 } elsif ($identifier =~ m/^typedef/) {
2095 $decl_type = 'typedef';
2096 } else {
2097 $decl_type = 'function';
2098 }
2099
2100 if ($verbose) {
2101 print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
2102 }
2103 } else {
2104 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
2105 " - I thought it was a doc line\n";
2106 ++$warnings;
2107 $state = 0;
2108 }
2109 } elsif ($state == 2) { # look for head: lines, and include content
2110 if (/$doc_sect/o) {
2111 $newsection = $1;
2112 $newcontents = $2;
2113
2114 if (($contents ne "") && ($contents ne "\n")) {
2115 if (!$in_doc_sect && $verbose) {
2116 print STDERR "Warning(${file}:$.): contents before sections\n";
2117 ++$warnings;
2118 }
2119 dump_section($file, $section, xml_escape($contents));
2120 $section = $section_default;
2121 }
2122
2123 $in_doc_sect = 1;
2124 $in_purpose = 0;
2125 $contents = $newcontents;
2126 if ($contents ne "") {
2127 while ((substr($contents, 0, 1) eq " ") ||
2128 substr($contents, 0, 1) eq "\t") {
2129 $contents = substr($contents, 1);
2130 }
2131 $contents .= "\n";
2132 }
2133 $section = $newsection;
2134 } elsif (/$doc_end/) {
2135
2136 if (($contents ne "") && ($contents ne "\n")) {
2137 dump_section($file, $section, xml_escape($contents));
2138 $section = $section_default;
2139 $contents = "";
2140 }
2141 # look for doc_com + <text> + doc_end:
2142 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2143 print STDERR "Warning(${file}:$.): suspicious ending line: $_";
2144 ++$warnings;
2145 }
2146
2147 $prototype = "";
2148 $state = 3;
2149 $brcount = 0;
2150# print STDERR "end of doc comment, looking for prototype\n";
2151 } elsif (/$doc_content/) {
2152 # miguel-style comment kludge, look for blank lines after
2153 # @parameter line to signify start of description
2154 if ($1 eq "") {
2155 if ($section =~ m/^@/ || $section eq $section_context) {
2156 dump_section($file, $section, xml_escape($contents));
2157 $section = $section_default;
2158 $contents = "";
2159 } else {
2160 $contents .= "\n";
2161 }
2162 $in_purpose = 0;
2163 } elsif ($in_purpose == 1) {
2164 # Continued declaration purpose
2165 chomp($declaration_purpose);
2166 $declaration_purpose .= " " . xml_escape($1);
2167 } else {
2168 $contents .= $1 . "\n";
2169 }
2170 } else {
2171 # i dont know - bad line? ignore.
2172 print STDERR "Warning(${file}:$.): bad line: $_";
2173 ++$warnings;
2174 }
2175 } elsif ($state == 3) { # scanning for function '{' (end of prototype)
2176 if ($decl_type eq 'function') {
2177 process_state3_function($_, $file);
2178 } else {
2179 process_state3_type($_, $file);
2180 }
2181 } elsif ($state == 4) {
2182 # Documentation block
2183 if (/$doc_block/) {
2184 dump_doc_section($file, $section, xml_escape($contents));
2185 $contents = "";
2186 $function = "";
2187 %constants = ();
2188 %parameterdescs = ();
2189 %parametertypes = ();
2190 @parameterlist = ();
2191 %sections = ();
2192 @sectionlist = ();
2193 $prototype = "";
2194 if ( $1 eq "" ) {
2195 $section = $section_intro;
2196 } else {
2197 $section = $1;
2198 }
2199 }
2200 elsif (/$doc_end/)
2201 {
2202 dump_doc_section($file, $section, xml_escape($contents));
2203 $contents = "";
2204 $function = "";
2205 %constants = ();
2206 %parameterdescs = ();
2207 %parametertypes = ();
2208 @parameterlist = ();
2209 %sections = ();
2210 @sectionlist = ();
2211 $prototype = "";
2212 $state = 0;
2213 }
2214 elsif (/$doc_content/)
2215 {
2216 if ( $1 eq "" )
2217 {
2218 $contents .= $blankline;
2219 }
2220 else
2221 {
2222 $contents .= $1 . "\n";
2223 }
2224 }
2225 }
2226 }
2227 if ($initial_section_counter == $section_counter) {
2228 print STDERR "Warning(${file}): no structured comments found\n";
2229 if ($output_mode eq "xml") {
2230 # The template wants at least one RefEntry here; make one.
2231 print "<refentry>\n";
2232 print " <refnamediv>\n";
2233 print " <refname>\n";
2234 print " ${file}\n";
2235 print " </refname>\n";
2236 print " <refpurpose>\n";
2237 print " Document generation inconsistency\n";
2238 print " </refpurpose>\n";
2239 print " </refnamediv>\n";
2240 print " <refsect1>\n";
2241 print " <title>\n";
2242 print " Oops\n";
2243 print " </title>\n";
2244 print " <warning>\n";
2245 print " <para>\n";
2246 print " The template for this document tried to insert\n";
2247 print " the structured comment from the file\n";
2248 print " <filename>${file}</filename> at this point,\n";
2249 print " but none was found.\n";
2250 print " This dummy section is inserted to allow\n";
2251 print " generation to continue.\n";
2252 print " </para>\n";
2253 print " </warning>\n";
2254 print " </refsect1>\n";
2255 print "</refentry>\n";
2256 }
2257 }
2258}
2259
2260
2261$kernelversion = get_kernel_version();
2262
2263# generate a sequence of code that will splice in highlighting information
2264# using the s// operator.
2265foreach my $pattern (keys %highlights) {
2266# print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
2267 $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
2268}
2269
2270# Read the file that maps relative names to absolute names for
2271# separate source and object directories and for shadow trees.
2272if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2273 my ($relname, $absname);
2274 while(<SOURCE_MAP>) {
2275 chop();
2276 ($relname, $absname) = (split())[0..1];
2277 $relname =~ s:^/+::;
2278 $source_map{$relname} = $absname;
2279 }
2280 close(SOURCE_MAP);
2281}
2282
2283foreach (@ARGV) {
2284 chomp;
2285 process_file($_);
2286}
2287if ($verbose && $errors) {
2288 print STDERR "$errors errors\n";
2289}
2290if ($verbose && $warnings) {
2291 print STDERR "$warnings warnings\n";
2292}
2293
2294exit($errors);
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3# vim: softtabstop=4
4
5use warnings;
6use strict;
7
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 ##
13## ##
14## #define enhancements by Armin Kuster <akuster@mvista.com> ##
15## Copyright (c) 2000 MontaVista Software, Inc. ##
16#
17# Copyright (C) 2022 Tomasz Warniełło (POD)
18
19use Pod::Usage qw/pod2usage/;
20
21=head1 NAME
22
23kernel-doc - Print formatted kernel documentation to stdout
24
25=head1 SYNOPSIS
26
27 kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]] [-Wcontents-before-sections]
28 [ -man |
29 -rst [-sphinx-version VERSION] [-enable-lineno] |
30 -none
31 ]
32 [
33 -export |
34 -internal |
35 [-function NAME] ... |
36 [-nosymbol NAME] ...
37 ]
38 [-no-doc-sections]
39 [-export-file FILE] ...
40 FILE ...
41
42Run `kernel-doc -h` for details.
43
44=head1 DESCRIPTION
45
46Read C language source or header FILEs, extract embedded documentation comments,
47and print formatted documentation to standard output.
48
49The documentation comments are identified by the "/**" opening comment mark.
50
51See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
52
53=cut
54
55# more perldoc at the end of the file
56
57## init lots of data
58
59my $errors = 0;
60my $warnings = 0;
61my $anon_struct_union = 0;
62
63# match expressions used to find embedded type information
64my $type_constant = '\b``([^\`]+)``\b';
65my $type_constant2 = '\%([-_\w]+)';
66my $type_func = '(\w+)\(\)';
67my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
68my $type_param_ref = '([\!~\*]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
69my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
70my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
71my $type_env = '(\$\w+)';
72my $type_enum = '\&(enum\s*([_\w]+))';
73my $type_struct = '\&(struct\s*([_\w]+))';
74my $type_typedef = '\&(typedef\s*([_\w]+))';
75my $type_union = '\&(union\s*([_\w]+))';
76my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
77my $type_fallback = '\&([_\w]+)';
78my $type_member_func = $type_member . '\(\)';
79
80# Output conversion substitutions.
81# One for each output format
82
83# these are pretty rough
84my @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"]
96 );
97my $blankline_man = "";
98
99# rst-mode
100my @highlights_rst = (
101 [$type_constant, "``\$1``"],
102 [$type_constant2, "``\$1``"],
103
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>`"],
114
115 # in rst this can refer to any type
116 [$type_fallback, "\\:c\\:type\\:`\$1`"],
117 [$type_param_ref, "**\$1\$2**"]
118 );
119my $blankline_rst = "\n";
120
121# read arguments
122if ($#ARGV == -1) {
123 pod2usage(
124 -message => "No arguments!\n",
125 -exitval => 1,
126 -verbose => 99,
127 -sections => 'SYNOPSIS',
128 -output => \*STDERR,
129 );
130}
131
132my $kernelversion;
133my ($sphinx_major, $sphinx_minor, $sphinx_patch);
134
135my $dohighlight = "";
136
137my $verbose = 0;
138my $Werror = 0;
139my $Wreturn = 0;
140my $Wshort_desc = 0;
141my $Wcontents_before_sections = 0;
142my $output_mode = "rst";
143my $output_preformatted = 0;
144my $no_doc_sections = 0;
145my $enable_lineno = 0;
146my @highlights = @highlights_rst;
147my $blankline = $blankline_rst;
148my $modulename = "Kernel API";
149
150use constant {
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
155};
156my $output_selection = OUTPUT_ALL;
157my $show_not_found = 0; # No longer used
158
159my @export_file_list;
160
161my @build_time;
162if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
163 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
164 @build_time = gmtime($seconds);
165} else {
166 @build_time = localtime;
167}
168
169my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
170 'July', 'August', 'September', 'October',
171 'November', 'December')[$build_time[4]] .
172 " " . ($build_time[5]+1900);
173
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.
178my ($function, %function_table, %parametertypes, $declaration_purpose);
179my %nosymbol_table = ();
180my $declaration_start_line;
181my ($type, $declaration_name, $return_type);
182my ($newsection, $newcontents, $prototype, $brcount, %source_map);
183
184if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =~ '1') {
185 $verbose = 1;
186}
187
188if (defined($ENV{'KCFLAGS'})) {
189 my $kcflags = "$ENV{'KCFLAGS'}";
190
191 if ($kcflags =~ /(\s|^)-Werror(\s|$)/) {
192 $Werror = 1;
193 }
194}
195
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
199if (defined($ENV{'KDOC_WERROR'})) {
200 $Werror = "$ENV{'KDOC_WERROR'}";
201}
202# other environment variables are converted to command-line
203# arguments in cmd_checkdoc in the build system
204
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
210# into html.
211my $section_counter = 0;
212
213my $lineprefix="";
214
215# Parser states
216use constant {
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
225};
226my $state;
227my $in_doc_sect;
228my $leading_space;
229
230# Inline documentation state
231use constant {
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.
239};
240my $inline_doc_state;
241
242#declaration types: can be
243# 'function', 'struct', 'union', 'enum', 'typedef'
244my $decl_type;
245
246# Name of the kernel-doc identifier for non-DOC markups
247my $identifier;
248
249my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
250my $doc_end = '\*/';
251my $doc_com = '\s*\*\s*';
252my $doc_com_body = '\s*\* ?';
253my $doc_decl = $doc_com . '(\w+)';
254# @params and a strictly limited set of supported section names
255# Specifically:
256# Match @word:
257# @...:
258# @{section-name}:
259# while trying to not match literal block starts like "example::"
260#
261my $doc_sect = $doc_com .
262 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
263my $doc_content = $doc_com_body . '(.*)';
264my $doc_block = $doc_com . 'DOC:\s*(.*)?';
265my $doc_inline_start = '^\s*/\*\*\s*$';
266my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
267my $doc_inline_end = '^\s*\*/\s*$';
268my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
269my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
270my $export_symbol_ns = '^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,\s*\w+\)\s*;';
271my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
272my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
273
274my %parameterdescs;
275my %parameterdesc_start_lines;
276my @parameterlist;
277my %sections;
278my @sectionlist;
279my %section_start_lines;
280my $sectcheck;
281my $struct_actual;
282
283my $contents = "";
284my $new_start_line = 0;
285
286# the canonical section names. see also $doc_sect above.
287my $section_default = "Description"; # default section
288my $section_intro = "Introduction";
289my $section = $section_default;
290my $section_context = "Context";
291my $section_return = "Return";
292
293my $undescribed = "-- undescribed --";
294
295reset_state();
296
297while ($ARGV[0] =~ m/^--?(.*)/) {
298 my $cmd = $1;
299 shift @ARGV;
300 if ($cmd eq "man") {
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") {
329 $verbose = 1;
330 } elsif ($cmd eq "Werror") {
331 $Werror = 1;
332 } elsif ($cmd eq "Wreturn") {
333 $Wreturn = 1;
334 } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") {
335 $Wshort_desc = 1;
336 } elsif ($cmd eq "Wcontents-before-sections") {
337 $Wcontents_before_sections = 1;
338 } elsif ($cmd eq "Wall") {
339 $Wreturn = 1;
340 $Wshort_desc = 1;
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') {
347 $enable_lineno = 1;
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+)?/) {
353 $sphinx_major = $1;
354 if (defined($2)) {
355 $sphinx_minor = substr($2,1);
356 } else {
357 $sphinx_minor = 0;
358 }
359 if (defined($3)) {
360 $sphinx_patch = substr($3,1)
361 } else {
362 $sphinx_patch = 0;
363 }
364 } else {
365 die "Sphinx version should either major.minor or major.minor.patch format\n";
366 }
367 } else {
368 # Unknown argument
369 pod2usage(
370 -message => "Argument unknown!\n",
371 -exitval => 1,
372 -verbose => 99,
373 -sections => 'SYNOPSIS',
374 -output => \*STDERR,
375 );
376 }
377 if ($#ARGV < 0){
378 pod2usage(
379 -message => "FILE argument missing\n",
380 -exitval => 1,
381 -verbose => 99,
382 -sections => 'SYNOPSIS',
383 -output => \*STDERR,
384 );
385 }
386}
387
388# continue execution near EOF;
389
390# The C domain dialect changed on Sphinx 3. So, we need to check the
391# version in order to produce the right tags.
392sub findprog($)
393{
394 foreach(split(/:/, $ENV{PATH})) {
395 return "$_/$_[0]" if(-x "$_/$_[0]");
396 }
397}
398
399sub get_sphinx_version()
400{
401 my $ver;
402
403 my $cmd = "sphinx-build";
404 if (!findprog($cmd)) {
405 my $cmd = "sphinx-build3";
406 if (!findprog($cmd)) {
407 $sphinx_major = 1;
408 $sphinx_minor = 2;
409 $sphinx_patch = 0;
410 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
411 $sphinx_major, $sphinx_minor, $sphinx_patch;
412 return;
413 }
414 }
415
416 open IN, "$cmd --version 2>&1 |";
417 while (<IN>) {
418 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
419 $sphinx_major = $1;
420 $sphinx_minor = $2;
421 $sphinx_patch = $3;
422 last;
423 }
424 # Sphinx 1.2.x uses a different format
425 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
426 $sphinx_major = $1;
427 $sphinx_minor = $2;
428 $sphinx_patch = $3;
429 last;
430 }
431 }
432 close IN;
433}
434
435# get kernel version from env
436sub get_kernel_version() {
437 my $version = 'unknown kernel version';
438
439 if (defined($ENV{'KERNELVERSION'})) {
440 $version = $ENV{'KERNELVERSION'};
441 }
442 return $version;
443}
444
445#
446sub print_lineno {
447 my $lineno = shift;
448 if ($enable_lineno && defined($lineno)) {
449 print ".. LINENO " . $lineno . "\n";
450 }
451}
452
453sub emit_warning {
454 my $location = shift;
455 my $msg = shift;
456 print STDERR "$location: warning: $msg";
457 ++$warnings;
458}
459##
460# dumps section contents to arrays/hashes intended for that purpose.
461#
462sub dump_section {
463 my $file = shift;
464 my $name = shift;
465 my $contents = join "\n", @_;
466
467 if ($name =~ m/$type_param/) {
468 $name = $1;
469 $parameterdescs{$name} = $contents;
470 $sectcheck = $sectcheck . $name . " ";
471 $parameterdesc_start_lines{$name} = $new_start_line;
472 $new_start_line = 0;
473 } elsif ($name eq "@\.\.\.") {
474 $name = "...";
475 $parameterdescs{$name} = $contents;
476 $sectcheck = $sectcheck . $name . " ";
477 $parameterdesc_start_lines{$name} = $new_start_line;
478 $new_start_line = 0;
479 } else {
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");
484 }
485 $sections{$name} .= $contents;
486 } else {
487 $sections{$name} = $contents;
488 push @sectionlist, $name;
489 $section_start_lines{$name} = $new_start_line;
490 $new_start_line = 0;
491 }
492 }
493}
494
495##
496# dump DOC: section after checking that it should go out
497#
498sub dump_doc_section {
499 my $file = shift;
500 my $name = shift;
501 my $contents = join "\n", @_;
502
503 if ($no_doc_sections) {
504 return;
505 }
506
507 return if (defined($nosymbol_table{$name}));
508
509 if (($output_selection == OUTPUT_ALL) ||
510 (($output_selection == OUTPUT_INCLUDE) &&
511 defined($function_table{$name})))
512 {
513 dump_section($file, $name, $contents);
514 output_blockhead({'sectionlist' => \@sectionlist,
515 'sections' => \%sections,
516 'module' => $modulename,
517 'content-only' => ($output_selection != OUTPUT_ALL), });
518 }
519}
520
521##
522# output function
523#
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
530#
531
532sub output_highlight {
533 my $contents = join "\n",@_;
534 my $line;
535
536# DEBUG
537# if (!defined $contents) {
538# use Carp;
539# confess "output_highlight got called with no args?\n";
540# }
541
542# print STDERR "contents b4:$contents\n";
543 eval $dohighlight;
544 die $@ if $@;
545# print STDERR "contents af:$contents\n";
546
547 foreach $line (split "\n", $contents) {
548 if (! $output_preformatted) {
549 $line =~ s/^\s*//;
550 }
551 if ($line eq ""){
552 if (! $output_preformatted) {
553 print $lineprefix, $blankline;
554 }
555 } else {
556 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
557 print "\\&$line";
558 } else {
559 print $lineprefix, $line;
560 }
561 }
562 print "\n";
563 }
564}
565
566##
567# output function in man
568sub output_function_man(%) {
569 my %args = %{$_[0]};
570 my ($parameter, $section);
571 my $count;
572
573 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
574
575 print ".SH NAME\n";
576 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
577
578 print ".SH SYNOPSIS\n";
579 if ($args{'functiontype'} ne "") {
580 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
581 } else {
582 print ".B \"" . $args{'function'} . "\n";
583 }
584 $count = 0;
585 my $parenth = "(";
586 my $post = ",";
587 foreach my $parameter (@{$args{'parameterlist'}}) {
588 if ($count == $#{$args{'parameterlist'}}) {
589 $post = ");";
590 }
591 $type = $args{'parametertypes'}{$parameter};
592 if ($type =~ m/$function_pointer/) {
593 # pointer-to-function
594 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
595 } else {
596 $type =~ s/([^\*])$/$1 /;
597 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
598 }
599 $count++;
600 $parenth = "";
601 }
602
603 print ".SH ARGUMENTS\n";
604 foreach $parameter (@{$args{'parameterlist'}}) {
605 my $parameter_name = $parameter;
606 $parameter_name =~ s/\[.*//;
607
608 print ".IP \"" . $parameter . "\" 12\n";
609 output_highlight($args{'parameterdescs'}{$parameter_name});
610 }
611 foreach $section (@{$args{'sectionlist'}}) {
612 print ".SH \"", uc $section, "\"\n";
613 output_highlight($args{'sections'}{$section});
614 }
615}
616
617##
618# output enum in man
619sub output_enum_man(%) {
620 my %args = %{$_[0]};
621 my ($parameter, $section);
622 my $count;
623
624 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
625
626 print ".SH NAME\n";
627 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
628
629 print ".SH SYNOPSIS\n";
630 print "enum " . $args{'enum'} . " {\n";
631 $count = 0;
632 foreach my $parameter (@{$args{'parameterlist'}}) {
633 print ".br\n.BI \" $parameter\"\n";
634 if ($count == $#{$args{'parameterlist'}}) {
635 print "\n};\n";
636 last;
637 } else {
638 print ", \n.br\n";
639 }
640 $count++;
641 }
642
643 print ".SH Constants\n";
644 foreach $parameter (@{$args{'parameterlist'}}) {
645 my $parameter_name = $parameter;
646 $parameter_name =~ s/\[.*//;
647
648 print ".IP \"" . $parameter . "\" 12\n";
649 output_highlight($args{'parameterdescs'}{$parameter_name});
650 }
651 foreach $section (@{$args{'sectionlist'}}) {
652 print ".SH \"$section\"\n";
653 output_highlight($args{'sections'}{$section});
654 }
655}
656
657##
658# output struct in man
659sub output_struct_man(%) {
660 my %args = %{$_[0]};
661 my ($parameter, $section);
662
663 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
664
665 print ".SH NAME\n";
666 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
667
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";
674
675 print ".SH Members\n";
676 foreach $parameter (@{$args{'parameterlist'}}) {
677 ($parameter =~ /^#/) && next;
678
679 my $parameter_name = $parameter;
680 $parameter_name =~ s/\[.*//;
681
682 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
683 print ".IP \"" . $parameter . "\" 12\n";
684 output_highlight($args{'parameterdescs'}{$parameter_name});
685 }
686 foreach $section (@{$args{'sectionlist'}}) {
687 print ".SH \"$section\"\n";
688 output_highlight($args{'sections'}{$section});
689 }
690}
691
692##
693# output typedef in man
694sub output_typedef_man(%) {
695 my %args = %{$_[0]};
696 my ($parameter, $section);
697
698 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
699
700 print ".SH NAME\n";
701 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
702
703 foreach $section (@{$args{'sectionlist'}}) {
704 print ".SH \"$section\"\n";
705 output_highlight($args{'sections'}{$section});
706 }
707}
708
709sub output_blockhead_man(%) {
710 my %args = %{$_[0]};
711 my ($parameter, $section);
712 my $count;
713
714 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
715
716 foreach $section (@{$args{'sectionlist'}}) {
717 print ".SH \"$section\"\n";
718 output_highlight($args{'sections'}{$section});
719 }
720}
721
722##
723# output in restructured text
724#
725
726#
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.
730#
731sub output_blockhead_rst(%) {
732 my %args = %{$_[0]};
733 my ($parameter, $section);
734
735 foreach $section (@{$args{'sectionlist'}}) {
736 next if (defined($nosymbol_table{$section}));
737
738 if ($output_selection != OUTPUT_INCLUDE) {
739 print ".. _$section:\n\n";
740 print "**$section**\n\n";
741 }
742 print_lineno($section_start_lines{$section});
743 output_highlight_rst($args{'sections'}{$section});
744 print "\n";
745 }
746}
747
748#
749# Apply the RST highlights to a sub-block of text.
750#
751sub highlight_block($) {
752 # The dohighlight kludge requires the text be called $contents
753 my $contents = shift;
754 eval $dohighlight;
755 die $@ if $@;
756 return $contents;
757}
758
759#
760# Regexes used only here.
761#
762my $sphinx_literal = '^[^.].*::$';
763my $sphinx_cblock = '^\.\.\ +code-block::';
764
765sub output_highlight_rst {
766 my $input = join "\n",@_;
767 my $output = "";
768 my $line;
769 my $in_literal = 0;
770 my $litprefix;
771 my $block = "";
772
773 foreach $line (split "\n",$input) {
774 #
775 # If we're in a literal block, see if we should drop out
776 # of it. Otherwise pass the line straight through unmunged.
777 #
778 if ($in_literal) {
779 if (! ($line =~ /^\s*$/)) {
780 #
781 # If this is the first non-blank line in a literal
782 # block we need to figure out what the proper indent is.
783 #
784 if ($litprefix eq "") {
785 $line =~ /^(\s*)/;
786 $litprefix = '^' . $1;
787 $output .= $line . "\n";
788 } elsif (! ($line =~ /$litprefix/)) {
789 $in_literal = 0;
790 } else {
791 $output .= $line . "\n";
792 }
793 } else {
794 $output .= $line . "\n";
795 }
796 }
797 #
798 # Not in a literal block (or just dropped out)
799 #
800 if (! $in_literal) {
801 $block .= $line . "\n";
802 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
803 $in_literal = 1;
804 $litprefix = "";
805 $output .= highlight_block($block);
806 $block = ""
807 }
808 }
809 }
810
811 if ($block) {
812 $output .= highlight_block($block);
813 }
814 foreach $line (split "\n", $output) {
815 print $lineprefix . $line . "\n";
816 }
817}
818
819sub output_function_rst(%) {
820 my %args = %{$_[0]};
821 my ($parameter, $section);
822 my $oldprefix = $lineprefix;
823
824 my $signature = "";
825 if ($args{'functiontype'} ne "") {
826 $signature = $args{'functiontype'} . " " . $args{'function'} . " (";
827 } else {
828 $signature = $args{'function'} . " (";
829 }
830
831 my $count = 0;
832 foreach my $parameter (@{$args{'parameterlist'}}) {
833 if ($count ne 0) {
834 $signature .= ", ";
835 }
836 $count++;
837 $type = $args{'parametertypes'}{$parameter};
838
839 if ($type =~ m/$function_pointer/) {
840 # pointer-to-function
841 $signature .= $1 . $parameter . ") (" . $2 . ")";
842 } else {
843 $signature .= $type;
844 }
845 }
846
847 $signature .= ")";
848
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**: ";
854 $lineprefix = "";
855 output_highlight_rst($args{'purpose'});
856 print "\n\n**Syntax**\n\n";
857 print " ``$signature``\n\n";
858 } else {
859 print ".. c:function:: $signature\n\n";
860 }
861 } else {
862 if ($args{'typedef'} || $args{'functiontype'} eq "") {
863 print ".. c:macro:: ". $args{'function'} . "\n\n";
864
865 if ($args{'typedef'}) {
866 print_lineno($declaration_start_line);
867 print " **Typedef**: ";
868 $lineprefix = "";
869 output_highlight_rst($args{'purpose'});
870 print "\n\n**Syntax**\n\n";
871 print " ``$signature``\n\n";
872 } else {
873 print "``$signature``\n\n";
874 }
875 } else {
876 print ".. c:function:: $signature\n\n";
877 }
878 }
879
880 if (!$args{'typedef'}) {
881 print_lineno($declaration_start_line);
882 $lineprefix = " ";
883 output_highlight_rst($args{'purpose'});
884 print "\n";
885 }
886
887 #
888 # Put our descriptive text into a container (thus an HTML <div>) to help
889 # set the function prototypes apart.
890 #
891 print ".. container:: kernelindent\n\n";
892 $lineprefix = " ";
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};
898
899 if ($type ne "") {
900 print $lineprefix . "``$type``\n";
901 } else {
902 print $lineprefix . "``$parameter``\n";
903 }
904
905 print_lineno($parameterdesc_start_lines{$parameter_name});
906
907 $lineprefix = " ";
908 if (defined($args{'parameterdescs'}{$parameter_name}) &&
909 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
910 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
911 } else {
912 print $lineprefix . "*undescribed*\n";
913 }
914 $lineprefix = " ";
915 print "\n";
916 }
917
918 output_section_rst(@_);
919 $lineprefix = $oldprefix;
920}
921
922sub output_section_rst(%) {
923 my %args = %{$_[0]};
924 my $section;
925 my $oldprefix = $lineprefix;
926
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});
931 print "\n";
932 }
933 print "\n";
934}
935
936sub output_enum_rst(%) {
937 my %args = %{$_[0]};
938 my ($parameter);
939 my $oldprefix = $lineprefix;
940 my $count;
941 my $outer;
942
943 if ($sphinx_major < 3) {
944 my $name = "enum " . $args{'enum'};
945 print "\n\n.. c:type:: " . $name . "\n\n";
946 } else {
947 my $name = $args{'enum'};
948 print "\n\n.. c:enum:: " . $name . "\n\n";
949 }
950 print_lineno($declaration_start_line);
951 $lineprefix = " ";
952 output_highlight_rst($args{'purpose'});
953 print "\n";
954
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";
961
962 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
963 output_highlight_rst($args{'parameterdescs'}{$parameter});
964 } else {
965 print $lineprefix . "*undescribed*\n";
966 }
967 print "\n";
968 }
969 print "\n";
970 $lineprefix = $oldprefix;
971 output_section_rst(@_);
972}
973
974sub output_typedef_rst(%) {
975 my %args = %{$_[0]};
976 my ($parameter);
977 my $oldprefix = $lineprefix;
978 my $name;
979
980 if ($sphinx_major < 3) {
981 $name = "typedef " . $args{'typedef'};
982 } else {
983 $name = $args{'typedef'};
984 }
985 print "\n\n.. c:type:: " . $name . "\n\n";
986 print_lineno($declaration_start_line);
987 $lineprefix = " ";
988 output_highlight_rst($args{'purpose'});
989 print "\n";
990
991 $lineprefix = $oldprefix;
992 output_section_rst(@_);
993}
994
995sub output_struct_rst(%) {
996 my %args = %{$_[0]};
997 my ($parameter);
998 my $oldprefix = $lineprefix;
999
1000 if ($sphinx_major < 3) {
1001 my $name = $args{'type'} . " " . $args{'struct'};
1002 print "\n\n.. c:type:: " . $name . "\n\n";
1003 } else {
1004 my $name = $args{'struct'};
1005 if ($args{'type'} eq 'union') {
1006 print "\n\n.. c:union:: " . $name . "\n\n";
1007 } else {
1008 print "\n\n.. c:struct:: " . $name . "\n\n";
1009 }
1010 }
1011 print_lineno($declaration_start_line);
1012 $lineprefix = " ";
1013 output_highlight_rst($args{'purpose'});
1014 print "\n";
1015
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";
1022
1023 $lineprefix = " ";
1024 print $lineprefix . "**Members**\n\n";
1025 foreach $parameter (@{$args{'parameterlist'}}) {
1026 ($parameter =~ /^#/) && next;
1027
1028 my $parameter_name = $parameter;
1029 $parameter_name =~ s/\[.*//;
1030
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";
1035 $lineprefix = " ";
1036 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1037 $lineprefix = " ";
1038 print "\n";
1039 }
1040 print "\n";
1041
1042 $lineprefix = $oldprefix;
1043 output_section_rst(@_);
1044}
1045
1046## none mode output functions
1047
1048sub output_function_none(%) {
1049}
1050
1051sub output_enum_none(%) {
1052}
1053
1054sub output_typedef_none(%) {
1055}
1056
1057sub output_struct_none(%) {
1058}
1059
1060sub output_blockhead_none(%) {
1061}
1062
1063##
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
1067sub output_declaration {
1068 no strict 'refs';
1069 my $name = shift;
1070 my $functype = shift;
1071 my $func = "output_${functype}_$output_mode";
1072
1073 return if (defined($nosymbol_table{$name}));
1074
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}))))
1081 {
1082 &$func(@_);
1083 $section_counter++;
1084 }
1085}
1086
1087##
1088# generic output function - calls the right one based on current output mode.
1089sub output_blockhead {
1090 no strict 'refs';
1091 my $func = "output_blockhead_" . $output_mode;
1092 &$func(@_);
1093 $section_counter++;
1094}
1095
1096##
1097# takes a declaration (struct, union, enum, typedef) and
1098# invokes the right handler. NOT called for functions.
1099sub dump_declaration($$) {
1100 no strict 'refs';
1101 my ($prototype, $file) = @_;
1102 my $func = "dump_" . $decl_type;
1103 &$func(@_);
1104}
1105
1106sub dump_union($$) {
1107 dump_struct(@_);
1108}
1109
1110sub dump_struct($$) {
1111 my $x = shift;
1112 my $file = shift;
1113 my $decl_type;
1114 my $members;
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)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1120
1121 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1122 $decl_type = $1;
1123 $declaration_name = $2;
1124 $members = $3;
1125 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1126 $decl_type = $1;
1127 $declaration_name = $3;
1128 $members = $2;
1129 }
1130
1131 if ($members) {
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");
1134 return;
1135 }
1136
1137 # ignore members marked private:
1138 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1139 $members =~ s/\/\*\s*private:.*//gosi;
1140 # strip comments:
1141 $members =~ s/\/\*.*?\*\///gos;
1142 # strip attributes
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|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1155 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1156 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
1157
1158 my $args = qr{([^,)]+)};
1159 # replace DECLARE_BITMAP
1160 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1161 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos;
1162 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1163 # replace DECLARE_HASHTABLE
1164 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1165 # replace DECLARE_KFIFO
1166 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1167 # replace DECLARE_KFIFO_PTR
1168 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1169 # replace DECLARE_FLEX_ARRAY
1170 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
1171 #replace DEFINE_DMA_UNMAP_ADDR
1172 $members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos;
1173 #replace DEFINE_DMA_UNMAP_LEN
1174 $members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos;
1175 my $declaration = $members;
1176
1177 # Split nested struct/union elements as newer ones
1178 while ($members =~ m/$struct_members/) {
1179 my $newmember;
1180 my $maintype = $1;
1181 my $ids = $4;
1182 my $content = $3;
1183 foreach my $id(split /,/, $ids) {
1184 $newmember .= "$maintype $id; ";
1185
1186 $id =~ s/[:\[].*//;
1187 $id =~ s/^\s*\**(\S+)\s*/$1/;
1188 foreach my $arg (split /;/, $content) {
1189 next if ($arg =~ m/^\s*$/);
1190 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1191 # pointer-to-function
1192 my $type = $1;
1193 my $name = $2;
1194 my $extra = $3;
1195 next if (!$name);
1196 if ($id =~ m/^\s*$/) {
1197 # anonymous struct/union
1198 $newmember .= "$type$name$extra; ";
1199 } else {
1200 $newmember .= "$type$id.$name$extra; ";
1201 }
1202 } else {
1203 my $type;
1204 my $names;
1205 $arg =~ s/^\s+//;
1206 $arg =~ s/\s+$//;
1207 # Handle bitmaps
1208 $arg =~ s/:\s*\d+\s*//g;
1209 # Handle arrays
1210 $arg =~ s/\[.*\]//g;
1211 # The type may have multiple words,
1212 # and multiple IDs can be defined, like:
1213 # const struct foo, *bar, foobar
1214 # So, we remove spaces when parsing the
1215 # names, in order to match just names
1216 # and commas for the names
1217 $arg =~ s/\s*,\s*/,/g;
1218 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1219 $type = $1;
1220 $names = $2;
1221 } else {
1222 $newmember .= "$arg; ";
1223 next;
1224 }
1225 foreach my $name (split /,/, $names) {
1226 $name =~ s/^\s*\**(\S+)\s*/$1/;
1227 next if (($name =~ m/^\s*$/));
1228 if ($id =~ m/^\s*$/) {
1229 # anonymous struct/union
1230 $newmember .= "$type $name; ";
1231 } else {
1232 $newmember .= "$type $id.$name; ";
1233 }
1234 }
1235 }
1236 }
1237 }
1238 $members =~ s/$struct_members/$newmember/;
1239 }
1240
1241 # Ignore other nested elements, like enums
1242 $members =~ s/(\{[^\{\}]*\})//g;
1243
1244 create_parameterlist($members, ';', $file, $declaration_name);
1245 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1246
1247 # Adjust declaration for better display
1248 $declaration =~ s/([\{;])/$1\n/g;
1249 $declaration =~ s/\}\s+;/};/g;
1250 # Better handle inlined enums
1251 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1252
1253 my @def_args = split /\n/, $declaration;
1254 my $level = 1;
1255 $declaration = "";
1256 foreach my $clause (@def_args) {
1257 $clause =~ s/^\s+//;
1258 $clause =~ s/\s+$//;
1259 $clause =~ s/\s+/ /;
1260 next if (!$clause);
1261 $level-- if ($clause =~ m/(\})/ && $level > 1);
1262 if (!($clause =~ m/^\s*#/)) {
1263 $declaration .= "\t" x $level;
1264 }
1265 $declaration .= "\t" . $clause . "\n";
1266 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1267 }
1268 output_declaration($declaration_name,
1269 'struct',
1270 {'struct' => $declaration_name,
1271 'module' => $modulename,
1272 'definition' => $declaration,
1273 'parameterlist' => \@parameterlist,
1274 'parameterdescs' => \%parameterdescs,
1275 'parametertypes' => \%parametertypes,
1276 'sectionlist' => \@sectionlist,
1277 'sections' => \%sections,
1278 'purpose' => $declaration_purpose,
1279 'type' => $decl_type
1280 });
1281 } else {
1282 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1283 ++$errors;
1284 }
1285}
1286
1287
1288sub show_warnings($$) {
1289 my $functype = shift;
1290 my $name = shift;
1291
1292 return 0 if (defined($nosymbol_table{$name}));
1293
1294 return 1 if ($output_selection == OUTPUT_ALL);
1295
1296 if ($output_selection == OUTPUT_EXPORTED) {
1297 if (defined($function_table{$name})) {
1298 return 1;
1299 } else {
1300 return 0;
1301 }
1302 }
1303 if ($output_selection == OUTPUT_INTERNAL) {
1304 if (!($functype eq "function" && defined($function_table{$name}))) {
1305 return 1;
1306 } else {
1307 return 0;
1308 }
1309 }
1310 if ($output_selection == OUTPUT_INCLUDE) {
1311 if (defined($function_table{$name})) {
1312 return 1;
1313 } else {
1314 return 0;
1315 }
1316 }
1317 die("Please add the new output type at show_warnings()");
1318}
1319
1320sub dump_enum($$) {
1321 my $x = shift;
1322 my $file = shift;
1323 my $members;
1324
1325 # ignore members marked private:
1326 $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1327 $x =~ s/\/\*\s*private:.*}/}/gosi;
1328
1329 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1330 # strip #define macros inside enums
1331 $x =~ s@#\s*((define|ifdef|if)\s+|endif)[^;]*;@@gos;
1332
1333 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1334 $declaration_name = $2;
1335 $members = $1;
1336 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1337 $declaration_name = $1;
1338 $members = $2;
1339 }
1340
1341 if ($members) {
1342 if ($identifier ne $declaration_name) {
1343 if ($identifier eq "") {
1344 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n");
1345 } else {
1346 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n");
1347 }
1348 return;
1349 }
1350 $declaration_name = "(anonymous)" if ($declaration_name eq "");
1351
1352 my %_members;
1353
1354 $members =~ s/\s+$//;
1355 $members =~ s/\([^;]*?[\)]//g;
1356
1357 foreach my $arg (split ',', $members) {
1358 $arg =~ s/^\s*(\w+).*/$1/;
1359 push @parameterlist, $arg;
1360 if (!$parameterdescs{$arg}) {
1361 $parameterdescs{$arg} = $undescribed;
1362 if (show_warnings("enum", $declaration_name)) {
1363 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n");
1364 }
1365 }
1366 $_members{$arg} = 1;
1367 }
1368
1369 while (my ($k, $v) = each %parameterdescs) {
1370 if (!exists($_members{$k})) {
1371 if (show_warnings("enum", $declaration_name)) {
1372 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n");
1373 }
1374 }
1375 }
1376
1377 output_declaration($declaration_name,
1378 'enum',
1379 {'enum' => $declaration_name,
1380 'module' => $modulename,
1381 'parameterlist' => \@parameterlist,
1382 'parameterdescs' => \%parameterdescs,
1383 'sectionlist' => \@sectionlist,
1384 'sections' => \%sections,
1385 'purpose' => $declaration_purpose
1386 });
1387 } else {
1388 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1389 ++$errors;
1390 }
1391}
1392
1393my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1394my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1395my $typedef_args = qr { \s*\((.*)\); }x;
1396
1397my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1398my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1399
1400sub dump_typedef($$) {
1401 my $x = shift;
1402 my $file = shift;
1403
1404 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1405
1406 # Parse function typedef prototypes
1407 if ($x =~ $typedef1 || $x =~ $typedef2) {
1408 $return_type = $1;
1409 $declaration_name = $2;
1410 my $args = $3;
1411 $return_type =~ s/^\s+//;
1412
1413 if ($identifier ne $declaration_name) {
1414 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1415 return;
1416 }
1417
1418 create_parameterlist($args, ',', $file, $declaration_name);
1419
1420 output_declaration($declaration_name,
1421 'function',
1422 {'function' => $declaration_name,
1423 'typedef' => 1,
1424 'module' => $modulename,
1425 'functiontype' => $return_type,
1426 'parameterlist' => \@parameterlist,
1427 'parameterdescs' => \%parameterdescs,
1428 'parametertypes' => \%parametertypes,
1429 'sectionlist' => \@sectionlist,
1430 'sections' => \%sections,
1431 'purpose' => $declaration_purpose
1432 });
1433 return;
1434 }
1435
1436 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1437 $x =~ s/\(*.\)\s*;$/;/;
1438 $x =~ s/\[*.\]\s*;$/;/;
1439 }
1440
1441 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1442 $declaration_name = $1;
1443
1444 if ($identifier ne $declaration_name) {
1445 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1446 return;
1447 }
1448
1449 output_declaration($declaration_name,
1450 'typedef',
1451 {'typedef' => $declaration_name,
1452 'module' => $modulename,
1453 'sectionlist' => \@sectionlist,
1454 'sections' => \%sections,
1455 'purpose' => $declaration_purpose
1456 });
1457 } else {
1458 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1459 ++$errors;
1460 }
1461}
1462
1463sub save_struct_actual($) {
1464 my $actual = shift;
1465
1466 # strip all spaces from the actual param so that it looks like one string item
1467 $actual =~ s/\s*//g;
1468 $struct_actual = $struct_actual . $actual . " ";
1469}
1470
1471sub create_parameterlist($$$$) {
1472 my $args = shift;
1473 my $splitter = shift;
1474 my $file = shift;
1475 my $declaration_name = shift;
1476 my $type;
1477 my $param;
1478
1479 # temporarily replace commas inside function pointer definition
1480 my $arg_expr = qr{\([^\),]+};
1481 while ($args =~ /$arg_expr,/) {
1482 $args =~ s/($arg_expr),/$1#/g;
1483 }
1484
1485 foreach my $arg (split($splitter, $args)) {
1486 # strip comments
1487 $arg =~ s/\/\*.*\*\///;
1488 # ignore argument attributes
1489 $arg =~ s/\sPOS0?\s/ /;
1490 # strip leading/trailing spaces
1491 $arg =~ s/^\s*//;
1492 $arg =~ s/\s*$//;
1493 $arg =~ s/\s+/ /;
1494
1495 if ($arg =~ /^#/) {
1496 # Treat preprocessor directive as a typeless variable just to fill
1497 # corresponding data structures "correctly". Catch it later in
1498 # output_* subs.
1499 push_parameter($arg, "", "", $file);
1500 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1501 # pointer-to-function
1502 $arg =~ tr/#/,/;
1503 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1504 $param = $1;
1505 $type = $arg;
1506 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1507 save_struct_actual($param);
1508 push_parameter($param, $type, $arg, $file, $declaration_name);
1509 } elsif ($arg =~ m/\(.+\)\s*\[/) {
1510 # array-of-pointers
1511 $arg =~ tr/#/,/;
1512 $arg =~ m/[^\(]+\(\s*\*\s*([\w\[\]\.]*?)\s*(\s*\[\s*[\w]+\s*\]\s*)*\)/;
1513 $param = $1;
1514 $type = $arg;
1515 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1516 save_struct_actual($param);
1517 push_parameter($param, $type, $arg, $file, $declaration_name);
1518 } elsif ($arg) {
1519 $arg =~ s/\s*:\s*/:/g;
1520 $arg =~ s/\s*\[/\[/g;
1521
1522 my @args = split('\s*,\s*', $arg);
1523 if ($args[0] =~ m/\*/) {
1524 $args[0] =~ s/(\*+)\s*/ $1/;
1525 }
1526
1527 my @first_arg;
1528 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1529 shift @args;
1530 push(@first_arg, split('\s+', $1));
1531 push(@first_arg, $2);
1532 } else {
1533 @first_arg = split('\s+', shift @args);
1534 }
1535
1536 unshift(@args, pop @first_arg);
1537 $type = join " ", @first_arg;
1538
1539 foreach $param (@args) {
1540 if ($param =~ m/^(\*+)\s*(.*)/) {
1541 save_struct_actual($2);
1542
1543 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1544 } elsif ($param =~ m/(.*?):(\w+)/) {
1545 if ($type ne "") { # skip unnamed bit-fields
1546 save_struct_actual($1);
1547 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1548 }
1549 } else {
1550 save_struct_actual($param);
1551 push_parameter($param, $type, $arg, $file, $declaration_name);
1552 }
1553 }
1554 }
1555 }
1556}
1557
1558sub push_parameter($$$$$) {
1559 my $param = shift;
1560 my $type = shift;
1561 my $org_arg = shift;
1562 my $file = shift;
1563 my $declaration_name = shift;
1564
1565 if (($anon_struct_union == 1) && ($type eq "") &&
1566 ($param eq "}")) {
1567 return; # ignore the ending }; from anon. struct/union
1568 }
1569
1570 $anon_struct_union = 0;
1571 $param =~ s/[\[\)].*//;
1572
1573 if ($type eq "" && $param =~ /\.\.\.$/)
1574 {
1575 if (!$param =~ /\w\.\.\.$/) {
1576 # handles unnamed variable parameters
1577 $param = "...";
1578 } elsif ($param =~ /\w\.\.\.$/) {
1579 # for named variable parameters of the form `x...`, remove the dots
1580 $param =~ s/\.\.\.$//;
1581 }
1582 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1583 $parameterdescs{$param} = "variable arguments";
1584 }
1585 }
1586 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1587 {
1588 $param="void";
1589 $parameterdescs{void} = "no arguments";
1590 }
1591 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1592 # handle unnamed (anonymous) union or struct:
1593 {
1594 $type = $param;
1595 $param = "{unnamed_" . $param . "}";
1596 $parameterdescs{$param} = "anonymous\n";
1597 $anon_struct_union = 1;
1598 }
1599 elsif ($param =~ "__cacheline_group" )
1600 # handle cache group enforcing variables: they do not need be described in header files
1601 {
1602 return; # ignore __cacheline_group_begin and __cacheline_group_end
1603 }
1604
1605 # warn if parameter has no description
1606 # (but ignore ones starting with # as these are not parameters
1607 # but inline preprocessor statements);
1608 # Note: It will also ignore void params and unnamed structs/unions
1609 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1610 $parameterdescs{$param} = $undescribed;
1611
1612 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1613 emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
1614 }
1615 }
1616
1617 # strip spaces from $param so that it is one continuous string
1618 # on @parameterlist;
1619 # this fixes a problem where check_sections() cannot find
1620 # a parameter like "addr[6 + 2]" because it actually appears
1621 # as "addr[6", "+", "2]" on the parameter list;
1622 # but it's better to maintain the param string unchanged for output,
1623 # so just weaken the string compare in check_sections() to ignore
1624 # "[blah" in a parameter string;
1625 ###$param =~ s/\s*//g;
1626 push @parameterlist, $param;
1627 $org_arg =~ s/\s\s+/ /g;
1628 $parametertypes{$param} = $org_arg;
1629}
1630
1631sub check_sections($$$$$) {
1632 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1633 my @sects = split ' ', $sectcheck;
1634 my @prms = split ' ', $prmscheck;
1635 my $err;
1636 my ($px, $sx);
1637 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1638
1639 foreach $sx (0 .. $#sects) {
1640 $err = 1;
1641 foreach $px (0 .. $#prms) {
1642 $prm_clean = $prms[$px];
1643 $prm_clean =~ s/\[.*\]//;
1644 $prm_clean =~ s/$attribute//i;
1645 # ignore array size in a parameter string;
1646 # however, the original param string may contain
1647 # spaces, e.g.: addr[6 + 2]
1648 # and this appears in @prms as "addr[6" since the
1649 # parameter list is split at spaces;
1650 # hence just ignore "[..." for the sections check;
1651 $prm_clean =~ s/\[.*//;
1652
1653 ##$prm_clean =~ s/^\**//;
1654 if ($prm_clean eq $sects[$sx]) {
1655 $err = 0;
1656 last;
1657 }
1658 }
1659 if ($err) {
1660 if ($decl_type eq "function") {
1661 emit_warning("${file}:$.",
1662 "Excess function parameter " .
1663 "'$sects[$sx]' " .
1664 "description in '$decl_name'\n");
1665 } elsif (($decl_type eq "struct") or
1666 ($decl_type eq "union")) {
1667 emit_warning("${file}:$.",
1668 "Excess $decl_type member " .
1669 "'$sects[$sx]' " .
1670 "description in '$decl_name'\n");
1671 }
1672 }
1673 }
1674}
1675
1676##
1677# Checks the section describing the return value of a function.
1678sub check_return_section {
1679 my $file = shift;
1680 my $declaration_name = shift;
1681 my $return_type = shift;
1682
1683 # Ignore an empty return type (It's a macro)
1684 # Ignore functions with a "void" return type. (But don't ignore "void *")
1685 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1686 return;
1687 }
1688
1689 if (!defined($sections{$section_return}) ||
1690 $sections{$section_return} eq "")
1691 {
1692 emit_warning("${file}:$.",
1693 "No description found for return value of " .
1694 "'$declaration_name'\n");
1695 }
1696}
1697
1698##
1699# takes a function prototype and the name of the current file being
1700# processed and spits out all the details stored in the global
1701# arrays/hashes.
1702sub dump_function($$) {
1703 my $prototype = shift;
1704 my $file = shift;
1705 my $noret = 0;
1706
1707 print_lineno($new_start_line);
1708
1709 $prototype =~ s/^static +//;
1710 $prototype =~ s/^extern +//;
1711 $prototype =~ s/^asmlinkage +//;
1712 $prototype =~ s/^inline +//;
1713 $prototype =~ s/^__inline__ +//;
1714 $prototype =~ s/^__inline +//;
1715 $prototype =~ s/^__always_inline +//;
1716 $prototype =~ s/^noinline +//;
1717 $prototype =~ s/^__FORTIFY_INLINE +//;
1718 $prototype =~ s/__init +//;
1719 $prototype =~ s/__init_or_module +//;
1720 $prototype =~ s/__deprecated +//;
1721 $prototype =~ s/__flatten +//;
1722 $prototype =~ s/__meminit +//;
1723 $prototype =~ s/__must_check +//;
1724 $prototype =~ s/__weak +//;
1725 $prototype =~ s/__sched +//;
1726 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1727 $prototype =~ s/__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//;
1728 $prototype =~ s/__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +//;
1729 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1730 $prototype =~ s/__attribute_const__ +//;
1731 $prototype =~ s/__attribute__\s*\(\(
1732 (?:
1733 [\w\s]++ # attribute name
1734 (?:\([^)]*+\))? # attribute arguments
1735 \s*+,? # optional comma at the end
1736 )+
1737 \)\)\s+//x;
1738
1739 # Yes, this truly is vile. We are looking for:
1740 # 1. Return type (may be nothing if we're looking at a macro)
1741 # 2. Function name
1742 # 3. Function parameters.
1743 #
1744 # All the while we have to watch out for function pointer parameters
1745 # (which IIRC is what the two sections are for), C types (these
1746 # regexps don't even start to express all the possibilities), and
1747 # so on.
1748 #
1749 # If you mess with these regexps, it's a good idea to check that
1750 # the following functions' documentation still comes out right:
1751 # - parport_register_device (function pointer parameters)
1752 # - atomic_set (macro)
1753 # - pci_match_device, __copy_to_user (long return type)
1754 my $name = qr{[a-zA-Z0-9_~:]+};
1755 my $prototype_end1 = qr{[^\(]*};
1756 my $prototype_end2 = qr{[^\{]*};
1757 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1758 my $type1 = qr{[\w\s]+};
1759 my $type2 = qr{$type1\*+};
1760
1761 if ($define && $prototype =~ m/^()($name)\s+/) {
1762 # This is an object-like macro, it has no return type and no parameter
1763 # list.
1764 # Function-like macros are not allowed to have spaces between
1765 # declaration_name and opening parenthesis (notice the \s+).
1766 $return_type = $1;
1767 $declaration_name = $2;
1768 $noret = 1;
1769 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1770 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1771 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1772 $return_type = $1;
1773 $declaration_name = $2;
1774 my $args = $3;
1775
1776 create_parameterlist($args, ',', $file, $declaration_name);
1777 } else {
1778 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n");
1779 return;
1780 }
1781
1782 if ($identifier ne $declaration_name) {
1783 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n");
1784 return;
1785 }
1786
1787 my $prms = join " ", @parameterlist;
1788 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1789
1790 # This check emits a lot of warnings at the moment, because many
1791 # functions don't have a 'Return' doc section. So until the number
1792 # of warnings goes sufficiently down, the check is only performed in
1793 # -Wreturn mode.
1794 # TODO: always perform the check.
1795 if ($Wreturn && !$noret) {
1796 check_return_section($file, $declaration_name, $return_type);
1797 }
1798
1799 # The function parser can be called with a typedef parameter.
1800 # Handle it.
1801 if ($return_type =~ /typedef/) {
1802 output_declaration($declaration_name,
1803 'function',
1804 {'function' => $declaration_name,
1805 'typedef' => 1,
1806 'module' => $modulename,
1807 'functiontype' => $return_type,
1808 'parameterlist' => \@parameterlist,
1809 'parameterdescs' => \%parameterdescs,
1810 'parametertypes' => \%parametertypes,
1811 'sectionlist' => \@sectionlist,
1812 'sections' => \%sections,
1813 'purpose' => $declaration_purpose
1814 });
1815 } else {
1816 output_declaration($declaration_name,
1817 'function',
1818 {'function' => $declaration_name,
1819 'module' => $modulename,
1820 'functiontype' => $return_type,
1821 'parameterlist' => \@parameterlist,
1822 'parameterdescs' => \%parameterdescs,
1823 'parametertypes' => \%parametertypes,
1824 'sectionlist' => \@sectionlist,
1825 'sections' => \%sections,
1826 'purpose' => $declaration_purpose
1827 });
1828 }
1829}
1830
1831sub reset_state {
1832 $function = "";
1833 %parameterdescs = ();
1834 %parametertypes = ();
1835 @parameterlist = ();
1836 %sections = ();
1837 @sectionlist = ();
1838 $sectcheck = "";
1839 $struct_actual = "";
1840 $prototype = "";
1841
1842 $state = STATE_NORMAL;
1843 $inline_doc_state = STATE_INLINE_NA;
1844}
1845
1846sub tracepoint_munge($) {
1847 my $file = shift;
1848 my $tracepointname = 0;
1849 my $tracepointargs = 0;
1850
1851 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1852 $tracepointname = $1;
1853 }
1854 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1855 $tracepointname = $1;
1856 }
1857 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1858 $tracepointname = $2;
1859 }
1860 $tracepointname =~ s/^\s+//; #strip leading whitespace
1861 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1862 $tracepointargs = $1;
1863 }
1864 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1865 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n".
1866 "$prototype\n");
1867 } else {
1868 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1869 $identifier = "trace_$identifier";
1870 }
1871}
1872
1873sub syscall_munge() {
1874 my $void = 0;
1875
1876 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1877## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1878 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1879 $void = 1;
1880## $prototype = "long sys_$1(void)";
1881 }
1882
1883 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1884 if ($prototype =~ m/long (sys_.*?),/) {
1885 $prototype =~ s/,/\(/;
1886 } elsif ($void) {
1887 $prototype =~ s/\)/\(void\)/;
1888 }
1889
1890 # now delete all of the odd-number commas in $prototype
1891 # so that arg types & arg names don't have a comma between them
1892 my $count = 0;
1893 my $len = length($prototype);
1894 if ($void) {
1895 $len = 0; # skip the for-loop
1896 }
1897 for (my $ix = 0; $ix < $len; $ix++) {
1898 if (substr($prototype, $ix, 1) eq ',') {
1899 $count++;
1900 if ($count % 2 == 1) {
1901 substr($prototype, $ix, 1) = ' ';
1902 }
1903 }
1904 }
1905}
1906
1907sub process_proto_function($$) {
1908 my $x = shift;
1909 my $file = shift;
1910
1911 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1912
1913 if ($x =~ /^#/ && $x !~ /^#\s*define/) {
1914 # do nothing
1915 } elsif ($x =~ /([^\{]*)/) {
1916 $prototype .= $1;
1917 }
1918
1919 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1920 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1921 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1922 $prototype =~ s@^\s+@@gos; # strip leading spaces
1923
1924 # Handle prototypes for function pointers like:
1925 # int (*pcs_config)(struct foo)
1926 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1927
1928 if ($prototype =~ /SYSCALL_DEFINE/) {
1929 syscall_munge();
1930 }
1931 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1932 $prototype =~ /DEFINE_SINGLE_EVENT/)
1933 {
1934 tracepoint_munge($file);
1935 }
1936 dump_function($prototype, $file);
1937 reset_state();
1938 }
1939}
1940
1941sub process_proto_type($$) {
1942 my $x = shift;
1943 my $file = shift;
1944
1945 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1946 $x =~ s@^\s+@@gos; # strip leading spaces
1947 $x =~ s@\s+$@@gos; # strip trailing spaces
1948 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1949
1950 if ($x =~ /^#/) {
1951 # To distinguish preprocessor directive from regular declaration later.
1952 $x .= ";";
1953 }
1954
1955 while (1) {
1956 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1957 if( length $prototype ) {
1958 $prototype .= " "
1959 }
1960 $prototype .= $1 . $2;
1961 ($2 eq '{') && $brcount++;
1962 ($2 eq '}') && $brcount--;
1963 if (($2 eq ';') && ($brcount == 0)) {
1964 dump_declaration($prototype, $file);
1965 reset_state();
1966 last;
1967 }
1968 $x = $3;
1969 } else {
1970 $prototype .= $x;
1971 last;
1972 }
1973 }
1974}
1975
1976
1977sub map_filename($) {
1978 my $file;
1979 my ($orig_file) = @_;
1980
1981 if (defined($ENV{'SRCTREE'})) {
1982 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1983 } else {
1984 $file = $orig_file;
1985 }
1986
1987 if (defined($source_map{$file})) {
1988 $file = $source_map{$file};
1989 }
1990
1991 return $file;
1992}
1993
1994sub process_export_file($) {
1995 my ($orig_file) = @_;
1996 my $file = map_filename($orig_file);
1997
1998 if (!open(IN,"<$file")) {
1999 print STDERR "Error: Cannot open file $file\n";
2000 ++$errors;
2001 return;
2002 }
2003
2004 while (<IN>) {
2005 if (/$export_symbol/) {
2006 next if (defined($nosymbol_table{$2}));
2007 $function_table{$2} = 1;
2008 }
2009 if (/$export_symbol_ns/) {
2010 next if (defined($nosymbol_table{$2}));
2011 $function_table{$2} = 1;
2012 }
2013 }
2014
2015 close(IN);
2016}
2017
2018#
2019# Parsers for the various processing states.
2020#
2021# STATE_NORMAL: looking for the /** to begin everything.
2022#
2023sub process_normal() {
2024 if (/$doc_start/o) {
2025 $state = STATE_NAME; # next line is always the function name
2026 $in_doc_sect = 0;
2027 $declaration_start_line = $. + 1;
2028 }
2029}
2030
2031#
2032# STATE_NAME: Looking for the "name - description" line
2033#
2034sub process_name($$) {
2035 my $file = shift;
2036 my $descr;
2037
2038 if (/$doc_block/o) {
2039 $state = STATE_DOCBLOCK;
2040 $contents = "";
2041 $new_start_line = $.;
2042
2043 if ( $1 eq "" ) {
2044 $section = $section_intro;
2045 } else {
2046 $section = $1;
2047 }
2048 } elsif (/$doc_decl/o) {
2049 $identifier = $1;
2050 my $is_kernel_comment = 0;
2051 my $decl_start = qr{$doc_com};
2052 # test for pointer declaration type, foo * bar() - desc
2053 my $fn_type = qr{\w+\s*\*\s*};
2054 my $parenthesis = qr{\(\w*\)};
2055 my $decl_end = qr{[-:].*};
2056 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2057 $identifier = $1;
2058 }
2059 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2060 $decl_type = $1;
2061 $identifier = $2;
2062 $is_kernel_comment = 1;
2063 }
2064 # Look for foo() or static void foo() - description; or misspelt
2065 # identifier
2066 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2067 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2068 $identifier = $1;
2069 $decl_type = 'function';
2070 $identifier =~ s/^define\s+//;
2071 $is_kernel_comment = 1;
2072 }
2073 $identifier =~ s/\s+$//;
2074
2075 $state = STATE_BODY;
2076 # if there's no @param blocks need to set up default section
2077 # here
2078 $contents = "";
2079 $section = $section_default;
2080 $new_start_line = $. + 1;
2081 if (/[-:](.*)/) {
2082 # strip leading/trailing/multiple spaces
2083 $descr= $1;
2084 $descr =~ s/^\s*//;
2085 $descr =~ s/\s*$//;
2086 $descr =~ s/\s+/ /g;
2087 $declaration_purpose = $descr;
2088 $state = STATE_BODY_MAYBE;
2089 } else {
2090 $declaration_purpose = "";
2091 }
2092
2093 if (!$is_kernel_comment) {
2094 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_");
2095 $state = STATE_NORMAL;
2096 }
2097
2098 if (($declaration_purpose eq "") && $Wshort_desc) {
2099 emit_warning("${file}:$.", "missing initial short description on line:\n$_");
2100 }
2101
2102 if ($identifier eq "" && $decl_type ne "enum") {
2103 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_");
2104 $state = STATE_NORMAL;
2105 }
2106
2107 if ($verbose) {
2108 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2109 }
2110 } else {
2111 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n");
2112 $state = STATE_NORMAL;
2113 }
2114}
2115
2116
2117#
2118# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2119#
2120sub process_body($$) {
2121 my $file = shift;
2122
2123 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2124 dump_section($file, $section, $contents);
2125 $section = $section_default;
2126 $new_start_line = $.;
2127 $contents = "";
2128 }
2129
2130 if (/$doc_sect/i) { # case insensitive for supported section names
2131 $in_doc_sect = 1;
2132 $newsection = $1;
2133 $newcontents = $2;
2134
2135 # map the supported section names to the canonical names
2136 if ($newsection =~ m/^description$/i) {
2137 $newsection = $section_default;
2138 } elsif ($newsection =~ m/^context$/i) {
2139 $newsection = $section_context;
2140 } elsif ($newsection =~ m/^returns?$/i) {
2141 $newsection = $section_return;
2142 } elsif ($newsection =~ m/^\@return$/) {
2143 # special: @return is a section, not a param description
2144 $newsection = $section_return;
2145 }
2146
2147 if (($contents ne "") && ($contents ne "\n")) {
2148 if (!$in_doc_sect && $Wcontents_before_sections) {
2149 emit_warning("${file}:$.", "contents before sections\n");
2150 }
2151 dump_section($file, $section, $contents);
2152 $section = $section_default;
2153 }
2154
2155 $in_doc_sect = 1;
2156 $state = STATE_BODY;
2157 $contents = $newcontents;
2158 $new_start_line = $.;
2159 while (substr($contents, 0, 1) eq " ") {
2160 $contents = substr($contents, 1);
2161 }
2162 if ($contents ne "") {
2163 $contents .= "\n";
2164 }
2165 $section = $newsection;
2166 $leading_space = undef;
2167 } elsif (/$doc_end/) {
2168 if (($contents ne "") && ($contents ne "\n")) {
2169 dump_section($file, $section, $contents);
2170 $section = $section_default;
2171 $contents = "";
2172 }
2173 # look for doc_com + <text> + doc_end:
2174 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2175 emit_warning("${file}:$.", "suspicious ending line: $_");
2176 }
2177
2178 $prototype = "";
2179 $state = STATE_PROTO;
2180 $brcount = 0;
2181 $new_start_line = $. + 1;
2182 } elsif (/$doc_content/) {
2183 if ($1 eq "") {
2184 if ($section eq $section_context) {
2185 dump_section($file, $section, $contents);
2186 $section = $section_default;
2187 $contents = "";
2188 $new_start_line = $.;
2189 $state = STATE_BODY;
2190 } else {
2191 if ($section ne $section_default) {
2192 $state = STATE_BODY_WITH_BLANK_LINE;
2193 } else {
2194 $state = STATE_BODY;
2195 }
2196 $contents .= "\n";
2197 }
2198 } elsif ($state == STATE_BODY_MAYBE) {
2199 # Continued declaration purpose
2200 chomp($declaration_purpose);
2201 $declaration_purpose .= " " . $1;
2202 $declaration_purpose =~ s/\s+/ /g;
2203 } else {
2204 my $cont = $1;
2205 if ($section =~ m/^@/ || $section eq $section_context) {
2206 if (!defined $leading_space) {
2207 if ($cont =~ m/^(\s+)/) {
2208 $leading_space = $1;
2209 } else {
2210 $leading_space = "";
2211 }
2212 }
2213 $cont =~ s/^$leading_space//;
2214 }
2215 $contents .= $cont . "\n";
2216 }
2217 } else {
2218 # i dont know - bad line? ignore.
2219 emit_warning("${file}:$.", "bad line: $_");
2220 }
2221}
2222
2223
2224#
2225# STATE_PROTO: reading a function/whatever prototype.
2226#
2227sub process_proto($$) {
2228 my $file = shift;
2229
2230 if (/$doc_inline_oneline/) {
2231 $section = $1;
2232 $contents = $2;
2233 if ($contents ne "") {
2234 $contents .= "\n";
2235 dump_section($file, $section, $contents);
2236 $section = $section_default;
2237 $contents = "";
2238 }
2239 } elsif (/$doc_inline_start/) {
2240 $state = STATE_INLINE;
2241 $inline_doc_state = STATE_INLINE_NAME;
2242 } elsif ($decl_type eq 'function') {
2243 process_proto_function($_, $file);
2244 } else {
2245 process_proto_type($_, $file);
2246 }
2247}
2248
2249#
2250# STATE_DOCBLOCK: within a DOC: block.
2251#
2252sub process_docblock($$) {
2253 my $file = shift;
2254
2255 if (/$doc_end/) {
2256 dump_doc_section($file, $section, $contents);
2257 $section = $section_default;
2258 $contents = "";
2259 $function = "";
2260 %parameterdescs = ();
2261 %parametertypes = ();
2262 @parameterlist = ();
2263 %sections = ();
2264 @sectionlist = ();
2265 $prototype = "";
2266 $state = STATE_NORMAL;
2267 } elsif (/$doc_content/) {
2268 if ( $1 eq "" ) {
2269 $contents .= $blankline;
2270 } else {
2271 $contents .= $1 . "\n";
2272 }
2273 }
2274}
2275
2276#
2277# STATE_INLINE: docbook comments within a prototype.
2278#
2279sub process_inline($$) {
2280 my $file = shift;
2281
2282 # First line (state 1) needs to be a @parameter
2283 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2284 $section = $1;
2285 $contents = $2;
2286 $new_start_line = $.;
2287 if ($contents ne "") {
2288 while (substr($contents, 0, 1) eq " ") {
2289 $contents = substr($contents, 1);
2290 }
2291 $contents .= "\n";
2292 }
2293 $inline_doc_state = STATE_INLINE_TEXT;
2294 # Documentation block end */
2295 } elsif (/$doc_inline_end/) {
2296 if (($contents ne "") && ($contents ne "\n")) {
2297 dump_section($file, $section, $contents);
2298 $section = $section_default;
2299 $contents = "";
2300 }
2301 $state = STATE_PROTO;
2302 $inline_doc_state = STATE_INLINE_NA;
2303 # Regular text
2304 } elsif (/$doc_content/) {
2305 if ($inline_doc_state == STATE_INLINE_TEXT) {
2306 $contents .= $1 . "\n";
2307 # nuke leading blank lines
2308 if ($contents =~ /^\s*$/) {
2309 $contents = "";
2310 }
2311 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2312 $inline_doc_state = STATE_INLINE_ERROR;
2313 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_");
2314 }
2315 }
2316}
2317
2318
2319sub process_file($) {
2320 my $file;
2321 my $initial_section_counter = $section_counter;
2322 my ($orig_file) = @_;
2323
2324 $file = map_filename($orig_file);
2325
2326 if (!open(IN_FILE,"<$file")) {
2327 print STDERR "Error: Cannot open file $file\n";
2328 ++$errors;
2329 return;
2330 }
2331
2332 $. = 1;
2333
2334 $section_counter = 0;
2335 while (<IN_FILE>) {
2336 while (!/^ \*/ && s/\\\s*$//) {
2337 $_ .= <IN_FILE>;
2338 }
2339 # Replace tabs by spaces
2340 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2341 # Hand this line to the appropriate state handler
2342 if ($state == STATE_NORMAL) {
2343 process_normal();
2344 } elsif ($state == STATE_NAME) {
2345 process_name($file, $_);
2346 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2347 $state == STATE_BODY_WITH_BLANK_LINE) {
2348 process_body($file, $_);
2349 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2350 process_inline($file, $_);
2351 } elsif ($state == STATE_PROTO) {
2352 process_proto($file, $_);
2353 } elsif ($state == STATE_DOCBLOCK) {
2354 process_docblock($file, $_);
2355 }
2356 }
2357
2358 # Make sure we got something interesting.
2359 if ($initial_section_counter == $section_counter && $
2360 output_mode ne "none") {
2361 if ($output_selection == OUTPUT_INCLUDE) {
2362 emit_warning("${file}:1", "'$_' not found\n")
2363 for keys %function_table;
2364 } else {
2365 emit_warning("${file}:1", "no structured comments found\n");
2366 }
2367 }
2368 close IN_FILE;
2369}
2370
2371
2372if ($output_mode eq "rst") {
2373 get_sphinx_version() if (!$sphinx_major);
2374}
2375
2376$kernelversion = get_kernel_version();
2377
2378# generate a sequence of code that will splice in highlighting information
2379# using the s// operator.
2380for (my $k = 0; $k < @highlights; $k++) {
2381 my $pattern = $highlights[$k][0];
2382 my $result = $highlights[$k][1];
2383# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2384 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2385}
2386
2387# Read the file that maps relative names to absolute names for
2388# separate source and object directories and for shadow trees.
2389if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2390 my ($relname, $absname);
2391 while(<SOURCE_MAP>) {
2392 chop();
2393 ($relname, $absname) = (split())[0..1];
2394 $relname =~ s:^/+::;
2395 $source_map{$relname} = $absname;
2396 }
2397 close(SOURCE_MAP);
2398}
2399
2400if ($output_selection == OUTPUT_EXPORTED ||
2401 $output_selection == OUTPUT_INTERNAL) {
2402
2403 push(@export_file_list, @ARGV);
2404
2405 foreach (@export_file_list) {
2406 chomp;
2407 process_export_file($_);
2408 }
2409}
2410
2411foreach (@ARGV) {
2412 chomp;
2413 process_file($_);
2414}
2415if ($verbose && $errors) {
2416 print STDERR "$errors errors\n";
2417}
2418if ($verbose && $warnings) {
2419 print STDERR "$warnings warnings\n";
2420}
2421
2422if ($Werror && $warnings) {
2423 print STDERR "$warnings warnings as Errors\n";
2424 exit($warnings);
2425} else {
2426 exit($output_mode eq "none" ? 0 : $errors)
2427}
2428
2429__END__
2430
2431=head1 OPTIONS
2432
2433=head2 Output format selection (mutually exclusive):
2434
2435=over 8
2436
2437=item -man
2438
2439Output troff manual page format.
2440
2441=item -rst
2442
2443Output reStructuredText format. This is the default.
2444
2445=item -none
2446
2447Do not output documentation, only warnings.
2448
2449=back
2450
2451=head2 Output format modifiers
2452
2453=head3 reStructuredText only
2454
2455=over 8
2456
2457=item -sphinx-version VERSION
2458
2459Use the ReST C domain dialect compatible with a specific Sphinx Version.
2460
2461If not specified, kernel-doc will auto-detect using the sphinx-build version
2462found on PATH.
2463
2464=back
2465
2466=head2 Output selection (mutually exclusive):
2467
2468=over 8
2469
2470=item -export
2471
2472Only output documentation for the symbols that have been exported using
2473EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2474
2475=item -internal
2476
2477Only output documentation for the symbols that have NOT been exported using
2478EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2479
2480=item -function NAME
2481
2482Only output documentation for the given function or DOC: section title.
2483All other functions and DOC: sections are ignored.
2484
2485May be specified multiple times.
2486
2487=item -nosymbol NAME
2488
2489Exclude the specified symbol from the output documentation.
2490
2491May be specified multiple times.
2492
2493=back
2494
2495=head2 Output selection modifiers:
2496
2497=over 8
2498
2499=item -no-doc-sections
2500
2501Do not output DOC: sections.
2502
2503=item -export-file FILE
2504
2505Specify an additional FILE in which to look for EXPORT_SYMBOL information.
2506
2507To be used with -export or -internal.
2508
2509May be specified multiple times.
2510
2511=back
2512
2513=head3 reStructuredText only
2514
2515=over 8
2516
2517=item -enable-lineno
2518
2519Enable output of .. LINENO lines.
2520
2521=back
2522
2523=head2 Other parameters:
2524
2525=over 8
2526
2527=item -h, -help
2528
2529Print this help.
2530
2531=item -v
2532
2533Verbose output, more warnings and other information.
2534
2535=item -Werror
2536
2537Treat warnings as errors.
2538
2539=back
2540
2541=cut