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