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