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