Blame view
scripts/kernel-doc
87.8 KB
1da177e4c Linux-2.6.12-rc2 |
1 2 3 4 5 6 7 |
#!/usr/bin/perl -w 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... |
8 |
## Copyright (C) 2005-2012 Randy Dunlap ## |
1b40c1944 scripts/kernel-do... |
9 |
## Copyright (C) 2012 Dan Luedtke ## |
1da177e4c Linux-2.6.12-rc2 |
10 11 12 13 14 15 |
## ## ## #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 |
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# 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... |
37 38 |
# 25/07/2012 - Added support for HTML5 # -- Dan Luedtke <mail@danrl.de> |
1da177e4c Linux-2.6.12-rc2 |
39 |
|
fadc0b31c kernel-doc: rewri... |
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
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 Documentation/kernel-doc-nano-HOWTO.txt for the documentation comment syntax. Output format selection (mutually exclusive): -docbook Output DocBook format. -html Output HTML format. -html5 Output HTML5 format. -list Output symbol list format. This is for use by docproc. -man Output troff manual page format. This is the default. |
c0d1b6ee7 kernel-doc: produ... |
56 |
-rst Output reStructuredText format. |
fadc0b31c kernel-doc: rewri... |
57 58 59 |
-text Output plain text format. Output selection (mutually exclusive): |
86ae2e38d kernel-doc: suppo... |
60 61 |
-export Only output documentation for symbols that have been exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() |
c9b2cfb3f kernel-doc: unify... |
62 |
in any input FILE or -export-file FILE. |
86ae2e38d kernel-doc: suppo... |
63 64 |
-internal Only output documentation for symbols that have NOT been exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() |
c9b2cfb3f kernel-doc: unify... |
65 |
in any input FILE or -export-file FILE. |
fadc0b31c kernel-doc: rewri... |
66 67 68 69 70 71 72 73 74 |
-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... |
75 76 |
-enable-lineno Enable output of #define LINENO lines. Only works with reStructuredText format. |
88c2b57da kernel-doc: add s... |
77 78 79 |
-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... |
80 81 82 83 84 85 86 87 88 |
Other parameters: -v Verbose output, more warnings and other information. -h Print this help. EOF print $message; exit 1; } |
1da177e4c Linux-2.6.12-rc2 |
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# # 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... |
106 |
# */ |
1da177e4c Linux-2.6.12-rc2 |
107 |
# |
891dcd2f7 [PATCH] kernel-do... |
108 |
# If the Description: header tag is omitted, then there must be a blank line |
1da177e4c Linux-2.6.12-rc2 |
109 110 111 112 113 114 |
# after the last parameter specification. # e.g. # /** # * my_function - does my stuff # * @my_arg: its mine damnit # * |
3c3b809e2 [PATCH] kernel-do... |
115 |
# * Does my stuff explained. |
1da177e4c Linux-2.6.12-rc2 |
116 117 118 119 120 121 |
# */ # # or, could also use: # /** # * my_function - does my stuff # * @my_arg: its mine damnit |
3c3b809e2 [PATCH] kernel-do... |
122 |
# * Description: Does my stuff explained. |
1da177e4c Linux-2.6.12-rc2 |
123 124 125 |
# */ # etc. # |
b9d97328e kernel-doc: clean... |
126 |
# Besides functions you can also write documentation for structs, unions, |
3c3b809e2 [PATCH] kernel-do... |
127 128 129 |
# 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 |
130 131 132 133 134 135 |
# 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... |
136 |
# * |
1da177e4c Linux-2.6.12-rc2 |
137 138 139 140 141 |
# * Longer description # */ # struct my_struct { # int a; # int b; |
aeec46b97 [PATCH] DocBook: ... |
142 143 |
# /* private: */ # int c; |
1da177e4c Linux-2.6.12-rc2 |
144 145 146 |
# }; # # All descriptions can be multiline, except the short function description. |
3c3b809e2 [PATCH] kernel-do... |
147 |
# |
a4c6ebede scripts/kernel-do... |
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# 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... |
172 173 |
# 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 |
174 |
# can be called form interrupts. Unlike other sections you can end it with an |
3c3b809e2 [PATCH] kernel-do... |
175 |
# empty line. |
4092bac77 scripts/kernel-do... |
176 177 |
# A non-void function should have a "Return:" section describing the return # value(s). |
3c3b809e2 [PATCH] kernel-do... |
178 |
# Example-sections should contain the string EXAMPLE so that they are marked |
1da177e4c Linux-2.6.12-rc2 |
179 180 181 182 183 184 185 |
# 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... |
186 |
# * |
1da177e4c Linux-2.6.12-rc2 |
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# * 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') # '@parameter' - name of a parameter # '%CONST' - name of a constant. |
8484baaa5 kernel-doc: code ... |
202 |
## init lots of data |
1da177e4c Linux-2.6.12-rc2 |
203 204 |
my $errors = 0; my $warnings = 0; |
5f8c7c98a kernel-doc: fix u... |
205 |
my $anon_struct_union = 0; |
1da177e4c Linux-2.6.12-rc2 |
206 207 208 209 210 |
# match expressions used to find embedded type information my $type_constant = '\%([-_\w]+)'; my $type_func = '(\w+)\(\)'; my $type_param = '\@(\w+)'; |
5219f18aa docs: Special-cas... |
211 |
my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params |
3eb014a10 kernel-doc: html ... |
212 |
my $type_struct = '\&((struct\s*)*[_\w]+)'; |
6b5b55f6c kernel-doc: fix d... |
213 |
my $type_struct_xml = '\\&((struct\s*)*[_\w]+)'; |
1da177e4c Linux-2.6.12-rc2 |
214 |
my $type_env = '(\$\w+)'; |
c0d1b6ee7 kernel-doc: produ... |
215 216 |
my $type_enum_full = '\&(enum)\s*([_\w]+)'; my $type_struct_full = '\&(struct)\s*([_\w]+)'; |
47ae7aed3 kernel-doc/rst: a... |
217 218 |
my $type_typedef_full = '\&(typedef)\s*([_\w]+)'; my $type_union_full = '\&(union)\s*([_\w]+)'; |
f3341dcf3 kernel-doc/rst: a... |
219 220 |
my $type_member = '\&([_\w]+)((\.|->)[_\w]+)'; my $type_member_func = $type_member . '\(\)'; |
1da177e4c Linux-2.6.12-rc2 |
221 222 223 224 225 |
# Output conversion substitutions. # One for each output format # these work fairly well |
4d7327019 scripts/kernel-do... |
226 227 228 229 230 231 232 |
my @highlights_html = ( [$type_constant, "<i>\$1</i>"], [$type_func, "<b>\$1</b>"], [$type_struct_xml, "<i>\$1</i>"], [$type_env, "<b><i>\$1</i></b>"], [$type_param, "<tt><b>\$1</b></tt>"] ); |
6b5b55f6c kernel-doc: fix d... |
233 234 235 |
my $local_lt = "\\\\\\\\lt:"; my $local_gt = "\\\\\\\\gt:"; my $blankline_html = $local_lt . "p" . $local_gt; # was "<p>" |
1da177e4c Linux-2.6.12-rc2 |
236 |
|
1b40c1944 scripts/kernel-do... |
237 |
# html version 5 |
4d7327019 scripts/kernel-do... |
238 239 240 241 242 243 244 |
my @highlights_html5 = ( [$type_constant, "<span class=\"const\">\$1</span>"], [$type_func, "<span class=\"func\">\$1</span>"], [$type_struct_xml, "<span class=\"struct\">\$1</span>"], [$type_env, "<span class=\"env\">\$1</span>"], [$type_param, "<span class=\"param\">\$1</span>]"] ); |
1b40c1944 scripts/kernel-do... |
245 |
my $blankline_html5 = $local_lt . "br /" . $local_gt; |
1da177e4c Linux-2.6.12-rc2 |
246 |
# XML, docbook format |
4d7327019 scripts/kernel-do... |
247 248 249 250 251 252 253 254 |
my @highlights_xml = ( ["([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>"], [$type_constant, "<constant>\$1</constant>"], [$type_struct_xml, "<structname>\$1</structname>"], [$type_param, "<parameter>\$1</parameter>"], [$type_func, "<function>\$1</function>"], [$type_env, "<envar>\$1</envar>"] ); |
5c98fc036 kernel-doc: fix x... |
255 256 |
my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . " "; |
1da177e4c Linux-2.6.12-rc2 |
257 258 |
# gnome, docbook format |
4d7327019 scripts/kernel-do... |
259 260 261 262 263 264 265 |
my @highlights_gnome = ( [$type_constant, "<replaceable class=\"option\">\$1</replaceable>"], [$type_func, "<function>\$1</function>"], [$type_struct, "<structname>\$1</structname>"], [$type_env, "<envar>\$1</envar>"], [$type_param, "<parameter>\$1</parameter>" ] ); |
1da177e4c Linux-2.6.12-rc2 |
266 267 268 269 |
my $blankline_gnome = "</para><para> "; # these are pretty rough |
4d7327019 scripts/kernel-do... |
270 271 272 273 274 275 |
my @highlights_man = ( [$type_constant, "\$1"], [$type_func, "\\\\fB\$1\\\\fP"], [$type_struct, "\\\\fI\$1\\\\fP"], [$type_param, "\\\\fI\$1\\\\fP"] ); |
1da177e4c Linux-2.6.12-rc2 |
276 277 278 |
my $blankline_man = ""; # text-mode |
4d7327019 scripts/kernel-do... |
279 280 281 282 283 284 |
my @highlights_text = ( [$type_constant, "\$1"], [$type_func, "\$1"], [$type_struct, "\$1"], [$type_param, "\$1"] ); |
1da177e4c Linux-2.6.12-rc2 |
285 |
my $blankline_text = ""; |
c0d1b6ee7 kernel-doc: produ... |
286 287 288 |
# rst-mode my @highlights_rst = ( [$type_constant, "``\$1``"], |
f3341dcf3 kernel-doc/rst: a... |
289 290 291 |
# Note: need to escape () to avoid func matching later [$type_member_func, "\\:c\\:type\\:`\$1\$2\\\\(\\\\) <\$1>`"], [$type_member, "\\:c\\:type\\:`\$1\$2 <\$1>`"], |
5219f18aa docs: Special-cas... |
292 |
[$type_fp_param, "**\$1\\\\(\\\\)**"], |
a19bce643 kernel-doc/rst: r... |
293 |
[$type_func, "\\:c\\:func\\:`\$1()`"], |
628509765 kernel-doc: use r... |
294 295 |
[$type_struct_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"], [$type_enum_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"], |
47ae7aed3 kernel-doc/rst: a... |
296 297 |
[$type_typedef_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"], [$type_union_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"], |
a7291e7e0 kernel-doc/rst: &... |
298 299 |
# in rst this can refer to any type [$type_struct, "\\:c\\:type\\:`\$1`"], |
c0d1b6ee7 kernel-doc: produ... |
300 301 302 303 |
[$type_param, "**\$1**"] ); my $blankline_rst = " "; |
eda603f6c docbook: warn on ... |
304 |
# list mode |
4d7327019 scripts/kernel-do... |
305 306 307 308 309 310 |
my @highlights_list = ( [$type_constant, "\$1"], [$type_func, "\$1"], [$type_struct, "\$1"], [$type_param, "\$1"] ); |
eda603f6c docbook: warn on ... |
311 |
my $blankline_list = ""; |
1da177e4c Linux-2.6.12-rc2 |
312 |
|
1da177e4c Linux-2.6.12-rc2 |
313 |
# read arguments |
b9d97328e kernel-doc: clean... |
314 |
if ($#ARGV == -1) { |
1da177e4c Linux-2.6.12-rc2 |
315 316 |
usage(); } |
8484baaa5 kernel-doc: code ... |
317 318 |
my $kernelversion; my $dohighlight = ""; |
1da177e4c Linux-2.6.12-rc2 |
319 320 |
my $verbose = 0; my $output_mode = "man"; |
e314ba313 kernel-doc: bugfi... |
321 |
my $output_preformatted = 0; |
4b44595a7 kernel-doc: proce... |
322 |
my $no_doc_sections = 0; |
0b0f5f29b scripts/kernel-do... |
323 |
my $enable_lineno = 0; |
4d7327019 scripts/kernel-do... |
324 |
my @highlights = @highlights_man; |
1da177e4c Linux-2.6.12-rc2 |
325 326 |
my $blankline = $blankline_man; my $modulename = "Kernel API"; |
b6c3f456c kernel-doc: add n... |
327 328 329 330 331 332 333 334 335 |
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; |
b2c4105b0 scripts/kernel-do... |
336 |
my $show_not_found = 0; |
88c2b57da kernel-doc: add s... |
337 |
my @export_file_list; |
b2c4105b0 scripts/kernel-do... |
338 339 340 341 342 343 344 |
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... |
345 346 |
my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', |
b2c4105b0 scripts/kernel-do... |
347 348 |
'November', 'December')[$build_time[4]] . " " . ($build_time[5]+1900); |
1da177e4c Linux-2.6.12-rc2 |
349 |
|
8484baaa5 kernel-doc: code ... |
350 |
# Essentially these are globals. |
b9d97328e kernel-doc: clean... |
351 352 |
# 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 |
353 |
# could cause "use of undefined value" or other bugs. |
b9d97328e kernel-doc: clean... |
354 |
my ($function, %function_table, %parametertypes, $declaration_purpose); |
0b0f5f29b scripts/kernel-do... |
355 |
my $declaration_start_line; |
b9d97328e kernel-doc: clean... |
356 |
my ($type, $declaration_name, $return_type); |
1c32fd0c5 kernel-doc: drop ... |
357 |
my ($newsection, $newcontents, $prototype, $brcount, %source_map); |
1da177e4c Linux-2.6.12-rc2 |
358 |
|
bd0e88e51 kernel-doc: set v... |
359 360 361 |
if (defined($ENV{'KBUILD_VERBOSE'})) { $verbose = "$ENV{'KBUILD_VERBOSE'}"; } |
3c3b809e2 [PATCH] kernel-do... |
362 |
# Generated docbook code is inserted in a template at a point where |
1da177e4c Linux-2.6.12-rc2 |
363 364 365 366 367 368 369 370 |
# docbook v3.1 requires a non-zero sequence of RefEntry's; see: # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html # 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... |
371 372 373 374 375 376 377 378 379 |
# Parser states use constant { STATE_NORMAL => 0, # normal code STATE_NAME => 1, # looking for function name STATE_FIELD => 2, # scanning field start STATE_PROTO => 3, # scanning prototype STATE_DOCBLOCK => 4, # documentation block STATE_INLINE => 5, # gathering documentation outside main block }; |
1da177e4c Linux-2.6.12-rc2 |
380 |
my $state; |
850622dfa [PATCH] kernel-do... |
381 |
my $in_doc_sect; |
1da177e4c Linux-2.6.12-rc2 |
382 |
|
48af606ad kernel-doc: add n... |
383 384 385 386 387 388 389 390 391 392 393 |
# 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... |
394 |
|
1da177e4c Linux-2.6.12-rc2 |
395 396 397 |
#declaration types: can be # 'function', 'struct', 'union', 'enum', 'typedef' my $decl_type; |
1da177e4c Linux-2.6.12-rc2 |
398 399 400 |
my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. my $doc_end = '\*/'; my $doc_com = '\s*\*\s*'; |
12ae67793 kernel-doc: don't... |
401 |
my $doc_com_body = '\s*\* ?'; |
b9d97328e kernel-doc: clean... |
402 |
my $doc_decl = $doc_com . '(\w+)'; |
f624adef3 kernel-doc: limit... |
403 |
# @params and a strictly limited set of supported section names |
8569de68e docs: kernel-doc:... |
404 |
my $doc_sect = $doc_com . |
ef00028b2 docs: make kernel... |
405 |
'\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)'; |
12ae67793 kernel-doc: don't... |
406 |
my $doc_content = $doc_com_body . '(.*)'; |
b9d97328e kernel-doc: clean... |
407 |
my $doc_block = $doc_com . 'DOC:\s*(.*)?'; |
48af606ad kernel-doc: add n... |
408 409 410 |
my $doc_inline_start = '^\s*/\*\*\s*$'; my $doc_inline_sect = '\s*\*\s*(@[\w\s]+):(.*)'; my $doc_inline_end = '^\s*\*/\s*$'; |
86ae2e38d kernel-doc: suppo... |
411 |
my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; |
1da177e4c Linux-2.6.12-rc2 |
412 |
|
1da177e4c Linux-2.6.12-rc2 |
413 |
my %parameterdescs; |
0b0f5f29b scripts/kernel-do... |
414 |
my %parameterdesc_start_lines; |
1da177e4c Linux-2.6.12-rc2 |
415 416 417 |
my @parameterlist; my %sections; my @sectionlist; |
0b0f5f29b scripts/kernel-do... |
418 |
my %section_start_lines; |
a1d94aa55 kernel-doc: check... |
419 420 |
my $sectcheck; my $struct_actual; |
1da177e4c Linux-2.6.12-rc2 |
421 422 |
my $contents = ""; |
0b0f5f29b scripts/kernel-do... |
423 |
my $new_start_line = 0; |
f624adef3 kernel-doc: limit... |
424 425 |
# the canonical section names. see also $doc_sect above. |
1da177e4c Linux-2.6.12-rc2 |
426 427 428 429 |
my $section_default = "Description"; # default section my $section_intro = "Introduction"; my $section = $section_default; my $section_context = "Context"; |
4092bac77 scripts/kernel-do... |
430 |
my $section_return = "Return"; |
1da177e4c Linux-2.6.12-rc2 |
431 432 433 434 435 436 437 438 439 |
my $undescribed = "-- undescribed --"; reset_state(); while ($ARGV[0] =~ m/^-(.*)/) { my $cmd = shift @ARGV; if ($cmd eq "-html") { $output_mode = "html"; |
4d7327019 scripts/kernel-do... |
440 |
@highlights = @highlights_html; |
1da177e4c Linux-2.6.12-rc2 |
441 |
$blankline = $blankline_html; |
1b40c1944 scripts/kernel-do... |
442 443 |
} elsif ($cmd eq "-html5") { $output_mode = "html5"; |
4d7327019 scripts/kernel-do... |
444 |
@highlights = @highlights_html5; |
1b40c1944 scripts/kernel-do... |
445 |
$blankline = $blankline_html5; |
1da177e4c Linux-2.6.12-rc2 |
446 447 |
} elsif ($cmd eq "-man") { $output_mode = "man"; |
4d7327019 scripts/kernel-do... |
448 |
@highlights = @highlights_man; |
1da177e4c Linux-2.6.12-rc2 |
449 450 451 |
$blankline = $blankline_man; } elsif ($cmd eq "-text") { $output_mode = "text"; |
4d7327019 scripts/kernel-do... |
452 |
@highlights = @highlights_text; |
1da177e4c Linux-2.6.12-rc2 |
453 |
$blankline = $blankline_text; |
c0d1b6ee7 kernel-doc: produ... |
454 455 456 457 |
} elsif ($cmd eq "-rst") { $output_mode = "rst"; @highlights = @highlights_rst; $blankline = $blankline_rst; |
1da177e4c Linux-2.6.12-rc2 |
458 459 |
} elsif ($cmd eq "-docbook") { $output_mode = "xml"; |
4d7327019 scripts/kernel-do... |
460 |
@highlights = @highlights_xml; |
1da177e4c Linux-2.6.12-rc2 |
461 |
$blankline = $blankline_xml; |
eda603f6c docbook: warn on ... |
462 463 |
} elsif ($cmd eq "-list") { $output_mode = "list"; |
4d7327019 scripts/kernel-do... |
464 |
@highlights = @highlights_list; |
eda603f6c docbook: warn on ... |
465 |
$blankline = $blankline_list; |
1da177e4c Linux-2.6.12-rc2 |
466 467 |
} elsif ($cmd eq "-gnome") { $output_mode = "gnome"; |
4d7327019 scripts/kernel-do... |
468 |
@highlights = @highlights_gnome; |
1da177e4c Linux-2.6.12-rc2 |
469 470 471 472 |
$blankline = $blankline_gnome; } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document $modulename = shift @ARGV; } elsif ($cmd eq "-function") { # to only output specific functions |
b6c3f456c kernel-doc: add n... |
473 |
$output_selection = OUTPUT_INCLUDE; |
1da177e4c Linux-2.6.12-rc2 |
474 475 |
$function = shift @ARGV; $function_table{$function} = 1; |
b6c3f456c kernel-doc: add n... |
476 477 |
} elsif ($cmd eq "-nofunction") { # output all except specific functions $output_selection = OUTPUT_EXCLUDE; |
1da177e4c Linux-2.6.12-rc2 |
478 479 |
$function = shift @ARGV; $function_table{$function} = 1; |
86ae2e38d kernel-doc: suppo... |
480 |
} elsif ($cmd eq "-export") { # only exported symbols |
b6c3f456c kernel-doc: add n... |
481 |
$output_selection = OUTPUT_EXPORTED; |
da9726ecf kernel-doc: add m... |
482 |
%function_table = (); |
86ae2e38d kernel-doc: suppo... |
483 |
} elsif ($cmd eq "-internal") { # only non-exported symbols |
b6c3f456c kernel-doc: add n... |
484 |
$output_selection = OUTPUT_INTERNAL; |
da9726ecf kernel-doc: add m... |
485 |
%function_table = (); |
88c2b57da kernel-doc: add s... |
486 487 488 |
} elsif ($cmd eq "-export-file") { my $file = shift @ARGV; push(@export_file_list, $file); |
1da177e4c Linux-2.6.12-rc2 |
489 490 491 492 |
} elsif ($cmd eq "-v") { $verbose = 1; } elsif (($cmd eq "-h") || ($cmd eq "--help")) { usage(); |
4b44595a7 kernel-doc: proce... |
493 494 |
} elsif ($cmd eq '-no-doc-sections') { $no_doc_sections = 1; |
0b0f5f29b scripts/kernel-do... |
495 496 |
} elsif ($cmd eq '-enable-lineno') { $enable_lineno = 1; |
e946c43a1 kernel-doc: impro... |
497 498 |
} elsif ($cmd eq '-show-not-found') { $show_not_found = 1; |
1da177e4c Linux-2.6.12-rc2 |
499 500 |
} } |
8484baaa5 kernel-doc: code ... |
501 |
# continue execution near EOF; |
53f049fa5 kill warnings whe... |
502 503 |
# get kernel version from env sub get_kernel_version() { |
1b9bc22d7 kernel-doc: init ... |
504 |
my $version = 'unknown kernel version'; |
53f049fa5 kill warnings whe... |
505 506 507 508 509 510 |
if (defined($ENV{'KERNELVERSION'})) { $version = $ENV{'KERNELVERSION'}; } return $version; } |
1da177e4c Linux-2.6.12-rc2 |
511 |
|
0b0f5f29b scripts/kernel-do... |
512 513 514 515 516 517 518 519 |
# sub print_lineno { my $lineno = shift; if ($enable_lineno && defined($lineno)) { print "#define LINENO " . $lineno . " "; } } |
1da177e4c Linux-2.6.12-rc2 |
520 521 522 523 |
## # dumps section contents to arrays/hashes intended for that purpose. # sub dump_section { |
94dc7ad55 kernel-doc: detec... |
524 |
my $file = shift; |
1da177e4c Linux-2.6.12-rc2 |
525 526 527 |
my $name = shift; my $contents = join " ", @_; |
13901ef27 kernel-doc: do no... |
528 |
if ($name =~ m/$type_param/) { |
1da177e4c Linux-2.6.12-rc2 |
529 530 |
$name = $1; $parameterdescs{$name} = $contents; |
a1d94aa55 kernel-doc: check... |
531 |
$sectcheck = $sectcheck . $name . " "; |
0b0f5f29b scripts/kernel-do... |
532 533 |
$parameterdesc_start_lines{$name} = $new_start_line; $new_start_line = 0; |
ced69090c kernel-doc: handl... |
534 |
} elsif ($name eq "@\.\.\.") { |
ced69090c kernel-doc: handl... |
535 536 |
$name = "..."; $parameterdescs{$name} = $contents; |
a1d94aa55 kernel-doc: check... |
537 |
$sectcheck = $sectcheck . $name . " "; |
0b0f5f29b scripts/kernel-do... |
538 539 |
$parameterdesc_start_lines{$name} = $new_start_line; $new_start_line = 0; |
1da177e4c Linux-2.6.12-rc2 |
540 |
} else { |
94dc7ad55 kernel-doc: detec... |
541 |
if (defined($sections{$name}) && ($sections{$name} ne "")) { |
95b6be9d1 kernel-doc: do no... |
542 543 544 545 546 547 |
# 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... |
548 549 550 551 |
$sections{$name} .= $contents; } else { $sections{$name} = $contents; push @sectionlist, $name; |
0b0f5f29b scripts/kernel-do... |
552 553 |
$section_start_lines{$name} = $new_start_line; $new_start_line = 0; |
94dc7ad55 kernel-doc: detec... |
554 |
} |
1da177e4c Linux-2.6.12-rc2 |
555 556 557 558 |
} } ## |
b112e0f73 kernel-doc: singl... |
559 560 561 |
# dump DOC: section after checking that it should go out # sub dump_doc_section { |
94dc7ad55 kernel-doc: detec... |
562 |
my $file = shift; |
b112e0f73 kernel-doc: singl... |
563 564 565 |
my $name = shift; my $contents = join " ", @_; |
4b44595a7 kernel-doc: proce... |
566 567 568 |
if ($no_doc_sections) { return; } |
b6c3f456c kernel-doc: add n... |
569 570 571 572 573 |
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... |
574 |
{ |
94dc7ad55 kernel-doc: detec... |
575 |
dump_section($file, $name, $contents); |
b112e0f73 kernel-doc: singl... |
576 577 578 |
output_blockhead({'sectionlist' => \@sectionlist, 'sections' => \%sections, 'module' => $modulename, |
b6c3f456c kernel-doc: add n... |
579 |
'content-only' => ($output_selection != OUTPUT_ALL), }); |
b112e0f73 kernel-doc: singl... |
580 581 582 583 |
} } ## |
1da177e4c Linux-2.6.12-rc2 |
584 585 586 587 588 589 590 |
# output function # # parameterdescs, a hash. # function => "function name" # parameterlist => @list of parameters # parameterdescs => %parameter descriptions # sectionlist => @list of sections |
a21217daa [PATCH] kernel-do... |
591 |
# sections => %section descriptions |
3c3b809e2 [PATCH] kernel-do... |
592 |
# |
1da177e4c Linux-2.6.12-rc2 |
593 594 595 596 597 598 599 600 601 602 603 604 |
sub output_highlight { my $contents = join " ",@_; my $line; # DEBUG # if (!defined $contents) { # use Carp; # confess "output_highlight got called with no args? "; # } |
1b40c1944 scripts/kernel-do... |
605 606 |
if ($output_mode eq "html" || $output_mode eq "html5" || $output_mode eq "xml") { |
6b5b55f6c kernel-doc: fix d... |
607 608 |
$contents = local_unescape($contents); # convert data read & converted thru xml_escape() into &xyz; format: |
2b35f4d9c kernel-doc: escap... |
609 |
$contents =~ s/\\\\\\/\&/g; |
6b5b55f6c kernel-doc: fix d... |
610 |
} |
3eb014a10 kernel-doc: html ... |
611 612 |
# print STDERR "contents b4:$contents "; |
1da177e4c Linux-2.6.12-rc2 |
613 614 |
eval $dohighlight; die $@ if $@; |
3eb014a10 kernel-doc: html ... |
615 616 |
# print STDERR "contents af:$contents "; |
1b40c1944 scripts/kernel-do... |
617 618 619 620 621 |
# strip whitespaces when generating html5 if ($output_mode eq "html5") { $contents =~ s/^\s+//; $contents =~ s/\s+$//; } |
1da177e4c Linux-2.6.12-rc2 |
622 623 |
foreach $line (split " ", $contents) { |
12ae67793 kernel-doc: don't... |
624 625 626 |
if (! $output_preformatted) { $line =~ s/^\s*//; } |
3c308798a scripts: kernel-d... |
627 |
if ($line eq ""){ |
e314ba313 kernel-doc: bugfi... |
628 629 630 |
if (! $output_preformatted) { print $lineprefix, local_unescape($blankline); } |
1da177e4c Linux-2.6.12-rc2 |
631 |
} else { |
3c308798a scripts: kernel-d... |
632 |
$line =~ s/\\\\\\/\&/g; |
cdccb316c kernel-doc: fix l... |
633 634 635 636 637 |
if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { print "\\&$line"; } else { print $lineprefix, $line; } |
1da177e4c Linux-2.6.12-rc2 |
638 639 640 641 642 |
} print " "; } } |
1b40c1944 scripts/kernel-do... |
643 |
# output sections in html |
1da177e4c Linux-2.6.12-rc2 |
644 645 646 647 648 649 650 651 652 653 654 655 |
sub output_section_html(%) { my %args = %{$_[0]}; my $section; foreach $section (@{$args{'sectionlist'}}) { print "<h3>$section</h3> "; print "<blockquote> "; output_highlight($args{'sections'}{$section}); print "</blockquote> "; |
3c3b809e2 [PATCH] kernel-do... |
656 |
} |
1da177e4c Linux-2.6.12-rc2 |
657 658 659 660 661 662 663 |
} # output enum in html sub output_enum_html(%) { my %args = %{$_[0]}; my ($parameter); my $count; |
b9d97328e kernel-doc: clean... |
664 665 |
print "<h2>enum " . $args{'enum'} . "</h2> "; |
1da177e4c Linux-2.6.12-rc2 |
666 |
|
b9d97328e kernel-doc: clean... |
667 668 |
print "<b>enum " . $args{'enum'} . "</b> {<br> "; |
1da177e4c Linux-2.6.12-rc2 |
669 670 |
$count = 0; foreach $parameter (@{$args{'parameterlist'}}) { |
b9d97328e kernel-doc: clean... |
671 |
print " <b>" . $parameter . "</b>"; |
1da177e4c Linux-2.6.12-rc2 |
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 |
if ($count != $#{$args{'parameterlist'}}) { $count++; print ", "; } print "<br>"; } print "};<br> "; print "<h3>Constants</h3> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { |
b9d97328e kernel-doc: clean... |
687 688 |
print "<dt><b>" . $parameter . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
689 690 691 692 693 694 695 696 697 |
print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter}); } print "</dl> "; output_section_html(@_); print "<hr> "; } |
d28bee0c0 [PATCH] Doc/kerne... |
698 |
# output typedef in html |
1da177e4c Linux-2.6.12-rc2 |
699 700 701 702 |
sub output_typedef_html(%) { my %args = %{$_[0]}; my ($parameter); my $count; |
b9d97328e kernel-doc: clean... |
703 704 |
print "<h2>typedef " . $args{'typedef'} . "</h2> "; |
1da177e4c Linux-2.6.12-rc2 |
705 |
|
b9d97328e kernel-doc: clean... |
706 707 |
print "<b>typedef " . $args{'typedef'} . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
708 709 710 711 712 713 714 715 716 |
output_section_html(@_); print "<hr> "; } # output struct in html sub output_struct_html(%) { my %args = %{$_[0]}; my ($parameter); |
b9d97328e kernel-doc: clean... |
717 718 719 720 |
print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2> "; print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br> "; |
1da177e4c Linux-2.6.12-rc2 |
721 722 723 724 725 726 727 728 |
foreach $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { print "$parameter<br> "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
729 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
730 731 732 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
3eb014a10 kernel-doc: html ... |
733 734 |
print " <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br> "; |
1da177e4c Linux-2.6.12-rc2 |
735 |
} elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
3eb014a10 kernel-doc: html ... |
736 737 738 |
# bitfield print " <i>$1</i> <b>$parameter</b>$2;<br> "; |
1da177e4c Linux-2.6.12-rc2 |
739 |
} else { |
3eb014a10 kernel-doc: html ... |
740 741 |
print " <i>$type</i> <b>$parameter</b>;<br> "; |
1da177e4c Linux-2.6.12-rc2 |
742 743 744 745 746 747 748 749 750 751 752 753 754 755 |
} } print "};<br> "; print "<h3>Members</h3> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
756 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
b9d97328e kernel-doc: clean... |
757 758 |
print "<dt><b>" . $parameter . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 |
print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter_name}); } print "</dl> "; output_section_html(@_); print "<hr> "; } # output function in html sub output_function_html(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; |
1da177e4c Linux-2.6.12-rc2 |
774 |
|
b9d97328e kernel-doc: clean... |
775 776 777 778 779 780 |
print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2> "; print "<i>" . $args{'functiontype'} . "</i> "; print "<b>" . $args{'function'} . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
781 782 783 784 785 786 787 788 |
print "("; $count = 0; foreach $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print "<i>$1</i><b>$parameter</b>) <i>($2)</i>"; } else { |
b9d97328e kernel-doc: clean... |
789 |
print "<i>" . $type . "</i> <b>" . $parameter . "</b>"; |
1da177e4c Linux-2.6.12-rc2 |
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 |
} if ($count != $#{$args{'parameterlist'}}) { $count++; print ", "; } } print ") "; print "<h3>Arguments</h3> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
807 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
b9d97328e kernel-doc: clean... |
808 809 |
print "<dt><b>" . $parameter . "</b> "; |
1da177e4c Linux-2.6.12-rc2 |
810 811 812 813 814 815 816 817 818 |
print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter_name}); } print "</dl> "; output_section_html(@_); print "<hr> "; } |
b112e0f73 kernel-doc: singl... |
819 820 |
# output DOC: block header in html sub output_blockhead_html(%) { |
1da177e4c Linux-2.6.12-rc2 |
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 |
my %args = %{$_[0]}; my ($parameter, $section); my $count; foreach $section (@{$args{'sectionlist'}}) { print "<h3>$section</h3> "; print "<ul> "; output_highlight($args{'sections'}{$section}); print "</ul> "; } print "<hr> "; } |
1b40c1944 scripts/kernel-do... |
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 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 |
# output sections in html5 sub output_section_html5(%) { my %args = %{$_[0]}; my $section; foreach $section (@{$args{'sectionlist'}}) { print "<section> "; print "<h1>$section</h1> "; print "<p> "; output_highlight($args{'sections'}{$section}); print "</p> "; print "</section> "; } } # output enum in html5 sub output_enum_html5(%) { my %args = %{$_[0]}; my ($parameter); my $count; my $html5id; $html5id = $args{'enum'}; $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; print "<article class=\"enum\" id=\"enum:". $html5id . "\">"; print "<h1>enum " . $args{'enum'} . "</h1> "; print "<ol class=\"code\"> "; print "<li>"; print "<span class=\"keyword\">enum</span> "; print "<span class=\"identifier\">" . $args{'enum'} . "</span> {"; print "</li> "; $count = 0; foreach $parameter (@{$args{'parameterlist'}}) { print "<li class=\"indent\">"; print "<span class=\"param\">" . $parameter . "</span>"; if ($count != $#{$args{'parameterlist'}}) { $count++; print ","; } print "</li> "; } print "<li>};</li> "; print "</ol> "; print "<section> "; print "<h1>Constants</h1> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { print "<dt>" . $parameter . "</dt> "; print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter}); print "</dd> "; } print "</dl> "; print "</section> "; output_section_html5(@_); print "</article> "; } # output typedef in html5 sub output_typedef_html5(%) { my %args = %{$_[0]}; my ($parameter); my $count; my $html5id; $html5id = $args{'typedef'}; $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; print "<article class=\"typedef\" id=\"typedef:" . $html5id . "\"> "; print "<h1>typedef " . $args{'typedef'} . "</h1> "; print "<ol class=\"code\"> "; print "<li>"; print "<span class=\"keyword\">typedef</span> "; print "<span class=\"identifier\">" . $args{'typedef'} . "</span>"; print "</li> "; print "</ol> "; output_section_html5(@_); print "</article> "; } # output struct in html5 sub output_struct_html5(%) { my %args = %{$_[0]}; my ($parameter); my $html5id; $html5id = $args{'struct'}; $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; print "<article class=\"struct\" id=\"struct:" . $html5id . "\"> "; print "<hgroup> "; print "<h1>" . $args{'type'} . " " . $args{'struct'} . "</h1>"; print "<h2>". $args{'purpose'} . "</h2> "; print "</hgroup> "; print "<ol class=\"code\"> "; print "<li>"; print "<span class=\"type\">" . $args{'type'} . "</span> "; print "<span class=\"identifier\">" . $args{'struct'} . "</span> {"; print "</li> "; foreach $parameter (@{$args{'parameterlist'}}) { print "<li class=\"indent\">"; if ($parameter =~ /^#/) { print "<span class=\"param\">" . $parameter ."</span> "; print "</li> "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print "<span class=\"type\">$1</span> "; print "<span class=\"param\">$parameter</span>"; print "<span class=\"type\">)</span> "; print "(<span class=\"args\">$2</span>);"; } elsif ($type =~ m/^(.*?)\s*(:.*)/) { # bitfield print "<span class=\"type\">$1</span> "; print "<span class=\"param\">$parameter</span>"; print "<span class=\"bits\">$2</span>;"; } else { print "<span class=\"type\">$type</span> "; print "<span class=\"param\">$parameter</span>;"; } print "</li> "; } print "<li>};</li> "; print "</ol> "; print "<section> "; print "<h1>Members</h1> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; print "<dt>" . $parameter . "</dt> "; print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter_name}); print "</dd> "; } print "</dl> "; print "</section> "; output_section_html5(@_); print "</article> "; } # output function in html5 sub output_function_html5(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $html5id; $html5id = $args{'function'}; $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; print "<article class=\"function\" id=\"func:". $html5id . "\"> "; print "<hgroup> "; print "<h1>" . $args{'function'} . "</h1>"; print "<h2>" . $args{'purpose'} . "</h2> "; print "</hgroup> "; print "<ol class=\"code\"> "; print "<li>"; print "<span class=\"type\">" . $args{'functiontype'} . "</span> "; print "<span class=\"identifier\">" . $args{'function'} . "</span> ("; print "</li>"; $count = 0; foreach $parameter (@{$args{'parameterlist'}}) { print "<li class=\"indent\">"; $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print "<span class=\"type\">$1</span> "; print "<span class=\"param\">$parameter</span>"; print "<span class=\"type\">)</span> "; print "(<span class=\"args\">$2</span>)"; } else { print "<span class=\"type\">$type</span> "; print "<span class=\"param\">$parameter</span>"; } if ($count != $#{$args{'parameterlist'}}) { $count++; print ","; } print "</li> "; } print "<li>)</li> "; print "</ol> "; print "<section> "; print "<h1>Arguments</h1> "; print "<p> "; print "<dl> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; print "<dt>" . $parameter . "</dt> "; print "<dd>"; output_highlight($args{'parameterdescs'}{$parameter_name}); print "</dd> "; } print "</dl> "; print "</section> "; output_section_html5(@_); print "</article> "; } # output DOC: block header in html5 sub output_blockhead_html5(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $html5id; foreach $section (@{$args{'sectionlist'}}) { $html5id = $section; $html5id =~ s/[^a-zA-Z0-9\-]+/_/g; print "<article class=\"doc\" id=\"doc:". $html5id . "\"> "; print "<h1>$section</h1> "; print "<p> "; output_highlight($args{'sections'}{$section}); print "</p> "; } print "</article> "; } |
1da177e4c Linux-2.6.12-rc2 |
1135 1136 |
sub output_section_xml(%) { my %args = %{$_[0]}; |
3c3b809e2 [PATCH] kernel-do... |
1137 |
my $section; |
1da177e4c Linux-2.6.12-rc2 |
1138 1139 1140 |
# print out each section $lineprefix=" "; foreach $section (@{$args{'sectionlist'}}) { |
c73894c1e [PATCH] DocBook: ... |
1141 1142 1143 1144 |
print "<refsect1> "; print "<title>$section</title> "; |
1da177e4c Linux-2.6.12-rc2 |
1145 |
if ($section =~ m/EXAMPLE/i) { |
c73894c1e [PATCH] DocBook: ... |
1146 1147 |
print "<informalexample><programlisting> "; |
e314ba313 kernel-doc: bugfi... |
1148 |
$output_preformatted = 1; |
c73894c1e [PATCH] DocBook: ... |
1149 1150 1151 |
} else { print "<para> "; |
1da177e4c Linux-2.6.12-rc2 |
1152 1153 |
} output_highlight($args{'sections'}{$section}); |
e314ba313 kernel-doc: bugfi... |
1154 |
$output_preformatted = 0; |
1da177e4c Linux-2.6.12-rc2 |
1155 |
if ($section =~ m/EXAMPLE/i) { |
c73894c1e [PATCH] DocBook: ... |
1156 1157 1158 1159 1160 |
print "</programlisting></informalexample> "; } else { print "</para> "; |
1da177e4c Linux-2.6.12-rc2 |
1161 |
} |
c73894c1e [PATCH] DocBook: ... |
1162 1163 |
print "</refsect1> "; |
1da177e4c Linux-2.6.12-rc2 |
1164 1165 1166 1167 1168 1169 1170 1171 1172 |
} } # output function in XML DocBook sub output_function_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id; |
b9d97328e kernel-doc: clean... |
1173 |
$id = "API-" . $args{'function'}; |
1da177e4c Linux-2.6.12-rc2 |
1174 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
1175 1176 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1187 1188 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
1189 1190 |
print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
1191 1192 |
print " <manvolnum>9</manvolnum> "; |
0366299bd kernel-doc: small... |
1193 1194 |
print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1195 1196 1197 1198 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
1199 1200 |
print " <refname>" . $args{'function'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; print " <funcsynopsis><funcprototype> "; |
b9d97328e kernel-doc: clean... |
1216 1217 1218 |
print " <funcdef>" . $args{'functiontype'} . " "; print "<function>" . $args{'function'} . " </function></funcdef> "; |
1da177e4c Linux-2.6.12-rc2 |
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 |
$count = 0; if ($#{$args{'parameterlist'}} >= 0) { foreach $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print " <paramdef>$1<parameter>$parameter</parameter>) "; print " <funcparams>$2</funcparams></paramdef> "; } else { |
b9d97328e kernel-doc: clean... |
1231 |
print " <paramdef>" . $type; |
1da177e4c Linux-2.6.12-rc2 |
1232 1233 1234 1235 1236 |
print " <parameter>$parameter</parameter></paramdef> "; } } } else { |
6013d5445 [PATCH] DocBook: ... |
1237 1238 |
print " <void/> "; |
1da177e4c Linux-2.6.12-rc2 |
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 |
} print " </funcprototype></funcsynopsis> "; print "</refsynopsisdiv> "; # print parameters print "<refsect1> <title>Arguments</title> "; if ($#{$args{'parameterlist'}} >= 0) { print " <variablelist> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; print " <varlistentry> <term><parameter>$parameter</parameter></term> "; print " <listitem> <para> "; $lineprefix=" "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </para> </listitem> </varlistentry> "; } print " </variablelist> "; } else { print " <para> None </para> "; } print "</refsect1> "; output_section_xml(@_); print "</refentry> "; } # output struct in XML DocBook sub output_struct_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $id; |
b9d97328e kernel-doc: clean... |
1291 |
$id = "API-struct-" . $args{'struct'}; |
1da177e4c Linux-2.6.12-rc2 |
1292 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
1293 1294 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1305 1306 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
1307 1308 |
print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
1309 1310 |
print " <manvolnum>9</manvolnum> "; |
0366299bd kernel-doc: small... |
1311 1312 |
print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1313 1314 1315 1316 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
1317 1318 |
print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; print " <programlisting> "; |
b9d97328e kernel-doc: clean... |
1334 1335 |
print $args{'type'} . " " . $args{'struct'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
1336 1337 |
foreach $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { |
2b35f4d9c kernel-doc: escap... |
1338 1339 1340 1341 1342 1343 |
my $prm = $parameter; # convert data read & converted thru xml_escape() into &xyz; format: # This allows us to have #define macros interspersed in a struct. $prm =~ s/\\\\\\/\&/g; print "$prm "; |
1da177e4c Linux-2.6.12-rc2 |
1344 1345 1346 1347 1348 1349 1350 |
next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; defined($args{'parameterdescs'}{$parameter_name}) || next; |
3c308798a scripts: kernel-d... |
1351 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
1352 1353 1354 1355 1356 1357 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print " $1 $parameter) ($2); "; } elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
51f5a0c8f kernel-doc: strip... |
1358 |
# bitfield |
1da177e4c Linux-2.6.12-rc2 |
1359 1360 1361 |
print " $1 $parameter$2; "; } else { |
b9d97328e kernel-doc: clean... |
1362 1363 |
print " " . $type . " " . $parameter . "; "; |
1da177e4c Linux-2.6.12-rc2 |
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 |
} } print "};"; print " </programlisting> "; print "</refsynopsisdiv> "; print " <refsect1> "; print " <title>Members</title> "; |
39f00c087 kernel-doc: allow... |
1376 |
if ($#{$args{'parameterlist'}} >= 0) { |
1da177e4c Linux-2.6.12-rc2 |
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 |
print " <variablelist> "; foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; defined($args{'parameterdescs'}{$parameter_name}) || next; ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; print " <varlistentry>"; print " <term>$parameter</term> "; print " <listitem><para> "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </para></listitem> "; print " </varlistentry> "; } print " </variablelist> "; |
39f00c087 kernel-doc: allow... |
1400 1401 1402 1403 1404 1405 |
} else { print " <para> None </para> "; } |
1da177e4c Linux-2.6.12-rc2 |
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 |
print " </refsect1> "; output_section_xml(@_); print "</refentry> "; } # output enum in XML DocBook sub output_enum_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id; |
b9d97328e kernel-doc: clean... |
1422 |
$id = "API-enum-" . $args{'enum'}; |
1da177e4c Linux-2.6.12-rc2 |
1423 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
1424 1425 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1436 1437 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
1438 1439 |
print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
1440 1441 |
print " <manvolnum>9</manvolnum> "; |
0366299bd kernel-doc: small... |
1442 1443 |
print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1444 1445 1446 1447 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
1448 1449 |
print " <refname>enum " . $args{'enum'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; print " <programlisting> "; |
b9d97328e kernel-doc: clean... |
1465 1466 |
print "enum " . $args{'enum'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
1467 1468 |
$count = 0; foreach $parameter (@{$args{'parameterlist'}}) { |
3c308798a scripts: kernel-d... |
1469 1470 |
print " $parameter"; if ($count != $#{$args{'parameterlist'}}) { |
1da177e4c Linux-2.6.12-rc2 |
1471 1472 |
$count++; print ","; |
3c308798a scripts: kernel-d... |
1473 |
} |
1da177e4c Linux-2.6.12-rc2 |
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 |
print " "; } print "};"; print " </programlisting> "; print "</refsynopsisdiv> "; print "<refsect1> "; |
3c3b809e2 [PATCH] kernel-do... |
1485 1486 |
print " <title>Constants</title> "; |
1da177e4c Linux-2.6.12-rc2 |
1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 |
print " <variablelist> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; print " <varlistentry>"; print " <term>$parameter</term> "; print " <listitem><para> "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </para></listitem> "; print " </varlistentry> "; } print " </variablelist> "; print "</refsect1> "; output_section_xml(@_); print "</refentry> "; } # output typedef in XML DocBook sub output_typedef_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $id; |
b9d97328e kernel-doc: clean... |
1521 |
$id = "API-typedef-" . $args{'typedef'}; |
1da177e4c Linux-2.6.12-rc2 |
1522 |
$id =~ s/[^A-Za-z0-9]/-/g; |
5449bc941 [PATCH] DocBook/H... |
1523 1524 |
print "<refentry id=\"$id\"> "; |
8b0c2d989 [PATCH] DocBook: ... |
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 |
print "<refentryinfo> "; print " <title>LINUX</title> "; print " <productname>Kernel Hackers Manual</productname> "; print " <date>$man_date</date> "; print "</refentryinfo> "; |
1da177e4c Linux-2.6.12-rc2 |
1535 1536 |
print "<refmeta> "; |
b9d97328e kernel-doc: clean... |
1537 1538 |
print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle> "; |
8b0c2d989 [PATCH] DocBook: ... |
1539 1540 |
print " <manvolnum>9</manvolnum> "; |
1da177e4c Linux-2.6.12-rc2 |
1541 1542 1543 1544 |
print "</refmeta> "; print "<refnamediv> "; |
b9d97328e kernel-doc: clean... |
1545 1546 |
print " <refname>typedef " . $args{'typedef'} . "</refname> "; |
1da177e4c Linux-2.6.12-rc2 |
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 |
print " <refpurpose> "; print " "; output_highlight ($args{'purpose'}); print " </refpurpose> "; print "</refnamediv> "; print "<refsynopsisdiv> "; print " <title>Synopsis</title> "; |
b9d97328e kernel-doc: clean... |
1560 1561 |
print " <synopsis>typedef " . $args{'typedef'} . ";</synopsis> "; |
1da177e4c Linux-2.6.12-rc2 |
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 |
print "</refsynopsisdiv> "; output_section_xml(@_); print "</refentry> "; } # output in XML DocBook |
b112e0f73 kernel-doc: singl... |
1573 |
sub output_blockhead_xml(%) { |
1da177e4c Linux-2.6.12-rc2 |
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 |
my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id = $args{'module'}; $id =~ s/[^A-Za-z0-9]/-/g; # print out each section $lineprefix=" "; foreach $section (@{$args{'sectionlist'}}) { |
b112e0f73 kernel-doc: singl... |
1584 1585 1586 1587 1588 |
if (!$args{'content-only'}) { print "<refsect1> <title>$section</title> "; } |
1da177e4c Linux-2.6.12-rc2 |
1589 1590 1591 |
if ($section =~ m/EXAMPLE/i) { print "<example><para> "; |
e314ba313 kernel-doc: bugfi... |
1592 |
$output_preformatted = 1; |
b112e0f73 kernel-doc: singl... |
1593 1594 1595 |
} else { print "<para> "; |
1da177e4c Linux-2.6.12-rc2 |
1596 1597 |
} output_highlight($args{'sections'}{$section}); |
e314ba313 kernel-doc: bugfi... |
1598 |
$output_preformatted = 0; |
1da177e4c Linux-2.6.12-rc2 |
1599 1600 1601 |
if ($section =~ m/EXAMPLE/i) { print "</para></example> "; |
b112e0f73 kernel-doc: singl... |
1602 1603 1604 1605 1606 1607 1608 |
} else { print "</para>"; } if (!$args{'content-only'}) { print " </refsect1> "; |
1da177e4c Linux-2.6.12-rc2 |
1609 |
} |
1da177e4c Linux-2.6.12-rc2 |
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 |
} print " "; } # output in XML DocBook sub output_function_gnome { my %args = %{$_[0]}; my ($parameter, $section); my $count; my $id; |
b9d97328e kernel-doc: clean... |
1623 |
$id = $args{'module'} . "-" . $args{'function'}; |
1da177e4c Linux-2.6.12-rc2 |
1624 1625 1626 1627 |
$id =~ s/[^A-Za-z0-9]/-/g; print "<sect2> "; |
b9d97328e kernel-doc: clean... |
1628 1629 |
print " <title id=\"$id\">" . $args{'function'} . "</title> "; |
1da177e4c Linux-2.6.12-rc2 |
1630 1631 1632 |
print " <funcsynopsis> "; |
b9d97328e kernel-doc: clean... |
1633 1634 |
print " <funcdef>" . $args{'functiontype'} . " "; print "<function>" . $args{'function'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 |
print "</function></funcdef> "; $count = 0; if ($#{$args{'parameterlist'}} >= 0) { foreach $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print " <paramdef>$1 <parameter>$parameter</parameter>) "; print " <funcparams>$2</funcparams></paramdef> "; } else { |
b9d97328e kernel-doc: clean... |
1649 |
print " <paramdef>" . $type; |
1da177e4c Linux-2.6.12-rc2 |
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 |
print " <parameter>$parameter</parameter></paramdef> "; } } } else { print " <void> "; } print " </funcsynopsis> "; if ($#{$args{'parameterlist'}} >= 0) { print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\"> "; print "<tgroup cols=\"2\"> "; print "<colspec colwidth=\"2*\"> "; print "<colspec colwidth=\"8*\"> "; print "<tbody> "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry> "; print " <entry> "; $lineprefix=" "; output_highlight($args{'parameterdescs'}{$parameter_name}); print " </entry></row> "; } print " </tbody></tgroup></informaltable> "; } else { print " <para> None </para> "; } # print out each section $lineprefix=" "; foreach $section (@{$args{'sectionlist'}}) { print "<simplesect> <title>$section</title> "; if ($section =~ m/EXAMPLE/i) { print "<example><programlisting> "; |
e314ba313 kernel-doc: bugfi... |
1702 |
$output_preformatted = 1; |
1da177e4c Linux-2.6.12-rc2 |
1703 1704 1705 1706 1707 |
} else { } print "<para> "; output_highlight($args{'sections'}{$section}); |
e314ba313 kernel-doc: bugfi... |
1708 |
$output_preformatted = 0; |
1da177e4c Linux-2.6.12-rc2 |
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 |
print "</para> "; if ($section =~ m/EXAMPLE/i) { print "</programlisting></example> "; } else { } print " </simplesect> "; } print "</sect2> "; } ## # 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... |
1737 1738 |
print $args{'function'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1739 1740 1741 |
print ".SH SYNOPSIS "; |
a21217daa [PATCH] kernel-do... |
1742 |
if ($args{'functiontype'} ne "") { |
b9d97328e kernel-doc: clean... |
1743 1744 |
print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . " "; |
a21217daa [PATCH] kernel-do... |
1745 |
} else { |
b9d97328e kernel-doc: clean... |
1746 1747 |
print ".B \"" . $args{'function'} . " "; |
a21217daa [PATCH] kernel-do... |
1748 |
} |
1da177e4c Linux-2.6.12-rc2 |
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 |
$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... |
1759 1760 |
print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\" "; |
1da177e4c Linux-2.6.12-rc2 |
1761 1762 |
} else { $type =~ s/([^\*])$/$1 /; |
b9d97328e kernel-doc: clean... |
1763 1764 |
print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\" "; |
1da177e4c Linux-2.6.12-rc2 |
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 |
} $count++; $parenth = ""; } print ".SH ARGUMENTS "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
b9d97328e kernel-doc: clean... |
1775 1776 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c Linux-2.6.12-rc2 |
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 |
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... |
1798 1799 |
print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1800 1801 1802 |
print ".SH SYNOPSIS "; |
b9d97328e kernel-doc: clean... |
1803 1804 |
print "enum " . $args{'enum'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
1805 1806 |
$count = 0; foreach my $parameter (@{$args{'parameterlist'}}) { |
3c308798a scripts: kernel-d... |
1807 1808 1809 |
print ".br .BI \" $parameter\" "; |
1da177e4c Linux-2.6.12-rc2 |
1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 |
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... |
1829 1830 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c Linux-2.6.12-rc2 |
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 |
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... |
1845 1846 |
print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX "; |
1da177e4c Linux-2.6.12-rc2 |
1847 1848 1849 |
print ".SH NAME "; |
b9d97328e kernel-doc: clean... |
1850 1851 |
print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1852 1853 1854 |
print ".SH SYNOPSIS "; |
b9d97328e kernel-doc: clean... |
1855 1856 1857 |
print $args{'type'} . " " . $args{'struct'} . " { .br "; |
1da177e4c Linux-2.6.12-rc2 |
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 |
foreach my $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { print ".BI \"$parameter\" .br "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
1868 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
1869 1870 1871 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
b9d97328e kernel-doc: clean... |
1872 1873 1874 |
print ".BI \" " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\" ; "; |
1da177e4c Linux-2.6.12-rc2 |
1875 |
} elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
1d7e1d451 [PATCH] kernel-do... |
1876 |
# bitfield |
b9d97328e kernel-doc: clean... |
1877 1878 1879 |
print ".BI \" " . $1 . "\ \" " . $parameter . $2 . " \"" . "\" ; "; |
1da177e4c Linux-2.6.12-rc2 |
1880 1881 |
} else { $type =~ s/([^\*])$/$1 /; |
b9d97328e kernel-doc: clean... |
1882 1883 1884 |
print ".BI \" " . $type . "\" " . $parameter . " \"" . "\" ; "; |
1da177e4c Linux-2.6.12-rc2 |
1885 1886 1887 1888 1889 1890 1891 1892 |
} print " .br "; } print "}; .br "; |
c51d3dac3 [PATCH] kernel-do... |
1893 1894 |
print ".SH Members "; |
1da177e4c Linux-2.6.12-rc2 |
1895 1896 1897 1898 1899 |
foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
1900 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
b9d97328e kernel-doc: clean... |
1901 1902 |
print ".IP \"" . $parameter . "\" 12 "; |
1da177e4c Linux-2.6.12-rc2 |
1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 |
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... |
1923 1924 |
print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
1925 1926 1927 1928 1929 1930 1931 |
foreach $section (@{$args{'sectionlist'}}) { print ".SH \"$section\" "; output_highlight($args{'sections'}{$section}); } } |
b112e0f73 kernel-doc: singl... |
1932 |
sub output_blockhead_man(%) { |
1da177e4c Linux-2.6.12-rc2 |
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 |
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}); } } ## # output in text sub output_function_text(%) { my %args = %{$_[0]}; my ($parameter, $section); |
a21217daa [PATCH] kernel-do... |
1952 |
my $start; |
1da177e4c Linux-2.6.12-rc2 |
1953 |
|
f47634b27 [PATCH] kernel-do... |
1954 1955 1956 |
print "Name: "; |
b9d97328e kernel-doc: clean... |
1957 1958 |
print $args{'function'} . " - " . $args{'purpose'} . " "; |
f47634b27 [PATCH] kernel-do... |
1959 1960 1961 1962 1963 |
print " Synopsis: "; |
a21217daa [PATCH] kernel-do... |
1964 |
if ($args{'functiontype'} ne "") { |
b9d97328e kernel-doc: clean... |
1965 |
$start = $args{'functiontype'} . " " . $args{'function'} . " ("; |
a21217daa [PATCH] kernel-do... |
1966 |
} else { |
b9d97328e kernel-doc: clean... |
1967 |
$start = $args{'function'} . " ("; |
a21217daa [PATCH] kernel-do... |
1968 |
} |
1da177e4c Linux-2.6.12-rc2 |
1969 |
print $start; |
a21217daa [PATCH] kernel-do... |
1970 |
|
1da177e4c Linux-2.6.12-rc2 |
1971 1972 1973 1974 1975 |
my $count = 0; foreach my $parameter (@{$args{'parameterlist'}}) { $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function |
b9d97328e kernel-doc: clean... |
1976 |
print $1 . $parameter . ") (" . $2; |
1da177e4c Linux-2.6.12-rc2 |
1977 |
} else { |
b9d97328e kernel-doc: clean... |
1978 |
print $type . " " . $parameter; |
1da177e4c Linux-2.6.12-rc2 |
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 |
} if ($count != $#{$args{'parameterlist'}}) { $count++; print ", "; print " " x length($start); } else { print "); "; } } print "Arguments: "; foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
b9d97328e kernel-doc: clean... |
1998 1999 2000 |
print $parameter . " \t" . $args{'parameterdescs'}{$parameter_name} . " "; |
1da177e4c Linux-2.6.12-rc2 |
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 |
} output_section_text(@_); } #output sections in text sub output_section_text(%) { my %args = %{$_[0]}; my $section; print " "; foreach $section (@{$args{'sectionlist'}}) { print "$section: "; output_highlight($args{'sections'}{$section}); |
3c3b809e2 [PATCH] kernel-do... |
2017 |
} |
1da177e4c Linux-2.6.12-rc2 |
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 |
print " "; } # output enum in text sub output_enum_text(%) { my %args = %{$_[0]}; my ($parameter); my $count; print "Enum: "; |
b9d97328e kernel-doc: clean... |
2031 2032 2033 2034 2035 |
print "enum " . $args{'enum'} . " - " . $args{'purpose'} . " "; print "enum " . $args{'enum'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
2036 2037 |
$count = 0; foreach $parameter (@{$args{'parameterlist'}}) { |
3c308798a scripts: kernel-d... |
2038 |
print "\t$parameter"; |
1da177e4c Linux-2.6.12-rc2 |
2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 |
if ($count != $#{$args{'parameterlist'}}) { $count++; print ","; } print " "; } print "}; "; print "Constants: "; foreach $parameter (@{$args{'parameterlist'}}) { print "$parameter \t"; |
b9d97328e kernel-doc: clean... |
2056 2057 |
print $args{'parameterdescs'}{$parameter} . " "; |
1da177e4c Linux-2.6.12-rc2 |
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 |
} output_section_text(@_); } # output typedef in text sub output_typedef_text(%) { my %args = %{$_[0]}; my ($parameter); my $count; print "Typedef: "; |
b9d97328e kernel-doc: clean... |
2071 2072 |
print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . " "; |
1da177e4c Linux-2.6.12-rc2 |
2073 2074 2075 2076 2077 2078 2079 |
output_section_text(@_); } # output struct as text sub output_struct_text(%) { my %args = %{$_[0]}; my ($parameter); |
b9d97328e kernel-doc: clean... |
2080 2081 2082 2083 2084 |
print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . " "; print $args{'type'} . " " . $args{'struct'} . " { "; |
1da177e4c Linux-2.6.12-rc2 |
2085 2086 2087 2088 2089 2090 2091 2092 2093 |
foreach $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { print "$parameter "; next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
2094 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
2095 2096 2097 2098 2099 2100 |
$type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print "\t$1 $parameter) ($2); "; } elsif ($type =~ m/^(.*?)\s*(:.*)/) { |
51f5a0c8f kernel-doc: strip... |
2101 |
# bitfield |
1da177e4c Linux-2.6.12-rc2 |
2102 2103 2104 |
print "\t$1 $parameter$2; "; } else { |
b9d97328e kernel-doc: clean... |
2105 2106 |
print "\t" . $type . " " . $parameter . "; "; |
1da177e4c Linux-2.6.12-rc2 |
2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 |
} } print "}; "; print "Members: "; foreach $parameter (@{$args{'parameterlist'}}) { ($parameter =~ /^#/) && next; my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; |
3c308798a scripts: kernel-d... |
2121 |
($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
1da177e4c Linux-2.6.12-rc2 |
2122 2123 |
print "$parameter \t"; |
b9d97328e kernel-doc: clean... |
2124 2125 |
print $args{'parameterdescs'}{$parameter_name} . " "; |
1da177e4c Linux-2.6.12-rc2 |
2126 2127 2128 2129 2130 |
} print " "; output_section_text(@_); } |
b112e0f73 kernel-doc: singl... |
2131 |
sub output_blockhead_text(%) { |
1da177e4c Linux-2.6.12-rc2 |
2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 |
my %args = %{$_[0]}; my ($parameter, $section); foreach $section (@{$args{'sectionlist'}}) { print " $section: "; print " -> "; output_highlight($args{'sections'}{$section}); } } |
c0d1b6ee7 kernel-doc: produ... |
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 |
## # 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... |
2156 2157 2158 2159 2160 |
if ($output_selection != OUTPUT_INCLUDE) { print "**$section** "; } |
0b0f5f29b scripts/kernel-do... |
2161 |
print_lineno($section_start_lines{$section}); |
c0d1b6ee7 kernel-doc: produ... |
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 |
output_highlight_rst($args{'sections'}{$section}); print " "; } } sub output_highlight_rst { my $contents = join " ",@_; my $line; # undo the evil effects of xml_escape() earlier $contents = xml_unescape($contents); eval $dohighlight; die $@ if $@; foreach $line (split " ", $contents) { |
830066a7a kernel-doc/rst: b... |
2181 2182 |
print $lineprefix . $line . " "; |
c0d1b6ee7 kernel-doc: produ... |
2183 2184 2185 2186 2187 2188 |
} } sub output_function_rst(%) { my %args = %{$_[0]}; my ($parameter, $section); |
c099ff698 kernel-doc/rst: h... |
2189 |
my $oldprefix = $lineprefix; |
82801d065 docs-rst: kernel-... |
2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 |
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... |
2208 |
if ($args{'functiontype'} ne "") { |
82801d065 docs-rst: kernel-... |
2209 |
$start .= $args{'functiontype'} . " " . $args{'function'} . " ("; |
c0d1b6ee7 kernel-doc: produ... |
2210 |
} else { |
82801d065 docs-rst: kernel-... |
2211 |
$start .= $args{'function'} . " ("; |
c0d1b6ee7 kernel-doc: produ... |
2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 |
} 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... |
2222 |
|
c0d1b6ee7 kernel-doc: produ... |
2223 2224 2225 2226 2227 2228 2229 |
if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print $1 . $parameter . ") (" . $2; } else { print $type . " " . $parameter; } } |
82801d065 docs-rst: kernel-... |
2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 |
if ($args{'typedef'}) { print ");`` "; } else { print ") "; print_lineno($declaration_start_line); $lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; } |
c0d1b6ee7 kernel-doc: produ... |
2244 |
|
ecbcfba12 kernel-doc/rst: c... |
2245 2246 2247 2248 |
print "**Parameters** "; $lineprefix = " "; |
c0d1b6ee7 kernel-doc: produ... |
2249 2250 2251 2252 2253 2254 |
foreach $parameter (@{$args{'parameterlist'}}) { my $parameter_name = $parameter; #$parameter_name =~ s/\[.*//; $type = $args{'parametertypes'}{$parameter}; if ($type ne "") { |
ecbcfba12 kernel-doc/rst: c... |
2255 2256 |
print "``$type $parameter`` "; |
c0d1b6ee7 kernel-doc: produ... |
2257 |
} else { |
ecbcfba12 kernel-doc/rst: c... |
2258 2259 |
print "``$parameter`` "; |
c0d1b6ee7 kernel-doc: produ... |
2260 |
} |
0b0f5f29b scripts/kernel-do... |
2261 2262 |
print_lineno($parameterdesc_start_lines{$parameter_name}); |
5e64fa9c4 kernel-doc/rst: f... |
2263 2264 |
if (defined($args{'parameterdescs'}{$parameter_name}) && $args{'parameterdescs'}{$parameter_name} ne $undescribed) { |
c0d1b6ee7 kernel-doc: produ... |
2265 |
output_highlight_rst($args{'parameterdescs'}{$parameter_name}); |
c0d1b6ee7 kernel-doc: produ... |
2266 |
} else { |
d4b08e0cd kernel-doc/rst: u... |
2267 2268 |
print " *undescribed* "; |
c0d1b6ee7 kernel-doc: produ... |
2269 2270 2271 2272 |
} print " "; } |
c099ff698 kernel-doc/rst: h... |
2273 2274 |
$lineprefix = $oldprefix; |
c0d1b6ee7 kernel-doc: produ... |
2275 2276 2277 2278 2279 2280 2281 |
output_section_rst(@_); } sub output_section_rst(%) { my %args = %{$_[0]}; my $section; my $oldprefix = $lineprefix; |
ecbcfba12 kernel-doc/rst: c... |
2282 |
$lineprefix = ""; |
c0d1b6ee7 kernel-doc: produ... |
2283 2284 |
foreach $section (@{$args{'sectionlist'}}) { |
ecbcfba12 kernel-doc/rst: c... |
2285 2286 2287 |
print "**$section** "; |
0b0f5f29b scripts/kernel-do... |
2288 |
print_lineno($section_start_lines{$section}); |
c0d1b6ee7 kernel-doc: produ... |
2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 |
output_highlight_rst($args{'sections'}{$section}); print " "; } print " "; $lineprefix = $oldprefix; } sub output_enum_rst(%) { my %args = %{$_[0]}; my ($parameter); |
c099ff698 kernel-doc/rst: h... |
2301 |
my $oldprefix = $lineprefix; |
c0d1b6ee7 kernel-doc: produ... |
2302 |
my $count; |
c0d1b6ee7 kernel-doc: produ... |
2303 |
my $name = "enum " . $args{'enum'}; |
628509765 kernel-doc: use r... |
2304 2305 2306 2307 2308 2309 |
print " .. c:type:: " . $name . " "; |
0b0f5f29b scripts/kernel-do... |
2310 |
print_lineno($declaration_start_line); |
c099ff698 kernel-doc/rst: h... |
2311 2312 2313 2314 |
$lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; |
c0d1b6ee7 kernel-doc: produ... |
2315 |
|
ecbcfba12 kernel-doc/rst: c... |
2316 2317 2318 2319 |
print "**Constants** "; $lineprefix = " "; |
c0d1b6ee7 kernel-doc: produ... |
2320 |
foreach $parameter (@{$args{'parameterlist'}}) { |
ecbcfba12 kernel-doc/rst: c... |
2321 2322 |
print "``$parameter`` "; |
c0d1b6ee7 kernel-doc: produ... |
2323 2324 2325 |
if ($args{'parameterdescs'}{$parameter} ne $undescribed) { output_highlight_rst($args{'parameterdescs'}{$parameter}); } else { |
d4b08e0cd kernel-doc/rst: u... |
2326 2327 |
print " *undescribed* "; |
c0d1b6ee7 kernel-doc: produ... |
2328 2329 2330 2331 |
} print " "; } |
c099ff698 kernel-doc/rst: h... |
2332 |
|
c0d1b6ee7 kernel-doc: produ... |
2333 2334 2335 2336 2337 2338 2339 |
$lineprefix = $oldprefix; output_section_rst(@_); } sub output_typedef_rst(%) { my %args = %{$_[0]}; my ($parameter); |
c099ff698 kernel-doc/rst: h... |
2340 |
my $oldprefix = $lineprefix; |
c0d1b6ee7 kernel-doc: produ... |
2341 |
my $name = "typedef " . $args{'typedef'}; |
628509765 kernel-doc: use r... |
2342 2343 2344 2345 2346 |
print " .. c:type:: " . $name . " "; |
0b0f5f29b scripts/kernel-do... |
2347 |
print_lineno($declaration_start_line); |
c099ff698 kernel-doc/rst: h... |
2348 2349 2350 2351 |
$lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; |
c0d1b6ee7 kernel-doc: produ... |
2352 |
|
c099ff698 kernel-doc/rst: h... |
2353 |
$lineprefix = $oldprefix; |
c0d1b6ee7 kernel-doc: produ... |
2354 2355 2356 2357 2358 2359 |
output_section_rst(@_); } sub output_struct_rst(%) { my %args = %{$_[0]}; my ($parameter); |
c099ff698 kernel-doc/rst: h... |
2360 |
my $oldprefix = $lineprefix; |
c0d1b6ee7 kernel-doc: produ... |
2361 |
my $name = $args{'type'} . " " . $args{'struct'}; |
628509765 kernel-doc: use r... |
2362 2363 2364 2365 2366 |
print " .. c:type:: " . $name . " "; |
0b0f5f29b scripts/kernel-do... |
2367 |
print_lineno($declaration_start_line); |
c099ff698 kernel-doc/rst: h... |
2368 2369 2370 2371 |
$lineprefix = " "; output_highlight_rst($args{'purpose'}); print " "; |
c0d1b6ee7 kernel-doc: produ... |
2372 |
|
ecbcfba12 kernel-doc/rst: c... |
2373 2374 2375 2376 2377 2378 |
print "**Definition** "; print ":: "; |
c0d1b6ee7 kernel-doc: produ... |
2379 2380 2381 2382 |
print " " . $args{'type'} . " " . $args{'struct'} . " { "; foreach $parameter (@{$args{'parameterlist'}}) { if ($parameter =~ /^#/) { |
ecbcfba12 kernel-doc/rst: c... |
2383 2384 |
print " " . "$parameter "; |
c0d1b6ee7 kernel-doc: produ... |
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 |
next; } my $parameter_name = $parameter; $parameter_name =~ s/\[.*//; ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; $type = $args{'parametertypes'}{$parameter}; if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function print " $1 $parameter) ($2); "; } elsif ($type =~ m/^(.*?)\s*(:.*)/) { # bitfield print " $1 $parameter$2; "; } else { print " " . $type . " " . $parameter . "; "; } } print " }; "; |
ecbcfba12 kernel-doc/rst: c... |
2409 2410 2411 2412 |
print "**Members** "; $lineprefix = " "; |
c0d1b6ee7 kernel-doc: produ... |
2413 2414 2415 2416 2417 2418 2419 2420 |
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... |
2421 |
print_lineno($parameterdesc_start_lines{$parameter_name}); |
6d232c801 docs-rst: kernel-... |
2422 2423 |
print "``" . $parameter . "`` "; |
c0d1b6ee7 kernel-doc: produ... |
2424 |
output_highlight_rst($args{'parameterdescs'}{$parameter_name}); |
c0d1b6ee7 kernel-doc: produ... |
2425 2426 2427 2428 2429 |
print " "; } print " "; |
c099ff698 kernel-doc/rst: h... |
2430 2431 |
$lineprefix = $oldprefix; |
c0d1b6ee7 kernel-doc: produ... |
2432 2433 |
output_section_rst(@_); } |
eda603f6c docbook: warn on ... |
2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
## list mode output functions sub output_function_list(%) { my %args = %{$_[0]}; print $args{'function'} . " "; } # output enum in list sub output_enum_list(%) { my %args = %{$_[0]}; print $args{'enum'} . " "; } # output typedef in list sub output_typedef_list(%) { my %args = %{$_[0]}; print $args{'typedef'} . " "; } # output struct as list sub output_struct_list(%) { my %args = %{$_[0]}; print $args{'struct'} . " "; } sub output_blockhead_list(%) { my %args = %{$_[0]}; my ($parameter, $section); foreach $section (@{$args{'sectionlist'}}) { print "DOC: $section "; } } |
1da177e4c Linux-2.6.12-rc2 |
2474 |
## |
272057447 [PATCH] kernel-do... |
2475 2476 2477 |
# 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 |
2478 2479 2480 2481 2482 |
sub output_declaration { no strict 'refs'; my $name = shift; my $functype = shift; my $func = "output_${functype}_$output_mode"; |
b6c3f456c kernel-doc: add n... |
2483 2484 2485 2486 2487 2488 2489 |
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 |
2490 |
{ |
3c308798a scripts: kernel-d... |
2491 |
&$func(@_); |
1da177e4c Linux-2.6.12-rc2 |
2492 2493 2494 2495 2496 |
$section_counter++; } } ## |
272057447 [PATCH] kernel-do... |
2497 |
# generic output function - calls the right one based on current output mode. |
b112e0f73 kernel-doc: singl... |
2498 |
sub output_blockhead { |
1da177e4c Linux-2.6.12-rc2 |
2499 |
no strict 'refs'; |
b9d97328e kernel-doc: clean... |
2500 |
my $func = "output_blockhead_" . $output_mode; |
1da177e4c Linux-2.6.12-rc2 |
2501 2502 2503 2504 2505 |
&$func(@_); $section_counter++; } ## |
3c3b809e2 [PATCH] kernel-do... |
2506 |
# takes a declaration (struct, union, enum, typedef) and |
1da177e4c Linux-2.6.12-rc2 |
2507 2508 2509 2510 |
# invokes the right handler. NOT called for functions. sub dump_declaration($$) { no strict 'refs'; my ($prototype, $file) = @_; |
b9d97328e kernel-doc: clean... |
2511 |
my $func = "dump_" . $decl_type; |
1da177e4c Linux-2.6.12-rc2 |
2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 |
&$func(@_); } sub dump_union($$) { dump_struct(@_); } sub dump_struct($$) { my $x = shift; my $file = shift; |
a1d94aa55 kernel-doc: check... |
2522 |
my $nested; |
1da177e4c Linux-2.6.12-rc2 |
2523 |
|
52dc5aec9 kernel-doc: restr... |
2524 2525 |
if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) { #my $decl_type = $1; |
3c308798a scripts: kernel-d... |
2526 2527 |
$declaration_name = $2; my $members = $3; |
1da177e4c Linux-2.6.12-rc2 |
2528 2529 |
# ignore embedded structs or unions |
a1d94aa55 kernel-doc: check... |
2530 2531 |
$members =~ s/({.*})//g; $nested = $1; |
1da177e4c Linux-2.6.12-rc2 |
2532 |
|
aeec46b97 [PATCH] DocBook: ... |
2533 |
# ignore members marked private: |
0d8c39e6c DocBook: Fix kern... |
2534 2535 |
$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; $members =~ s/\/\*\s*private:.*//gosi; |
aeec46b97 [PATCH] DocBook: ... |
2536 2537 |
# strip comments: $members =~ s/\/\*.*?\*\///gos; |
a1d94aa55 kernel-doc: check... |
2538 |
$nested =~ s/\/\*.*?\*\///gos; |
d960eea97 kernel-doc: move ... |
2539 2540 |
# strip kmemcheck_bitfield_{begin,end}.*; $members =~ s/kmemcheck_bitfield_.*?;//gos; |
ef5da59f1 scripts/kernel-do... |
2541 |
# strip attributes |
f00749296 kernel-doc: ignor... |
2542 |
$members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; |
7b990789a scripts/kernel-do... |
2543 |
$members =~ s/__aligned\s*\([^;]*\)//gos; |
f00749296 kernel-doc: ignor... |
2544 |
$members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos; |
b22b5a9ef kernel-doc: Fix p... |
2545 2546 |
# replace DECLARE_BITMAP $members =~ s/DECLARE_BITMAP\s*\(([^,)]+), ([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; |
aeec46b97 [PATCH] DocBook: ... |
2547 |
|
1da177e4c Linux-2.6.12-rc2 |
2548 |
create_parameterlist($members, ';', $file); |
a1d94aa55 kernel-doc: check... |
2549 |
check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested); |
1da177e4c Linux-2.6.12-rc2 |
2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 |
output_declaration($declaration_name, 'struct', {'struct' => $declaration_name, 'module' => $modulename, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, 'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose, 'type' => $decl_type }); } else { |
d40e1e653 kerneldoc: Conver... |
2565 2566 |
print STDERR "${file}:$.: error: Cannot parse struct or union! "; |
1da177e4c Linux-2.6.12-rc2 |
2567 2568 2569 2570 2571 2572 2573 |
++$errors; } } sub dump_enum($$) { my $x = shift; my $file = shift; |
aeec46b97 [PATCH] DocBook: ... |
2574 |
$x =~ s@/\*.*?\*/@@gos; # strip comments. |
4468e21ee kernel-doc: Strip... |
2575 2576 |
# strip #define macros inside enums $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; |
b6d676db3 mtd/nand_base: fi... |
2577 |
|
1da177e4c Linux-2.6.12-rc2 |
2578 |
if ($x =~ /enum\s+(\w+)\s*{(.*)}/) { |
3c308798a scripts: kernel-d... |
2579 2580 |
$declaration_name = $1; my $members = $2; |
1da177e4c Linux-2.6.12-rc2 |
2581 2582 2583 2584 2585 |
foreach my $arg (split ',', $members) { $arg =~ s/^\s*(\w+).*/$1/; push @parameterlist, $arg; if (!$parameterdescs{$arg}) { |
3c308798a scripts: kernel-d... |
2586 |
$parameterdescs{$arg} = $undescribed; |
d40e1e653 kerneldoc: Conver... |
2587 |
print STDERR "${file}:$.: warning: Enum value '$arg' ". |
1da177e4c Linux-2.6.12-rc2 |
2588 2589 2590 2591 2592 |
"not described in enum '$declaration_name' "; } } |
3c3b809e2 [PATCH] kernel-do... |
2593 |
|
1da177e4c Linux-2.6.12-rc2 |
2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 |
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... |
2606 2607 |
print STDERR "${file}:$.: error: Cannot parse enum! "; |
1da177e4c Linux-2.6.12-rc2 |
2608 2609 2610 2611 2612 2613 2614 |
++$errors; } } sub dump_typedef($$) { my $x = shift; my $file = shift; |
aeec46b97 [PATCH] DocBook: ... |
2615 |
$x =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4c Linux-2.6.12-rc2 |
2616 |
|
837664528 kernel-doc: bette... |
2617 |
# Parse function prototypes |
d37c43ce1 docs-rst: improve... |
2618 2619 |
if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ || $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) { |
837664528 kernel-doc: bette... |
2620 2621 2622 2623 2624 2625 |
# Function typedefs $return_type = $1; $declaration_name = $2; my $args = $3; create_parameterlist($args, ',', $file); |
1da177e4c Linux-2.6.12-rc2 |
2626 2627 |
output_declaration($declaration_name, |
837664528 kernel-doc: bette... |
2628 2629 |
'function', {'function' => $declaration_name, |
82801d065 docs-rst: kernel-... |
2630 |
'typedef' => 1, |
1da177e4c Linux-2.6.12-rc2 |
2631 |
'module' => $modulename, |
837664528 kernel-doc: bette... |
2632 2633 2634 2635 |
'functiontype' => $return_type, 'parameterlist' => \@parameterlist, 'parameterdescs' => \%parameterdescs, 'parametertypes' => \%parametertypes, |
1da177e4c Linux-2.6.12-rc2 |
2636 2637 2638 2639 |
'sectionlist' => \@sectionlist, 'sections' => \%sections, 'purpose' => $declaration_purpose }); |
837664528 kernel-doc: bette... |
2640 2641 2642 2643 2644 2645 |
return; } while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { $x =~ s/\(*.\)\s*;$/;/; $x =~ s/\[*.\]\s*;$/;/; |
1da177e4c Linux-2.6.12-rc2 |
2646 |
} |
837664528 kernel-doc: bette... |
2647 2648 |
if ($x =~ /typedef.*\s+(\w+)\s*;/) { |
3a80a7663 kernel-doc: Add a... |
2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 |
$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 |
2660 |
else { |
d40e1e653 kerneldoc: Conver... |
2661 2662 |
print STDERR "${file}:$.: error: Cannot parse typedef! "; |
1da177e4c Linux-2.6.12-rc2 |
2663 2664 2665 |
++$errors; } } |
a1d94aa55 kernel-doc: check... |
2666 2667 2668 2669 2670 2671 2672 |
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 . " "; } |
1da177e4c Linux-2.6.12-rc2 |
2673 2674 2675 2676 2677 2678 |
sub create_parameterlist($$$) { my $args = shift; my $splitter = shift; my $file = shift; my $type; my $param; |
a6d3fe77d [PATCH] DocBook: ... |
2679 |
# temporarily replace commas inside function pointer definition |
1da177e4c Linux-2.6.12-rc2 |
2680 |
while ($args =~ /(\([^\),]+),/) { |
3c308798a scripts: kernel-d... |
2681 |
$args =~ s/(\([^\),]+),/$1#/g; |
1da177e4c Linux-2.6.12-rc2 |
2682 |
} |
3c3b809e2 [PATCH] kernel-do... |
2683 |
|
1da177e4c Linux-2.6.12-rc2 |
2684 2685 2686 |
foreach my $arg (split($splitter, $args)) { # strip comments $arg =~ s/\/\*.*\*\///; |
3c308798a scripts: kernel-d... |
2687 2688 |
# strip leading/trailing spaces $arg =~ s/^\s*//; |
1da177e4c Linux-2.6.12-rc2 |
2689 2690 2691 2692 2693 2694 2695 2696 |
$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... |
2697 |
} elsif ($arg =~ m/\(.+\)\s*\(/) { |
1da177e4c Linux-2.6.12-rc2 |
2698 2699 |
# pointer-to-function $arg =~ tr/#/,/; |
00d629614 kernel-doc: fix f... |
2700 |
$arg =~ m/[^\(]+\(\*?\s*(\w*)\s*\)/; |
1da177e4c Linux-2.6.12-rc2 |
2701 2702 |
$param = $1; $type = $arg; |
00d629614 kernel-doc: fix f... |
2703 |
$type =~ s/([^\(]+\(\*?)\s*$param/$1/; |
a1d94aa55 kernel-doc: check... |
2704 |
save_struct_actual($param); |
1da177e4c Linux-2.6.12-rc2 |
2705 |
push_parameter($param, $type, $file); |
aeec46b97 [PATCH] DocBook: ... |
2706 |
} elsif ($arg) { |
1da177e4c Linux-2.6.12-rc2 |
2707 2708 2709 2710 2711 2712 2713 |
$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... |
2714 2715 2716 2717 2718 2719 2720 2721 2722 |
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 |
2723 2724 2725 2726 2727 |
unshift(@args, pop @first_arg); $type = join " ", @first_arg; foreach $param (@args) { if ($param =~ m/^(\*+)\s*(.*)/) { |
a1d94aa55 kernel-doc: check... |
2728 |
save_struct_actual($2); |
1da177e4c Linux-2.6.12-rc2 |
2729 2730 2731 |
push_parameter($2, "$type $1", $file); } elsif ($param =~ m/(.*?):(\d+)/) { |
7b97887ea kernel-doc: allow... |
2732 |
if ($type ne "") { # skip unnamed bit-fields |
a1d94aa55 kernel-doc: check... |
2733 |
save_struct_actual($1); |
7b97887ea kernel-doc: allow... |
2734 2735 |
push_parameter($1, "$type:$2", $file) } |
1da177e4c Linux-2.6.12-rc2 |
2736 2737 |
} else { |
a1d94aa55 kernel-doc: check... |
2738 |
save_struct_actual($param); |
1da177e4c Linux-2.6.12-rc2 |
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 |
push_parameter($param, $type, $file); } } } } } sub push_parameter($$$) { my $param = shift; my $type = shift; my $file = shift; |
5f8c7c98a kernel-doc: fix u... |
2750 2751 2752 2753 2754 2755 |
if (($anon_struct_union == 1) && ($type eq "") && ($param eq "}")) { return; # ignore the ending }; from anon. struct/union } $anon_struct_union = 0; |
1da177e4c Linux-2.6.12-rc2 |
2756 2757 |
my $param_name = $param; $param_name =~ s/\[.*//; |
a6d3fe77d [PATCH] DocBook: ... |
2758 |
if ($type eq "" && $param =~ /\.\.\.$/) |
1da177e4c Linux-2.6.12-rc2 |
2759 |
{ |
ef00028b2 docs: make kernel... |
2760 |
$param = "..."; |
ced69090c kernel-doc: handl... |
2761 2762 2763 |
if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { $parameterdescs{$param} = "variable arguments"; } |
1da177e4c Linux-2.6.12-rc2 |
2764 2765 2766 |
} elsif ($type eq "" && ($param eq "" or $param eq "void")) { |
1da177e4c Linux-2.6.12-rc2 |
2767 2768 2769 |
$param="void"; $parameterdescs{void} = "no arguments"; } |
134fe01bf [PATCH] kernel-do... |
2770 2771 2772 2773 |
elsif ($type eq "" && ($param eq "struct" or $param eq "union")) # handle unnamed (anonymous) union or struct: { $type = $param; |
5f8c7c98a kernel-doc: fix u... |
2774 |
$param = "{unnamed_" . $param . "}"; |
134fe01bf [PATCH] kernel-do... |
2775 2776 |
$parameterdescs{$param} = "anonymous "; |
5f8c7c98a kernel-doc: fix u... |
2777 |
$anon_struct_union = 1; |
134fe01bf [PATCH] kernel-do... |
2778 |
} |
a6d3fe77d [PATCH] DocBook: ... |
2779 |
# warn if parameter has no description |
134fe01bf [PATCH] kernel-do... |
2780 2781 2782 |
# (but ignore ones starting with # as these are not parameters # but inline preprocessor statements); # also ignore unnamed structs/unions; |
5f8c7c98a kernel-doc: fix u... |
2783 |
if (!$anon_struct_union) { |
a6d3fe77d [PATCH] DocBook: ... |
2784 |
if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) { |
1da177e4c Linux-2.6.12-rc2 |
2785 2786 2787 |
$parameterdescs{$param_name} = $undescribed; if (($type eq 'function') || ($type eq 'enum')) { |
d40e1e653 kerneldoc: Conver... |
2788 |
print STDERR "${file}:$.: warning: Function parameter ". |
1da177e4c Linux-2.6.12-rc2 |
2789 2790 2791 2792 |
"or member '$param' not " . "described in '$declaration_name' "; } |
d40e1e653 kerneldoc: Conver... |
2793 |
print STDERR "${file}:$.: warning:" . |
3c308798a scripts: kernel-d... |
2794 2795 |
" No description found for parameter '$param' "; |
1da177e4c Linux-2.6.12-rc2 |
2796 |
++$warnings; |
3c308798a scripts: kernel-d... |
2797 2798 |
} } |
1da177e4c Linux-2.6.12-rc2 |
2799 |
|
2b35f4d9c kernel-doc: escap... |
2800 |
$param = xml_escape($param); |
25985edce Fix common misspe... |
2801 |
# strip spaces from $param so that it is one continuous string |
e34e7dbb3 kernel-doc: fix p... |
2802 2803 2804 2805 2806 2807 2808 2809 |
# 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 |
2810 2811 2812 |
push @parameterlist, $param; $parametertypes{$param} = $type; } |
a1d94aa55 kernel-doc: check... |
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 |
sub check_sections($$$$$$) { my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck, $nested) = @_; 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... |
2826 |
$prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; |
e34e7dbb3 kernel-doc: fix p... |
2827 2828 2829 2830 2831 2832 2833 |
# 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... |
2834 2835 2836 2837 2838 2839 2840 2841 |
##$prm_clean =~ s/^\**//; if ($prm_clean eq $sects[$sx]) { $err = 0; last; } } if ($err) { if ($decl_type eq "function") { |
d40e1e653 kerneldoc: Conver... |
2842 |
print STDERR "${file}:$.: warning: " . |
a1d94aa55 kernel-doc: check... |
2843 2844 2845 2846 2847 2848 2849 |
"Excess function parameter " . "'$sects[$sx]' " . "description in '$decl_name' "; ++$warnings; } else { if ($nested !~ m/\Q$sects[$sx]\E/) { |
d40e1e653 kerneldoc: Conver... |
2850 |
print STDERR "${file}:$.: warning: " . |
a1d94aa55 kernel-doc: check... |
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 |
"Excess struct/union/enum/typedef member " . "'$sects[$sx]' " . "description in '$decl_name' "; ++$warnings; } } } } } |
1da177e4c Linux-2.6.12-rc2 |
2861 |
## |
4092bac77 scripts/kernel-do... |
2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 |
# 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... |
2876 |
print STDERR "${file}:$.: warning: " . |
4092bac77 scripts/kernel-do... |
2877 2878 2879 2880 2881 2882 2883 2884 |
"No description found for return value of " . "'$declaration_name' "; ++$warnings; } } ## |
1da177e4c Linux-2.6.12-rc2 |
2885 2886 2887 2888 2889 2890 |
# 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... |
2891 |
my $noret = 0; |
1da177e4c Linux-2.6.12-rc2 |
2892 2893 2894 |
$prototype =~ s/^static +//; $prototype =~ s/^extern +//; |
4dc3b16ba [PATCH] DocBook: ... |
2895 |
$prototype =~ s/^asmlinkage +//; |
1da177e4c Linux-2.6.12-rc2 |
2896 2897 |
$prototype =~ s/^inline +//; $prototype =~ s/^__inline__ +//; |
32e794015 [PATCH] kernel-do... |
2898 2899 2900 |
$prototype =~ s/^__inline +//; $prototype =~ s/^__always_inline +//; $prototype =~ s/^noinline +//; |
74fc5c653 kernel-doc: handl... |
2901 |
$prototype =~ s/__init +//; |
20072205f scripts/kernel-do... |
2902 |
$prototype =~ s/__init_or_module +//; |
270a00963 scripts/kernel-do... |
2903 |
$prototype =~ s/__meminit +//; |
70c95b00b scripts/kernel-do... |
2904 |
$prototype =~ s/__must_check +//; |
0df7c0e3a scripts/kernel-do... |
2905 |
$prototype =~ s/__weak +//; |
cbb4d3e65 scripts/kernel-do... |
2906 |
my $define = $prototype =~ s/^#\s*define\s+//; #ak added |
328d24403 [PATCH] kernel-do... |
2907 |
$prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//; |
1da177e4c Linux-2.6.12-rc2 |
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 |
# 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: ... |
2923 |
# - pci_match_device, __copy_to_user (long return type) |
1da177e4c Linux-2.6.12-rc2 |
2924 |
|
cbb4d3e65 scripts/kernel-do... |
2925 2926 2927 2928 2929 2930 2931 2932 2933 |
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 |
2934 2935 2936 |
$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
94b3e03c8 kernel-doc: fix f... |
2937 |
$prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || |
1da177e4c Linux-2.6.12-rc2 |
2938 2939 2940 2941 2942 2943 2944 2945 |
$prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
9598f91f2 [PATCH] DocBook: ... |
2946 2947 |
$prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || |
412ecd775 [PATCH] fix fatal... |
2948 2949 |
$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 |
2950 2951 2952 2953 2954 2955 |
$return_type = $1; $declaration_name = $2; my $args = $3; create_parameterlist($args, ',', $file); } else { |
d40e1e653 kerneldoc: Conver... |
2956 2957 |
print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype' "; |
1da177e4c Linux-2.6.12-rc2 |
2958 2959 |
return; } |
a1d94aa55 kernel-doc: check... |
2960 2961 |
my $prms = join " ", @parameterlist; check_sections($file, $declaration_name, "function", $sectcheck, $prms, ""); |
4092bac77 scripts/kernel-do... |
2962 2963 2964 2965 2966 |
# 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... |
2967 |
if ($verbose && !$noret) { |
4092bac77 scripts/kernel-do... |
2968 2969 |
check_return_section($file, $declaration_name, $return_type); } |
3c3b809e2 [PATCH] kernel-do... |
2970 |
output_declaration($declaration_name, |
1da177e4c Linux-2.6.12-rc2 |
2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 |
'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 |
2983 2984 |
sub reset_state { $function = ""; |
1da177e4c Linux-2.6.12-rc2 |
2985 2986 2987 2988 2989 |
%parameterdescs = (); %parametertypes = (); @parameterlist = (); %sections = (); @sectionlist = (); |
a1d94aa55 kernel-doc: check... |
2990 2991 |
$sectcheck = ""; $struct_actual = ""; |
1da177e4c Linux-2.6.12-rc2 |
2992 |
$prototype = ""; |
3c3b809e2 [PATCH] kernel-do... |
2993 |
|
48af606ad kernel-doc: add n... |
2994 2995 |
$state = STATE_NORMAL; $inline_doc_state = STATE_INLINE_NA; |
1da177e4c Linux-2.6.12-rc2 |
2996 |
} |
56afb0f88 kerneldoc, tracin... |
2997 2998 2999 3000 |
sub tracepoint_munge($) { my $file = shift; my $tracepointname = 0; my $tracepointargs = 0; |
3a9089fd7 tracing: Add DEFI... |
3001 |
if ($prototype =~ m/TRACE_EVENT\((.*?),/) { |
56afb0f88 kerneldoc, tracin... |
3002 3003 |
$tracepointname = $1; } |
3a9089fd7 tracing: Add DEFI... |
3004 3005 3006 3007 3008 3009 3010 3011 |
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... |
3012 3013 3014 |
$tracepointargs = $1; } if (($tracepointname eq 0) || ($tracepointargs eq 0)) { |
d40e1e653 kerneldoc: Conver... |
3015 3016 |
print STDERR "${file}:$.: warning: Unrecognized tracepoint format: ". |
56afb0f88 kerneldoc, tracin... |
3017 3018 3019 3020 3021 3022 |
"$prototype "; } else { $prototype = "static inline void trace_$tracepointname($tracepointargs)"; } } |
b4870bc5e kernel-doc: fix s... |
3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 |
sub syscall_munge() { my $void = 0; $prototype =~ s@[\r \t]+@ @gos; # strip newlines/CR's/tabs ## 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... |
3057 |
sub process_proto_function($$) { |
1da177e4c Linux-2.6.12-rc2 |
3058 3059 |
my $x = shift; my $file = shift; |
51f5a0c8f kernel-doc: strip... |
3060 |
$x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
890c78c2d kernel-doc: allow... |
3061 |
if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { |
1da177e4c Linux-2.6.12-rc2 |
3062 3063 3064 |
# do nothing } elsif ($x =~ /([^\{]*)/) { |
3c308798a scripts: kernel-d... |
3065 |
$prototype .= $1; |
1da177e4c Linux-2.6.12-rc2 |
3066 |
} |
b4870bc5e kernel-doc: fix s... |
3067 |
|
890c78c2d kernel-doc: allow... |
3068 |
if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { |
3c308798a scripts: kernel-d... |
3069 |
$prototype =~ s@/\*.*?\*/@@gos; # strip comments. |
1da177e4c Linux-2.6.12-rc2 |
3070 3071 3072 |
$prototype =~ s@[\r ]+@ @gos; # strip newlines/cr's. $prototype =~ s@^\s+@@gos; # strip leading spaces |
b4870bc5e kernel-doc: fix s... |
3073 3074 3075 |
if ($prototype =~ /SYSCALL_DEFINE/) { syscall_munge(); } |
3a9089fd7 tracing: Add DEFI... |
3076 3077 3078 |
if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || $prototype =~ /DEFINE_SINGLE_EVENT/) { |
56afb0f88 kerneldoc, tracin... |
3079 3080 |
tracepoint_munge($file); } |
b4870bc5e kernel-doc: fix s... |
3081 |
dump_function($prototype, $file); |
1da177e4c Linux-2.6.12-rc2 |
3082 3083 3084 |
reset_state(); } } |
b7afa92b5 scripts/kernel-do... |
3085 |
sub process_proto_type($$) { |
1da177e4c Linux-2.6.12-rc2 |
3086 3087 |
my $x = shift; my $file = shift; |
1da177e4c Linux-2.6.12-rc2 |
3088 3089 3090 3091 |
$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... |
3092 |
$x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line |
1da177e4c Linux-2.6.12-rc2 |
3093 3094 3095 3096 3097 3098 |
if ($x =~ /^#/) { # To distinguish preprocessor directive from regular declaration later. $x .= ";"; } while (1) { |
3c308798a scripts: kernel-d... |
3099 |
if ( $x =~ /([^{};]*)([{};])(.*)/ ) { |
1da177e4c Linux-2.6.12-rc2 |
3100 3101 3102 3103 |
$prototype .= $1 . $2; ($2 eq '{') && $brcount++; ($2 eq '}') && $brcount--; if (($2 eq ';') && ($brcount == 0)) { |
b9d97328e kernel-doc: clean... |
3104 |
dump_declaration($prototype, $file); |
1da177e4c Linux-2.6.12-rc2 |
3105 |
reset_state(); |
3c308798a scripts: kernel-d... |
3106 |
last; |
1da177e4c Linux-2.6.12-rc2 |
3107 3108 |
} $x = $3; |
3c308798a scripts: kernel-d... |
3109 |
} else { |
1da177e4c Linux-2.6.12-rc2 |
3110 3111 3112 3113 3114 |
$prototype .= $x; last; } } } |
6b5b55f6c kernel-doc: fix d... |
3115 3116 3117 3118 3119 3120 3121 |
# xml_escape: replace <, >, and & in the text stream; # # however, formatting controls that are generated internally/locally in the # kernel-doc script are not escaped here; instead, they begin life like # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings # are converted to their mnemonic-expected output, without the 4 * '\' & ':', # just before actual output; (this is done by local_unescape()) |
1da177e4c Linux-2.6.12-rc2 |
3122 3123 |
sub xml_escape($) { my $text = shift; |
ecfb251a9 [PATCH] kernel-do... |
3124 3125 3126 |
if (($output_mode eq "text") || ($output_mode eq "man")) { return $text; } |
1da177e4c Linux-2.6.12-rc2 |
3127 3128 3129 3130 3131 |
$text =~ s/\&/\\\\\\amp;/g; $text =~ s/\</\\\\\\lt;/g; $text =~ s/\>/\\\\\\gt;/g; return $text; } |
c0d1b6ee7 kernel-doc: produ... |
3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 |
# xml_unescape: reverse the effects of xml_escape sub xml_unescape($) { my $text = shift; if (($output_mode eq "text") || ($output_mode eq "man")) { return $text; } $text =~ s/\\\\\\amp;/\&/g; $text =~ s/\\\\\\lt;/</g; $text =~ s/\\\\\\gt;/>/g; return $text; } |
6b5b55f6c kernel-doc: fix d... |
3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 |
# convert local escape strings to html # local escape strings look like: '\\\\menmonic:' (that's 4 backslashes) sub local_unescape($) { my $text = shift; if (($output_mode eq "text") || ($output_mode eq "man")) { return $text; } $text =~ s/\\\\\\\\lt:/</g; $text =~ s/\\\\\\\\gt:/>/g; return $text; } |
1ad560e43 kernel-doc: abstr... |
3154 |
sub map_filename($) { |
2283a117f [PATCH] scripts/k... |
3155 |
my $file; |
68f866623 Documentation: Av... |
3156 |
my ($orig_file) = @_; |
1da177e4c Linux-2.6.12-rc2 |
3157 |
|
2283a117f [PATCH] scripts/k... |
3158 |
if (defined($ENV{'SRCTREE'})) { |
68f866623 Documentation: Av... |
3159 |
$file = "$ENV{'SRCTREE'}" . "/" . $orig_file; |
1ad560e43 kernel-doc: abstr... |
3160 |
} else { |
68f866623 Documentation: Av... |
3161 |
$file = $orig_file; |
2283a117f [PATCH] scripts/k... |
3162 |
} |
1ad560e43 kernel-doc: abstr... |
3163 |
|
1da177e4c Linux-2.6.12-rc2 |
3164 3165 3166 |
if (defined($source_map{$file})) { $file = $source_map{$file}; } |
1ad560e43 kernel-doc: abstr... |
3167 3168 |
return $file; } |
88c2b57da kernel-doc: add s... |
3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 |
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); } |
1ad560e43 kernel-doc: abstr... |
3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 |
sub process_file($) { my $file; my $identifier; my $func; my $descr; my $in_purpose = 0; my $initial_section_counter = $section_counter; my ($orig_file) = @_; my $leading_space; $file = map_filename($orig_file); |
1da177e4c Linux-2.6.12-rc2 |
3199 3200 3201 3202 3203 3204 |
if (!open(IN,"<$file")) { print STDERR "Error: Cannot open file $file "; ++$errors; return; } |
a9e7314b7 kernel-doc: track... |
3205 |
$. = 1; |
1da177e4c Linux-2.6.12-rc2 |
3206 3207 |
$section_counter = 0; while (<IN>) { |
654784284 kernel-doc: bugfi... |
3208 3209 3210 |
while (s/\\\s*$//) { $_ .= <IN>; } |
48af606ad kernel-doc: add n... |
3211 |
if ($state == STATE_NORMAL) { |
1da177e4c Linux-2.6.12-rc2 |
3212 |
if (/$doc_start/o) { |
48af606ad kernel-doc: add n... |
3213 |
$state = STATE_NAME; # next line is always the function name |
850622dfa [PATCH] kernel-do... |
3214 |
$in_doc_sect = 0; |
0b0f5f29b scripts/kernel-do... |
3215 |
$declaration_start_line = $. + 1; |
1da177e4c Linux-2.6.12-rc2 |
3216 |
} |
48af606ad kernel-doc: add n... |
3217 |
} elsif ($state == STATE_NAME) {# this line is the function name (always) |
1da177e4c Linux-2.6.12-rc2 |
3218 |
if (/$doc_block/o) { |
48af606ad kernel-doc: add n... |
3219 |
$state = STATE_DOCBLOCK; |
1da177e4c Linux-2.6.12-rc2 |
3220 |
$contents = ""; |
0b0f5f29b scripts/kernel-do... |
3221 |
$new_start_line = $. + 1; |
1da177e4c Linux-2.6.12-rc2 |
3222 3223 3224 3225 3226 |
if ( $1 eq "" ) { $section = $section_intro; } else { $section = $1; } |
3c308798a scripts: kernel-d... |
3227 |
} |
1da177e4c Linux-2.6.12-rc2 |
3228 3229 3230 3231 3232 |
elsif (/$doc_decl/o) { $identifier = $1; if (/\s*([\w\s]+?)\s*-/) { $identifier = $1; } |
48af606ad kernel-doc: add n... |
3233 |
$state = STATE_FIELD; |
0b0f5f29b scripts/kernel-do... |
3234 3235 |
# if there's no @param blocks need to set up default section # here |
2f4ad40a0 kernel-doc: reset... |
3236 3237 |
$contents = ""; $section = $section_default; |
0b0f5f29b scripts/kernel-do... |
3238 |
$new_start_line = $. + 1; |
1da177e4c Linux-2.6.12-rc2 |
3239 |
if (/-(.*)/) { |
51f5a0c8f kernel-doc: strip... |
3240 |
# strip leading/trailing/multiple spaces |
a21217daa [PATCH] kernel-do... |
3241 3242 3243 |
$descr= $1; $descr =~ s/^\s*//; $descr =~ s/\s*$//; |
12ae67793 kernel-doc: don't... |
3244 |
$descr =~ s/\s+/ /g; |
a21217daa [PATCH] kernel-do... |
3245 |
$declaration_purpose = xml_escape($descr); |
6423133bd kernel-doc: allow... |
3246 |
$in_purpose = 1; |
1da177e4c Linux-2.6.12-rc2 |
3247 3248 3249 |
} else { $declaration_purpose = ""; } |
77cc23b8c kernel-doc: warn ... |
3250 3251 |
if (($declaration_purpose eq "") && $verbose) { |
d40e1e653 kerneldoc: Conver... |
3252 3253 |
print STDERR "${file}:$.: warning: missing initial short description on line: "; |
77cc23b8c kernel-doc: warn ... |
3254 3255 3256 |
print STDERR $_; ++$warnings; } |
1da177e4c Linux-2.6.12-rc2 |
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 |
if ($identifier =~ m/^struct/) { $decl_type = 'struct'; } elsif ($identifier =~ m/^union/) { $decl_type = 'union'; } elsif ($identifier =~ m/^enum/) { $decl_type = 'enum'; } elsif ($identifier =~ m/^typedef/) { $decl_type = 'typedef'; } else { $decl_type = 'function'; } if ($verbose) { |
d40e1e653 kerneldoc: Conver... |
3270 3271 |
print STDERR "${file}:$.: info: Scanning doc for $identifier "; |
1da177e4c Linux-2.6.12-rc2 |
3272 3273 |
} } else { |
d40e1e653 kerneldoc: Conver... |
3274 |
print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", |
1da177e4c Linux-2.6.12-rc2 |
3275 3276 3277 |
" - I thought it was a doc line "; ++$warnings; |
48af606ad kernel-doc: add n... |
3278 |
$state = STATE_NORMAL; |
1da177e4c Linux-2.6.12-rc2 |
3279 |
} |
48af606ad kernel-doc: add n... |
3280 |
} elsif ($state == STATE_FIELD) { # look for head: lines, and include content |
f624adef3 kernel-doc: limit... |
3281 |
if (/$doc_sect/i) { # case insensitive for supported section names |
1da177e4c Linux-2.6.12-rc2 |
3282 3283 |
$newsection = $1; $newcontents = $2; |
f624adef3 kernel-doc: limit... |
3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 |
# 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; } |
792aa2f2c kernel-doc: preve... |
3295 3296 |
if (($contents ne "") && ($contents ne " ")) { |
850622dfa [PATCH] kernel-do... |
3297 |
if (!$in_doc_sect && $verbose) { |
d40e1e653 kerneldoc: Conver... |
3298 3299 |
print STDERR "${file}:$.: warning: contents before sections "; |
850622dfa [PATCH] kernel-do... |
3300 3301 |
++$warnings; } |
94dc7ad55 kernel-doc: detec... |
3302 |
dump_section($file, $section, xml_escape($contents)); |
1da177e4c Linux-2.6.12-rc2 |
3303 3304 |
$section = $section_default; } |
850622dfa [PATCH] kernel-do... |
3305 |
$in_doc_sect = 1; |
6423133bd kernel-doc: allow... |
3306 |
$in_purpose = 0; |
1da177e4c Linux-2.6.12-rc2 |
3307 |
$contents = $newcontents; |
0b0f5f29b scripts/kernel-do... |
3308 |
$new_start_line = $.; |
0a7263014 kernel-doc: impro... |
3309 3310 3311 3312 |
while ((substr($contents, 0, 1) eq " ") || substr($contents, 0, 1) eq "\t") { $contents = substr($contents, 1); } |
1da177e4c Linux-2.6.12-rc2 |
3313 3314 3315 3316 3317 |
if ($contents ne "") { $contents .= " "; } $section = $newsection; |
b7886de43 kernel-doc: strip... |
3318 |
$leading_space = undef; |
1da177e4c Linux-2.6.12-rc2 |
3319 |
} elsif (/$doc_end/) { |
4c98ecaf3 scripts/kernel-do... |
3320 3321 |
if (($contents ne "") && ($contents ne " ")) { |
94dc7ad55 kernel-doc: detec... |
3322 |
dump_section($file, $section, xml_escape($contents)); |
1da177e4c Linux-2.6.12-rc2 |
3323 3324 3325 |
$section = $section_default; $contents = ""; } |
46b958eb8 kernel-doc: detec... |
3326 3327 |
# look for doc_com + <text> + doc_end: if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { |
d40e1e653 kerneldoc: Conver... |
3328 |
print STDERR "${file}:$.: warning: suspicious ending line: $_"; |
46b958eb8 kernel-doc: detec... |
3329 3330 |
++$warnings; } |
1da177e4c Linux-2.6.12-rc2 |
3331 3332 |
$prototype = ""; |
48af606ad kernel-doc: add n... |
3333 |
$state = STATE_PROTO; |
1da177e4c Linux-2.6.12-rc2 |
3334 |
$brcount = 0; |
232acbcf5 [PATCH] kernel-do... |
3335 3336 |
# print STDERR "end of doc comment, looking for prototype "; |
1da177e4c Linux-2.6.12-rc2 |
3337 3338 3339 |
} elsif (/$doc_content/) { # miguel-style comment kludge, look for blank lines after # @parameter line to signify start of description |
6423133bd kernel-doc: allow... |
3340 3341 3342 3343 3344 |
if ($1 eq "") { if ($section =~ m/^@/ || $section eq $section_context) { dump_section($file, $section, xml_escape($contents)); $section = $section_default; $contents = ""; |
0b0f5f29b scripts/kernel-do... |
3345 |
$new_start_line = $.; |
6423133bd kernel-doc: allow... |
3346 3347 3348 3349 3350 3351 3352 3353 3354 |
} else { $contents .= " "; } $in_purpose = 0; } elsif ($in_purpose == 1) { # Continued declaration purpose chomp($declaration_purpose); $declaration_purpose .= " " . xml_escape($1); |
12ae67793 kernel-doc: don't... |
3355 |
$declaration_purpose =~ s/\s+/ /g; |
1da177e4c Linux-2.6.12-rc2 |
3356 |
} else { |
b7886de43 kernel-doc: strip... |
3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 |
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 . " "; |
1da177e4c Linux-2.6.12-rc2 |
3371 3372 3373 |
} } else { # i dont know - bad line? ignore. |
d40e1e653 kerneldoc: Conver... |
3374 |
print STDERR "${file}:$.: warning: bad line: $_"; |
1da177e4c Linux-2.6.12-rc2 |
3375 3376 |
++$warnings; } |
48af606ad kernel-doc: add n... |
3377 |
} elsif ($state == STATE_INLINE) { # scanning for inline parameters |
a4c6ebede scripts/kernel-do... |
3378 |
# First line (state 1) needs to be a @parameter |
48af606ad kernel-doc: add n... |
3379 |
if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { |
a4c6ebede scripts/kernel-do... |
3380 3381 |
$section = $1; $contents = $2; |
0b0f5f29b scripts/kernel-do... |
3382 |
$new_start_line = $.; |
a4c6ebede scripts/kernel-do... |
3383 3384 3385 3386 3387 |
if ($contents ne "") { while ((substr($contents, 0, 1) eq " ") || substr($contents, 0, 1) eq "\t") { $contents = substr($contents, 1); } |
a0b96c2db kernel-doc: fix w... |
3388 3389 |
$contents .= " "; |
a4c6ebede scripts/kernel-do... |
3390 |
} |
48af606ad kernel-doc: add n... |
3391 |
$inline_doc_state = STATE_INLINE_TEXT; |
a4c6ebede scripts/kernel-do... |
3392 |
# Documentation block end */ |
48af606ad kernel-doc: add n... |
3393 |
} elsif (/$doc_inline_end/) { |
a4c6ebede scripts/kernel-do... |
3394 3395 3396 3397 3398 3399 |
if (($contents ne "") && ($contents ne " ")) { dump_section($file, $section, xml_escape($contents)); $section = $section_default; $contents = ""; } |
48af606ad kernel-doc: add n... |
3400 3401 |
$state = STATE_PROTO; $inline_doc_state = STATE_INLINE_NA; |
a4c6ebede scripts/kernel-do... |
3402 3403 |
# Regular text } elsif (/$doc_content/) { |
48af606ad kernel-doc: add n... |
3404 |
if ($inline_doc_state == STATE_INLINE_TEXT) { |
a4c6ebede scripts/kernel-do... |
3405 3406 |
$contents .= $1 . " "; |
6450c8957 kernel-doc: strip... |
3407 3408 3409 3410 |
# nuke leading blank lines if ($contents =~ /^\s*$/) { $contents = ""; } |
48af606ad kernel-doc: add n... |
3411 3412 |
} elsif ($inline_doc_state == STATE_INLINE_NAME) { $inline_doc_state = STATE_INLINE_ERROR; |
e7ca311e3 kernel-doc: Fix u... |
3413 |
print STDERR "${file}:$.: warning: "; |
a4c6ebede scripts/kernel-do... |
3414 3415 3416 3417 |
print STDERR "Incorrect use of kernel-doc format: $_"; ++$warnings; } } |
48af606ad kernel-doc: add n... |
3418 3419 3420 3421 |
} elsif ($state == STATE_PROTO) { # scanning for function '{' (end of prototype) if (/$doc_inline_start/) { $state = STATE_INLINE; $inline_doc_state = STATE_INLINE_NAME; |
a4c6ebede scripts/kernel-do... |
3422 |
} elsif ($decl_type eq 'function') { |
b7afa92b5 scripts/kernel-do... |
3423 |
process_proto_function($_, $file); |
1da177e4c Linux-2.6.12-rc2 |
3424 |
} else { |
b7afa92b5 scripts/kernel-do... |
3425 |
process_proto_type($_, $file); |
1da177e4c Linux-2.6.12-rc2 |
3426 |
} |
48af606ad kernel-doc: add n... |
3427 |
} elsif ($state == STATE_DOCBLOCK) { |
ebff7f929 scripts/kernel-do... |
3428 |
if (/$doc_end/) |
1da177e4c Linux-2.6.12-rc2 |
3429 |
{ |
94dc7ad55 kernel-doc: detec... |
3430 |
dump_doc_section($file, $section, xml_escape($contents)); |
2f4ad40a0 kernel-doc: reset... |
3431 |
$section = $section_default; |
1da177e4c Linux-2.6.12-rc2 |
3432 3433 |
$contents = ""; $function = ""; |
1da177e4c Linux-2.6.12-rc2 |
3434 3435 3436 3437 3438 3439 |
%parameterdescs = (); %parametertypes = (); @parameterlist = (); %sections = (); @sectionlist = (); $prototype = ""; |
48af606ad kernel-doc: add n... |
3440 |
$state = STATE_NORMAL; |
1da177e4c Linux-2.6.12-rc2 |
3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 |
} elsif (/$doc_content/) { if ( $1 eq "" ) { $contents .= $blankline; } else { $contents .= $1 . " "; |
3c3b809e2 [PATCH] kernel-do... |
3452 |
} |
3c308798a scripts: kernel-d... |
3453 3454 |
} } |
1da177e4c Linux-2.6.12-rc2 |
3455 3456 |
} if ($initial_section_counter == $section_counter) { |
d40e1e653 kerneldoc: Conver... |
3457 3458 |
print STDERR "${file}:1: warning: no structured comments found "; |
b6c3f456c kernel-doc: add n... |
3459 |
if (($output_selection == OUTPUT_INCLUDE) && ($show_not_found == 1)) { |
e946c43a1 kernel-doc: impro... |
3460 3461 3462 |
print STDERR " Was looking for '$_'. " for keys %function_table; } |
1da177e4c Linux-2.6.12-rc2 |
3463 3464 3465 3466 3467 3468 3469 3470 |
if ($output_mode eq "xml") { # The template wants at least one RefEntry here; make one. print "<refentry> "; print " <refnamediv> "; print " <refname> "; |
68f866623 Documentation: Av... |
3471 3472 |
print " ${orig_file} "; |
1da177e4c Linux-2.6.12-rc2 |
3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 |
print " </refname> "; print " <refpurpose> "; print " Document generation inconsistency "; print " </refpurpose> "; print " </refnamediv> "; print " <refsect1> "; print " <title> "; print " Oops "; print " </title> "; print " <warning> "; print " <para> "; print " The template for this document tried to insert "; print " the structured comment from the file "; |
68f866623 Documentation: Av... |
3499 3500 |
print " <filename>${orig_file}</filename> at this point, "; |
1da177e4c Linux-2.6.12-rc2 |
3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 |
print " but none was found. "; print " This dummy section is inserted to allow "; print " generation to continue. "; print " </para> "; print " </warning> "; print " </refsect1> "; print "</refentry> "; } } } |
8484baaa5 kernel-doc: code ... |
3518 3519 3520 3521 3522 3523 |
$kernelversion = get_kernel_version(); # generate a sequence of code that will splice in highlighting information # using the s// operator. |
1ef062337 kernel-doc: Make ... |
3524 |
for (my $k = 0; $k < @highlights; $k++) { |
4d7327019 scripts/kernel-do... |
3525 3526 3527 3528 3529 3530 |
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 ... |
3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 |
} # 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... |
3545 3546 |
if ($output_selection == OUTPUT_EXPORTED || $output_selection == OUTPUT_INTERNAL) { |
c9b2cfb3f kernel-doc: unify... |
3547 3548 |
push(@export_file_list, @ARGV); |
88c2b57da kernel-doc: add s... |
3549 3550 3551 3552 3553 |
foreach (@export_file_list) { chomp; process_export_file($_); } } |
8484baaa5 kernel-doc: code ... |
3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 |
foreach (@ARGV) { chomp; process_file($_); } if ($verbose && $errors) { print STDERR "$errors errors "; } if ($verbose && $warnings) { print STDERR "$warnings warnings "; } exit($errors); |