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