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