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