Commit | Line | Data |
---|---|---|
cb77f0d6 | 1 | #!/usr/bin/env perl |
38476378 | 2 | # SPDX-License-Identifier: GPL-2.0 |
a3a23d36 | 3 | # vim: softtabstop=4 |
1da177e4 | 4 | |
cb77f0d6 | 5 | use warnings; |
1da177e4 LT |
6 | use 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 ## | |
70c95b00 | 11 | ## Copyright (C) 2005-2012 Randy Dunlap ## |
1b40c194 | 12 | ## Copyright (C) 2012 Dan Luedtke ## |
1da177e4 LT |
13 | ## ## |
14 | ## #define enhancements by Armin Kuster <akuster@mvista.com> ## | |
15 | ## Copyright (c) 2000 MontaVista Software, Inc. ## | |
2b306eca TW |
16 | # |
17 | # Copyright (C) 2022 Tomasz Warniełło (POD) | |
1da177e4 | 18 | |
43caf1a6 TW |
19 | use Pod::Usage qw/pod2usage/; |
20 | ||
a5cdaea5 TW |
21 | =head1 NAME |
22 | ||
23 | kernel-doc - Print formatted kernel documentation to stdout | |
24 | ||
25 | =head1 SYNOPSIS | |
26 | ||
dcd39fa2 | 27 | kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]] [-Wcontents-before-sections] |
a5cdaea5 TW |
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 | ||
42 | Run `kernel-doc -h` for details. | |
43 | ||
f1583922 TW |
44 | =head1 DESCRIPTION |
45 | ||
46 | Read C language source or header FILEs, extract embedded documentation comments, | |
47 | and print formatted documentation to standard output. | |
48 | ||
49 | The documentation comments are identified by the "/**" opening comment mark. | |
50 | ||
51 | See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. | |
52 | ||
a5cdaea5 TW |
53 | =cut |
54 | ||
2875f787 TW |
55 | # more perldoc at the end of the file |
56 | ||
8484baaa RD |
57 | ## init lots of data |
58 | ||
1da177e4 LT |
59 | my $errors = 0; |
60 | my $warnings = 0; | |
5f8c7c98 | 61 | my $anon_struct_union = 0; |
1da177e4 LT |
62 | |
63 | # match expressions used to find embedded type information | |
b97f193a MCC |
64 | my $type_constant = '\b``([^\`]+)``\b'; |
65 | my $type_constant2 = '\%([-_\w]+)'; | |
1da177e4 | 66 | my $type_func = '(\w+)\(\)'; |
bfd228c7 | 67 | my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; |
69fc23ef | 68 | my $type_param_ref = '([\!~\*]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; |
5219f18a | 69 | my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params |
346282db | 70 | my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params |
1da177e4 | 71 | my $type_env = '(\$\w+)'; |
df31175b PB |
72 | my $type_enum = '\&(enum\s*([_\w]+))'; |
73 | my $type_struct = '\&(struct\s*([_\w]+))'; | |
74 | my $type_typedef = '\&(typedef\s*([_\w]+))'; | |
75 | my $type_union = '\&(union\s*([_\w]+))'; | |
5267dd35 | 76 | my $type_member = '\&([_\w]+)(\.|->)([_\w]+)'; |
df31175b | 77 | my $type_fallback = '\&([_\w]+)'; |
f3341dcf | 78 | my $type_member_func = $type_member . '\(\)'; |
1da177e4 LT |
79 | |
80 | # Output conversion substitutions. | |
81 | # One for each output format | |
82 | ||
1da177e4 | 83 | # these are pretty rough |
4d732701 | 84 | my @highlights_man = ( |
af404fb1 VN |
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 | ); | |
1da177e4 LT |
97 | my $blankline_man = ""; |
98 | ||
c0d1b6ee JC |
99 | # rst-mode |
100 | my @highlights_rst = ( | |
af404fb1 VN |
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 | ); | |
c0d1b6ee JC |
119 | my $blankline_rst = "\n"; |
120 | ||
1da177e4 | 121 | # read arguments |
b9d97328 | 122 | if ($#ARGV == -1) { |
af404fb1 VN |
123 | pod2usage( |
124 | -message => "No arguments!\n", | |
125 | -exitval => 1, | |
126 | -verbose => 99, | |
127 | -sections => 'SYNOPSIS', | |
128 | -output => \*STDERR, | |
129 | ); | |
1da177e4 LT |
130 | } |
131 | ||
8484baaa | 132 | my $kernelversion; |
93351d41 | 133 | my ($sphinx_major, $sphinx_minor, $sphinx_patch); |
efa44475 | 134 | |
8484baaa RD |
135 | my $dohighlight = ""; |
136 | ||
1da177e4 | 137 | my $verbose = 0; |
2c12c810 | 138 | my $Werror = 0; |
56b0f453 JB |
139 | my $Wreturn = 0; |
140 | my $Wshort_desc = 0; | |
141 | my $Wcontents_before_sections = 0; | |
bdfe2be3 | 142 | my $output_mode = "rst"; |
e314ba31 | 143 | my $output_preformatted = 0; |
4b44595a | 144 | my $no_doc_sections = 0; |
0b0f5f29 | 145 | my $enable_lineno = 0; |
bdfe2be3 MCC |
146 | my @highlights = @highlights_rst; |
147 | my $blankline = $blankline_rst; | |
1da177e4 | 148 | my $modulename = "Kernel API"; |
b6c3f456 JN |
149 | |
150 | use constant { | |
151 | OUTPUT_ALL => 0, # output all symbols and doc sections | |
152 | OUTPUT_INCLUDE => 1, # output only specified symbols | |
eab795dd MCC |
153 | OUTPUT_EXPORTED => 2, # output exported symbols |
154 | OUTPUT_INTERNAL => 3, # output non-exported symbols | |
b6c3f456 JN |
155 | }; |
156 | my $output_selection = OUTPUT_ALL; | |
b0d60bfb | 157 | my $show_not_found = 0; # No longer used |
b2c4105b | 158 | |
88c2b57d JN |
159 | my @export_file_list; |
160 | ||
b2c4105b BH |
161 | my @build_time; |
162 | if (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 | ||
3c3b809e | 169 | my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', |
af404fb1 VN |
170 | 'July', 'August', 'September', 'October', |
171 | 'November', 'December')[$build_time[4]] . | |
172 | " " . ($build_time[5]+1900); | |
1da177e4 | 173 | |
8484baaa | 174 | # Essentially these are globals. |
b9d97328 RD |
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 | |
1da177e4 | 177 | # could cause "use of undefined value" or other bugs. |
b9d97328 | 178 | my ($function, %function_table, %parametertypes, $declaration_purpose); |
eab795dd | 179 | my %nosymbol_table = (); |
0b0f5f29 | 180 | my $declaration_start_line; |
b9d97328 | 181 | my ($type, $declaration_name, $return_type); |
1c32fd0c | 182 | my ($newsection, $newcontents, $prototype, $brcount, %source_map); |
1da177e4 | 183 | |
c0d3b831 | 184 | if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =~ '1') { |
af404fb1 | 185 | $verbose = 1; |
bd0e88e5 RD |
186 | } |
187 | ||
2c12c810 | 188 | if (defined($ENV{'KCFLAGS'})) { |
af404fb1 | 189 | my $kcflags = "$ENV{'KCFLAGS'}"; |
2c12c810 | 190 | |
af404fb1 VN |
191 | if ($kcflags =~ /(\s|^)-Werror(\s|$)/) { |
192 | $Werror = 1; | |
193 | } | |
2c12c810 PLB |
194 | } |
195 | ||
56b0f453 JB |
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 | |
bed4ed30 | 199 | if (defined($ENV{'KDOC_WERROR'})) { |
af404fb1 | 200 | $Werror = "$ENV{'KDOC_WERROR'}"; |
bed4ed30 | 201 | } |
56b0f453 JB |
202 | # other environment variables are converted to command-line |
203 | # arguments in cmd_checkdoc in the build system | |
bed4ed30 | 204 | |
3c3b809e | 205 | # Generated docbook code is inserted in a template at a point where |
1da177e4 | 206 | # docbook v3.1 requires a non-zero sequence of RefEntry's; see: |
93431e06 | 207 | # https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html |
1da177e4 LT |
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. | |
211 | my $section_counter = 0; | |
212 | ||
213 | my $lineprefix=""; | |
214 | ||
48af606a JN |
215 | # Parser states |
216 | use constant { | |
0d55d48b MCC |
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 | |
48af606a | 225 | }; |
1da177e4 | 226 | my $state; |
850622df | 227 | my $in_doc_sect; |
d742f24d | 228 | my $leading_space; |
1da177e4 | 229 | |
48af606a JN |
230 | # Inline documentation state |
231 | use 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 | }; | |
240 | my $inline_doc_state; | |
a4c6ebed | 241 | |
1da177e4 LT |
242 | #declaration types: can be |
243 | # 'function', 'struct', 'union', 'enum', 'typedef' | |
244 | my $decl_type; | |
245 | ||
52042e2d MCC |
246 | # Name of the kernel-doc identifier for non-DOC markups |
247 | my $identifier; | |
248 | ||
1da177e4 LT |
249 | my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. |
250 | my $doc_end = '\*/'; | |
251 | my $doc_com = '\s*\*\s*'; | |
12ae6779 | 252 | my $doc_com_body = '\s*\* ?'; |
b9d97328 | 253 | my $doc_decl = $doc_com . '(\w+)'; |
f624adef | 254 | # @params and a strictly limited set of supported section names |
212209cf JC |
255 | # Specifically: |
256 | # Match @word: | |
257 | # @...: | |
258 | # @{section-name}: | |
259 | # while trying to not match literal block starts like "example::" | |
260 | # | |
76dd3e7b | 261 | my $doc_sect = $doc_com . |
212209cf | 262 | '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$'; |
12ae6779 | 263 | my $doc_content = $doc_com_body . '(.*)'; |
b9d97328 | 264 | my $doc_block = $doc_com . 'DOC:\s*(.*)?'; |
48af606a | 265 | my $doc_inline_start = '^\s*/\*\*\s*$'; |
fe7bc493 | 266 | my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)'; |
48af606a | 267 | my $doc_inline_end = '^\s*\*/\s*$'; |
0c9aa209 | 268 | my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; |
86ae2e38 | 269 | my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; |
632ce137 | 270 | my $export_symbol_ns = '^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,\s*\w+\)\s*;'; |
e86bdb24 AS |
271 | my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)}; |
272 | my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i; | |
1da177e4 | 273 | |
1da177e4 | 274 | my %parameterdescs; |
0b0f5f29 | 275 | my %parameterdesc_start_lines; |
1da177e4 LT |
276 | my @parameterlist; |
277 | my %sections; | |
278 | my @sectionlist; | |
0b0f5f29 | 279 | my %section_start_lines; |
a1d94aa5 RD |
280 | my $sectcheck; |
281 | my $struct_actual; | |
1da177e4 LT |
282 | |
283 | my $contents = ""; | |
0b0f5f29 | 284 | my $new_start_line = 0; |
f624adef JN |
285 | |
286 | # the canonical section names. see also $doc_sect above. | |
1da177e4 LT |
287 | my $section_default = "Description"; # default section |
288 | my $section_intro = "Introduction"; | |
289 | my $section = $section_default; | |
290 | my $section_context = "Context"; | |
4092bac7 | 291 | my $section_return = "Return"; |
1da177e4 LT |
292 | |
293 | my $undescribed = "-- undescribed --"; | |
294 | ||
295 | reset_state(); | |
296 | ||
b031ac4e MCC |
297 | while ($ARGV[0] =~ m/^--?(.*)/) { |
298 | my $cmd = $1; | |
299 | shift @ARGV; | |
300 | if ($cmd eq "man") { | |
af404fb1 VN |
301 | $output_mode = "man"; |
302 | @highlights = @highlights_man; | |
303 | $blankline = $blankline_man; | |
b031ac4e | 304 | } elsif ($cmd eq "rst") { |
af404fb1 VN |
305 | $output_mode = "rst"; |
306 | @highlights = @highlights_rst; | |
307 | $blankline = $blankline_rst; | |
b031ac4e | 308 | } elsif ($cmd eq "none") { |
af404fb1 | 309 | $output_mode = "none"; |
b031ac4e | 310 | } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document |
af404fb1 | 311 | $modulename = shift @ARGV; |
b031ac4e | 312 | } elsif ($cmd eq "function") { # to only output specific functions |
af404fb1 VN |
313 | $output_selection = OUTPUT_INCLUDE; |
314 | $function = shift @ARGV; | |
315 | $function_table{$function} = 1; | |
eab795dd | 316 | } elsif ($cmd eq "nosymbol") { # Exclude specific symbols |
af404fb1 VN |
317 | my $symbol = shift @ARGV; |
318 | $nosymbol_table{$symbol} = 1; | |
b031ac4e | 319 | } elsif ($cmd eq "export") { # only exported symbols |
af404fb1 VN |
320 | $output_selection = OUTPUT_EXPORTED; |
321 | %function_table = (); | |
b031ac4e | 322 | } elsif ($cmd eq "internal") { # only non-exported symbols |
af404fb1 VN |
323 | $output_selection = OUTPUT_INTERNAL; |
324 | %function_table = (); | |
b031ac4e | 325 | } elsif ($cmd eq "export-file") { |
af404fb1 VN |
326 | my $file = shift @ARGV; |
327 | push(@export_file_list, $file); | |
b031ac4e | 328 | } elsif ($cmd eq "v") { |
af404fb1 | 329 | $verbose = 1; |
2c12c810 | 330 | } elsif ($cmd eq "Werror") { |
af404fb1 | 331 | $Werror = 1; |
56b0f453 | 332 | } elsif ($cmd eq "Wreturn") { |
af404fb1 | 333 | $Wreturn = 1; |
dcd39fa2 | 334 | } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") { |
af404fb1 | 335 | $Wshort_desc = 1; |
56b0f453 | 336 | } elsif ($cmd eq "Wcontents-before-sections") { |
af404fb1 | 337 | $Wcontents_before_sections = 1; |
56b0f453 JB |
338 | } elsif ($cmd eq "Wall") { |
339 | $Wreturn = 1; | |
340 | $Wshort_desc = 1; | |
341 | $Wcontents_before_sections = 1; | |
b031ac4e | 342 | } elsif (($cmd eq "h") || ($cmd eq "help")) { |
af404fb1 | 343 | pod2usage(-exitval => 0, -verbose => 2); |
b031ac4e | 344 | } elsif ($cmd eq 'no-doc-sections') { |
af404fb1 | 345 | $no_doc_sections = 1; |
b031ac4e | 346 | } elsif ($cmd eq 'enable-lineno') { |
af404fb1 | 347 | $enable_lineno = 1; |
b031ac4e | 348 | } elsif ($cmd eq 'show-not-found') { |
af404fb1 | 349 | $show_not_found = 1; # A no-op but don't fail |
93351d41 | 350 | } elsif ($cmd eq "sphinx-version") { |
af404fb1 VN |
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 | } | |
b031ac4e | 367 | } else { |
af404fb1 VN |
368 | # Unknown argument |
369 | pod2usage( | |
370 | -message => "Argument unknown!\n", | |
371 | -exitval => 1, | |
372 | -verbose => 99, | |
373 | -sections => 'SYNOPSIS', | |
374 | -output => \*STDERR, | |
375 | ); | |
e334f873 AY |
376 | } |
377 | if ($#ARGV < 0){ | |
af404fb1 VN |
378 | pod2usage( |
379 | -message => "FILE argument missing\n", | |
380 | -exitval => 1, | |
381 | -verbose => 99, | |
382 | -sections => 'SYNOPSIS', | |
383 | -output => \*STDERR, | |
384 | ); | |
1da177e4 LT |
385 | } |
386 | } | |
387 | ||
8484baaa RD |
388 | # continue execution near EOF; |
389 | ||
efa44475 MCC |
390 | # The C domain dialect changed on Sphinx 3. So, we need to check the |
391 | # version in order to produce the right tags. | |
392 | sub findprog($) | |
393 | { | |
af404fb1 VN |
394 | foreach(split(/:/, $ENV{PATH})) { |
395 | return "$_/$_[0]" if(-x "$_/$_[0]"); | |
396 | } | |
efa44475 MCC |
397 | } |
398 | ||
399 | sub get_sphinx_version() | |
400 | { | |
af404fb1 VN |
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; | |
efa44475 MCC |
433 | } |
434 | ||
53f049fa BP |
435 | # get kernel version from env |
436 | sub get_kernel_version() { | |
1b9bc22d | 437 | my $version = 'unknown kernel version'; |
53f049fa BP |
438 | |
439 | if (defined($ENV{'KERNELVERSION'})) { | |
af404fb1 | 440 | $version = $ENV{'KERNELVERSION'}; |
53f049fa BP |
441 | } |
442 | return $version; | |
443 | } | |
1da177e4 | 444 | |
0b0f5f29 DV |
445 | # |
446 | sub print_lineno { | |
447 | my $lineno = shift; | |
448 | if ($enable_lineno && defined($lineno)) { | |
b79dfef0 | 449 | print ".. LINENO " . $lineno . "\n"; |
0b0f5f29 DV |
450 | } |
451 | } | |
df4bf98e NS |
452 | |
453 | sub emit_warning { | |
454 | my $location = shift; | |
455 | my $msg = shift; | |
456 | print STDERR "$location: warning: $msg"; | |
457 | ++$warnings; | |
458 | } | |
1da177e4 LT |
459 | ## |
460 | # dumps section contents to arrays/hashes intended for that purpose. | |
461 | # | |
462 | sub dump_section { | |
94dc7ad5 | 463 | my $file = shift; |
1da177e4 LT |
464 | my $name = shift; |
465 | my $contents = join "\n", @_; | |
466 | ||
13901ef2 | 467 | if ($name =~ m/$type_param/) { |
af404fb1 VN |
468 | $name = $1; |
469 | $parameterdescs{$name} = $contents; | |
470 | $sectcheck = $sectcheck . $name . " "; | |
0b0f5f29 DV |
471 | $parameterdesc_start_lines{$name} = $new_start_line; |
472 | $new_start_line = 0; | |
ced69090 | 473 | } elsif ($name eq "@\.\.\.") { |
af404fb1 VN |
474 | $name = "..."; |
475 | $parameterdescs{$name} = $contents; | |
476 | $sectcheck = $sectcheck . $name . " "; | |
0b0f5f29 DV |
477 | $parameterdesc_start_lines{$name} = $new_start_line; |
478 | $new_start_line = 0; | |
1da177e4 | 479 | } else { |
af404fb1 VN |
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; | |
0b0f5f29 DV |
489 | $section_start_lines{$name} = $new_start_line; |
490 | $new_start_line = 0; | |
af404fb1 | 491 | } |
1da177e4 LT |
492 | } |
493 | } | |
494 | ||
b112e0f7 JB |
495 | ## |
496 | # dump DOC: section after checking that it should go out | |
497 | # | |
498 | sub dump_doc_section { | |
94dc7ad5 | 499 | my $file = shift; |
b112e0f7 JB |
500 | my $name = shift; |
501 | my $contents = join "\n", @_; | |
502 | ||
4b44595a JB |
503 | if ($no_doc_sections) { |
504 | return; | |
505 | } | |
506 | ||
eab795dd MCC |
507 | return if (defined($nosymbol_table{$name})); |
508 | ||
b6c3f456 | 509 | if (($output_selection == OUTPUT_ALL) || |
af404fb1 VN |
510 | (($output_selection == OUTPUT_INCLUDE) && |
511 | defined($function_table{$name}))) | |
b112e0f7 | 512 | { |
af404fb1 VN |
513 | dump_section($file, $name, $contents); |
514 | output_blockhead({'sectionlist' => \@sectionlist, | |
515 | 'sections' => \%sections, | |
516 | 'module' => $modulename, | |
517 | 'content-only' => ($output_selection != OUTPUT_ALL), }); | |
b112e0f7 JB |
518 | } |
519 | } | |
520 | ||
1da177e4 LT |
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 | |
a21217da | 529 | # sections => %section descriptions |
3c3b809e | 530 | # |
1da177e4 LT |
531 | |
532 | sub 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 | ||
3eb014a1 | 542 | # print STDERR "contents b4:$contents\n"; |
1da177e4 LT |
543 | eval $dohighlight; |
544 | die $@ if $@; | |
3eb014a1 RD |
545 | # print STDERR "contents af:$contents\n"; |
546 | ||
1da177e4 | 547 | foreach $line (split "\n", $contents) { |
af404fb1 VN |
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"; | |
1da177e4 LT |
563 | } |
564 | } | |
565 | ||
1da177e4 LT |
566 | ## |
567 | # output function in man | |
568 | sub 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"; | |
b9d97328 | 576 | print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; |
1da177e4 LT |
577 | |
578 | print ".SH SYNOPSIS\n"; | |
a21217da | 579 | if ($args{'functiontype'} ne "") { |
af404fb1 | 580 | print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; |
a21217da | 581 | } else { |
af404fb1 | 582 | print ".B \"" . $args{'function'} . "\n"; |
a21217da | 583 | } |
1da177e4 LT |
584 | $count = 0; |
585 | my $parenth = "("; | |
586 | my $post = ","; | |
587 | foreach my $parameter (@{$args{'parameterlist'}}) { | |
af404fb1 VN |
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 = ""; | |
1da177e4 LT |
601 | } |
602 | ||
603 | print ".SH ARGUMENTS\n"; | |
604 | foreach $parameter (@{$args{'parameterlist'}}) { | |
af404fb1 VN |
605 | my $parameter_name = $parameter; |
606 | $parameter_name =~ s/\[.*//; | |
1da177e4 | 607 | |
af404fb1 VN |
608 | print ".IP \"" . $parameter . "\" 12\n"; |
609 | output_highlight($args{'parameterdescs'}{$parameter_name}); | |
1da177e4 LT |
610 | } |
611 | foreach $section (@{$args{'sectionlist'}}) { | |
af404fb1 VN |
612 | print ".SH \"", uc $section, "\"\n"; |
613 | output_highlight($args{'sections'}{$section}); | |
1da177e4 LT |
614 | } |
615 | } | |
616 | ||
617 | ## | |
618 | # output enum in man | |
619 | sub 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"; | |
b9d97328 | 627 | print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; |
1da177e4 LT |
628 | |
629 | print ".SH SYNOPSIS\n"; | |
b9d97328 | 630 | print "enum " . $args{'enum'} . " {\n"; |
1da177e4 LT |
631 | $count = 0; |
632 | foreach my $parameter (@{$args{'parameterlist'}}) { | |
af404fb1 VN |
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++; | |
1da177e4 LT |
641 | } |
642 | ||
643 | print ".SH Constants\n"; | |
644 | foreach $parameter (@{$args{'parameterlist'}}) { | |
af404fb1 VN |
645 | my $parameter_name = $parameter; |
646 | $parameter_name =~ s/\[.*//; | |
1da177e4 | 647 | |
af404fb1 VN |
648 | print ".IP \"" . $parameter . "\" 12\n"; |
649 | output_highlight($args{'parameterdescs'}{$parameter_name}); | |
1da177e4 LT |
650 | } |
651 | foreach $section (@{$args{'sectionlist'}}) { | |
af404fb1 VN |
652 | print ".SH \"$section\"\n"; |
653 | output_highlight($args{'sections'}{$section}); | |
1da177e4 LT |
654 | } |
655 | } | |
656 | ||
657 | ## | |
658 | # output struct in man | |
659 | sub output_struct_man(%) { | |
660 | my %args = %{$_[0]}; | |
661 | my ($parameter, $section); | |
662 | ||
b9d97328 | 663 | print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; |
1da177e4 LT |
664 | |
665 | print ".SH NAME\n"; | |
b9d97328 | 666 | print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n"; |
1da177e4 | 667 | |
8ad72163 MCC |
668 | my $declaration = $args{'definition'}; |
669 | $declaration =~ s/\t/ /g; | |
670 | $declaration =~ s/\n/"\n.br\n.BI \"/g; | |
1da177e4 | 671 | print ".SH SYNOPSIS\n"; |
b9d97328 | 672 | print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; |
8ad72163 | 673 | print ".BI \"$declaration\n};\n.br\n\n"; |
1da177e4 | 674 | |
c51d3dac | 675 | print ".SH Members\n"; |
1da177e4 | 676 | foreach $parameter (@{$args{'parameterlist'}}) { |
af404fb1 | 677 | ($parameter =~ /^#/) && next; |
1da177e4 | 678 | |
af404fb1 VN |
679 | my $parameter_name = $parameter; |
680 | $parameter_name =~ s/\[.*//; | |
1da177e4 | 681 | |
af404fb1 VN |
682 | ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
683 | print ".IP \"" . $parameter . "\" 12\n"; | |
684 | output_highlight($args{'parameterdescs'}{$parameter_name}); | |
1da177e4 LT |
685 | } |
686 | foreach $section (@{$args{'sectionlist'}}) { | |
af404fb1 VN |
687 | print ".SH \"$section\"\n"; |
688 | output_highlight($args{'sections'}{$section}); | |
1da177e4 LT |
689 | } |
690 | } | |
691 | ||
692 | ## | |
693 | # output typedef in man | |
694 | sub 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"; | |
b9d97328 | 701 | print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n"; |
1da177e4 LT |
702 | |
703 | foreach $section (@{$args{'sectionlist'}}) { | |
af404fb1 VN |
704 | print ".SH \"$section\"\n"; |
705 | output_highlight($args{'sections'}{$section}); | |
1da177e4 LT |
706 | } |
707 | } | |
708 | ||
b112e0f7 | 709 | sub output_blockhead_man(%) { |
1da177e4 LT |
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'}}) { | |
af404fb1 VN |
717 | print ".SH \"$section\"\n"; |
718 | output_highlight($args{'sections'}{$section}); | |
1da177e4 LT |
719 | } |
720 | } | |
721 | ||
c0d1b6ee JC |
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 | # | |
731 | sub output_blockhead_rst(%) { | |
732 | my %args = %{$_[0]}; | |
733 | my ($parameter, $section); | |
734 | ||
735 | foreach $section (@{$args{'sectionlist'}}) { | |
af404fb1 | 736 | next if (defined($nosymbol_table{$section})); |
eab795dd | 737 | |
af404fb1 VN |
738 | if ($output_selection != OUTPUT_INCLUDE) { |
739 | print ".. _$section:\n\n"; | |
740 | print "**$section**\n\n"; | |
741 | } | |
0b0f5f29 | 742 | print_lineno($section_start_lines{$section}); |
af404fb1 VN |
743 | output_highlight_rst($args{'sections'}{$section}); |
744 | print "\n"; | |
c0d1b6ee JC |
745 | } |
746 | } | |
747 | ||
af250290 JC |
748 | # |
749 | # Apply the RST highlights to a sub-block of text. | |
76dd3e7b | 750 | # |
af250290 JC |
751 | sub highlight_block($) { |
752 | # The dohighlight kludge requires the text be called $contents | |
753 | my $contents = shift; | |
c0d1b6ee JC |
754 | eval $dohighlight; |
755 | die $@ if $@; | |
af250290 JC |
756 | return $contents; |
757 | } | |
c0d1b6ee | 758 | |
af250290 JC |
759 | # |
760 | # Regexes used only here. | |
761 | # | |
762 | my $sphinx_literal = '^[^.].*::$'; | |
763 | my $sphinx_cblock = '^\.\.\ +code-block::'; | |
764 | ||
765 | sub 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) { | |
af404fb1 VN |
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 | } | |
af250290 JC |
809 | } |
810 | ||
811 | if ($block) { | |
af404fb1 | 812 | $output .= highlight_block($block); |
af250290 JC |
813 | } |
814 | foreach $line (split "\n", $output) { | |
af404fb1 | 815 | print $lineprefix . $line . "\n"; |
c0d1b6ee JC |
816 | } |
817 | } | |
818 | ||
819 | sub output_function_rst(%) { | |
820 | my %args = %{$_[0]}; | |
821 | my ($parameter, $section); | |
c099ff69 | 822 | my $oldprefix = $lineprefix; |
82801d06 | 823 | |
d3c55a71 VN |
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 | ||
e3ad05fe | 849 | if ($sphinx_major < 3) { |
af404fb1 VN |
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'}); | |
9f6f4c11 VN |
856 | print "\n\n**Syntax**\n\n"; |
857 | print " ``$signature``\n\n"; | |
af404fb1 | 858 | } else { |
9f6f4c11 | 859 | print ".. c:function:: $signature\n\n"; |
af404fb1 | 860 | } |
82801d06 | 861 | } else { |
af404fb1 | 862 | if ($args{'typedef'} || $args{'functiontype'} eq "") { |
af404fb1 | 863 | print ".. c:macro:: ". $args{'function'} . "\n\n"; |
af404fb1 | 864 | |
9f6f4c11 VN |
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 | } | |
af404fb1 | 875 | } else { |
9f6f4c11 | 876 | print ".. c:function:: $signature\n\n"; |
af404fb1 | 877 | } |
82801d06 | 878 | } |
c0d1b6ee | 879 | |
6e9e4158 | 880 | if (!$args{'typedef'}) { |
af404fb1 VN |
881 | print_lineno($declaration_start_line); |
882 | $lineprefix = " "; | |
883 | output_highlight_rst($args{'purpose'}); | |
884 | print "\n"; | |
82801d06 | 885 | } |
c0d1b6ee | 886 | |
eaf710ce JC |
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"; | |
ecbcfba1 | 892 | $lineprefix = " "; |
eaf710ce | 893 | print $lineprefix . "**Parameters**\n\n"; |
c0d1b6ee | 894 | foreach $parameter (@{$args{'parameterlist'}}) { |
af404fb1 VN |
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 | } | |
0b0f5f29 DV |
904 | |
905 | print_lineno($parameterdesc_start_lines{$parameter_name}); | |
906 | ||
af404fb1 VN |
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"; | |
c0d1b6ee | 916 | } |
c099ff69 | 917 | |
c0d1b6ee | 918 | output_section_rst(@_); |
eaf710ce | 919 | $lineprefix = $oldprefix; |
c0d1b6ee JC |
920 | } |
921 | ||
922 | sub output_section_rst(%) { | |
923 | my %args = %{$_[0]}; | |
924 | my $section; | |
925 | my $oldprefix = $lineprefix; | |
c0d1b6ee JC |
926 | |
927 | foreach $section (@{$args{'sectionlist'}}) { | |
af404fb1 | 928 | print $lineprefix . "**$section**\n\n"; |
0b0f5f29 | 929 | print_lineno($section_start_lines{$section}); |
af404fb1 VN |
930 | output_highlight_rst($args{'sections'}{$section}); |
931 | print "\n"; | |
c0d1b6ee JC |
932 | } |
933 | print "\n"; | |
c0d1b6ee JC |
934 | } |
935 | ||
936 | sub output_enum_rst(%) { | |
937 | my %args = %{$_[0]}; | |
938 | my ($parameter); | |
c099ff69 | 939 | my $oldprefix = $lineprefix; |
c0d1b6ee | 940 | my $count; |
eaf710ce | 941 | my $outer; |
62850976 | 942 | |
efa44475 | 943 | if ($sphinx_major < 3) { |
af404fb1 VN |
944 | my $name = "enum " . $args{'enum'}; |
945 | print "\n\n.. c:type:: " . $name . "\n\n"; | |
efa44475 | 946 | } else { |
af404fb1 VN |
947 | my $name = $args{'enum'}; |
948 | print "\n\n.. c:enum:: " . $name . "\n\n"; | |
efa44475 | 949 | } |
0b0f5f29 | 950 | print_lineno($declaration_start_line); |
eaf710ce | 951 | $lineprefix = " "; |
c099ff69 JN |
952 | output_highlight_rst($args{'purpose'}); |
953 | print "\n"; | |
c0d1b6ee | 954 | |
eaf710ce JC |
955 | print ".. container:: kernelindent\n\n"; |
956 | $outer = $lineprefix . " "; | |
957 | $lineprefix = $outer . " "; | |
958 | print $outer . "**Constants**\n\n"; | |
c0d1b6ee | 959 | foreach $parameter (@{$args{'parameterlist'}}) { |
af404fb1 | 960 | print $outer . "``$parameter``\n"; |
eaf710ce | 961 | |
af404fb1 VN |
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"; | |
c0d1b6ee | 968 | } |
eaf710ce | 969 | print "\n"; |
c0d1b6ee JC |
970 | $lineprefix = $oldprefix; |
971 | output_section_rst(@_); | |
972 | } | |
973 | ||
974 | sub output_typedef_rst(%) { | |
975 | my %args = %{$_[0]}; | |
976 | my ($parameter); | |
c099ff69 | 977 | my $oldprefix = $lineprefix; |
efa44475 | 978 | my $name; |
c0d1b6ee | 979 | |
efa44475 | 980 | if ($sphinx_major < 3) { |
af404fb1 | 981 | $name = "typedef " . $args{'typedef'}; |
efa44475 | 982 | } else { |
af404fb1 | 983 | $name = $args{'typedef'}; |
efa44475 | 984 | } |
62850976 | 985 | print "\n\n.. c:type:: " . $name . "\n\n"; |
0b0f5f29 | 986 | print_lineno($declaration_start_line); |
c099ff69 JN |
987 | $lineprefix = " "; |
988 | output_highlight_rst($args{'purpose'}); | |
989 | print "\n"; | |
c0d1b6ee | 990 | |
c099ff69 | 991 | $lineprefix = $oldprefix; |
c0d1b6ee JC |
992 | output_section_rst(@_); |
993 | } | |
994 | ||
995 | sub output_struct_rst(%) { | |
996 | my %args = %{$_[0]}; | |
997 | my ($parameter); | |
c099ff69 | 998 | my $oldprefix = $lineprefix; |
c0d1b6ee | 999 | |
efa44475 | 1000 | if ($sphinx_major < 3) { |
af404fb1 VN |
1001 | my $name = $args{'type'} . " " . $args{'struct'}; |
1002 | print "\n\n.. c:type:: " . $name . "\n\n"; | |
efa44475 | 1003 | } else { |
af404fb1 VN |
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 | } | |
efa44475 | 1010 | } |
0b0f5f29 | 1011 | print_lineno($declaration_start_line); |
eaf710ce | 1012 | $lineprefix = " "; |
c099ff69 JN |
1013 | output_highlight_rst($args{'purpose'}); |
1014 | print "\n"; | |
c0d1b6ee | 1015 | |
eaf710ce JC |
1016 | print ".. container:: kernelindent\n\n"; |
1017 | print $lineprefix . "**Definition**::\n\n"; | |
8ad72163 | 1018 | my $declaration = $args{'definition'}; |
eaf710ce JC |
1019 | $lineprefix = $lineprefix . " "; |
1020 | $declaration =~ s/\t/$lineprefix/g; | |
1021 | print $lineprefix . $args{'type'} . " " . $args{'struct'} . " {\n$declaration" . $lineprefix . "};\n\n"; | |
c0d1b6ee | 1022 | |
ecbcfba1 | 1023 | $lineprefix = " "; |
eaf710ce | 1024 | print $lineprefix . "**Members**\n\n"; |
c0d1b6ee | 1025 | foreach $parameter (@{$args{'parameterlist'}}) { |
af404fb1 | 1026 | ($parameter =~ /^#/) && next; |
c0d1b6ee | 1027 | |
af404fb1 VN |
1028 | my $parameter_name = $parameter; |
1029 | $parameter_name =~ s/\[.*//; | |
c0d1b6ee | 1030 | |
af404fb1 VN |
1031 | ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1032 | $type = $args{'parametertypes'}{$parameter}; | |
0b0f5f29 | 1033 | print_lineno($parameterdesc_start_lines{$parameter_name}); |
af404fb1 VN |
1034 | print $lineprefix . "``" . $parameter . "``\n"; |
1035 | $lineprefix = " "; | |
1036 | output_highlight_rst($args{'parameterdescs'}{$parameter_name}); | |
1037 | $lineprefix = " "; | |
1038 | print "\n"; | |
c0d1b6ee JC |
1039 | } |
1040 | print "\n"; | |
c099ff69 JN |
1041 | |
1042 | $lineprefix = $oldprefix; | |
c0d1b6ee JC |
1043 | output_section_rst(@_); |
1044 | } | |
1045 | ||
3a025e1d MW |
1046 | ## none mode output functions |
1047 | ||
1048 | sub output_function_none(%) { | |
1049 | } | |
1050 | ||
1051 | sub output_enum_none(%) { | |
1052 | } | |
1053 | ||
1054 | sub output_typedef_none(%) { | |
1055 | } | |
1056 | ||
1057 | sub output_struct_none(%) { | |
1058 | } | |
1059 | ||
1060 | sub output_blockhead_none(%) { | |
1061 | } | |
1062 | ||
1da177e4 | 1063 | ## |
27205744 RD |
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 | |
1da177e4 LT |
1067 | sub output_declaration { |
1068 | no strict 'refs'; | |
1069 | my $name = shift; | |
1070 | my $functype = shift; | |
1071 | my $func = "output_${functype}_$output_mode"; | |
eab795dd MCC |
1072 | |
1073 | return if (defined($nosymbol_table{$name})); | |
1074 | ||
b6c3f456 | 1075 | if (($output_selection == OUTPUT_ALL) || |
af404fb1 VN |
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})))) | |
1da177e4 | 1081 | { |
af404fb1 VN |
1082 | &$func(@_); |
1083 | $section_counter++; | |
1da177e4 LT |
1084 | } |
1085 | } | |
1086 | ||
1087 | ## | |
27205744 | 1088 | # generic output function - calls the right one based on current output mode. |
b112e0f7 | 1089 | sub output_blockhead { |
1da177e4 | 1090 | no strict 'refs'; |
b9d97328 | 1091 | my $func = "output_blockhead_" . $output_mode; |
1da177e4 LT |
1092 | &$func(@_); |
1093 | $section_counter++; | |
1094 | } | |
1095 | ||
1096 | ## | |
3c3b809e | 1097 | # takes a declaration (struct, union, enum, typedef) and |
1da177e4 LT |
1098 | # invokes the right handler. NOT called for functions. |
1099 | sub dump_declaration($$) { | |
1100 | no strict 'refs'; | |
1101 | my ($prototype, $file) = @_; | |
b9d97328 | 1102 | my $func = "dump_" . $decl_type; |
1da177e4 LT |
1103 | &$func(@_); |
1104 | } | |
1105 | ||
1106 | sub dump_union($$) { | |
1107 | dump_struct(@_); | |
1108 | } | |
1109 | ||
1110 | sub dump_struct($$) { | |
1111 | my $x = shift; | |
1112 | my $file = shift; | |
a746fe32 AS |
1113 | my $decl_type; |
1114 | my $members; | |
1115 | my $type = qr{struct|union}; | |
1116 | # For capturing struct/union definition body, i.e. "{members*}qualifiers*" | |
e86bdb24 AS |
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)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;}; | |
a746fe32 AS |
1120 | |
1121 | if ($x =~ /($type)\s+(\w+)\s*$definition_body/) { | |
af404fb1 VN |
1122 | $decl_type = $1; |
1123 | $declaration_name = $2; | |
1124 | $members = $3; | |
a746fe32 | 1125 | } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) { |
af404fb1 VN |
1126 | $decl_type = $1; |
1127 | $declaration_name = $3; | |
1128 | $members = $2; | |
a746fe32 | 1129 | } |
1da177e4 | 1130 | |
a746fe32 | 1131 | if ($members) { |
af404fb1 VN |
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; | |
ca7e324e | 1146 | $members =~ s/\s*__counted_by_(le|be)\s*\([^;]*\)/ /gos; |
af404fb1 VN |
1147 | $members =~ s/\s*__packed\s*/ /gos; |
1148 | $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; | |
1149 | $members =~ s/\s*____cacheline_aligned_in_smp/ /gos; | |
1150 | $members =~ s/\s*____cacheline_aligned/ /gos; | |
1151 | # unwrap struct_group(): | |
1152 | # - first eat non-declaration parameters and rewrite for final match | |
1153 | # - then remove macro, outer parens, and trailing semicolon | |
1154 | $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; | |
1155 | $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; | |
1156 | $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; | |
1157 | $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos; | |
1158 | ||
1159 | my $args = qr{([^,)]+)}; | |
1160 | # replace DECLARE_BITMAP | |
1161 | $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos; | |
1162 | $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos; | |
1163 | $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; | |
1164 | # replace DECLARE_HASHTABLE | |
1165 | $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos; | |
1166 | # replace DECLARE_KFIFO | |
1167 | $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos; | |
1168 | # replace DECLARE_KFIFO_PTR | |
1169 | $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos; | |
1170 | # replace DECLARE_FLEX_ARRAY | |
1171 | $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos; | |
1172 | #replace DEFINE_DMA_UNMAP_ADDR | |
1173 | $members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos; | |
1174 | #replace DEFINE_DMA_UNMAP_LEN | |
1175 | $members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos; | |
1176 | my $declaration = $members; | |
1177 | ||
1178 | # Split nested struct/union elements as newer ones | |
1179 | while ($members =~ m/$struct_members/) { | |
1180 | my $newmember; | |
1181 | my $maintype = $1; | |
1182 | my $ids = $4; | |
1183 | my $content = $3; | |
1184 | foreach my $id(split /,/, $ids) { | |
1185 | $newmember .= "$maintype $id; "; | |
1186 | ||
1187 | $id =~ s/[:\[].*//; | |
1188 | $id =~ s/^\s*\**(\S+)\s*/$1/; | |
1189 | foreach my $arg (split /;/, $content) { | |
1190 | next if ($arg =~ m/^\s*$/); | |
1191 | if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { | |
1192 | # pointer-to-function | |
1193 | my $type = $1; | |
1194 | my $name = $2; | |
1195 | my $extra = $3; | |
1196 | next if (!$name); | |
1197 | if ($id =~ m/^\s*$/) { | |
1198 | # anonymous struct/union | |
1199 | $newmember .= "$type$name$extra; "; | |
1200 | } else { | |
1201 | $newmember .= "$type$id.$name$extra; "; | |
1202 | } | |
1203 | } else { | |
1204 | my $type; | |
1205 | my $names; | |
1206 | $arg =~ s/^\s+//; | |
1207 | $arg =~ s/\s+$//; | |
1208 | # Handle bitmaps | |
1209 | $arg =~ s/:\s*\d+\s*//g; | |
1210 | # Handle arrays | |
1211 | $arg =~ s/\[.*\]//g; | |
1212 | # The type may have multiple words, | |
1213 | # and multiple IDs can be defined, like: | |
1214 | # const struct foo, *bar, foobar | |
1215 | # So, we remove spaces when parsing the | |
1216 | # names, in order to match just names | |
1217 | # and commas for the names | |
1218 | $arg =~ s/\s*,\s*/,/g; | |
1219 | if ($arg =~ m/(.*)\s+([\S+,]+)/) { | |
1220 | $type = $1; | |
1221 | $names = $2; | |
1222 | } else { | |
1223 | $newmember .= "$arg; "; | |
1224 | next; | |
1225 | } | |
1226 | foreach my $name (split /,/, $names) { | |
1227 | $name =~ s/^\s*\**(\S+)\s*/$1/; | |
1228 | next if (($name =~ m/^\s*$/)); | |
1229 | if ($id =~ m/^\s*$/) { | |
1230 | # anonymous struct/union | |
1231 | $newmember .= "$type $name; "; | |
1232 | } else { | |
1233 | $newmember .= "$type $id.$name; "; | |
1234 | } | |
1235 | } | |
1236 | } | |
1237 | } | |
1238 | } | |
1239 | $members =~ s/$struct_members/$newmember/; | |
1240 | } | |
1241 | ||
1242 | # Ignore other nested elements, like enums | |
1243 | $members =~ s/(\{[^\{\}]*\})//g; | |
1244 | ||
1245 | create_parameterlist($members, ';', $file, $declaration_name); | |
1246 | check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual); | |
1247 | ||
1248 | # Adjust declaration for better display | |
1249 | $declaration =~ s/([\{;])/$1\n/g; | |
1250 | $declaration =~ s/\}\s+;/};/g; | |
1251 | # Better handle inlined enums | |
1252 | do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/); | |
1253 | ||
1254 | my @def_args = split /\n/, $declaration; | |
1255 | my $level = 1; | |
1256 | $declaration = ""; | |
1257 | foreach my $clause (@def_args) { | |
1258 | $clause =~ s/^\s+//; | |
1259 | $clause =~ s/\s+$//; | |
1260 | $clause =~ s/\s+/ /; | |
1261 | next if (!$clause); | |
1262 | $level-- if ($clause =~ m/(\})/ && $level > 1); | |
1263 | if (!($clause =~ m/^\s*#/)) { | |
1264 | $declaration .= "\t" x $level; | |
1265 | } | |
1266 | $declaration .= "\t" . $clause . "\n"; | |
1267 | $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/)); | |
1268 | } | |
1269 | output_declaration($declaration_name, | |
1270 | 'struct', | |
1271 | {'struct' => $declaration_name, | |
1272 | 'module' => $modulename, | |
1273 | 'definition' => $declaration, | |
1274 | 'parameterlist' => \@parameterlist, | |
1275 | 'parameterdescs' => \%parameterdescs, | |
1276 | 'parametertypes' => \%parametertypes, | |
1277 | 'sectionlist' => \@sectionlist, | |
1278 | 'sections' => \%sections, | |
1279 | 'purpose' => $declaration_purpose, | |
1280 | 'type' => $decl_type | |
1281 | }); | |
1282 | } else { | |
1283 | print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; | |
1284 | ++$errors; | |
1da177e4 LT |
1285 | } |
1286 | } | |
1287 | ||
85afe608 MCC |
1288 | |
1289 | sub show_warnings($$) { | |
af404fb1 VN |
1290 | my $functype = shift; |
1291 | my $name = shift; | |
1292 | ||
1293 | return 0 if (defined($nosymbol_table{$name})); | |
1294 | ||
1295 | return 1 if ($output_selection == OUTPUT_ALL); | |
1296 | ||
1297 | if ($output_selection == OUTPUT_EXPORTED) { | |
1298 | if (defined($function_table{$name})) { | |
1299 | return 1; | |
1300 | } else { | |
1301 | return 0; | |
1302 | } | |
1303 | } | |
1304 | if ($output_selection == OUTPUT_INTERNAL) { | |
1305 | if (!($functype eq "function" && defined($function_table{$name}))) { | |
1306 | return 1; | |
1307 | } else { | |
1308 | return 0; | |
1309 | } | |
1310 | } | |
1311 | if ($output_selection == OUTPUT_INCLUDE) { | |
1312 | if (defined($function_table{$name})) { | |
1313 | return 1; | |
1314 | } else { | |
1315 | return 0; | |
1316 | } | |
1317 | } | |
1318 | die("Please add the new output type at show_warnings()"); | |
85afe608 MCC |
1319 | } |
1320 | ||
1da177e4 LT |
1321 | sub dump_enum($$) { |
1322 | my $x = shift; | |
1323 | my $file = shift; | |
d38c8cfb MCC |
1324 | my $members; |
1325 | ||
e27cb89a JK |
1326 | # ignore members marked private: |
1327 | $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; | |
1328 | $x =~ s/\/\*\s*private:.*}/}/gosi; | |
1da177e4 | 1329 | |
aeec46b9 | 1330 | $x =~ s@/\*.*?\*/@@gos; # strip comments. |
4468e21e | 1331 | # strip #define macros inside enums |
8e93cb78 | 1332 | $x =~ s@#\s*((define|ifdef|if)\s+|endif)[^;]*;@@gos; |
b6d676db | 1333 | |
d38c8cfb | 1334 | if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) { |
af404fb1 VN |
1335 | $declaration_name = $2; |
1336 | $members = $1; | |
d38c8cfb | 1337 | } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) { |
af404fb1 VN |
1338 | $declaration_name = $1; |
1339 | $members = $2; | |
d38c8cfb MCC |
1340 | } |
1341 | ||
ae5b17e4 | 1342 | if ($members) { |
af404fb1 VN |
1343 | if ($identifier ne $declaration_name) { |
1344 | if ($identifier eq "") { | |
1345 | emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n"); | |
1346 | } else { | |
1347 | emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n"); | |
1348 | } | |
1349 | return; | |
1350 | } | |
1351 | $declaration_name = "(anonymous)" if ($declaration_name eq ""); | |
1352 | ||
1353 | my %_members; | |
1354 | ||
1355 | $members =~ s/\s+$//; | |
1356 | $members =~ s/\([^;]*?[\)]//g; | |
1357 | ||
1358 | foreach my $arg (split ',', $members) { | |
1359 | $arg =~ s/^\s*(\w+).*/$1/; | |
1360 | push @parameterlist, $arg; | |
1361 | if (!$parameterdescs{$arg}) { | |
1362 | $parameterdescs{$arg} = $undescribed; | |
1363 | if (show_warnings("enum", $declaration_name)) { | |
1364 | emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n"); | |
1365 | } | |
1366 | } | |
1367 | $_members{$arg} = 1; | |
1368 | } | |
1369 | ||
1370 | while (my ($k, $v) = each %parameterdescs) { | |
1371 | if (!exists($_members{$k})) { | |
1372 | if (show_warnings("enum", $declaration_name)) { | |
1373 | emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n"); | |
1374 | } | |
1375 | } | |
1376 | } | |
1377 | ||
1378 | output_declaration($declaration_name, | |
1379 | 'enum', | |
1380 | {'enum' => $declaration_name, | |
1381 | 'module' => $modulename, | |
1382 | 'parameterlist' => \@parameterlist, | |
1383 | 'parameterdescs' => \%parameterdescs, | |
1384 | 'sectionlist' => \@sectionlist, | |
1385 | 'sections' => \%sections, | |
1386 | 'purpose' => $declaration_purpose | |
1387 | }); | |
d38c8cfb | 1388 | } else { |
af404fb1 VN |
1389 | print STDERR "${file}:$.: error: Cannot parse enum!\n"; |
1390 | ++$errors; | |
1da177e4 LT |
1391 | } |
1392 | } | |
1393 | ||
7d2c6b1e | 1394 | my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x; |
7efc6c42 MCC |
1395 | my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x; |
1396 | my $typedef_args = qr { \s*\((.*)\); }x; | |
1397 | ||
1398 | my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x; | |
1399 | my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x; | |
1400 | ||
1da177e4 LT |
1401 | sub dump_typedef($$) { |
1402 | my $x = shift; | |
1403 | my $file = shift; | |
1404 | ||
aeec46b9 | 1405 | $x =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4 | 1406 | |
7efc6c42 MCC |
1407 | # Parse function typedef prototypes |
1408 | if ($x =~ $typedef1 || $x =~ $typedef2) { | |
af404fb1 VN |
1409 | $return_type = $1; |
1410 | $declaration_name = $2; | |
1411 | my $args = $3; | |
1412 | $return_type =~ s/^\s+//; | |
1413 | ||
1414 | if ($identifier ne $declaration_name) { | |
1415 | emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n"); | |
1416 | return; | |
1417 | } | |
1418 | ||
1419 | create_parameterlist($args, ',', $file, $declaration_name); | |
1420 | ||
1421 | output_declaration($declaration_name, | |
1422 | 'function', | |
1423 | {'function' => $declaration_name, | |
1424 | 'typedef' => 1, | |
1425 | 'module' => $modulename, | |
1426 | 'functiontype' => $return_type, | |
1427 | 'parameterlist' => \@parameterlist, | |
1428 | 'parameterdescs' => \%parameterdescs, | |
1429 | 'parametertypes' => \%parametertypes, | |
1430 | 'sectionlist' => \@sectionlist, | |
1431 | 'sections' => \%sections, | |
1432 | 'purpose' => $declaration_purpose | |
1433 | }); | |
1434 | return; | |
83766452 MCC |
1435 | } |
1436 | ||
1437 | while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { | |
af404fb1 VN |
1438 | $x =~ s/\(*.\)\s*;$/;/; |
1439 | $x =~ s/\[*.\]\s*;$/;/; | |
1da177e4 | 1440 | } |
83766452 MCC |
1441 | |
1442 | if ($x =~ /typedef.*\s+(\w+)\s*;/) { | |
af404fb1 | 1443 | $declaration_name = $1; |
3a80a766 | 1444 | |
af404fb1 VN |
1445 | if ($identifier ne $declaration_name) { |
1446 | emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n"); | |
1447 | return; | |
1448 | } | |
52042e2d | 1449 | |
af404fb1 VN |
1450 | output_declaration($declaration_name, |
1451 | 'typedef', | |
1452 | {'typedef' => $declaration_name, | |
1453 | 'module' => $modulename, | |
1454 | 'sectionlist' => \@sectionlist, | |
1455 | 'sections' => \%sections, | |
1456 | 'purpose' => $declaration_purpose | |
1457 | }); | |
1458 | } else { | |
1459 | print STDERR "${file}:$.: error: Cannot parse typedef!\n"; | |
1460 | ++$errors; | |
1da177e4 LT |
1461 | } |
1462 | } | |
1463 | ||
a1d94aa5 RD |
1464 | sub save_struct_actual($) { |
1465 | my $actual = shift; | |
1466 | ||
1467 | # strip all spaces from the actual param so that it looks like one string item | |
1468 | $actual =~ s/\s*//g; | |
1469 | $struct_actual = $struct_actual . $actual . " "; | |
1470 | } | |
1471 | ||
151c468b | 1472 | sub create_parameterlist($$$$) { |
1da177e4 LT |
1473 | my $args = shift; |
1474 | my $splitter = shift; | |
1475 | my $file = shift; | |
151c468b | 1476 | my $declaration_name = shift; |
1da177e4 LT |
1477 | my $type; |
1478 | my $param; | |
1479 | ||
a6d3fe77 | 1480 | # temporarily replace commas inside function pointer definition |
e86bdb24 AS |
1481 | my $arg_expr = qr{\([^\),]+}; |
1482 | while ($args =~ /$arg_expr,/) { | |
af404fb1 | 1483 | $args =~ s/($arg_expr),/$1#/g; |
1da177e4 | 1484 | } |
3c3b809e | 1485 | |
1da177e4 | 1486 | foreach my $arg (split($splitter, $args)) { |
af404fb1 VN |
1487 | # strip comments |
1488 | $arg =~ s/\/\*.*\*\///; | |
1489 | # ignore argument attributes | |
1490 | $arg =~ s/\sPOS0?\s/ /; | |
1491 | # strip leading/trailing spaces | |
1492 | $arg =~ s/^\s*//; | |
1493 | $arg =~ s/\s*$//; | |
1494 | $arg =~ s/\s+/ /; | |
1495 | ||
1496 | if ($arg =~ /^#/) { | |
1497 | # Treat preprocessor directive as a typeless variable just to fill | |
1498 | # corresponding data structures "correctly". Catch it later in | |
1499 | # output_* subs. | |
1500 | push_parameter($arg, "", "", $file); | |
1501 | } elsif ($arg =~ m/\(.+\)\s*\(/) { | |
1502 | # pointer-to-function | |
1503 | $arg =~ tr/#/,/; | |
1504 | $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/; | |
1505 | $param = $1; | |
1506 | $type = $arg; | |
1507 | $type =~ s/([^\(]+\(\*?)\s*$param/$1/; | |
1508 | save_struct_actual($param); | |
1509 | push_parameter($param, $type, $arg, $file, $declaration_name); | |
1510 | } elsif ($arg =~ m/\(.+\)\s*\[/) { | |
1511 | # array-of-pointers | |
1512 | $arg =~ tr/#/,/; | |
1513 | $arg =~ m/[^\(]+\(\s*\*\s*([\w\[\]\.]*?)\s*(\s*\[\s*[\w]+\s*\]\s*)*\)/; | |
1514 | $param = $1; | |
1515 | $type = $arg; | |
1516 | $type =~ s/([^\(]+\(\*?)\s*$param/$1/; | |
1517 | save_struct_actual($param); | |
1518 | push_parameter($param, $type, $arg, $file, $declaration_name); | |
1519 | } elsif ($arg) { | |
1520 | $arg =~ s/\s*:\s*/:/g; | |
1521 | $arg =~ s/\s*\[/\[/g; | |
1522 | ||
1523 | my @args = split('\s*,\s*', $arg); | |
1524 | if ($args[0] =~ m/\*/) { | |
1525 | $args[0] =~ s/(\*+)\s*/ $1/; | |
1526 | } | |
1527 | ||
1528 | my @first_arg; | |
1529 | if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { | |
1530 | shift @args; | |
1531 | push(@first_arg, split('\s+', $1)); | |
1532 | push(@first_arg, $2); | |
1533 | } else { | |
1534 | @first_arg = split('\s+', shift @args); | |
1535 | } | |
1536 | ||
1537 | unshift(@args, pop @first_arg); | |
1538 | $type = join " ", @first_arg; | |
1539 | ||
1540 | foreach $param (@args) { | |
1541 | if ($param =~ m/^(\*+)\s*(.*)/) { | |
1542 | save_struct_actual($2); | |
1543 | ||
1544 | push_parameter($2, "$type $1", $arg, $file, $declaration_name); | |
1545 | } elsif ($param =~ m/(.*?):(\d+)/) { | |
1546 | if ($type ne "") { # skip unnamed bit-fields | |
1547 | save_struct_actual($1); | |
1548 | push_parameter($1, "$type:$2", $arg, $file, $declaration_name) | |
1549 | } | |
1550 | } else { | |
1551 | save_struct_actual($param); | |
1552 | push_parameter($param, $type, $arg, $file, $declaration_name); | |
1553 | } | |
1554 | } | |
1555 | } | |
1da177e4 LT |
1556 | } |
1557 | } | |
1558 | ||
ed8348e2 | 1559 | sub push_parameter($$$$$) { |
af404fb1 VN |
1560 | my $param = shift; |
1561 | my $type = shift; | |
1562 | my $org_arg = shift; | |
1563 | my $file = shift; | |
1564 | my $declaration_name = shift; | |
1565 | ||
1566 | if (($anon_struct_union == 1) && ($type eq "") && | |
1567 | ($param eq "}")) { | |
1568 | return; # ignore the ending }; from anon. struct/union | |
1569 | } | |
1570 | ||
1571 | $anon_struct_union = 0; | |
1572 | $param =~ s/[\[\)].*//; | |
1573 | ||
1574 | if ($type eq "" && $param =~ /\.\.\.$/) | |
1575 | { | |
1576 | if (!$param =~ /\w\.\.\.$/) { | |
1577 | # handles unnamed variable parameters | |
1578 | $param = "..."; | |
1579 | } elsif ($param =~ /\w\.\.\.$/) { | |
1580 | # for named variable parameters of the form `x...`, remove the dots | |
1581 | $param =~ s/\.\.\.$//; | |
1582 | } | |
1583 | if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { | |
1584 | $parameterdescs{$param} = "variable arguments"; | |
1585 | } | |
1586 | } | |
1587 | elsif ($type eq "" && ($param eq "" or $param eq "void")) | |
1588 | { | |
1589 | $param="void"; | |
1590 | $parameterdescs{void} = "no arguments"; | |
1591 | } | |
1592 | elsif ($type eq "" && ($param eq "struct" or $param eq "union")) | |
1593 | # handle unnamed (anonymous) union or struct: | |
1594 | { | |
1595 | $type = $param; | |
1596 | $param = "{unnamed_" . $param . "}"; | |
1597 | $parameterdescs{$param} = "anonymous\n"; | |
1598 | $anon_struct_union = 1; | |
1599 | } | |
1600 | elsif ($param =~ "__cacheline_group" ) | |
1601 | # handle cache group enforcing variables: they do not need be described in header files | |
1602 | { | |
1603 | return; # ignore __cacheline_group_begin and __cacheline_group_end | |
1604 | } | |
1605 | ||
1606 | # warn if parameter has no description | |
1607 | # (but ignore ones starting with # as these are not parameters | |
1608 | # but inline preprocessor statements); | |
1609 | # Note: It will also ignore void params and unnamed structs/unions | |
1610 | if (!defined $parameterdescs{$param} && $param !~ /^#/) { | |
1611 | $parameterdescs{$param} = $undescribed; | |
1612 | ||
1613 | if (show_warnings($type, $declaration_name) && $param !~ /\./) { | |
1614 | emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n"); | |
1615 | } | |
1616 | } | |
1617 | ||
1618 | # strip spaces from $param so that it is one continuous string | |
1619 | # on @parameterlist; | |
1620 | # this fixes a problem where check_sections() cannot find | |
1621 | # a parameter like "addr[6 + 2]" because it actually appears | |
1622 | # as "addr[6", "+", "2]" on the parameter list; | |
1623 | # but it's better to maintain the param string unchanged for output, | |
1624 | # so just weaken the string compare in check_sections() to ignore | |
1625 | # "[blah" in a parameter string; | |
1626 | ###$param =~ s/\s*//g; | |
1627 | push @parameterlist, $param; | |
1628 | $org_arg =~ s/\s\s+/ /g; | |
1629 | $parametertypes{$param} = $org_arg; | |
1da177e4 LT |
1630 | } |
1631 | ||
1081de2d | 1632 | sub check_sections($$$$$) { |
af404fb1 VN |
1633 | my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_; |
1634 | my @sects = split ' ', $sectcheck; | |
1635 | my @prms = split ' ', $prmscheck; | |
1636 | my $err; | |
1637 | my ($px, $sx); | |
1638 | my $prm_clean; # strip trailing "[array size]" and/or beginning "*" | |
1639 | ||
1640 | foreach $sx (0 .. $#sects) { | |
1641 | $err = 1; | |
1642 | foreach $px (0 .. $#prms) { | |
1643 | $prm_clean = $prms[$px]; | |
1644 | $prm_clean =~ s/\[.*\]//; | |
1645 | $prm_clean =~ s/$attribute//i; | |
1646 | # ignore array size in a parameter string; | |
1647 | # however, the original param string may contain | |
1648 | # spaces, e.g.: addr[6 + 2] | |
1649 | # and this appears in @prms as "addr[6" since the | |
1650 | # parameter list is split at spaces; | |
1651 | # hence just ignore "[..." for the sections check; | |
1652 | $prm_clean =~ s/\[.*//; | |
1653 | ||
1654 | ##$prm_clean =~ s/^\**//; | |
1655 | if ($prm_clean eq $sects[$sx]) { | |
1656 | $err = 0; | |
1657 | last; | |
1658 | } | |
1659 | } | |
1660 | if ($err) { | |
1661 | if ($decl_type eq "function") { | |
1662 | emit_warning("${file}:$.", | |
1663 | "Excess function parameter " . | |
1664 | "'$sects[$sx]' " . | |
1665 | "description in '$decl_name'\n"); | |
1666 | } elsif (($decl_type eq "struct") or | |
1667 | ($decl_type eq "union")) { | |
1668 | emit_warning("${file}:$.", | |
1669 | "Excess $decl_type member " . | |
1670 | "'$sects[$sx]' " . | |
1671 | "description in '$decl_name'\n"); | |
1672 | } | |
1673 | } | |
1674 | } | |
a1d94aa5 RD |
1675 | } |
1676 | ||
4092bac7 YB |
1677 | ## |
1678 | # Checks the section describing the return value of a function. | |
1679 | sub check_return_section { | |
af404fb1 VN |
1680 | my $file = shift; |
1681 | my $declaration_name = shift; | |
1682 | my $return_type = shift; | |
4092bac7 | 1683 | |
af404fb1 VN |
1684 | # Ignore an empty return type (It's a macro) |
1685 | # Ignore functions with a "void" return type. (But don't ignore "void *") | |
1686 | if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { | |
1687 | return; | |
1688 | } | |
4092bac7 | 1689 | |
af404fb1 VN |
1690 | if (!defined($sections{$section_return}) || |
1691 | $sections{$section_return} eq "") | |
1692 | { | |
1693 | emit_warning("${file}:$.", | |
1694 | "No description found for return value of " . | |
1695 | "'$declaration_name'\n"); | |
1696 | } | |
4092bac7 YB |
1697 | } |
1698 | ||
1da177e4 LT |
1699 | ## |
1700 | # takes a function prototype and the name of the current file being | |
1701 | # processed and spits out all the details stored in the global | |
1702 | # arrays/hashes. | |
1703 | sub dump_function($$) { | |
1704 | my $prototype = shift; | |
1705 | my $file = shift; | |
cbb4d3e6 | 1706 | my $noret = 0; |
1da177e4 | 1707 | |
5ef09c96 | 1708 | print_lineno($new_start_line); |
5eb6b4b3 | 1709 | |
1da177e4 LT |
1710 | $prototype =~ s/^static +//; |
1711 | $prototype =~ s/^extern +//; | |
4dc3b16b | 1712 | $prototype =~ s/^asmlinkage +//; |
1da177e4 LT |
1713 | $prototype =~ s/^inline +//; |
1714 | $prototype =~ s/^__inline__ +//; | |
32e79401 RD |
1715 | $prototype =~ s/^__inline +//; |
1716 | $prototype =~ s/^__always_inline +//; | |
1717 | $prototype =~ s/^noinline +//; | |
03699f27 | 1718 | $prototype =~ s/^__FORTIFY_INLINE +//; |
74fc5c65 | 1719 | $prototype =~ s/__init +//; |
20072205 | 1720 | $prototype =~ s/__init_or_module +//; |
80342d48 | 1721 | $prototype =~ s/__deprecated +//; |
084aa001 | 1722 | $prototype =~ s/__flatten +//; |
270a0096 | 1723 | $prototype =~ s/__meminit +//; |
70c95b00 | 1724 | $prototype =~ s/__must_check +//; |
0df7c0e3 | 1725 | $prototype =~ s/__weak +//; |
0891f959 | 1726 | $prototype =~ s/__sched +//; |
95e760cb | 1727 | $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; |
03699f27 KC |
1728 | $prototype =~ s/__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//; |
1729 | $prototype =~ s/__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +//; | |
cbb4d3e6 | 1730 | my $define = $prototype =~ s/^#\s*define\s+//; #ak added |
084aa001 | 1731 | $prototype =~ s/__attribute_const__ +//; |
b1aaa546 PB |
1732 | $prototype =~ s/__attribute__\s*\(\( |
1733 | (?: | |
1734 | [\w\s]++ # attribute name | |
1735 | (?:\([^)]*+\))? # attribute arguments | |
1736 | \s*+,? # optional comma at the end | |
1737 | )+ | |
1738 | \)\)\s+//x; | |
1da177e4 LT |
1739 | |
1740 | # Yes, this truly is vile. We are looking for: | |
1741 | # 1. Return type (may be nothing if we're looking at a macro) | |
1742 | # 2. Function name | |
1743 | # 3. Function parameters. | |
1744 | # | |
1745 | # All the while we have to watch out for function pointer parameters | |
1746 | # (which IIRC is what the two sections are for), C types (these | |
1747 | # regexps don't even start to express all the possibilities), and | |
1748 | # so on. | |
1749 | # | |
1750 | # If you mess with these regexps, it's a good idea to check that | |
1751 | # the following functions' documentation still comes out right: | |
1752 | # - parport_register_device (function pointer parameters) | |
1753 | # - atomic_set (macro) | |
9598f91f | 1754 | # - pci_match_device, __copy_to_user (long return type) |
e86bdb24 AS |
1755 | my $name = qr{[a-zA-Z0-9_~:]+}; |
1756 | my $prototype_end1 = qr{[^\(]*}; | |
1757 | my $prototype_end2 = qr{[^\{]*}; | |
1758 | my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)}; | |
1759 | my $type1 = qr{[\w\s]+}; | |
1760 | my $type2 = qr{$type1\*+}; | |
1761 | ||
1762 | if ($define && $prototype =~ m/^()($name)\s+/) { | |
cbb4d3e6 HG |
1763 | # This is an object-like macro, it has no return type and no parameter |
1764 | # list. | |
1765 | # Function-like macros are not allowed to have spaces between | |
1766 | # declaration_name and opening parenthesis (notice the \s+). | |
1767 | $return_type = $1; | |
1768 | $declaration_name = $2; | |
1769 | $noret = 1; | |
e86bdb24 | 1770 | } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ || |
af404fb1 VN |
1771 | $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ || |
1772 | $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) { | |
1773 | $return_type = $1; | |
1774 | $declaration_name = $2; | |
1775 | my $args = $3; | |
1da177e4 | 1776 | |
af404fb1 | 1777 | create_parameterlist($args, ',', $file, $declaration_name); |
1da177e4 | 1778 | } else { |
af404fb1 VN |
1779 | emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n"); |
1780 | return; | |
1da177e4 LT |
1781 | } |
1782 | ||
52042e2d | 1783 | if ($identifier ne $declaration_name) { |
af404fb1 VN |
1784 | emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n"); |
1785 | return; | |
52042e2d MCC |
1786 | } |
1787 | ||
47bcacfd MCC |
1788 | my $prms = join " ", @parameterlist; |
1789 | check_sections($file, $declaration_name, "function", $sectcheck, $prms); | |
1790 | ||
1791 | # This check emits a lot of warnings at the moment, because many | |
1792 | # functions don't have a 'Return' doc section. So until the number | |
1793 | # of warnings goes sufficiently down, the check is only performed in | |
56b0f453 | 1794 | # -Wreturn mode. |
47bcacfd | 1795 | # TODO: always perform the check. |
56b0f453 | 1796 | if ($Wreturn && !$noret) { |
af404fb1 | 1797 | check_return_section($file, $declaration_name, $return_type); |
47bcacfd | 1798 | } |
4092bac7 | 1799 | |
47bcacfd MCC |
1800 | # The function parser can be called with a typedef parameter. |
1801 | # Handle it. | |
1802 | if ($return_type =~ /typedef/) { | |
af404fb1 VN |
1803 | output_declaration($declaration_name, |
1804 | 'function', | |
1805 | {'function' => $declaration_name, | |
1806 | 'typedef' => 1, | |
1807 | 'module' => $modulename, | |
1808 | 'functiontype' => $return_type, | |
1809 | 'parameterlist' => \@parameterlist, | |
1810 | 'parameterdescs' => \%parameterdescs, | |
1811 | 'parametertypes' => \%parametertypes, | |
1812 | 'sectionlist' => \@sectionlist, | |
1813 | 'sections' => \%sections, | |
1814 | 'purpose' => $declaration_purpose | |
1815 | }); | |
47bcacfd | 1816 | } else { |
af404fb1 VN |
1817 | output_declaration($declaration_name, |
1818 | 'function', | |
1819 | {'function' => $declaration_name, | |
1820 | 'module' => $modulename, | |
1821 | 'functiontype' => $return_type, | |
1822 | 'parameterlist' => \@parameterlist, | |
1823 | 'parameterdescs' => \%parameterdescs, | |
1824 | 'parametertypes' => \%parametertypes, | |
1825 | 'sectionlist' => \@sectionlist, | |
1826 | 'sections' => \%sections, | |
1827 | 'purpose' => $declaration_purpose | |
1828 | }); | |
47bcacfd | 1829 | } |
1da177e4 LT |
1830 | } |
1831 | ||
1da177e4 LT |
1832 | sub reset_state { |
1833 | $function = ""; | |
1da177e4 LT |
1834 | %parameterdescs = (); |
1835 | %parametertypes = (); | |
1836 | @parameterlist = (); | |
1837 | %sections = (); | |
1838 | @sectionlist = (); | |
a1d94aa5 RD |
1839 | $sectcheck = ""; |
1840 | $struct_actual = ""; | |
1da177e4 | 1841 | $prototype = ""; |
3c3b809e | 1842 | |
48af606a JN |
1843 | $state = STATE_NORMAL; |
1844 | $inline_doc_state = STATE_INLINE_NA; | |
1da177e4 LT |
1845 | } |
1846 | ||
56afb0f8 | 1847 | sub tracepoint_munge($) { |
af404fb1 VN |
1848 | my $file = shift; |
1849 | my $tracepointname = 0; | |
1850 | my $tracepointargs = 0; | |
1851 | ||
1852 | if ($prototype =~ m/TRACE_EVENT\((.*?),/) { | |
1853 | $tracepointname = $1; | |
1854 | } | |
1855 | if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { | |
1856 | $tracepointname = $1; | |
1857 | } | |
1858 | if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { | |
1859 | $tracepointname = $2; | |
1860 | } | |
1861 | $tracepointname =~ s/^\s+//; #strip leading whitespace | |
1862 | if ($prototype =~ m/TP_PROTO\((.*?)\)/) { | |
1863 | $tracepointargs = $1; | |
1864 | } | |
1865 | if (($tracepointname eq 0) || ($tracepointargs eq 0)) { | |
1866 | emit_warning("${file}:$.", "Unrecognized tracepoint format: \n". | |
1867 | "$prototype\n"); | |
1868 | } else { | |
1869 | $prototype = "static inline void trace_$tracepointname($tracepointargs)"; | |
1870 | $identifier = "trace_$identifier"; | |
1871 | } | |
56afb0f8 JB |
1872 | } |
1873 | ||
b4870bc5 | 1874 | sub syscall_munge() { |
af404fb1 VN |
1875 | my $void = 0; |
1876 | ||
1877 | $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's | |
1878 | ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { | |
1879 | if ($prototype =~ m/SYSCALL_DEFINE0/) { | |
1880 | $void = 1; | |
1881 | ## $prototype = "long sys_$1(void)"; | |
1882 | } | |
1883 | ||
1884 | $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name | |
1885 | if ($prototype =~ m/long (sys_.*?),/) { | |
1886 | $prototype =~ s/,/\(/; | |
1887 | } elsif ($void) { | |
1888 | $prototype =~ s/\)/\(void\)/; | |
1889 | } | |
1890 | ||
1891 | # now delete all of the odd-number commas in $prototype | |
1892 | # so that arg types & arg names don't have a comma between them | |
1893 | my $count = 0; | |
1894 | my $len = length($prototype); | |
1895 | if ($void) { | |
1896 | $len = 0; # skip the for-loop | |
1897 | } | |
1898 | for (my $ix = 0; $ix < $len; $ix++) { | |
1899 | if (substr($prototype, $ix, 1) eq ',') { | |
1900 | $count++; | |
1901 | if ($count % 2 == 1) { | |
1902 | substr($prototype, $ix, 1) = ' '; | |
1903 | } | |
1904 | } | |
1905 | } | |
b4870bc5 RD |
1906 | } |
1907 | ||
b7afa92b | 1908 | sub process_proto_function($$) { |
1da177e4 LT |
1909 | my $x = shift; |
1910 | my $file = shift; | |
1911 | ||
51f5a0c8 RD |
1912 | $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
1913 | ||
d2a70e28 | 1914 | if ($x =~ /^#/ && $x !~ /^#\s*define/) { |
af404fb1 VN |
1915 | # do nothing |
1916 | } elsif ($x =~ /([^\{]*)/) { | |
1917 | $prototype .= $1; | |
1da177e4 | 1918 | } |
b4870bc5 | 1919 | |
890c78c2 | 1920 | if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { |
af404fb1 VN |
1921 | $prototype =~ s@/\*.*?\*/@@gos; # strip comments. |
1922 | $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. | |
1923 | $prototype =~ s@^\s+@@gos; # strip leading spaces | |
7ae281b0 | 1924 | |
af404fb1 VN |
1925 | # Handle prototypes for function pointers like: |
1926 | # int (*pcs_config)(struct foo) | |
1927 | $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos; | |
7ae281b0 | 1928 | |
af404fb1 VN |
1929 | if ($prototype =~ /SYSCALL_DEFINE/) { |
1930 | syscall_munge(); | |
1931 | } | |
1932 | if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || | |
1933 | $prototype =~ /DEFINE_SINGLE_EVENT/) | |
1934 | { | |
1935 | tracepoint_munge($file); | |
1936 | } | |
1937 | dump_function($prototype, $file); | |
1938 | reset_state(); | |
1da177e4 LT |
1939 | } |
1940 | } | |
1941 | ||
b7afa92b | 1942 | sub process_proto_type($$) { |
1da177e4 LT |
1943 | my $x = shift; |
1944 | my $file = shift; | |
1945 | ||
1da177e4 LT |
1946 | $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. |
1947 | $x =~ s@^\s+@@gos; # strip leading spaces | |
1948 | $x =~ s@\s+$@@gos; # strip trailing spaces | |
51f5a0c8 RD |
1949 | $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
1950 | ||
1da177e4 | 1951 | if ($x =~ /^#/) { |
af404fb1 VN |
1952 | # To distinguish preprocessor directive from regular declaration later. |
1953 | $x .= ";"; | |
1da177e4 LT |
1954 | } |
1955 | ||
1956 | while (1) { | |
af404fb1 | 1957 | if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) { |
463a0fdc MH |
1958 | if( length $prototype ) { |
1959 | $prototype .= " " | |
1960 | } | |
af404fb1 VN |
1961 | $prototype .= $1 . $2; |
1962 | ($2 eq '{') && $brcount++; | |
1963 | ($2 eq '}') && $brcount--; | |
1964 | if (($2 eq ';') && ($brcount == 0)) { | |
1965 | dump_declaration($prototype, $file); | |
1966 | reset_state(); | |
1967 | last; | |
1968 | } | |
1969 | $x = $3; | |
1970 | } else { | |
1971 | $prototype .= $x; | |
1972 | last; | |
1973 | } | |
1da177e4 LT |
1974 | } |
1975 | } | |
1976 | ||
6b5b55f6 | 1977 | |
1ad560e4 | 1978 | sub map_filename($) { |
2283a117 | 1979 | my $file; |
68f86662 | 1980 | my ($orig_file) = @_; |
1da177e4 | 1981 | |
2283a117 | 1982 | if (defined($ENV{'SRCTREE'})) { |
af404fb1 | 1983 | $file = "$ENV{'SRCTREE'}" . "/" . $orig_file; |
1ad560e4 | 1984 | } else { |
af404fb1 | 1985 | $file = $orig_file; |
2283a117 | 1986 | } |
1ad560e4 | 1987 | |
1da177e4 | 1988 | if (defined($source_map{$file})) { |
af404fb1 | 1989 | $file = $source_map{$file}; |
1da177e4 LT |
1990 | } |
1991 | ||
1ad560e4 JN |
1992 | return $file; |
1993 | } | |
1994 | ||
88c2b57d JN |
1995 | sub process_export_file($) { |
1996 | my ($orig_file) = @_; | |
1997 | my $file = map_filename($orig_file); | |
1998 | ||
1999 | if (!open(IN,"<$file")) { | |
af404fb1 VN |
2000 | print STDERR "Error: Cannot open file $file\n"; |
2001 | ++$errors; | |
2002 | return; | |
88c2b57d JN |
2003 | } |
2004 | ||
2005 | while (<IN>) { | |
af404fb1 VN |
2006 | if (/$export_symbol/) { |
2007 | next if (defined($nosymbol_table{$2})); | |
2008 | $function_table{$2} = 1; | |
2009 | } | |
2010 | if (/$export_symbol_ns/) { | |
2011 | next if (defined($nosymbol_table{$2})); | |
2012 | $function_table{$2} = 1; | |
2013 | } | |
88c2b57d JN |
2014 | } |
2015 | ||
2016 | close(IN); | |
2017 | } | |
2018 | ||
07048d13 JC |
2019 | # |
2020 | # Parsers for the various processing states. | |
2021 | # | |
2022 | # STATE_NORMAL: looking for the /** to begin everything. | |
2023 | # | |
2024 | sub process_normal() { | |
2025 | if (/$doc_start/o) { | |
af404fb1 VN |
2026 | $state = STATE_NAME; # next line is always the function name |
2027 | $in_doc_sect = 0; | |
2028 | $declaration_start_line = $. + 1; | |
07048d13 JC |
2029 | } |
2030 | } | |
2031 | ||
3cac2bc4 JC |
2032 | # |
2033 | # STATE_NAME: Looking for the "name - description" line | |
2034 | # | |
2035 | sub process_name($$) { | |
2036 | my $file = shift; | |
1ad560e4 | 2037 | my $descr; |
3cac2bc4 JC |
2038 | |
2039 | if (/$doc_block/o) { | |
af404fb1 VN |
2040 | $state = STATE_DOCBLOCK; |
2041 | $contents = ""; | |
2042 | $new_start_line = $.; | |
2043 | ||
2044 | if ( $1 eq "" ) { | |
2045 | $section = $section_intro; | |
2046 | } else { | |
2047 | $section = $1; | |
2048 | } | |
52042e2d | 2049 | } elsif (/$doc_decl/o) { |
af404fb1 VN |
2050 | $identifier = $1; |
2051 | my $is_kernel_comment = 0; | |
2052 | my $decl_start = qr{$doc_com}; | |
2053 | # test for pointer declaration type, foo * bar() - desc | |
2054 | my $fn_type = qr{\w+\s*\*\s*}; | |
2055 | my $parenthesis = qr{\(\w*\)}; | |
2056 | my $decl_end = qr{[-:].*}; | |
2057 | if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) { | |
2058 | $identifier = $1; | |
2059 | } | |
2060 | if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) { | |
2061 | $decl_type = $1; | |
2062 | $identifier = $2; | |
2063 | $is_kernel_comment = 1; | |
2064 | } | |
2065 | # Look for foo() or static void foo() - description; or misspelt | |
2066 | # identifier | |
2067 | elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ || | |
2068 | /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) { | |
2069 | $identifier = $1; | |
2070 | $decl_type = 'function'; | |
2071 | $identifier =~ s/^define\s+//; | |
2072 | $is_kernel_comment = 1; | |
2073 | } | |
2074 | $identifier =~ s/\s+$//; | |
2075 | ||
2076 | $state = STATE_BODY; | |
2077 | # if there's no @param blocks need to set up default section | |
2078 | # here | |
2079 | $contents = ""; | |
2080 | $section = $section_default; | |
2081 | $new_start_line = $. + 1; | |
2082 | if (/[-:](.*)/) { | |
2083 | # strip leading/trailing/multiple spaces | |
2084 | $descr= $1; | |
2085 | $descr =~ s/^\s*//; | |
2086 | $descr =~ s/\s*$//; | |
2087 | $descr =~ s/\s+/ /g; | |
2088 | $declaration_purpose = $descr; | |
2089 | $state = STATE_BODY_MAYBE; | |
2090 | } else { | |
2091 | $declaration_purpose = ""; | |
2092 | } | |
2093 | ||
2094 | if (!$is_kernel_comment) { | |
2095 | emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_"); | |
2096 | $state = STATE_NORMAL; | |
2097 | } | |
2098 | ||
2099 | if (($declaration_purpose eq "") && $Wshort_desc) { | |
2100 | emit_warning("${file}:$.", "missing initial short description on line:\n$_"); | |
2101 | } | |
2102 | ||
2103 | if ($identifier eq "" && $decl_type ne "enum") { | |
2104 | emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_"); | |
2105 | $state = STATE_NORMAL; | |
2106 | } | |
2107 | ||
2108 | if ($verbose) { | |
2109 | print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n"; | |
2110 | } | |
3cac2bc4 | 2111 | } else { |
af404fb1 VN |
2112 | emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n"); |
2113 | $state = STATE_NORMAL; | |
3cac2bc4 JC |
2114 | } |
2115 | } | |
07048d13 | 2116 | |
d742f24d JC |
2117 | |
2118 | # | |
2119 | # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. | |
2120 | # | |
2121 | sub process_body($$) { | |
2122 | my $file = shift; | |
2123 | ||
0d55d48b | 2124 | if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) { |
af404fb1 VN |
2125 | dump_section($file, $section, $contents); |
2126 | $section = $section_default; | |
2127 | $new_start_line = $.; | |
2128 | $contents = ""; | |
0d55d48b MCC |
2129 | } |
2130 | ||
d742f24d | 2131 | if (/$doc_sect/i) { # case insensitive for supported section names |
af404fb1 VN |
2132 | $in_doc_sect = 1; |
2133 | $newsection = $1; | |
2134 | $newcontents = $2; | |
2135 | ||
2136 | # map the supported section names to the canonical names | |
2137 | if ($newsection =~ m/^description$/i) { | |
2138 | $newsection = $section_default; | |
2139 | } elsif ($newsection =~ m/^context$/i) { | |
2140 | $newsection = $section_context; | |
2141 | } elsif ($newsection =~ m/^returns?$/i) { | |
2142 | $newsection = $section_return; | |
2143 | } elsif ($newsection =~ m/^\@return$/) { | |
2144 | # special: @return is a section, not a param description | |
2145 | $newsection = $section_return; | |
2146 | } | |
2147 | ||
2148 | if (($contents ne "") && ($contents ne "\n")) { | |
2149 | if (!$in_doc_sect && $Wcontents_before_sections) { | |
2150 | emit_warning("${file}:$.", "contents before sections\n"); | |
2151 | } | |
2152 | dump_section($file, $section, $contents); | |
2153 | $section = $section_default; | |
2154 | } | |
2155 | ||
2156 | $in_doc_sect = 1; | |
2157 | $state = STATE_BODY; | |
2158 | $contents = $newcontents; | |
2159 | $new_start_line = $.; | |
2160 | while (substr($contents, 0, 1) eq " ") { | |
2161 | $contents = substr($contents, 1); | |
2162 | } | |
2163 | if ($contents ne "") { | |
2164 | $contents .= "\n"; | |
2165 | } | |
2166 | $section = $newsection; | |
2167 | $leading_space = undef; | |
d742f24d | 2168 | } elsif (/$doc_end/) { |
af404fb1 VN |
2169 | if (($contents ne "") && ($contents ne "\n")) { |
2170 | dump_section($file, $section, $contents); | |
2171 | $section = $section_default; | |
2172 | $contents = ""; | |
2173 | } | |
2174 | # look for doc_com + <text> + doc_end: | |
2175 | if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { | |
2176 | emit_warning("${file}:$.", "suspicious ending line: $_"); | |
2177 | } | |
2178 | ||
2179 | $prototype = ""; | |
2180 | $state = STATE_PROTO; | |
2181 | $brcount = 0; | |
5ef09c96 | 2182 | $new_start_line = $. + 1; |
d742f24d | 2183 | } elsif (/$doc_content/) { |
af404fb1 VN |
2184 | if ($1 eq "") { |
2185 | if ($section eq $section_context) { | |
2186 | dump_section($file, $section, $contents); | |
2187 | $section = $section_default; | |
2188 | $contents = ""; | |
2189 | $new_start_line = $.; | |
2190 | $state = STATE_BODY; | |
2191 | } else { | |
2192 | if ($section ne $section_default) { | |
2193 | $state = STATE_BODY_WITH_BLANK_LINE; | |
2194 | } else { | |
2195 | $state = STATE_BODY; | |
2196 | } | |
2197 | $contents .= "\n"; | |
2198 | } | |
2199 | } elsif ($state == STATE_BODY_MAYBE) { | |
2200 | # Continued declaration purpose | |
2201 | chomp($declaration_purpose); | |
2202 | $declaration_purpose .= " " . $1; | |
2203 | $declaration_purpose =~ s/\s+/ /g; | |
2204 | } else { | |
2205 | my $cont = $1; | |
2206 | if ($section =~ m/^@/ || $section eq $section_context) { | |
2207 | if (!defined $leading_space) { | |
2208 | if ($cont =~ m/^(\s+)/) { | |
2209 | $leading_space = $1; | |
2210 | } else { | |
2211 | $leading_space = ""; | |
2212 | } | |
2213 | } | |
2214 | $cont =~ s/^$leading_space//; | |
2215 | } | |
2216 | $contents .= $cont . "\n"; | |
2217 | } | |
d742f24d | 2218 | } else { |
af404fb1 VN |
2219 | # i dont know - bad line? ignore. |
2220 | emit_warning("${file}:$.", "bad line: $_"); | |
d742f24d JC |
2221 | } |
2222 | } | |
2223 | ||
2224 | ||
cc794812 JC |
2225 | # |
2226 | # STATE_PROTO: reading a function/whatever prototype. | |
2227 | # | |
2228 | sub process_proto($$) { | |
2229 | my $file = shift; | |
2230 | ||
2231 | if (/$doc_inline_oneline/) { | |
af404fb1 VN |
2232 | $section = $1; |
2233 | $contents = $2; | |
2234 | if ($contents ne "") { | |
2235 | $contents .= "\n"; | |
2236 | dump_section($file, $section, $contents); | |
2237 | $section = $section_default; | |
2238 | $contents = ""; | |
2239 | } | |
cc794812 | 2240 | } elsif (/$doc_inline_start/) { |
af404fb1 VN |
2241 | $state = STATE_INLINE; |
2242 | $inline_doc_state = STATE_INLINE_NAME; | |
cc794812 | 2243 | } elsif ($decl_type eq 'function') { |
af404fb1 | 2244 | process_proto_function($_, $file); |
cc794812 | 2245 | } else { |
af404fb1 | 2246 | process_proto_type($_, $file); |
cc794812 JC |
2247 | } |
2248 | } | |
2249 | ||
c17add56 JC |
2250 | # |
2251 | # STATE_DOCBLOCK: within a DOC: block. | |
2252 | # | |
2253 | sub process_docblock($$) { | |
2254 | my $file = shift; | |
2255 | ||
2256 | if (/$doc_end/) { | |
af404fb1 VN |
2257 | dump_doc_section($file, $section, $contents); |
2258 | $section = $section_default; | |
2259 | $contents = ""; | |
2260 | $function = ""; | |
2261 | %parameterdescs = (); | |
2262 | %parametertypes = (); | |
2263 | @parameterlist = (); | |
2264 | %sections = (); | |
2265 | @sectionlist = (); | |
2266 | $prototype = ""; | |
2267 | $state = STATE_NORMAL; | |
c17add56 | 2268 | } elsif (/$doc_content/) { |
af404fb1 VN |
2269 | if ( $1 eq "" ) { |
2270 | $contents .= $blankline; | |
2271 | } else { | |
2272 | $contents .= $1 . "\n"; | |
2273 | } | |
c17add56 JC |
2274 | } |
2275 | } | |
2276 | ||
2277 | # | |
2278 | # STATE_INLINE: docbook comments within a prototype. | |
2279 | # | |
2280 | sub process_inline($$) { | |
2281 | my $file = shift; | |
2282 | ||
2283 | # First line (state 1) needs to be a @parameter | |
2284 | if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { | |
af404fb1 VN |
2285 | $section = $1; |
2286 | $contents = $2; | |
2287 | $new_start_line = $.; | |
2288 | if ($contents ne "") { | |
2289 | while (substr($contents, 0, 1) eq " ") { | |
2290 | $contents = substr($contents, 1); | |
2291 | } | |
2292 | $contents .= "\n"; | |
2293 | } | |
2294 | $inline_doc_state = STATE_INLINE_TEXT; | |
2295 | # Documentation block end */ | |
c17add56 | 2296 | } elsif (/$doc_inline_end/) { |
af404fb1 VN |
2297 | if (($contents ne "") && ($contents ne "\n")) { |
2298 | dump_section($file, $section, $contents); | |
2299 | $section = $section_default; | |
2300 | $contents = ""; | |
2301 | } | |
2302 | $state = STATE_PROTO; | |
2303 | $inline_doc_state = STATE_INLINE_NA; | |
2304 | # Regular text | |
c17add56 | 2305 | } elsif (/$doc_content/) { |
af404fb1 VN |
2306 | if ($inline_doc_state == STATE_INLINE_TEXT) { |
2307 | $contents .= $1 . "\n"; | |
2308 | # nuke leading blank lines | |
2309 | if ($contents =~ /^\s*$/) { | |
2310 | $contents = ""; | |
2311 | } | |
2312 | } elsif ($inline_doc_state == STATE_INLINE_NAME) { | |
2313 | $inline_doc_state = STATE_INLINE_ERROR; | |
2314 | emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_"); | |
2315 | } | |
c17add56 JC |
2316 | } |
2317 | } | |
2318 | ||
cc794812 | 2319 | |
1ad560e4 JN |
2320 | sub process_file($) { |
2321 | my $file; | |
1ad560e4 JN |
2322 | my $initial_section_counter = $section_counter; |
2323 | my ($orig_file) = @_; | |
1ad560e4 JN |
2324 | |
2325 | $file = map_filename($orig_file); | |
2326 | ||
dbe8ba00 | 2327 | if (!open(IN_FILE,"<$file")) { |
af404fb1 VN |
2328 | print STDERR "Error: Cannot open file $file\n"; |
2329 | ++$errors; | |
2330 | return; | |
1da177e4 LT |
2331 | } |
2332 | ||
a9e7314b ID |
2333 | $. = 1; |
2334 | ||
1da177e4 | 2335 | $section_counter = 0; |
dbe8ba00 | 2336 | while (<IN_FILE>) { |
af404fb1 VN |
2337 | while (!/^ \*/ && s/\\\s*$//) { |
2338 | $_ .= <IN_FILE>; | |
2339 | } | |
2340 | # Replace tabs by spaces | |
7c9aa015 | 2341 | while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; |
af404fb1 VN |
2342 | # Hand this line to the appropriate state handler |
2343 | if ($state == STATE_NORMAL) { | |
2344 | process_normal(); | |
2345 | } elsif ($state == STATE_NAME) { | |
2346 | process_name($file, $_); | |
2347 | } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE || | |
2348 | $state == STATE_BODY_WITH_BLANK_LINE) { | |
2349 | process_body($file, $_); | |
2350 | } elsif ($state == STATE_INLINE) { # scanning for inline parameters | |
2351 | process_inline($file, $_); | |
2352 | } elsif ($state == STATE_PROTO) { | |
2353 | process_proto($file, $_); | |
2354 | } elsif ($state == STATE_DOCBLOCK) { | |
2355 | process_docblock($file, $_); | |
2356 | } | |
1da177e4 | 2357 | } |
c17add56 JC |
2358 | |
2359 | # Make sure we got something interesting. | |
b0d60bfb | 2360 | if ($initial_section_counter == $section_counter && $ |
af404fb1 VN |
2361 | output_mode ne "none") { |
2362 | if ($output_selection == OUTPUT_INCLUDE) { | |
2363 | emit_warning("${file}:1", "'$_' not found\n") | |
2364 | for keys %function_table; | |
2365 | } else { | |
2366 | emit_warning("${file}:1", "no structured comments found\n"); | |
2367 | } | |
1da177e4 | 2368 | } |
dbe8ba00 | 2369 | close IN_FILE; |
1da177e4 | 2370 | } |
8484baaa RD |
2371 | |
2372 | ||
93351d41 | 2373 | if ($output_mode eq "rst") { |
af404fb1 | 2374 | get_sphinx_version() if (!$sphinx_major); |
93351d41 MCC |
2375 | } |
2376 | ||
8484baaa RD |
2377 | $kernelversion = get_kernel_version(); |
2378 | ||
2379 | # generate a sequence of code that will splice in highlighting information | |
2380 | # using the s// operator. | |
1ef06233 | 2381 | for (my $k = 0; $k < @highlights; $k++) { |
4d732701 DCLP |
2382 | my $pattern = $highlights[$k][0]; |
2383 | my $result = $highlights[$k][1]; | |
2384 | # print STDERR "scanning pattern:$pattern, highlight:($result)\n"; | |
2385 | $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n"; | |
8484baaa RD |
2386 | } |
2387 | ||
2388 | # Read the file that maps relative names to absolute names for | |
2389 | # separate source and object directories and for shadow trees. | |
2390 | if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { | |
af404fb1 VN |
2391 | my ($relname, $absname); |
2392 | while(<SOURCE_MAP>) { | |
2393 | chop(); | |
2394 | ($relname, $absname) = (split())[0..1]; | |
2395 | $relname =~ s:^/+::; | |
2396 | $source_map{$relname} = $absname; | |
2397 | } | |
2398 | close(SOURCE_MAP); | |
8484baaa RD |
2399 | } |
2400 | ||
88c2b57d JN |
2401 | if ($output_selection == OUTPUT_EXPORTED || |
2402 | $output_selection == OUTPUT_INTERNAL) { | |
c9b2cfb3 JN |
2403 | |
2404 | push(@export_file_list, @ARGV); | |
2405 | ||
88c2b57d | 2406 | foreach (@export_file_list) { |
af404fb1 VN |
2407 | chomp; |
2408 | process_export_file($_); | |
88c2b57d JN |
2409 | } |
2410 | } | |
2411 | ||
8484baaa RD |
2412 | foreach (@ARGV) { |
2413 | chomp; | |
2414 | process_file($_); | |
2415 | } | |
2416 | if ($verbose && $errors) { | |
af404fb1 | 2417 | print STDERR "$errors errors\n"; |
8484baaa RD |
2418 | } |
2419 | if ($verbose && $warnings) { | |
af404fb1 | 2420 | print STDERR "$warnings warnings\n"; |
8484baaa RD |
2421 | } |
2422 | ||
2c12c810 PLB |
2423 | if ($Werror && $warnings) { |
2424 | print STDERR "$warnings warnings as Errors\n"; | |
2425 | exit($warnings); | |
2426 | } else { | |
2427 | exit($output_mode eq "none" ? 0 : $errors) | |
2428 | } | |
2875f787 TW |
2429 | |
2430 | __END__ | |
2431 | ||
2432 | =head1 OPTIONS | |
2433 | ||
2434 | =head2 Output format selection (mutually exclusive): | |
2435 | ||
2436 | =over 8 | |
2437 | ||
2438 | =item -man | |
2439 | ||
2440 | Output troff manual page format. | |
2441 | ||
2442 | =item -rst | |
2443 | ||
2444 | Output reStructuredText format. This is the default. | |
2445 | ||
2446 | =item -none | |
2447 | ||
2448 | Do not output documentation, only warnings. | |
2449 | ||
2450 | =back | |
2451 | ||
dd803b04 TW |
2452 | =head2 Output format modifiers |
2453 | ||
2454 | =head3 reStructuredText only | |
2455 | ||
2456 | =over 8 | |
2457 | ||
2458 | =item -sphinx-version VERSION | |
2459 | ||
2460 | Use the ReST C domain dialect compatible with a specific Sphinx Version. | |
2461 | ||
2462 | If not specified, kernel-doc will auto-detect using the sphinx-build version | |
2463 | found on PATH. | |
2464 | ||
2465 | =back | |
2466 | ||
9c77f108 TW |
2467 | =head2 Output selection (mutually exclusive): |
2468 | ||
2469 | =over 8 | |
2470 | ||
2471 | =item -export | |
2472 | ||
2473 | Only output documentation for the symbols that have been exported using | |
632ce137 | 2474 | EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. |
9c77f108 TW |
2475 | |
2476 | =item -internal | |
2477 | ||
2478 | Only output documentation for the symbols that have NOT been exported using | |
632ce137 | 2479 | EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. |
9c77f108 TW |
2480 | |
2481 | =item -function NAME | |
2482 | ||
2483 | Only output documentation for the given function or DOC: section title. | |
2484 | All other functions and DOC: sections are ignored. | |
2485 | ||
2486 | May be specified multiple times. | |
2487 | ||
2488 | =item -nosymbol NAME | |
2489 | ||
2490 | Exclude the specified symbol from the output documentation. | |
2491 | ||
2492 | May be specified multiple times. | |
2493 | ||
2494 | =back | |
2495 | ||
c15de5a1 TW |
2496 | =head2 Output selection modifiers: |
2497 | ||
2498 | =over 8 | |
2499 | ||
2500 | =item -no-doc-sections | |
2501 | ||
2502 | Do not output DOC: sections. | |
2503 | ||
2504 | =item -export-file FILE | |
2505 | ||
632ce137 | 2506 | Specify an additional FILE in which to look for EXPORT_SYMBOL information. |
c15de5a1 TW |
2507 | |
2508 | To be used with -export or -internal. | |
2509 | ||
2510 | May be specified multiple times. | |
2511 | ||
2512 | =back | |
2513 | ||
2514 | =head3 reStructuredText only | |
2515 | ||
2516 | =over 8 | |
2517 | ||
2518 | =item -enable-lineno | |
2519 | ||
b79dfef0 | 2520 | Enable output of .. LINENO lines. |
c15de5a1 TW |
2521 | |
2522 | =back | |
2523 | ||
834cf6b9 TW |
2524 | =head2 Other parameters: |
2525 | ||
2526 | =over 8 | |
2527 | ||
2528 | =item -h, -help | |
2529 | ||
2530 | Print this help. | |
2531 | ||
2532 | =item -v | |
2533 | ||
2534 | Verbose output, more warnings and other information. | |
2535 | ||
2536 | =item -Werror | |
2537 | ||
2538 | Treat warnings as errors. | |
2539 | ||
2540 | =back | |
2541 | ||
2875f787 | 2542 | =cut |