kernel-doc (03c11eb3b16dc0058589751dfd91f254be2be613) kernel-doc (af404fb1ed2a19bd30f5e50bfb4f93a42737a6eb)
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3
4use warnings;
5use strict;
6
7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##

--- 67 unchanged lines hidden (view full) ---

76my $type_fallback = '\&([_\w]+)';
77my $type_member_func = $type_member . '\(\)';
78
79# Output conversion substitutions.
80# One for each output format
81
82# these are pretty rough
83my @highlights_man = (
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3
4use warnings;
5use strict;
6
7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##

--- 67 unchanged lines hidden (view full) ---

76my $type_fallback = '\&([_\w]+)';
77my $type_member_func = $type_member . '\(\)';
78
79# Output conversion substitutions.
80# One for each output format
81
82# these are pretty rough
83my @highlights_man = (
84 [$type_constant, "\$1"],
85 [$type_constant2, "\$1"],
86 [$type_func, "\\\\fB\$1\\\\fP"],
87 [$type_enum, "\\\\fI\$1\\\\fP"],
88 [$type_struct, "\\\\fI\$1\\\\fP"],
89 [$type_typedef, "\\\\fI\$1\\\\fP"],
90 [$type_union, "\\\\fI\$1\\\\fP"],
91 [$type_param, "\\\\fI\$1\\\\fP"],
92 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
93 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
94 [$type_fallback, "\\\\fI\$1\\\\fP"]
95 );
84 [$type_constant, "\$1"],
85 [$type_constant2, "\$1"],
86 [$type_func, "\\\\fB\$1\\\\fP"],
87 [$type_enum, "\\\\fI\$1\\\\fP"],
88 [$type_struct, "\\\\fI\$1\\\\fP"],
89 [$type_typedef, "\\\\fI\$1\\\\fP"],
90 [$type_union, "\\\\fI\$1\\\\fP"],
91 [$type_param, "\\\\fI\$1\\\\fP"],
92 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
93 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
94 [$type_fallback, "\\\\fI\$1\\\\fP"]
95 );
96my $blankline_man = "";
97
98# rst-mode
99my @highlights_rst = (
96my $blankline_man = "";
97
98# rst-mode
99my @highlights_rst = (
100 [$type_constant, "``\$1``"],
101 [$type_constant2, "``\$1``"],
102 # Note: need to escape () to avoid func matching later
103 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
104 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
105 [$type_fp_param, "**\$1\\\\(\\\\)**"],
106 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
107 [$type_func, "\$1()"],
108 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
109 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
110 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
111 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
112 # in rst this can refer to any type
113 [$type_fallback, "\\:c\\:type\\:`\$1`"],
114 [$type_param_ref, "**\$1\$2**"]
115 );
100 [$type_constant, "``\$1``"],
101 [$type_constant2, "``\$1``"],
102
103 # Note: need to escape () to avoid func matching later
104 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
105 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
106 [$type_fp_param, "**\$1\\\\(\\\\)**"],
107 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
108 [$type_func, "\$1()"],
109 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
110 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
111 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
112 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
113
114 # in rst this can refer to any type
115 [$type_fallback, "\\:c\\:type\\:`\$1`"],
116 [$type_param_ref, "**\$1\$2**"]
117 );
116my $blankline_rst = "\n";
117
118# read arguments
119if ($#ARGV == -1) {
118my $blankline_rst = "\n";
119
120# read arguments
121if ($#ARGV == -1) {
120 pod2usage(
121 -message => "No arguments!\n",
122 -exitval => 1,
123 -verbose => 99,
124 -sections => 'SYNOPSIS',
125 -output => \*STDERR,
126 );
122 pod2usage(
123 -message => "No arguments!\n",
124 -exitval => 1,
125 -verbose => 99,
126 -sections => 'SYNOPSIS',
127 -output => \*STDERR,
128 );
127}
128
129my $kernelversion;
130my ($sphinx_major, $sphinx_minor, $sphinx_patch);
131
132my $dohighlight = "";
133
134my $verbose = 0;

--- 24 unchanged lines hidden (view full) ---

159if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
160 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
161 @build_time = gmtime($seconds);
162} else {
163 @build_time = localtime;
164}
165
166my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
129}
130
131my $kernelversion;
132my ($sphinx_major, $sphinx_minor, $sphinx_patch);
133
134my $dohighlight = "";
135
136my $verbose = 0;

--- 24 unchanged lines hidden (view full) ---

161if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
162 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
163 @build_time = gmtime($seconds);
164} else {
165 @build_time = localtime;
166}
167
168my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
167 'July', 'August', 'September', 'October',
168 'November', 'December')[$build_time[4]] .
169 " " . ($build_time[5]+1900);
169 'July', 'August', 'September', 'October',
170 'November', 'December')[$build_time[4]] .
171 " " . ($build_time[5]+1900);
170
171# Essentially these are globals.
172# They probably want to be tidied up, made more localised or something.
173# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
174# could cause "use of undefined value" or other bugs.
175my ($function, %function_table, %parametertypes, $declaration_purpose);
176my %nosymbol_table = ();
177my $declaration_start_line;
178my ($type, $declaration_name, $return_type);
179my ($newsection, $newcontents, $prototype, $brcount, %source_map);
180
181if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =~ '1') {
172
173# Essentially these are globals.
174# They probably want to be tidied up, made more localised or something.
175# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
176# could cause "use of undefined value" or other bugs.
177my ($function, %function_table, %parametertypes, $declaration_purpose);
178my %nosymbol_table = ();
179my $declaration_start_line;
180my ($type, $declaration_name, $return_type);
181my ($newsection, $newcontents, $prototype, $brcount, %source_map);
182
183if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =~ '1') {
182 $verbose = 1;
184 $verbose = 1;
183}
184
185if (defined($ENV{'KCFLAGS'})) {
185}
186
187if (defined($ENV{'KCFLAGS'})) {
186 my $kcflags = "$ENV{'KCFLAGS'}";
188 my $kcflags = "$ENV{'KCFLAGS'}";
187
189
188 if ($kcflags =~ /(\s|^)-Werror(\s|$)/) {
189 $Werror = 1;
190 }
190 if ($kcflags =~ /(\s|^)-Werror(\s|$)/) {
191 $Werror = 1;
192 }
191}
192
193# reading this variable is for backwards compat just in case
194# someone was calling it with the variable from outside the
195# kernel's build system
196if (defined($ENV{'KDOC_WERROR'})) {
193}
194
195# reading this variable is for backwards compat just in case
196# someone was calling it with the variable from outside the
197# kernel's build system
198if (defined($ENV{'KDOC_WERROR'})) {
197 $Werror = "$ENV{'KDOC_WERROR'}";
199 $Werror = "$ENV{'KDOC_WERROR'}";
198}
199# other environment variables are converted to command-line
200# arguments in cmd_checkdoc in the build system
201
202# Generated docbook code is inserted in a template at a point where
203# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
204# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
205# We keep track of number of generated entries and generate a dummy

--- 84 unchanged lines hidden (view full) ---

290my $undescribed = "-- undescribed --";
291
292reset_state();
293
294while ($ARGV[0] =~ m/^--?(.*)/) {
295 my $cmd = $1;
296 shift @ARGV;
297 if ($cmd eq "man") {
200}
201# other environment variables are converted to command-line
202# arguments in cmd_checkdoc in the build system
203
204# Generated docbook code is inserted in a template at a point where
205# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
206# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
207# We keep track of number of generated entries and generate a dummy

--- 84 unchanged lines hidden (view full) ---

292my $undescribed = "-- undescribed --";
293
294reset_state();
295
296while ($ARGV[0] =~ m/^--?(.*)/) {
297 my $cmd = $1;
298 shift @ARGV;
299 if ($cmd eq "man") {
298 $output_mode = "man";
299 @highlights = @highlights_man;
300 $blankline = $blankline_man;
300 $output_mode = "man";
301 @highlights = @highlights_man;
302 $blankline = $blankline_man;
301 } elsif ($cmd eq "rst") {
303 } elsif ($cmd eq "rst") {
302 $output_mode = "rst";
303 @highlights = @highlights_rst;
304 $blankline = $blankline_rst;
304 $output_mode = "rst";
305 @highlights = @highlights_rst;
306 $blankline = $blankline_rst;
305 } elsif ($cmd eq "none") {
307 } elsif ($cmd eq "none") {
306 $output_mode = "none";
308 $output_mode = "none";
307 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
309 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
308 $modulename = shift @ARGV;
310 $modulename = shift @ARGV;
309 } elsif ($cmd eq "function") { # to only output specific functions
311 } elsif ($cmd eq "function") { # to only output specific functions
310 $output_selection = OUTPUT_INCLUDE;
311 $function = shift @ARGV;
312 $function_table{$function} = 1;
312 $output_selection = OUTPUT_INCLUDE;
313 $function = shift @ARGV;
314 $function_table{$function} = 1;
313 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
315 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
314 my $symbol = shift @ARGV;
315 $nosymbol_table{$symbol} = 1;
316 my $symbol = shift @ARGV;
317 $nosymbol_table{$symbol} = 1;
316 } elsif ($cmd eq "export") { # only exported symbols
318 } elsif ($cmd eq "export") { # only exported symbols
317 $output_selection = OUTPUT_EXPORTED;
318 %function_table = ();
319 $output_selection = OUTPUT_EXPORTED;
320 %function_table = ();
319 } elsif ($cmd eq "internal") { # only non-exported symbols
321 } elsif ($cmd eq "internal") { # only non-exported symbols
320 $output_selection = OUTPUT_INTERNAL;
321 %function_table = ();
322 $output_selection = OUTPUT_INTERNAL;
323 %function_table = ();
322 } elsif ($cmd eq "export-file") {
324 } elsif ($cmd eq "export-file") {
323 my $file = shift @ARGV;
324 push(@export_file_list, $file);
325 my $file = shift @ARGV;
326 push(@export_file_list, $file);
325 } elsif ($cmd eq "v") {
327 } elsif ($cmd eq "v") {
326 $verbose = 1;
328 $verbose = 1;
327 } elsif ($cmd eq "Werror") {
329 } elsif ($cmd eq "Werror") {
328 $Werror = 1;
330 $Werror = 1;
329 } elsif ($cmd eq "Wreturn") {
331 } elsif ($cmd eq "Wreturn") {
330 $Wreturn = 1;
332 $Wreturn = 1;
331 } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") {
333 } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") {
332 $Wshort_desc = 1;
334 $Wshort_desc = 1;
333 } elsif ($cmd eq "Wcontents-before-sections") {
335 } elsif ($cmd eq "Wcontents-before-sections") {
334 $Wcontents_before_sections = 1;
336 $Wcontents_before_sections = 1;
335 } elsif ($cmd eq "Wall") {
336 $Wreturn = 1;
337 $Wshort_desc = 1;
338 $Wcontents_before_sections = 1;
339 } elsif (($cmd eq "h") || ($cmd eq "help")) {
337 } elsif ($cmd eq "Wall") {
338 $Wreturn = 1;
339 $Wshort_desc = 1;
340 $Wcontents_before_sections = 1;
341 } elsif (($cmd eq "h") || ($cmd eq "help")) {
340 pod2usage(-exitval => 0, -verbose => 2);
342 pod2usage(-exitval => 0, -verbose => 2);
341 } elsif ($cmd eq 'no-doc-sections') {
343 } elsif ($cmd eq 'no-doc-sections') {
342 $no_doc_sections = 1;
344 $no_doc_sections = 1;
343 } elsif ($cmd eq 'enable-lineno') {
345 } elsif ($cmd eq 'enable-lineno') {
344 $enable_lineno = 1;
346 $enable_lineno = 1;
345 } elsif ($cmd eq 'show-not-found') {
347 } elsif ($cmd eq 'show-not-found') {
346 $show_not_found = 1; # A no-op but don't fail
348 $show_not_found = 1; # A no-op but don't fail
347 } elsif ($cmd eq "sphinx-version") {
349 } elsif ($cmd eq "sphinx-version") {
348 my $ver_string = shift @ARGV;
349 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
350 $sphinx_major = $1;
351 if (defined($2)) {
352 $sphinx_minor = substr($2,1);
353 } else {
354 $sphinx_minor = 0;
355 }
356 if (defined($3)) {
357 $sphinx_patch = substr($3,1)
358 } else {
359 $sphinx_patch = 0;
360 }
361 } else {
362 die "Sphinx version should either major.minor or major.minor.patch format\n";
363 }
350 my $ver_string = shift @ARGV;
351 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
352 $sphinx_major = $1;
353 if (defined($2)) {
354 $sphinx_minor = substr($2,1);
355 } else {
356 $sphinx_minor = 0;
357 }
358 if (defined($3)) {
359 $sphinx_patch = substr($3,1)
360 } else {
361 $sphinx_patch = 0;
362 }
363 } else {
364 die "Sphinx version should either major.minor or major.minor.patch format\n";
365 }
364 } else {
366 } else {
365 # Unknown argument
366 pod2usage(
367 -message => "Argument unknown!\n",
368 -exitval => 1,
369 -verbose => 99,
370 -sections => 'SYNOPSIS',
371 -output => \*STDERR,
372 );
367 # Unknown argument
368 pod2usage(
369 -message => "Argument unknown!\n",
370 -exitval => 1,
371 -verbose => 99,
372 -sections => 'SYNOPSIS',
373 -output => \*STDERR,
374 );
373 }
374 if ($#ARGV < 0){
375 }
376 if ($#ARGV < 0){
375 pod2usage(
376 -message => "FILE argument missing\n",
377 -exitval => 1,
378 -verbose => 99,
379 -sections => 'SYNOPSIS',
380 -output => \*STDERR,
381 );
377 pod2usage(
378 -message => "FILE argument missing\n",
379 -exitval => 1,
380 -verbose => 99,
381 -sections => 'SYNOPSIS',
382 -output => \*STDERR,
383 );
382 }
383}
384
385# continue execution near EOF;
386
387# The C domain dialect changed on Sphinx 3. So, we need to check the
388# version in order to produce the right tags.
389sub findprog($)
390{
384 }
385}
386
387# continue execution near EOF;
388
389# The C domain dialect changed on Sphinx 3. So, we need to check the
390# version in order to produce the right tags.
391sub findprog($)
392{
391 foreach(split(/:/, $ENV{PATH})) {
392 return "$_/$_[0]" if(-x "$_/$_[0]");
393 }
393 foreach(split(/:/, $ENV{PATH})) {
394 return "$_/$_[0]" if(-x "$_/$_[0]");
395 }
394}
395
396sub get_sphinx_version()
397{
396}
397
398sub get_sphinx_version()
399{
398 my $ver;
400 my $ver;
399
401
400 my $cmd = "sphinx-build";
401 if (!findprog($cmd)) {
402 my $cmd = "sphinx-build3";
403 if (!findprog($cmd)) {
404 $sphinx_major = 1;
405 $sphinx_minor = 2;
406 $sphinx_patch = 0;
407 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
408 $sphinx_major, $sphinx_minor, $sphinx_patch;
409 return;
410 }
411 }
402 my $cmd = "sphinx-build";
403 if (!findprog($cmd)) {
404 my $cmd = "sphinx-build3";
405 if (!findprog($cmd)) {
406 $sphinx_major = 1;
407 $sphinx_minor = 2;
408 $sphinx_patch = 0;
409 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
410 $sphinx_major, $sphinx_minor, $sphinx_patch;
411 return;
412 }
413 }
412
414
413 open IN, "$cmd --version 2>&1 |";
414 while (<IN>) {
415 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
416 $sphinx_major = $1;
417 $sphinx_minor = $2;
418 $sphinx_patch = $3;
419 last;
420 }
421 # Sphinx 1.2.x uses a different format
422 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
423 $sphinx_major = $1;
424 $sphinx_minor = $2;
425 $sphinx_patch = $3;
426 last;
427 }
428 }
429 close IN;
415 open IN, "$cmd --version 2>&1 |";
416 while (<IN>) {
417 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
418 $sphinx_major = $1;
419 $sphinx_minor = $2;
420 $sphinx_patch = $3;
421 last;
422 }
423 # Sphinx 1.2.x uses a different format
424 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
425 $sphinx_major = $1;
426 $sphinx_minor = $2;
427 $sphinx_patch = $3;
428 last;
429 }
430 }
431 close IN;
430}
431
432# get kernel version from env
433sub get_kernel_version() {
434 my $version = 'unknown kernel version';
435
436 if (defined($ENV{'KERNELVERSION'})) {
432}
433
434# get kernel version from env
435sub get_kernel_version() {
436 my $version = 'unknown kernel version';
437
438 if (defined($ENV{'KERNELVERSION'})) {
437 $version = $ENV{'KERNELVERSION'};
439 $version = $ENV{'KERNELVERSION'};
438 }
439 return $version;
440}
441
442#
443sub print_lineno {
444 my $lineno = shift;
445 if ($enable_lineno && defined($lineno)) {

--- 11 unchanged lines hidden (view full) ---

457# dumps section contents to arrays/hashes intended for that purpose.
458#
459sub dump_section {
460 my $file = shift;
461 my $name = shift;
462 my $contents = join "\n", @_;
463
464 if ($name =~ m/$type_param/) {
440 }
441 return $version;
442}
443
444#
445sub print_lineno {
446 my $lineno = shift;
447 if ($enable_lineno && defined($lineno)) {

--- 11 unchanged lines hidden (view full) ---

459# dumps section contents to arrays/hashes intended for that purpose.
460#
461sub dump_section {
462 my $file = shift;
463 my $name = shift;
464 my $contents = join "\n", @_;
465
466 if ($name =~ m/$type_param/) {
465 $name = $1;
466 $parameterdescs{$name} = $contents;
467 $sectcheck = $sectcheck . $name . " ";
467 $name = $1;
468 $parameterdescs{$name} = $contents;
469 $sectcheck = $sectcheck . $name . " ";
468 $parameterdesc_start_lines{$name} = $new_start_line;
469 $new_start_line = 0;
470 } elsif ($name eq "@\.\.\.") {
470 $parameterdesc_start_lines{$name} = $new_start_line;
471 $new_start_line = 0;
472 } elsif ($name eq "@\.\.\.") {
471 $name = "...";
472 $parameterdescs{$name} = $contents;
473 $sectcheck = $sectcheck . $name . " ";
473 $name = "...";
474 $parameterdescs{$name} = $contents;
475 $sectcheck = $sectcheck . $name . " ";
474 $parameterdesc_start_lines{$name} = $new_start_line;
475 $new_start_line = 0;
476 } else {
476 $parameterdesc_start_lines{$name} = $new_start_line;
477 $new_start_line = 0;
478 } else {
477 if (defined($sections{$name}) && ($sections{$name} ne "")) {
478 # Only warn on user specified duplicate section names.
479 if ($name ne $section_default) {
480 emit_warning("${file}:$.", "duplicate section name '$name'\n");
481 }
482 $sections{$name} .= $contents;
483 } else {
484 $sections{$name} = $contents;
485 push @sectionlist, $name;
479 if (defined($sections{$name}) && ($sections{$name} ne "")) {
480 # Only warn on user specified duplicate section names.
481 if ($name ne $section_default) {
482 emit_warning("${file}:$.", "duplicate section name '$name'\n");
483 }
484 $sections{$name} .= $contents;
485 } else {
486 $sections{$name} = $contents;
487 push @sectionlist, $name;
486 $section_start_lines{$name} = $new_start_line;
487 $new_start_line = 0;
488 $section_start_lines{$name} = $new_start_line;
489 $new_start_line = 0;
488 }
490 }
489 }
490}
491
492##
493# dump DOC: section after checking that it should go out
494#
495sub dump_doc_section {
496 my $file = shift;
497 my $name = shift;
498 my $contents = join "\n", @_;
499
500 if ($no_doc_sections) {
501 return;
502 }
503
504 return if (defined($nosymbol_table{$name}));
505
506 if (($output_selection == OUTPUT_ALL) ||
491 }
492}
493
494##
495# dump DOC: section after checking that it should go out
496#
497sub dump_doc_section {
498 my $file = shift;
499 my $name = shift;
500 my $contents = join "\n", @_;
501
502 if ($no_doc_sections) {
503 return;
504 }
505
506 return if (defined($nosymbol_table{$name}));
507
508 if (($output_selection == OUTPUT_ALL) ||
507 (($output_selection == OUTPUT_INCLUDE) &&
508 defined($function_table{$name})))
509 (($output_selection == OUTPUT_INCLUDE) &&
510 defined($function_table{$name})))
509 {
511 {
510 dump_section($file, $name, $contents);
511 output_blockhead({'sectionlist' => \@sectionlist,
512 'sections' => \%sections,
513 'module' => $modulename,
514 'content-only' => ($output_selection != OUTPUT_ALL), });
512 dump_section($file, $name, $contents);
513 output_blockhead({'sectionlist' => \@sectionlist,
514 'sections' => \%sections,
515 'module' => $modulename,
516 'content-only' => ($output_selection != OUTPUT_ALL), });
515 }
516}
517
518##
519# output function
520#
521# parameterdescs, a hash.
522# function => "function name"

--- 14 unchanged lines hidden (view full) ---

537# }
538
539# print STDERR "contents b4:$contents\n";
540 eval $dohighlight;
541 die $@ if $@;
542# print STDERR "contents af:$contents\n";
543
544 foreach $line (split "\n", $contents) {
517 }
518}
519
520##
521# output function
522#
523# parameterdescs, a hash.
524# function => "function name"

--- 14 unchanged lines hidden (view full) ---

539# }
540
541# print STDERR "contents b4:$contents\n";
542 eval $dohighlight;
543 die $@ if $@;
544# print STDERR "contents af:$contents\n";
545
546 foreach $line (split "\n", $contents) {
545 if (! $output_preformatted) {
546 $line =~ s/^\s*//;
547 }
548 if ($line eq ""){
549 if (! $output_preformatted) {
550 print $lineprefix, $blankline;
551 }
552 } else {
553 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
554 print "\\&$line";
555 } else {
556 print $lineprefix, $line;
557 }
558 }
559 print "\n";
547 if (! $output_preformatted) {
548 $line =~ s/^\s*//;
549 }
550 if ($line eq ""){
551 if (! $output_preformatted) {
552 print $lineprefix, $blankline;
553 }
554 } else {
555 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
556 print "\\&$line";
557 } else {
558 print $lineprefix, $line;
559 }
560 }
561 print "\n";
560 }
561}
562
563##
564# output function in man
565sub output_function_man(%) {
566 my %args = %{$_[0]};
567 my ($parameter, $section);
568 my $count;
569
570 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
571
572 print ".SH NAME\n";
573 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
574
575 print ".SH SYNOPSIS\n";
576 if ($args{'functiontype'} ne "") {
562 }
563}
564
565##
566# output function in man
567sub output_function_man(%) {
568 my %args = %{$_[0]};
569 my ($parameter, $section);
570 my $count;
571
572 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
573
574 print ".SH NAME\n";
575 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
576
577 print ".SH SYNOPSIS\n";
578 if ($args{'functiontype'} ne "") {
577 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
579 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
578 } else {
580 } else {
579 print ".B \"" . $args{'function'} . "\n";
581 print ".B \"" . $args{'function'} . "\n";
580 }
581 $count = 0;
582 my $parenth = "(";
583 my $post = ",";
584 foreach my $parameter (@{$args{'parameterlist'}}) {
582 }
583 $count = 0;
584 my $parenth = "(";
585 my $post = ",";
586 foreach my $parameter (@{$args{'parameterlist'}}) {
585 if ($count == $#{$args{'parameterlist'}}) {
586 $post = ");";
587 }
588 $type = $args{'parametertypes'}{$parameter};
589 if ($type =~ m/$function_pointer/) {
590 # pointer-to-function
591 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
592 } else {
593 $type =~ s/([^\*])$/$1 /;
594 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
595 }
596 $count++;
597 $parenth = "";
587 if ($count == $#{$args{'parameterlist'}}) {
588 $post = ");";
589 }
590 $type = $args{'parametertypes'}{$parameter};
591 if ($type =~ m/$function_pointer/) {
592 # pointer-to-function
593 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
594 } else {
595 $type =~ s/([^\*])$/$1 /;
596 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
597 }
598 $count++;
599 $parenth = "";
598 }
599
600 print ".SH ARGUMENTS\n";
601 foreach $parameter (@{$args{'parameterlist'}}) {
600 }
601
602 print ".SH ARGUMENTS\n";
603 foreach $parameter (@{$args{'parameterlist'}}) {
602 my $parameter_name = $parameter;
603 $parameter_name =~ s/\[.*//;
604 my $parameter_name = $parameter;
605 $parameter_name =~ s/\[.*//;
604
606
605 print ".IP \"" . $parameter . "\" 12\n";
606 output_highlight($args{'parameterdescs'}{$parameter_name});
607 print ".IP \"" . $parameter . "\" 12\n";
608 output_highlight($args{'parameterdescs'}{$parameter_name});
607 }
608 foreach $section (@{$args{'sectionlist'}}) {
609 }
610 foreach $section (@{$args{'sectionlist'}}) {
609 print ".SH \"", uc $section, "\"\n";
610 output_highlight($args{'sections'}{$section});
611 print ".SH \"", uc $section, "\"\n";
612 output_highlight($args{'sections'}{$section});
611 }
612}
613
614##
615# output enum in man
616sub output_enum_man(%) {
617 my %args = %{$_[0]};
618 my ($parameter, $section);
619 my $count;
620
621 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
622
623 print ".SH NAME\n";
624 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
625
626 print ".SH SYNOPSIS\n";
627 print "enum " . $args{'enum'} . " {\n";
628 $count = 0;
629 foreach my $parameter (@{$args{'parameterlist'}}) {
613 }
614}
615
616##
617# output enum in man
618sub output_enum_man(%) {
619 my %args = %{$_[0]};
620 my ($parameter, $section);
621 my $count;
622
623 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
624
625 print ".SH NAME\n";
626 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
627
628 print ".SH SYNOPSIS\n";
629 print "enum " . $args{'enum'} . " {\n";
630 $count = 0;
631 foreach my $parameter (@{$args{'parameterlist'}}) {
630 print ".br\n.BI \" $parameter\"\n";
631 if ($count == $#{$args{'parameterlist'}}) {
632 print "\n};\n";
633 last;
634 }
635 else {
636 print ", \n.br\n";
637 }
638 $count++;
632 print ".br\n.BI \" $parameter\"\n";
633 if ($count == $#{$args{'parameterlist'}}) {
634 print "\n};\n";
635 last;
636 } else {
637 print ", \n.br\n";
638 }
639 $count++;
639 }
640
641 print ".SH Constants\n";
642 foreach $parameter (@{$args{'parameterlist'}}) {
640 }
641
642 print ".SH Constants\n";
643 foreach $parameter (@{$args{'parameterlist'}}) {
643 my $parameter_name = $parameter;
644 $parameter_name =~ s/\[.*//;
644 my $parameter_name = $parameter;
645 $parameter_name =~ s/\[.*//;
645
646
646 print ".IP \"" . $parameter . "\" 12\n";
647 output_highlight($args{'parameterdescs'}{$parameter_name});
647 print ".IP \"" . $parameter . "\" 12\n";
648 output_highlight($args{'parameterdescs'}{$parameter_name});
648 }
649 foreach $section (@{$args{'sectionlist'}}) {
649 }
650 foreach $section (@{$args{'sectionlist'}}) {
650 print ".SH \"$section\"\n";
651 output_highlight($args{'sections'}{$section});
651 print ".SH \"$section\"\n";
652 output_highlight($args{'sections'}{$section});
652 }
653}
654
655##
656# output struct in man
657sub output_struct_man(%) {
658 my %args = %{$_[0]};
659 my ($parameter, $section);

--- 7 unchanged lines hidden (view full) ---

667 $declaration =~ s/\t/ /g;
668 $declaration =~ s/\n/"\n.br\n.BI \"/g;
669 print ".SH SYNOPSIS\n";
670 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
671 print ".BI \"$declaration\n};\n.br\n\n";
672
673 print ".SH Members\n";
674 foreach $parameter (@{$args{'parameterlist'}}) {
653 }
654}
655
656##
657# output struct in man
658sub output_struct_man(%) {
659 my %args = %{$_[0]};
660 my ($parameter, $section);

--- 7 unchanged lines hidden (view full) ---

668 $declaration =~ s/\t/ /g;
669 $declaration =~ s/\n/"\n.br\n.BI \"/g;
670 print ".SH SYNOPSIS\n";
671 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
672 print ".BI \"$declaration\n};\n.br\n\n";
673
674 print ".SH Members\n";
675 foreach $parameter (@{$args{'parameterlist'}}) {
675 ($parameter =~ /^#/) && next;
676 ($parameter =~ /^#/) && next;
676
677
677 my $parameter_name = $parameter;
678 $parameter_name =~ s/\[.*//;
678 my $parameter_name = $parameter;
679 $parameter_name =~ s/\[.*//;
679
680
680 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
681 print ".IP \"" . $parameter . "\" 12\n";
682 output_highlight($args{'parameterdescs'}{$parameter_name});
681 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
682 print ".IP \"" . $parameter . "\" 12\n";
683 output_highlight($args{'parameterdescs'}{$parameter_name});
683 }
684 foreach $section (@{$args{'sectionlist'}}) {
684 }
685 foreach $section (@{$args{'sectionlist'}}) {
685 print ".SH \"$section\"\n";
686 output_highlight($args{'sections'}{$section});
686 print ".SH \"$section\"\n";
687 output_highlight($args{'sections'}{$section});
687 }
688}
689
690##
691# output typedef in man
692sub output_typedef_man(%) {
693 my %args = %{$_[0]};
694 my ($parameter, $section);
695
696 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
697
698 print ".SH NAME\n";
699 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
700
701 foreach $section (@{$args{'sectionlist'}}) {
688 }
689}
690
691##
692# output typedef in man
693sub output_typedef_man(%) {
694 my %args = %{$_[0]};
695 my ($parameter, $section);
696
697 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
698
699 print ".SH NAME\n";
700 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
701
702 foreach $section (@{$args{'sectionlist'}}) {
702 print ".SH \"$section\"\n";
703 output_highlight($args{'sections'}{$section});
703 print ".SH \"$section\"\n";
704 output_highlight($args{'sections'}{$section});
704 }
705}
706
707sub output_blockhead_man(%) {
708 my %args = %{$_[0]};
709 my ($parameter, $section);
710 my $count;
711
712 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
713
714 foreach $section (@{$args{'sectionlist'}}) {
705 }
706}
707
708sub output_blockhead_man(%) {
709 my %args = %{$_[0]};
710 my ($parameter, $section);
711 my $count;
712
713 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
714
715 foreach $section (@{$args{'sectionlist'}}) {
715 print ".SH \"$section\"\n";
716 output_highlight($args{'sections'}{$section});
716 print ".SH \"$section\"\n";
717 output_highlight($args{'sections'}{$section});
717 }
718}
719
720##
721# output in restructured text
722#
723
724#
725# This could use some work; it's used to output the DOC: sections, and
726# starts by putting out the name of the doc section itself, but that tends
727# to duplicate a header already in the template file.
728#
729sub output_blockhead_rst(%) {
730 my %args = %{$_[0]};
731 my ($parameter, $section);
732
733 foreach $section (@{$args{'sectionlist'}}) {
718 }
719}
720
721##
722# output in restructured text
723#
724
725#
726# This could use some work; it's used to output the DOC: sections, and
727# starts by putting out the name of the doc section itself, but that tends
728# to duplicate a header already in the template file.
729#
730sub output_blockhead_rst(%) {
731 my %args = %{$_[0]};
732 my ($parameter, $section);
733
734 foreach $section (@{$args{'sectionlist'}}) {
734 next if (defined($nosymbol_table{$section}));
735 next if (defined($nosymbol_table{$section}));
735
736
736 if ($output_selection != OUTPUT_INCLUDE) {
737 print ".. _$section:\n\n";
738 print "**$section**\n\n";
739 }
737 if ($output_selection != OUTPUT_INCLUDE) {
738 print ".. _$section:\n\n";
739 print "**$section**\n\n";
740 }
740 print_lineno($section_start_lines{$section});
741 print_lineno($section_start_lines{$section});
741 output_highlight_rst($args{'sections'}{$section});
742 print "\n";
742 output_highlight_rst($args{'sections'}{$section});
743 print "\n";
743 }
744}
745
746#
747# Apply the RST highlights to a sub-block of text.
748#
749sub highlight_block($) {
750 # The dohighlight kludge requires the text be called $contents

--- 13 unchanged lines hidden (view full) ---

764 my $input = join "\n",@_;
765 my $output = "";
766 my $line;
767 my $in_literal = 0;
768 my $litprefix;
769 my $block = "";
770
771 foreach $line (split "\n",$input) {
744 }
745}
746
747#
748# Apply the RST highlights to a sub-block of text.
749#
750sub highlight_block($) {
751 # The dohighlight kludge requires the text be called $contents

--- 13 unchanged lines hidden (view full) ---

765 my $input = join "\n",@_;
766 my $output = "";
767 my $line;
768 my $in_literal = 0;
769 my $litprefix;
770 my $block = "";
771
772 foreach $line (split "\n",$input) {
772 #
773 # If we're in a literal block, see if we should drop out
774 # of it. Otherwise pass the line straight through unmunged.
775 #
776 if ($in_literal) {
777 if (! ($line =~ /^\s*$/)) {
778 #
779 # If this is the first non-blank line in a literal
780 # block we need to figure out what the proper indent is.
781 #
782 if ($litprefix eq "") {
783 $line =~ /^(\s*)/;
784 $litprefix = '^' . $1;
785 $output .= $line . "\n";
786 } elsif (! ($line =~ /$litprefix/)) {
787 $in_literal = 0;
788 } else {
789 $output .= $line . "\n";
790 }
791 } else {
792 $output .= $line . "\n";
793 }
794 }
795 #
796 # Not in a literal block (or just dropped out)
797 #
798 if (! $in_literal) {
799 $block .= $line . "\n";
800 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
801 $in_literal = 1;
802 $litprefix = "";
803 $output .= highlight_block($block);
804 $block = ""
805 }
806 }
773 #
774 # If we're in a literal block, see if we should drop out
775 # of it. Otherwise pass the line straight through unmunged.
776 #
777 if ($in_literal) {
778 if (! ($line =~ /^\s*$/)) {
779 #
780 # If this is the first non-blank line in a literal
781 # block we need to figure out what the proper indent is.
782 #
783 if ($litprefix eq "") {
784 $line =~ /^(\s*)/;
785 $litprefix = '^' . $1;
786 $output .= $line . "\n";
787 } elsif (! ($line =~ /$litprefix/)) {
788 $in_literal = 0;
789 } else {
790 $output .= $line . "\n";
791 }
792 } else {
793 $output .= $line . "\n";
794 }
795 }
796 #
797 # Not in a literal block (or just dropped out)
798 #
799 if (! $in_literal) {
800 $block .= $line . "\n";
801 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
802 $in_literal = 1;
803 $litprefix = "";
804 $output .= highlight_block($block);
805 $block = ""
806 }
807 }
807 }
808
809 if ($block) {
808 }
809
810 if ($block) {
810 $output .= highlight_block($block);
811 $output .= highlight_block($block);
811 }
812 foreach $line (split "\n", $output) {
812 }
813 foreach $line (split "\n", $output) {
813 print $lineprefix . $line . "\n";
814 print $lineprefix . $line . "\n";
814 }
815}
816
817sub output_function_rst(%) {
818 my %args = %{$_[0]};
819 my ($parameter, $section);
820 my $oldprefix = $lineprefix;
821 my $start = "";
822 my $is_macro = 0;
823
824 if ($sphinx_major < 3) {
815 }
816}
817
818sub output_function_rst(%) {
819 my %args = %{$_[0]};
820 my ($parameter, $section);
821 my $oldprefix = $lineprefix;
822 my $start = "";
823 my $is_macro = 0;
824
825 if ($sphinx_major < 3) {
825 if ($args{'typedef'}) {
826 print ".. c:type:: ". $args{'function'} . "\n\n";
827 print_lineno($declaration_start_line);
828 print " **Typedef**: ";
829 $lineprefix = "";
830 output_highlight_rst($args{'purpose'});
831 $start = "\n\n**Syntax**\n\n ``";
832 $is_macro = 1;
833 } else {
834 print ".. c:function:: ";
835 }
826 if ($args{'typedef'}) {
827 print ".. c:type:: ". $args{'function'} . "\n\n";
828 print_lineno($declaration_start_line);
829 print " **Typedef**: ";
830 $lineprefix = "";
831 output_highlight_rst($args{'purpose'});
832 $start = "\n\n**Syntax**\n\n ``";
833 $is_macro = 1;
834 } else {
835 print ".. c:function:: ";
836 }
836 } else {
837 } else {
837 if ($args{'typedef'} || $args{'functiontype'} eq "") {
838 $is_macro = 1;
839 print ".. c:macro:: ". $args{'function'} . "\n\n";
840 } else {
841 print ".. c:function:: ";
842 }
838 if ($args{'typedef'} || $args{'functiontype'} eq "") {
839 $is_macro = 1;
840 print ".. c:macro:: ". $args{'function'} . "\n\n";
841 } else {
842 print ".. c:function:: ";
843 }
843
844
844 if ($args{'typedef'}) {
845 print_lineno($declaration_start_line);
846 print " **Typedef**: ";
847 $lineprefix = "";
848 output_highlight_rst($args{'purpose'});
849 $start = "\n\n**Syntax**\n\n ``";
850 } else {
851 print "``" if ($is_macro);
852 }
845 if ($args{'typedef'}) {
846 print_lineno($declaration_start_line);
847 print " **Typedef**: ";
848 $lineprefix = "";
849 output_highlight_rst($args{'purpose'});
850 $start = "\n\n**Syntax**\n\n ``";
851 } else {
852 print "``" if ($is_macro);
853 }
853 }
854 if ($args{'functiontype'} ne "") {
854 }
855 if ($args{'functiontype'} ne "") {
855 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
856 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
856 } else {
857 } else {
857 $start .= $args{'function'} . " (";
858 $start .= $args{'function'} . " (";
858 }
859 print $start;
860
861 my $count = 0;
862 foreach my $parameter (@{$args{'parameterlist'}}) {
859 }
860 print $start;
861
862 my $count = 0;
863 foreach my $parameter (@{$args{'parameterlist'}}) {
863 if ($count ne 0) {
864 print ", ";
865 }
866 $count++;
867 $type = $args{'parametertypes'}{$parameter};
864 if ($count ne 0) {
865 print ", ";
866 }
867 $count++;
868 $type = $args{'parametertypes'}{$parameter};
868
869
869 if ($type =~ m/$function_pointer/) {
870 # pointer-to-function
871 print $1 . $parameter . ") (" . $2 . ")";
872 } else {
873 print $type;
874 }
870 if ($type =~ m/$function_pointer/) {
871 # pointer-to-function
872 print $1 . $parameter . ") (" . $2 . ")";
873 } else {
874 print $type;
875 }
875 }
876 if ($is_macro) {
876 }
877 if ($is_macro) {
877 print ")``\n\n";
878 print ")``\n\n";
878 } else {
879 } else {
879 print ")\n\n";
880 print ")\n\n";
880 }
881 if (!$args{'typedef'}) {
881 }
882 if (!$args{'typedef'}) {
882 print_lineno($declaration_start_line);
883 $lineprefix = " ";
884 output_highlight_rst($args{'purpose'});
885 print "\n";
883 print_lineno($declaration_start_line);
884 $lineprefix = " ";
885 output_highlight_rst($args{'purpose'});
886 print "\n";
886 }
887
888 #
889 # Put our descriptive text into a container (thus an HTML <div>) to help
890 # set the function prototypes apart.
891 #
892 print ".. container:: kernelindent\n\n";
893 $lineprefix = " ";
894 print $lineprefix . "**Parameters**\n\n";
895 foreach $parameter (@{$args{'parameterlist'}}) {
887 }
888
889 #
890 # Put our descriptive text into a container (thus an HTML <div>) to help
891 # set the function prototypes apart.
892 #
893 print ".. container:: kernelindent\n\n";
894 $lineprefix = " ";
895 print $lineprefix . "**Parameters**\n\n";
896 foreach $parameter (@{$args{'parameterlist'}}) {
896 my $parameter_name = $parameter;
897 $parameter_name =~ s/\[.*//;
898 $type = $args{'parametertypes'}{$parameter};
897 my $parameter_name = $parameter;
898 $parameter_name =~ s/\[.*//;
899 $type = $args{'parametertypes'}{$parameter};
899
900
900 if ($type ne "") {
901 print $lineprefix . "``$type``\n";
902 } else {
903 print $lineprefix . "``$parameter``\n";
904 }
901 if ($type ne "") {
902 print $lineprefix . "``$type``\n";
903 } else {
904 print $lineprefix . "``$parameter``\n";
905 }
905
906 print_lineno($parameterdesc_start_lines{$parameter_name});
907
906
907 print_lineno($parameterdesc_start_lines{$parameter_name});
908
908 $lineprefix = " ";
909 if (defined($args{'parameterdescs'}{$parameter_name}) &&
910 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
911 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
912 } else {
913 print $lineprefix . "*undescribed*\n";
914 }
915 $lineprefix = " ";
916 print "\n";
909 $lineprefix = " ";
910 if (defined($args{'parameterdescs'}{$parameter_name}) &&
911 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
912 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
913 } else {
914 print $lineprefix . "*undescribed*\n";
915 }
916 $lineprefix = " ";
917 print "\n";
917 }
918
919 output_section_rst(@_);
920 $lineprefix = $oldprefix;
921}
922
923sub output_section_rst(%) {
924 my %args = %{$_[0]};
925 my $section;
926 my $oldprefix = $lineprefix;
927
928 foreach $section (@{$args{'sectionlist'}}) {
918 }
919
920 output_section_rst(@_);
921 $lineprefix = $oldprefix;
922}
923
924sub output_section_rst(%) {
925 my %args = %{$_[0]};
926 my $section;
927 my $oldprefix = $lineprefix;
928
929 foreach $section (@{$args{'sectionlist'}}) {
929 print $lineprefix . "**$section**\n\n";
930 print $lineprefix . "**$section**\n\n";
930 print_lineno($section_start_lines{$section});
931 print_lineno($section_start_lines{$section});
931 output_highlight_rst($args{'sections'}{$section});
932 print "\n";
932 output_highlight_rst($args{'sections'}{$section});
933 print "\n";
933 }
934 print "\n";
935}
936
937sub output_enum_rst(%) {
938 my %args = %{$_[0]};
939 my ($parameter);
940 my $oldprefix = $lineprefix;
941 my $count;
942 my $outer;
943
944 if ($sphinx_major < 3) {
934 }
935 print "\n";
936}
937
938sub output_enum_rst(%) {
939 my %args = %{$_[0]};
940 my ($parameter);
941 my $oldprefix = $lineprefix;
942 my $count;
943 my $outer;
944
945 if ($sphinx_major < 3) {
945 my $name = "enum " . $args{'enum'};
946 print "\n\n.. c:type:: " . $name . "\n\n";
946 my $name = "enum " . $args{'enum'};
947 print "\n\n.. c:type:: " . $name . "\n\n";
947 } else {
948 } else {
948 my $name = $args{'enum'};
949 print "\n\n.. c:enum:: " . $name . "\n\n";
949 my $name = $args{'enum'};
950 print "\n\n.. c:enum:: " . $name . "\n\n";
950 }
951 print_lineno($declaration_start_line);
952 $lineprefix = " ";
953 output_highlight_rst($args{'purpose'});
954 print "\n";
955
956 print ".. container:: kernelindent\n\n";
957 $outer = $lineprefix . " ";
958 $lineprefix = $outer . " ";
959 print $outer . "**Constants**\n\n";
960 foreach $parameter (@{$args{'parameterlist'}}) {
951 }
952 print_lineno($declaration_start_line);
953 $lineprefix = " ";
954 output_highlight_rst($args{'purpose'});
955 print "\n";
956
957 print ".. container:: kernelindent\n\n";
958 $outer = $lineprefix . " ";
959 $lineprefix = $outer . " ";
960 print $outer . "**Constants**\n\n";
961 foreach $parameter (@{$args{'parameterlist'}}) {
961 print $outer . "``$parameter``\n";
962 print $outer . "``$parameter``\n";
962
963
963 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
964 output_highlight_rst($args{'parameterdescs'}{$parameter});
965 } else {
966 print $lineprefix . "*undescribed*\n";
967 }
968 print "\n";
964 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
965 output_highlight_rst($args{'parameterdescs'}{$parameter});
966 } else {
967 print $lineprefix . "*undescribed*\n";
968 }
969 print "\n";
969 }
970 print "\n";
971 $lineprefix = $oldprefix;
972 output_section_rst(@_);
973}
974
975sub output_typedef_rst(%) {
976 my %args = %{$_[0]};
977 my ($parameter);
978 my $oldprefix = $lineprefix;
979 my $name;
980
981 if ($sphinx_major < 3) {
970 }
971 print "\n";
972 $lineprefix = $oldprefix;
973 output_section_rst(@_);
974}
975
976sub output_typedef_rst(%) {
977 my %args = %{$_[0]};
978 my ($parameter);
979 my $oldprefix = $lineprefix;
980 my $name;
981
982 if ($sphinx_major < 3) {
982 $name = "typedef " . $args{'typedef'};
983 $name = "typedef " . $args{'typedef'};
983 } else {
984 } else {
984 $name = $args{'typedef'};
985 $name = $args{'typedef'};
985 }
986 print "\n\n.. c:type:: " . $name . "\n\n";
987 print_lineno($declaration_start_line);
988 $lineprefix = " ";
989 output_highlight_rst($args{'purpose'});
990 print "\n";
991
992 $lineprefix = $oldprefix;
993 output_section_rst(@_);
994}
995
996sub output_struct_rst(%) {
997 my %args = %{$_[0]};
998 my ($parameter);
999 my $oldprefix = $lineprefix;
1000
1001 if ($sphinx_major < 3) {
986 }
987 print "\n\n.. c:type:: " . $name . "\n\n";
988 print_lineno($declaration_start_line);
989 $lineprefix = " ";
990 output_highlight_rst($args{'purpose'});
991 print "\n";
992
993 $lineprefix = $oldprefix;
994 output_section_rst(@_);
995}
996
997sub output_struct_rst(%) {
998 my %args = %{$_[0]};
999 my ($parameter);
1000 my $oldprefix = $lineprefix;
1001
1002 if ($sphinx_major < 3) {
1002 my $name = $args{'type'} . " " . $args{'struct'};
1003 print "\n\n.. c:type:: " . $name . "\n\n";
1003 my $name = $args{'type'} . " " . $args{'struct'};
1004 print "\n\n.. c:type:: " . $name . "\n\n";
1004 } else {
1005 } else {
1005 my $name = $args{'struct'};
1006 if ($args{'type'} eq 'union') {
1007 print "\n\n.. c:union:: " . $name . "\n\n";
1008 } else {
1009 print "\n\n.. c:struct:: " . $name . "\n\n";
1010 }
1006 my $name = $args{'struct'};
1007 if ($args{'type'} eq 'union') {
1008 print "\n\n.. c:union:: " . $name . "\n\n";
1009 } else {
1010 print "\n\n.. c:struct:: " . $name . "\n\n";
1011 }
1011 }
1012 print_lineno($declaration_start_line);
1013 $lineprefix = " ";
1014 output_highlight_rst($args{'purpose'});
1015 print "\n";
1016
1017 print ".. container:: kernelindent\n\n";
1018 print $lineprefix . "**Definition**::\n\n";
1019 my $declaration = $args{'definition'};
1020 $lineprefix = $lineprefix . " ";
1021 $declaration =~ s/\t/$lineprefix/g;
1022 print $lineprefix . $args{'type'} . " " . $args{'struct'} . " {\n$declaration" . $lineprefix . "};\n\n";
1023
1024 $lineprefix = " ";
1025 print $lineprefix . "**Members**\n\n";
1026 foreach $parameter (@{$args{'parameterlist'}}) {
1012 }
1013 print_lineno($declaration_start_line);
1014 $lineprefix = " ";
1015 output_highlight_rst($args{'purpose'});
1016 print "\n";
1017
1018 print ".. container:: kernelindent\n\n";
1019 print $lineprefix . "**Definition**::\n\n";
1020 my $declaration = $args{'definition'};
1021 $lineprefix = $lineprefix . " ";
1022 $declaration =~ s/\t/$lineprefix/g;
1023 print $lineprefix . $args{'type'} . " " . $args{'struct'} . " {\n$declaration" . $lineprefix . "};\n\n";
1024
1025 $lineprefix = " ";
1026 print $lineprefix . "**Members**\n\n";
1027 foreach $parameter (@{$args{'parameterlist'}}) {
1027 ($parameter =~ /^#/) && next;
1028 ($parameter =~ /^#/) && next;
1028
1029
1029 my $parameter_name = $parameter;
1030 $parameter_name =~ s/\[.*//;
1030 my $parameter_name = $parameter;
1031 $parameter_name =~ s/\[.*//;
1031
1032
1032 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1033 $type = $args{'parametertypes'}{$parameter};
1033 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1034 $type = $args{'parametertypes'}{$parameter};
1034 print_lineno($parameterdesc_start_lines{$parameter_name});
1035 print_lineno($parameterdesc_start_lines{$parameter_name});
1035 print $lineprefix . "``" . $parameter . "``\n";
1036 $lineprefix = " ";
1037 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1038 $lineprefix = " ";
1039 print "\n";
1036 print $lineprefix . "``" . $parameter . "``\n";
1037 $lineprefix = " ";
1038 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1039 $lineprefix = " ";
1040 print "\n";
1040 }
1041 print "\n";
1042
1043 $lineprefix = $oldprefix;
1044 output_section_rst(@_);
1045}
1046
1047## none mode output functions

--- 21 unchanged lines hidden (view full) ---

1069 no strict 'refs';
1070 my $name = shift;
1071 my $functype = shift;
1072 my $func = "output_${functype}_$output_mode";
1073
1074 return if (defined($nosymbol_table{$name}));
1075
1076 if (($output_selection == OUTPUT_ALL) ||
1041 }
1042 print "\n";
1043
1044 $lineprefix = $oldprefix;
1045 output_section_rst(@_);
1046}
1047
1048## none mode output functions

--- 21 unchanged lines hidden (view full) ---

1070 no strict 'refs';
1071 my $name = shift;
1072 my $functype = shift;
1073 my $func = "output_${functype}_$output_mode";
1074
1075 return if (defined($nosymbol_table{$name}));
1076
1077 if (($output_selection == OUTPUT_ALL) ||
1077 (($output_selection == OUTPUT_INCLUDE ||
1078 $output_selection == OUTPUT_EXPORTED) &&
1079 defined($function_table{$name})) ||
1080 ($output_selection == OUTPUT_INTERNAL &&
1081 !($functype eq "function" && defined($function_table{$name}))))
1078 (($output_selection == OUTPUT_INCLUDE ||
1079 $output_selection == OUTPUT_EXPORTED) &&
1080 defined($function_table{$name})) ||
1081 ($output_selection == OUTPUT_INTERNAL &&
1082 !($functype eq "function" && defined($function_table{$name}))))
1082 {
1083 {
1083 &$func(@_);
1084 $section_counter++;
1084 &$func(@_);
1085 $section_counter++;
1085 }
1086}
1087
1088##
1089# generic output function - calls the right one based on current output mode.
1090sub output_blockhead {
1091 no strict 'refs';
1092 my $func = "output_blockhead_" . $output_mode;

--- 22 unchanged lines hidden (view full) ---

1115 my $members;
1116 my $type = qr{struct|union};
1117 # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
1118 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned};
1119 my $definition_body = qr{\{(.*)\}\s*$qualifiers*};
1120 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1121
1122 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1086 }
1087}
1088
1089##
1090# generic output function - calls the right one based on current output mode.
1091sub output_blockhead {
1092 no strict 'refs';
1093 my $func = "output_blockhead_" . $output_mode;

--- 22 unchanged lines hidden (view full) ---

1116 my $members;
1117 my $type = qr{struct|union};
1118 # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
1119 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned};
1120 my $definition_body = qr{\{(.*)\}\s*$qualifiers*};
1121 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1122
1123 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1123 $decl_type = $1;
1124 $declaration_name = $2;
1125 $members = $3;
1124 $decl_type = $1;
1125 $declaration_name = $2;
1126 $members = $3;
1126 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1127 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1127 $decl_type = $1;
1128 $declaration_name = $3;
1129 $members = $2;
1128 $decl_type = $1;
1129 $declaration_name = $3;
1130 $members = $2;
1130 }
1131
1132 if ($members) {
1131 }
1132
1133 if ($members) {
1133 if ($identifier ne $declaration_name) {
1134 emit_warning("${file}:$.", "expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n");
1135 return;
1136 }
1134 if ($identifier ne $declaration_name) {
1135 emit_warning("${file}:$.", "expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n");
1136 return;
1137 }
1137
1138
1138 # ignore members marked private:
1139 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1140 $members =~ s/\/\*\s*private:.*//gosi;
1141 # strip comments:
1142 $members =~ s/\/\*.*?\*\///gos;
1143 # strip attributes
1144 $members =~ s/\s*$attribute/ /gi;
1145 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1146 $members =~ s/\s*__counted_by\s*\([^;]*\)/ /gos;
1147 $members =~ s/\s*__packed\s*/ /gos;
1148 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1149 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1150 $members =~ s/\s*____cacheline_aligned/ /gos;
1151 # unwrap struct_group():
1152 # - first eat non-declaration parameters and rewrite for final match
1153 # - then remove macro, outer parens, and trailing semicolon
1154 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
1155 $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1156 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1157 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
1139 # ignore members marked private:
1140 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1141 $members =~ s/\/\*\s*private:.*//gosi;
1142 # strip comments:
1143 $members =~ s/\/\*.*?\*\///gos;
1144 # strip attributes
1145 $members =~ s/\s*$attribute/ /gi;
1146 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1147 $members =~ s/\s*__counted_by\s*\([^;]*\)/ /gos;
1148 $members =~ s/\s*__packed\s*/ /gos;
1149 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1150 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1151 $members =~ s/\s*____cacheline_aligned/ /gos;
1152 # unwrap struct_group():
1153 # - first eat non-declaration parameters and rewrite for final match
1154 # - then remove macro, outer parens, and trailing semicolon
1155 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
1156 $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1157 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1158 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
1158
1159
1159 my $args = qr{([^,)]+)};
1160 # replace DECLARE_BITMAP
1161 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1162 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos;
1163 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1164 # replace DECLARE_HASHTABLE
1165 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1166 # replace DECLARE_KFIFO
1167 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1168 # replace DECLARE_KFIFO_PTR
1169 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1170 # replace DECLARE_FLEX_ARRAY
1171 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
1172 #replace DEFINE_DMA_UNMAP_ADDR
1173 $members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos;
1174 #replace DEFINE_DMA_UNMAP_LEN
1175 $members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos;
1176 my $declaration = $members;
1160 my $args = qr{([^,)]+)};
1161 # replace DECLARE_BITMAP
1162 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1163 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos;
1164 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1165 # replace DECLARE_HASHTABLE
1166 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1167 # replace DECLARE_KFIFO
1168 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1169 # replace DECLARE_KFIFO_PTR
1170 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1171 # replace DECLARE_FLEX_ARRAY
1172 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
1173 #replace DEFINE_DMA_UNMAP_ADDR
1174 $members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos;
1175 #replace DEFINE_DMA_UNMAP_LEN
1176 $members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos;
1177 my $declaration = $members;
1177
1178
1178 # Split nested struct/union elements as newer ones
1179 while ($members =~ m/$struct_members/) {
1180 my $newmember;
1181 my $maintype = $1;
1182 my $ids = $4;
1183 my $content = $3;
1184 foreach my $id(split /,/, $ids) {
1185 $newmember .= "$maintype $id; ";
1179 # Split nested struct/union elements as newer ones
1180 while ($members =~ m/$struct_members/) {
1181 my $newmember;
1182 my $maintype = $1;
1183 my $ids = $4;
1184 my $content = $3;
1185 foreach my $id(split /,/, $ids) {
1186 $newmember .= "$maintype $id; ";
1186
1187
1187 $id =~ s/[:\[].*//;
1188 $id =~ s/^\s*\**(\S+)\s*/$1/;
1189 foreach my $arg (split /;/, $content) {
1190 next if ($arg =~ m/^\s*$/);
1191 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1192 # pointer-to-function
1193 my $type = $1;
1194 my $name = $2;
1195 my $extra = $3;
1196 next if (!$name);
1197 if ($id =~ m/^\s*$/) {
1198 # anonymous struct/union
1199 $newmember .= "$type$name$extra; ";
1200 } else {
1201 $newmember .= "$type$id.$name$extra; ";
1202 }
1203 } else {
1204 my $type;
1205 my $names;
1206 $arg =~ s/^\s+//;
1207 $arg =~ s/\s+$//;
1208 # Handle bitmaps
1209 $arg =~ s/:\s*\d+\s*//g;
1210 # Handle arrays
1211 $arg =~ s/\[.*\]//g;
1212 # The type may have multiple words,
1213 # and multiple IDs can be defined, like:
1214 # const struct foo, *bar, foobar
1215 # So, we remove spaces when parsing the
1216 # names, in order to match just names
1217 # and commas for the names
1218 $arg =~ s/\s*,\s*/,/g;
1219 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1220 $type = $1;
1221 $names = $2;
1222 } else {
1223 $newmember .= "$arg; ";
1224 next;
1225 }
1226 foreach my $name (split /,/, $names) {
1227 $name =~ s/^\s*\**(\S+)\s*/$1/;
1228 next if (($name =~ m/^\s*$/));
1229 if ($id =~ m/^\s*$/) {
1230 # anonymous struct/union
1231 $newmember .= "$type $name; ";
1232 } else {
1233 $newmember .= "$type $id.$name; ";
1234 }
1235 }
1236 }
1237 }
1238 }
1239 $members =~ s/$struct_members/$newmember/;
1240 }
1188 $id =~ s/[:\[].*//;
1189 $id =~ s/^\s*\**(\S+)\s*/$1/;
1190 foreach my $arg (split /;/, $content) {
1191 next if ($arg =~ m/^\s*$/);
1192 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1193 # pointer-to-function
1194 my $type = $1;
1195 my $name = $2;
1196 my $extra = $3;
1197 next if (!$name);
1198 if ($id =~ m/^\s*$/) {
1199 # anonymous struct/union
1200 $newmember .= "$type$name$extra; ";
1201 } else {
1202 $newmember .= "$type$id.$name$extra; ";
1203 }
1204 } else {
1205 my $type;
1206 my $names;
1207 $arg =~ s/^\s+//;
1208 $arg =~ s/\s+$//;
1209 # Handle bitmaps
1210 $arg =~ s/:\s*\d+\s*//g;
1211 # Handle arrays
1212 $arg =~ s/\[.*\]//g;
1213 # The type may have multiple words,
1214 # and multiple IDs can be defined, like:
1215 # const struct foo, *bar, foobar
1216 # So, we remove spaces when parsing the
1217 # names, in order to match just names
1218 # and commas for the names
1219 $arg =~ s/\s*,\s*/,/g;
1220 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1221 $type = $1;
1222 $names = $2;
1223 } else {
1224 $newmember .= "$arg; ";
1225 next;
1226 }
1227 foreach my $name (split /,/, $names) {
1228 $name =~ s/^\s*\**(\S+)\s*/$1/;
1229 next if (($name =~ m/^\s*$/));
1230 if ($id =~ m/^\s*$/) {
1231 # anonymous struct/union
1232 $newmember .= "$type $name; ";
1233 } else {
1234 $newmember .= "$type $id.$name; ";
1235 }
1236 }
1237 }
1238 }
1239 }
1240 $members =~ s/$struct_members/$newmember/;
1241 }
1241
1242
1242 # Ignore other nested elements, like enums
1243 $members =~ s/(\{[^\{\}]*\})//g;
1243 # Ignore other nested elements, like enums
1244 $members =~ s/(\{[^\{\}]*\})//g;
1244
1245
1245 create_parameterlist($members, ';', $file, $declaration_name);
1246 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1246 create_parameterlist($members, ';', $file, $declaration_name);
1247 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1247
1248
1248 # Adjust declaration for better display
1249 $declaration =~ s/([\{;])/$1\n/g;
1250 $declaration =~ s/\}\s+;/};/g;
1251 # Better handle inlined enums
1252 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1249 # Adjust declaration for better display
1250 $declaration =~ s/([\{;])/$1\n/g;
1251 $declaration =~ s/\}\s+;/};/g;
1252 # Better handle inlined enums
1253 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1253
1254
1254 my @def_args = split /\n/, $declaration;
1255 my $level = 1;
1256 $declaration = "";
1257 foreach my $clause (@def_args) {
1258 $clause =~ s/^\s+//;
1259 $clause =~ s/\s+$//;
1260 $clause =~ s/\s+/ /;
1261 next if (!$clause);
1262 $level-- if ($clause =~ m/(\})/ && $level > 1);
1263 if (!($clause =~ m/^\s*#/)) {
1264 $declaration .= "\t" x $level;
1265 }
1266 $declaration .= "\t" . $clause . "\n";
1267 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1268 }
1269 output_declaration($declaration_name,
1270 'struct',
1271 {'struct' => $declaration_name,
1272 'module' => $modulename,
1273 'definition' => $declaration,
1274 'parameterlist' => \@parameterlist,
1275 'parameterdescs' => \%parameterdescs,
1276 'parametertypes' => \%parametertypes,
1277 'sectionlist' => \@sectionlist,
1278 'sections' => \%sections,
1279 'purpose' => $declaration_purpose,
1280 'type' => $decl_type
1281 });
1255 my @def_args = split /\n/, $declaration;
1256 my $level = 1;
1257 $declaration = "";
1258 foreach my $clause (@def_args) {
1259 $clause =~ s/^\s+//;
1260 $clause =~ s/\s+$//;
1261 $clause =~ s/\s+/ /;
1262 next if (!$clause);
1263 $level-- if ($clause =~ m/(\})/ && $level > 1);
1264 if (!($clause =~ m/^\s*#/)) {
1265 $declaration .= "\t" x $level;
1266 }
1267 $declaration .= "\t" . $clause . "\n";
1268 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1269 }
1270 output_declaration($declaration_name,
1271 'struct',
1272 {'struct' => $declaration_name,
1273 'module' => $modulename,
1274 'definition' => $declaration,
1275 'parameterlist' => \@parameterlist,
1276 'parameterdescs' => \%parameterdescs,
1277 'parametertypes' => \%parametertypes,
1278 'sectionlist' => \@sectionlist,
1279 'sections' => \%sections,
1280 'purpose' => $declaration_purpose,
1281 'type' => $decl_type
1282 });
1283 } else {
1284 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1285 ++$errors;
1282 }
1286 }
1283 else {
1284 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1285 ++$errors;
1286 }
1287}
1288
1289
1290sub show_warnings($$) {
1287}
1288
1289
1290sub show_warnings($$) {
1291 my $functype = shift;
1292 my $name = shift;
1291 my $functype = shift;
1292 my $name = shift;
1293
1293
1294 return 0 if (defined($nosymbol_table{$name}));
1294 return 0 if (defined($nosymbol_table{$name}));
1295
1295
1296 return 1 if ($output_selection == OUTPUT_ALL);
1296 return 1 if ($output_selection == OUTPUT_ALL);
1297
1297
1298 if ($output_selection == OUTPUT_EXPORTED) {
1299 if (defined($function_table{$name})) {
1300 return 1;
1301 } else {
1302 return 0;
1303 }
1304 }
1305 if ($output_selection == OUTPUT_INTERNAL) {
1306 if (!($functype eq "function" && defined($function_table{$name}))) {
1307 return 1;
1308 } else {
1309 return 0;
1310 }
1311 }
1312 if ($output_selection == OUTPUT_INCLUDE) {
1313 if (defined($function_table{$name})) {
1314 return 1;
1315 } else {
1316 return 0;
1317 }
1318 }
1319 die("Please add the new output type at show_warnings()");
1298 if ($output_selection == OUTPUT_EXPORTED) {
1299 if (defined($function_table{$name})) {
1300 return 1;
1301 } else {
1302 return 0;
1303 }
1304 }
1305 if ($output_selection == OUTPUT_INTERNAL) {
1306 if (!($functype eq "function" && defined($function_table{$name}))) {
1307 return 1;
1308 } else {
1309 return 0;
1310 }
1311 }
1312 if ($output_selection == OUTPUT_INCLUDE) {
1313 if (defined($function_table{$name})) {
1314 return 1;
1315 } else {
1316 return 0;
1317 }
1318 }
1319 die("Please add the new output type at show_warnings()");
1320}
1321
1322sub dump_enum($$) {
1323 my $x = shift;
1324 my $file = shift;
1325 my $members;
1326
1327 # ignore members marked private:
1328 $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1329 $x =~ s/\/\*\s*private:.*}/}/gosi;
1330
1331 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1332 # strip #define macros inside enums
1333 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1334
1335 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1320}
1321
1322sub dump_enum($$) {
1323 my $x = shift;
1324 my $file = shift;
1325 my $members;
1326
1327 # ignore members marked private:
1328 $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1329 $x =~ s/\/\*\s*private:.*}/}/gosi;
1330
1331 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1332 # strip #define macros inside enums
1333 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1334
1335 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1336 $declaration_name = $2;
1337 $members = $1;
1336 $declaration_name = $2;
1337 $members = $1;
1338 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1338 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1339 $declaration_name = $1;
1340 $members = $2;
1339 $declaration_name = $1;
1340 $members = $2;
1341 }
1342
1343 if ($members) {
1341 }
1342
1343 if ($members) {
1344 if ($identifier ne $declaration_name) {
1345 if ($identifier eq "") {
1346 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n");
1347 } else {
1348 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n");
1349 }
1350 return;
1351 }
1352 $declaration_name = "(anonymous)" if ($declaration_name eq "");
1344 if ($identifier ne $declaration_name) {
1345 if ($identifier eq "") {
1346 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n");
1347 } else {
1348 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n");
1349 }
1350 return;
1351 }
1352 $declaration_name = "(anonymous)" if ($declaration_name eq "");
1353
1353
1354 my %_members;
1354 my %_members;
1355
1355
1356 $members =~ s/\s+$//;
1357 $members =~ s/\([^;]*?[\)]//g;
1356 $members =~ s/\s+$//;
1357 $members =~ s/\([^;]*?[\)]//g;
1358
1358
1359 foreach my $arg (split ',', $members) {
1360 $arg =~ s/^\s*(\w+).*/$1/;
1361 push @parameterlist, $arg;
1362 if (!$parameterdescs{$arg}) {
1363 $parameterdescs{$arg} = $undescribed;
1364 if (show_warnings("enum", $declaration_name)) {
1365 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n");
1366 }
1367 }
1368 $_members{$arg} = 1;
1369 }
1359 foreach my $arg (split ',', $members) {
1360 $arg =~ s/^\s*(\w+).*/$1/;
1361 push @parameterlist, $arg;
1362 if (!$parameterdescs{$arg}) {
1363 $parameterdescs{$arg} = $undescribed;
1364 if (show_warnings("enum", $declaration_name)) {
1365 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n");
1366 }
1367 }
1368 $_members{$arg} = 1;
1369 }
1370
1370
1371 while (my ($k, $v) = each %parameterdescs) {
1372 if (!exists($_members{$k})) {
1373 if (show_warnings("enum", $declaration_name)) {
1374 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n");
1375 }
1376 }
1371 while (my ($k, $v) = each %parameterdescs) {
1372 if (!exists($_members{$k})) {
1373 if (show_warnings("enum", $declaration_name)) {
1374 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n");
1375 }
1376 }
1377 }
1378
1377 }
1378
1379 output_declaration($declaration_name,
1380 'enum',
1381 {'enum' => $declaration_name,
1382 'module' => $modulename,
1383 'parameterlist' => \@parameterlist,
1384 'parameterdescs' => \%parameterdescs,
1385 'sectionlist' => \@sectionlist,
1386 'sections' => \%sections,
1387 'purpose' => $declaration_purpose
1388 });
1379 output_declaration($declaration_name,
1380 'enum',
1381 {'enum' => $declaration_name,
1382 'module' => $modulename,
1383 'parameterlist' => \@parameterlist,
1384 'parameterdescs' => \%parameterdescs,
1385 'sectionlist' => \@sectionlist,
1386 'sections' => \%sections,
1387 'purpose' => $declaration_purpose
1388 });
1389 } else {
1389 } else {
1390 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1391 ++$errors;
1390 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1391 ++$errors;
1392 }
1393}
1394
1395my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1396my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1397my $typedef_args = qr { \s*\((.*)\); }x;
1398
1399my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1400my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1401
1402sub dump_typedef($$) {
1403 my $x = shift;
1404 my $file = shift;
1405
1406 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1407
1408 # Parse function typedef prototypes
1409 if ($x =~ $typedef1 || $x =~ $typedef2) {
1392 }
1393}
1394
1395my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1396my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1397my $typedef_args = qr { \s*\((.*)\); }x;
1398
1399my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1400my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1401
1402sub dump_typedef($$) {
1403 my $x = shift;
1404 my $file = shift;
1405
1406 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1407
1408 # Parse function typedef prototypes
1409 if ($x =~ $typedef1 || $x =~ $typedef2) {
1410 $return_type = $1;
1411 $declaration_name = $2;
1412 my $args = $3;
1413 $return_type =~ s/^\s+//;
1410 $return_type = $1;
1411 $declaration_name = $2;
1412 my $args = $3;
1413 $return_type =~ s/^\s+//;
1414
1414
1415 if ($identifier ne $declaration_name) {
1416 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1417 return;
1418 }
1415 if ($identifier ne $declaration_name) {
1416 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1417 return;
1418 }
1419
1419
1420 create_parameterlist($args, ',', $file, $declaration_name);
1420 create_parameterlist($args, ',', $file, $declaration_name);
1421
1421
1422 output_declaration($declaration_name,
1423 'function',
1424 {'function' => $declaration_name,
1425 'typedef' => 1,
1426 'module' => $modulename,
1427 'functiontype' => $return_type,
1428 'parameterlist' => \@parameterlist,
1429 'parameterdescs' => \%parameterdescs,
1430 'parametertypes' => \%parametertypes,
1431 'sectionlist' => \@sectionlist,
1432 'sections' => \%sections,
1433 'purpose' => $declaration_purpose
1434 });
1435 return;
1422 output_declaration($declaration_name,
1423 'function',
1424 {'function' => $declaration_name,
1425 'typedef' => 1,
1426 'module' => $modulename,
1427 'functiontype' => $return_type,
1428 'parameterlist' => \@parameterlist,
1429 'parameterdescs' => \%parameterdescs,
1430 'parametertypes' => \%parametertypes,
1431 'sectionlist' => \@sectionlist,
1432 'sections' => \%sections,
1433 'purpose' => $declaration_purpose
1434 });
1435 return;
1436 }
1437
1438 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1436 }
1437
1438 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1439 $x =~ s/\(*.\)\s*;$/;/;
1440 $x =~ s/\[*.\]\s*;$/;/;
1439 $x =~ s/\(*.\)\s*;$/;/;
1440 $x =~ s/\[*.\]\s*;$/;/;
1441 }
1442
1443 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1441 }
1442
1443 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1444 $declaration_name = $1;
1444 $declaration_name = $1;
1445
1445
1446 if ($identifier ne $declaration_name) {
1447 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1448 return;
1449 }
1446 if ($identifier ne $declaration_name) {
1447 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1448 return;
1449 }
1450
1450
1451 output_declaration($declaration_name,
1452 'typedef',
1453 {'typedef' => $declaration_name,
1454 'module' => $modulename,
1455 'sectionlist' => \@sectionlist,
1456 'sections' => \%sections,
1457 'purpose' => $declaration_purpose
1458 });
1451 output_declaration($declaration_name,
1452 'typedef',
1453 {'typedef' => $declaration_name,
1454 'module' => $modulename,
1455 'sectionlist' => \@sectionlist,
1456 'sections' => \%sections,
1457 'purpose' => $declaration_purpose
1458 });
1459 } else {
1460 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1461 ++$errors;
1459 }
1462 }
1460 else {
1461 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1462 ++$errors;
1463 }
1464}
1465
1466sub save_struct_actual($) {
1467 my $actual = shift;
1468
1469 # strip all spaces from the actual param so that it looks like one string item
1470 $actual =~ s/\s*//g;
1471 $struct_actual = $struct_actual . $actual . " ";

--- 5 unchanged lines hidden (view full) ---

1477 my $file = shift;
1478 my $declaration_name = shift;
1479 my $type;
1480 my $param;
1481
1482 # temporarily replace commas inside function pointer definition
1483 my $arg_expr = qr{\([^\),]+};
1484 while ($args =~ /$arg_expr,/) {
1463}
1464
1465sub save_struct_actual($) {
1466 my $actual = shift;
1467
1468 # strip all spaces from the actual param so that it looks like one string item
1469 $actual =~ s/\s*//g;
1470 $struct_actual = $struct_actual . $actual . " ";

--- 5 unchanged lines hidden (view full) ---

1476 my $file = shift;
1477 my $declaration_name = shift;
1478 my $type;
1479 my $param;
1480
1481 # temporarily replace commas inside function pointer definition
1482 my $arg_expr = qr{\([^\),]+};
1483 while ($args =~ /$arg_expr,/) {
1485 $args =~ s/($arg_expr),/$1#/g;
1484 $args =~ s/($arg_expr),/$1#/g;
1486 }
1487
1488 foreach my $arg (split($splitter, $args)) {
1485 }
1486
1487 foreach my $arg (split($splitter, $args)) {
1489 # strip comments
1490 $arg =~ s/\/\*.*\*\///;
1491 # ignore argument attributes
1492 $arg =~ s/\sPOS0?\s/ /;
1493 # strip leading/trailing spaces
1494 $arg =~ s/^\s*//;
1495 $arg =~ s/\s*$//;
1496 $arg =~ s/\s+/ /;
1488 # strip comments
1489 $arg =~ s/\/\*.*\*\///;
1490 # ignore argument attributes
1491 $arg =~ s/\sPOS0?\s/ /;
1492 # strip leading/trailing spaces
1493 $arg =~ s/^\s*//;
1494 $arg =~ s/\s*$//;
1495 $arg =~ s/\s+/ /;
1497
1496
1498 if ($arg =~ /^#/) {
1499 # Treat preprocessor directive as a typeless variable just to fill
1500 # corresponding data structures "correctly". Catch it later in
1501 # output_* subs.
1502 push_parameter($arg, "", "", $file);
1503 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1504 # pointer-to-function
1505 $arg =~ tr/#/,/;
1506 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1507 $param = $1;
1508 $type = $arg;
1509 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1510 save_struct_actual($param);
1511 push_parameter($param, $type, $arg, $file, $declaration_name);
1512 } elsif ($arg) {
1513 $arg =~ s/\s*:\s*/:/g;
1514 $arg =~ s/\s*\[/\[/g;
1497 if ($arg =~ /^#/) {
1498 # Treat preprocessor directive as a typeless variable just to fill
1499 # corresponding data structures "correctly". Catch it later in
1500 # output_* subs.
1501 push_parameter($arg, "", "", $file);
1502 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1503 # pointer-to-function
1504 $arg =~ tr/#/,/;
1505 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1506 $param = $1;
1507 $type = $arg;
1508 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1509 save_struct_actual($param);
1510 push_parameter($param, $type, $arg, $file, $declaration_name);
1511 } elsif ($arg =~ m/\(.+\)\s*\[/) {
1512 # array-of-pointers
1513 $arg =~ tr/#/,/;
1514 $arg =~ m/[^\(]+\(\s*\*\s*([\w\[\]\.]*?)\s*(\s*\[\s*[\w]+\s*\]\s*)*\)/;
1515 $param = $1;
1516 $type = $arg;
1517 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1518 save_struct_actual($param);
1519 push_parameter($param, $type, $arg, $file, $declaration_name);
1520 } elsif ($arg) {
1521 $arg =~ s/\s*:\s*/:/g;
1522 $arg =~ s/\s*\[/\[/g;
1515
1523
1516 my @args = split('\s*,\s*', $arg);
1517 if ($args[0] =~ m/\*/) {
1518 $args[0] =~ s/(\*+)\s*/ $1/;
1519 }
1524 my @args = split('\s*,\s*', $arg);
1525 if ($args[0] =~ m/\*/) {
1526 $args[0] =~ s/(\*+)\s*/ $1/;
1527 }
1520
1528
1521 my @first_arg;
1522 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1523 shift @args;
1524 push(@first_arg, split('\s+', $1));
1525 push(@first_arg, $2);
1526 } else {
1527 @first_arg = split('\s+', shift @args);
1528 }
1529 my @first_arg;
1530 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1531 shift @args;
1532 push(@first_arg, split('\s+', $1));
1533 push(@first_arg, $2);
1534 } else {
1535 @first_arg = split('\s+', shift @args);
1536 }
1529
1537
1530 unshift(@args, pop @first_arg);
1531 $type = join " ", @first_arg;
1538 unshift(@args, pop @first_arg);
1539 $type = join " ", @first_arg;
1532
1540
1533 foreach $param (@args) {
1534 if ($param =~ m/^(\*+)\s*(.*)/) {
1535 save_struct_actual($2);
1541 foreach $param (@args) {
1542 if ($param =~ m/^(\*+)\s*(.*)/) {
1543 save_struct_actual($2);
1536
1544
1537 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1538 }
1539 elsif ($param =~ m/(.*?):(\d+)/) {
1540 if ($type ne "") { # skip unnamed bit-fields
1541 save_struct_actual($1);
1542 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1543 }
1544 }
1545 else {
1546 save_struct_actual($param);
1547 push_parameter($param, $type, $arg, $file, $declaration_name);
1548 }
1549 }
1550 }
1545 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1546 } elsif ($param =~ m/(.*?):(\d+)/) {
1547 if ($type ne "") { # skip unnamed bit-fields
1548 save_struct_actual($1);
1549 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1550 }
1551 } else {
1552 save_struct_actual($param);
1553 push_parameter($param, $type, $arg, $file, $declaration_name);
1554 }
1555 }
1556 }
1551 }
1552}
1553
1554sub push_parameter($$$$$) {
1557 }
1558}
1559
1560sub push_parameter($$$$$) {
1555 my $param = shift;
1556 my $type = shift;
1557 my $org_arg = shift;
1558 my $file = shift;
1559 my $declaration_name = shift;
1561 my $param = shift;
1562 my $type = shift;
1563 my $org_arg = shift;
1564 my $file = shift;
1565 my $declaration_name = shift;
1560
1566
1561 if (($anon_struct_union == 1) && ($type eq "") &&
1562 ($param eq "}")) {
1563 return; # ignore the ending }; from anon. struct/union
1564 }
1567 if (($anon_struct_union == 1) && ($type eq "") &&
1568 ($param eq "}")) {
1569 return; # ignore the ending }; from anon. struct/union
1570 }
1565
1571
1566 $anon_struct_union = 0;
1567 $param =~ s/[\[\)].*//;
1572 $anon_struct_union = 0;
1573 $param =~ s/[\[\)].*//;
1568
1574
1569 if ($type eq "" && $param =~ /\.\.\.$/)
1570 {
1571 if (!$param =~ /\w\.\.\.$/) {
1572 # handles unnamed variable parameters
1573 $param = "...";
1574 }
1575 elsif ($param =~ /\w\.\.\.$/) {
1576 # for named variable parameters of the form `x...`, remove the dots
1577 $param =~ s/\.\.\.$//;
1578 }
1579 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1580 $parameterdescs{$param} = "variable arguments";
1581 }
1582 }
1583 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1584 {
1585 $param="void";
1586 $parameterdescs{void} = "no arguments";
1587 }
1588 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1589 # handle unnamed (anonymous) union or struct:
1590 {
1591 $type = $param;
1592 $param = "{unnamed_" . $param . "}";
1593 $parameterdescs{$param} = "anonymous\n";
1594 $anon_struct_union = 1;
1595 }
1596 elsif ($param =~ "__cacheline_group" )
1597 # handle cache group enforcing variables: they do not need be described in header files
1598 {
1599 return; # ignore __cacheline_group_begin and __cacheline_group_end
1600 }
1575 if ($type eq "" && $param =~ /\.\.\.$/)
1576 {
1577 if (!$param =~ /\w\.\.\.$/) {
1578 # handles unnamed variable parameters
1579 $param = "...";
1580 } elsif ($param =~ /\w\.\.\.$/) {
1581 # for named variable parameters of the form `x...`, remove the dots
1582 $param =~ s/\.\.\.$//;
1583 }
1584 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1585 $parameterdescs{$param} = "variable arguments";
1586 }
1587 }
1588 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1589 {
1590 $param="void";
1591 $parameterdescs{void} = "no arguments";
1592 }
1593 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1594 # handle unnamed (anonymous) union or struct:
1595 {
1596 $type = $param;
1597 $param = "{unnamed_" . $param . "}";
1598 $parameterdescs{$param} = "anonymous\n";
1599 $anon_struct_union = 1;
1600 }
1601 elsif ($param =~ "__cacheline_group" )
1602 # handle cache group enforcing variables: they do not need be described in header files
1603 {
1604 return; # ignore __cacheline_group_begin and __cacheline_group_end
1605 }
1601
1606
1602 # warn if parameter has no description
1603 # (but ignore ones starting with # as these are not parameters
1604 # but inline preprocessor statements);
1605 # Note: It will also ignore void params and unnamed structs/unions
1606 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1607 $parameterdescs{$param} = $undescribed;
1607 # warn if parameter has no description
1608 # (but ignore ones starting with # as these are not parameters
1609 # but inline preprocessor statements);
1610 # Note: It will also ignore void params and unnamed structs/unions
1611 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1612 $parameterdescs{$param} = $undescribed;
1608
1613
1609 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1610 emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
1611 }
1612 }
1614 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1615 emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
1616 }
1617 }
1613
1618
1614 # strip spaces from $param so that it is one continuous string
1615 # on @parameterlist;
1616 # this fixes a problem where check_sections() cannot find
1617 # a parameter like "addr[6 + 2]" because it actually appears
1618 # as "addr[6", "+", "2]" on the parameter list;
1619 # but it's better to maintain the param string unchanged for output,
1620 # so just weaken the string compare in check_sections() to ignore
1621 # "[blah" in a parameter string;
1622 ###$param =~ s/\s*//g;
1623 push @parameterlist, $param;
1624 $org_arg =~ s/\s\s+/ /g;
1625 $parametertypes{$param} = $org_arg;
1619 # strip spaces from $param so that it is one continuous string
1620 # on @parameterlist;
1621 # this fixes a problem where check_sections() cannot find
1622 # a parameter like "addr[6 + 2]" because it actually appears
1623 # as "addr[6", "+", "2]" on the parameter list;
1624 # but it's better to maintain the param string unchanged for output,
1625 # so just weaken the string compare in check_sections() to ignore
1626 # "[blah" in a parameter string;
1627 ###$param =~ s/\s*//g;
1628 push @parameterlist, $param;
1629 $org_arg =~ s/\s\s+/ /g;
1630 $parametertypes{$param} = $org_arg;
1626}
1627
1628sub check_sections($$$$$) {
1631}
1632
1633sub check_sections($$$$$) {
1629 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1630 my @sects = split ' ', $sectcheck;
1631 my @prms = split ' ', $prmscheck;
1632 my $err;
1633 my ($px, $sx);
1634 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1634 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1635 my @sects = split ' ', $sectcheck;
1636 my @prms = split ' ', $prmscheck;
1637 my $err;
1638 my ($px, $sx);
1639 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1635
1640
1636 foreach $sx (0 .. $#sects) {
1637 $err = 1;
1638 foreach $px (0 .. $#prms) {
1639 $prm_clean = $prms[$px];
1640 $prm_clean =~ s/\[.*\]//;
1641 $prm_clean =~ s/$attribute//i;
1642 # ignore array size in a parameter string;
1643 # however, the original param string may contain
1644 # spaces, e.g.: addr[6 + 2]
1645 # and this appears in @prms as "addr[6" since the
1646 # parameter list is split at spaces;
1647 # hence just ignore "[..." for the sections check;
1648 $prm_clean =~ s/\[.*//;
1641 foreach $sx (0 .. $#sects) {
1642 $err = 1;
1643 foreach $px (0 .. $#prms) {
1644 $prm_clean = $prms[$px];
1645 $prm_clean =~ s/\[.*\]//;
1646 $prm_clean =~ s/$attribute//i;
1647 # ignore array size in a parameter string;
1648 # however, the original param string may contain
1649 # spaces, e.g.: addr[6 + 2]
1650 # and this appears in @prms as "addr[6" since the
1651 # parameter list is split at spaces;
1652 # hence just ignore "[..." for the sections check;
1653 $prm_clean =~ s/\[.*//;
1649
1654
1650 ##$prm_clean =~ s/^\**//;
1651 if ($prm_clean eq $sects[$sx]) {
1652 $err = 0;
1653 last;
1654 }
1655 }
1656 if ($err) {
1657 if ($decl_type eq "function") {
1658 emit_warning("${file}:$.",
1659 "Excess function parameter " .
1660 "'$sects[$sx]' " .
1661 "description in '$decl_name'\n");
1662 }
1663 elsif (($decl_type eq "struct") or
1664 ($decl_type eq "union")) {
1665 emit_warning("${file}:$.",
1666 "Excess $decl_type member " .
1667 "'$sects[$sx]' " .
1668 "description in '$decl_name'\n");
1669 }
1670 }
1671 }
1655 ##$prm_clean =~ s/^\**//;
1656 if ($prm_clean eq $sects[$sx]) {
1657 $err = 0;
1658 last;
1659 }
1660 }
1661 if ($err) {
1662 if ($decl_type eq "function") {
1663 emit_warning("${file}:$.",
1664 "Excess function parameter " .
1665 "'$sects[$sx]' " .
1666 "description in '$decl_name'\n");
1667 } elsif (($decl_type eq "struct") or
1668 ($decl_type eq "union")) {
1669 emit_warning("${file}:$.",
1670 "Excess $decl_type member " .
1671 "'$sects[$sx]' " .
1672 "description in '$decl_name'\n");
1673 }
1674 }
1675 }
1672}
1673
1674##
1675# Checks the section describing the return value of a function.
1676sub check_return_section {
1676}
1677
1678##
1679# Checks the section describing the return value of a function.
1680sub check_return_section {
1677 my $file = shift;
1678 my $declaration_name = shift;
1679 my $return_type = shift;
1681 my $file = shift;
1682 my $declaration_name = shift;
1683 my $return_type = shift;
1680
1684
1681 # Ignore an empty return type (It's a macro)
1682 # Ignore functions with a "void" return type. (But don't ignore "void *")
1683 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1684 return;
1685 }
1685 # Ignore an empty return type (It's a macro)
1686 # Ignore functions with a "void" return type. (But don't ignore "void *")
1687 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1688 return;
1689 }
1686
1690
1687 if (!defined($sections{$section_return}) ||
1688 $sections{$section_return} eq "") {
1689 emit_warning("${file}:$.",
1690 "No description found for return value of " .
1691 "'$declaration_name'\n");
1692 }
1691 if (!defined($sections{$section_return}) ||
1692 $sections{$section_return} eq "")
1693 {
1694 emit_warning("${file}:$.",
1695 "No description found for return value of " .
1696 "'$declaration_name'\n");
1697 }
1693}
1694
1695##
1696# takes a function prototype and the name of the current file being
1697# processed and spits out all the details stored in the global
1698# arrays/hashes.
1699sub dump_function($$) {
1700 my $prototype = shift;

--- 58 unchanged lines hidden (view full) ---

1759 # This is an object-like macro, it has no return type and no parameter
1760 # list.
1761 # Function-like macros are not allowed to have spaces between
1762 # declaration_name and opening parenthesis (notice the \s+).
1763 $return_type = $1;
1764 $declaration_name = $2;
1765 $noret = 1;
1766 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1698}
1699
1700##
1701# takes a function prototype and the name of the current file being
1702# processed and spits out all the details stored in the global
1703# arrays/hashes.
1704sub dump_function($$) {
1705 my $prototype = shift;

--- 58 unchanged lines hidden (view full) ---

1764 # This is an object-like macro, it has no return type and no parameter
1765 # list.
1766 # Function-like macros are not allowed to have spaces between
1767 # declaration_name and opening parenthesis (notice the \s+).
1768 $return_type = $1;
1769 $declaration_name = $2;
1770 $noret = 1;
1771 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1767 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1768 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1769 $return_type = $1;
1770 $declaration_name = $2;
1771 my $args = $3;
1772 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1773 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1774 $return_type = $1;
1775 $declaration_name = $2;
1776 my $args = $3;
1772
1777
1773 create_parameterlist($args, ',', $file, $declaration_name);
1778 create_parameterlist($args, ',', $file, $declaration_name);
1774 } else {
1779 } else {
1775 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n");
1776 return;
1780 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n");
1781 return;
1777 }
1778
1779 if ($identifier ne $declaration_name) {
1782 }
1783
1784 if ($identifier ne $declaration_name) {
1780 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n");
1781 return;
1785 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n");
1786 return;
1782 }
1783
1784 my $prms = join " ", @parameterlist;
1785 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1786
1787 # This check emits a lot of warnings at the moment, because many
1788 # functions don't have a 'Return' doc section. So until the number
1789 # of warnings goes sufficiently down, the check is only performed in
1790 # -Wreturn mode.
1791 # TODO: always perform the check.
1792 if ($Wreturn && !$noret) {
1787 }
1788
1789 my $prms = join " ", @parameterlist;
1790 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1791
1792 # This check emits a lot of warnings at the moment, because many
1793 # functions don't have a 'Return' doc section. So until the number
1794 # of warnings goes sufficiently down, the check is only performed in
1795 # -Wreturn mode.
1796 # TODO: always perform the check.
1797 if ($Wreturn && !$noret) {
1793 check_return_section($file, $declaration_name, $return_type);
1798 check_return_section($file, $declaration_name, $return_type);
1794 }
1795
1796 # The function parser can be called with a typedef parameter.
1797 # Handle it.
1798 if ($return_type =~ /typedef/) {
1799 }
1800
1801 # The function parser can be called with a typedef parameter.
1802 # Handle it.
1803 if ($return_type =~ /typedef/) {
1799 output_declaration($declaration_name,
1800 'function',
1801 {'function' => $declaration_name,
1802 'typedef' => 1,
1803 'module' => $modulename,
1804 'functiontype' => $return_type,
1805 'parameterlist' => \@parameterlist,
1806 'parameterdescs' => \%parameterdescs,
1807 'parametertypes' => \%parametertypes,
1808 'sectionlist' => \@sectionlist,
1809 'sections' => \%sections,
1810 'purpose' => $declaration_purpose
1811 });
1804 output_declaration($declaration_name,
1805 'function',
1806 {'function' => $declaration_name,
1807 'typedef' => 1,
1808 'module' => $modulename,
1809 'functiontype' => $return_type,
1810 'parameterlist' => \@parameterlist,
1811 'parameterdescs' => \%parameterdescs,
1812 'parametertypes' => \%parametertypes,
1813 'sectionlist' => \@sectionlist,
1814 'sections' => \%sections,
1815 'purpose' => $declaration_purpose
1816 });
1812 } else {
1817 } else {
1813 output_declaration($declaration_name,
1814 'function',
1815 {'function' => $declaration_name,
1816 'module' => $modulename,
1817 'functiontype' => $return_type,
1818 'parameterlist' => \@parameterlist,
1819 'parameterdescs' => \%parameterdescs,
1820 'parametertypes' => \%parametertypes,
1821 'sectionlist' => \@sectionlist,
1822 'sections' => \%sections,
1823 'purpose' => $declaration_purpose
1824 });
1818 output_declaration($declaration_name,
1819 'function',
1820 {'function' => $declaration_name,
1821 'module' => $modulename,
1822 'functiontype' => $return_type,
1823 'parameterlist' => \@parameterlist,
1824 'parameterdescs' => \%parameterdescs,
1825 'parametertypes' => \%parametertypes,
1826 'sectionlist' => \@sectionlist,
1827 'sections' => \%sections,
1828 'purpose' => $declaration_purpose
1829 });
1825 }
1826}
1827
1828sub reset_state {
1829 $function = "";
1830 %parameterdescs = ();
1831 %parametertypes = ();
1832 @parameterlist = ();
1833 %sections = ();
1834 @sectionlist = ();
1835 $sectcheck = "";
1836 $struct_actual = "";
1837 $prototype = "";
1838
1839 $state = STATE_NORMAL;
1840 $inline_doc_state = STATE_INLINE_NA;
1841}
1842
1843sub tracepoint_munge($) {
1830 }
1831}
1832
1833sub reset_state {
1834 $function = "";
1835 %parameterdescs = ();
1836 %parametertypes = ();
1837 @parameterlist = ();
1838 %sections = ();
1839 @sectionlist = ();
1840 $sectcheck = "";
1841 $struct_actual = "";
1842 $prototype = "";
1843
1844 $state = STATE_NORMAL;
1845 $inline_doc_state = STATE_INLINE_NA;
1846}
1847
1848sub tracepoint_munge($) {
1844 my $file = shift;
1845 my $tracepointname = 0;
1846 my $tracepointargs = 0;
1849 my $file = shift;
1850 my $tracepointname = 0;
1851 my $tracepointargs = 0;
1847
1852
1848 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1849 $tracepointname = $1;
1850 }
1851 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1852 $tracepointname = $1;
1853 }
1854 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1855 $tracepointname = $2;
1856 }
1857 $tracepointname =~ s/^\s+//; #strip leading whitespace
1858 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1859 $tracepointargs = $1;
1860 }
1861 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1862 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n".
1863 "$prototype\n");
1864 } else {
1865 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1866 $identifier = "trace_$identifier";
1867 }
1853 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1854 $tracepointname = $1;
1855 }
1856 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1857 $tracepointname = $1;
1858 }
1859 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1860 $tracepointname = $2;
1861 }
1862 $tracepointname =~ s/^\s+//; #strip leading whitespace
1863 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1864 $tracepointargs = $1;
1865 }
1866 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1867 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n".
1868 "$prototype\n");
1869 } else {
1870 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1871 $identifier = "trace_$identifier";
1872 }
1868}
1869
1870sub syscall_munge() {
1873}
1874
1875sub syscall_munge() {
1871 my $void = 0;
1876 my $void = 0;
1872
1877
1873 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1874## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1875 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1876 $void = 1;
1877## $prototype = "long sys_$1(void)";
1878 }
1878 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1879## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1880 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1881 $void = 1;
1882## $prototype = "long sys_$1(void)";
1883 }
1879
1884
1880 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1881 if ($prototype =~ m/long (sys_.*?),/) {
1882 $prototype =~ s/,/\(/;
1883 } elsif ($void) {
1884 $prototype =~ s/\)/\(void\)/;
1885 }
1885 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1886 if ($prototype =~ m/long (sys_.*?),/) {
1887 $prototype =~ s/,/\(/;
1888 } elsif ($void) {
1889 $prototype =~ s/\)/\(void\)/;
1890 }
1886
1891
1887 # now delete all of the odd-number commas in $prototype
1888 # so that arg types & arg names don't have a comma between them
1889 my $count = 0;
1890 my $len = length($prototype);
1891 if ($void) {
1892 $len = 0; # skip the for-loop
1893 }
1894 for (my $ix = 0; $ix < $len; $ix++) {
1895 if (substr($prototype, $ix, 1) eq ',') {
1896 $count++;
1897 if ($count % 2 == 1) {
1898 substr($prototype, $ix, 1) = ' ';
1899 }
1900 }
1901 }
1892 # now delete all of the odd-number commas in $prototype
1893 # so that arg types & arg names don't have a comma between them
1894 my $count = 0;
1895 my $len = length($prototype);
1896 if ($void) {
1897 $len = 0; # skip the for-loop
1898 }
1899 for (my $ix = 0; $ix < $len; $ix++) {
1900 if (substr($prototype, $ix, 1) eq ',') {
1901 $count++;
1902 if ($count % 2 == 1) {
1903 substr($prototype, $ix, 1) = ' ';
1904 }
1905 }
1906 }
1902}
1903
1904sub process_proto_function($$) {
1905 my $x = shift;
1906 my $file = shift;
1907
1908 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1909
1907}
1908
1909sub process_proto_function($$) {
1910 my $x = shift;
1911 my $file = shift;
1912
1913 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1914
1910 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1911 # do nothing
1915 if ($x =~ /^#/ && $x !~ /^#\s*define/) {
1916 # do nothing
1917 } elsif ($x =~ /([^\{]*)/) {
1918 $prototype .= $1;
1912 }
1919 }
1913 elsif ($x =~ /([^\{]*)/) {
1914 $prototype .= $1;
1915 }
1916
1917 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1920
1921 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1918 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1919 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1920 $prototype =~ s@^\s+@@gos; # strip leading spaces
1922 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1923 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1924 $prototype =~ s@^\s+@@gos; # strip leading spaces
1921
1925
1922 # Handle prototypes for function pointers like:
1923 # int (*pcs_config)(struct foo)
1924 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1926 # Handle prototypes for function pointers like:
1927 # int (*pcs_config)(struct foo)
1928 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1925
1929
1926 if ($prototype =~ /SYSCALL_DEFINE/) {
1927 syscall_munge();
1928 }
1929 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1930 $prototype =~ /DEFINE_SINGLE_EVENT/)
1931 {
1932 tracepoint_munge($file);
1933 }
1934 dump_function($prototype, $file);
1935 reset_state();
1930 if ($prototype =~ /SYSCALL_DEFINE/) {
1931 syscall_munge();
1932 }
1933 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1934 $prototype =~ /DEFINE_SINGLE_EVENT/)
1935 {
1936 tracepoint_munge($file);
1937 }
1938 dump_function($prototype, $file);
1939 reset_state();
1936 }
1937}
1938
1939sub process_proto_type($$) {
1940 my $x = shift;
1941 my $file = shift;
1942
1943 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1944 $x =~ s@^\s+@@gos; # strip leading spaces
1945 $x =~ s@\s+$@@gos; # strip trailing spaces
1946 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1947
1948 if ($x =~ /^#/) {
1940 }
1941}
1942
1943sub process_proto_type($$) {
1944 my $x = shift;
1945 my $file = shift;
1946
1947 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1948 $x =~ s@^\s+@@gos; # strip leading spaces
1949 $x =~ s@\s+$@@gos; # strip trailing spaces
1950 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1951
1952 if ($x =~ /^#/) {
1949 # To distinguish preprocessor directive from regular declaration later.
1950 $x .= ";";
1953 # To distinguish preprocessor directive from regular declaration later.
1954 $x .= ";";
1951 }
1952
1953 while (1) {
1955 }
1956
1957 while (1) {
1954 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1958 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1955 if( length $prototype ) {
1956 $prototype .= " "
1957 }
1959 if( length $prototype ) {
1960 $prototype .= " "
1961 }
1958 $prototype .= $1 . $2;
1959 ($2 eq '{') && $brcount++;
1960 ($2 eq '}') && $brcount--;
1961 if (($2 eq ';') && ($brcount == 0)) {
1962 dump_declaration($prototype, $file);
1963 reset_state();
1964 last;
1965 }
1966 $x = $3;
1967 } else {
1968 $prototype .= $x;
1969 last;
1970 }
1962 $prototype .= $1 . $2;
1963 ($2 eq '{') && $brcount++;
1964 ($2 eq '}') && $brcount--;
1965 if (($2 eq ';') && ($brcount == 0)) {
1966 dump_declaration($prototype, $file);
1967 reset_state();
1968 last;
1969 }
1970 $x = $3;
1971 } else {
1972 $prototype .= $x;
1973 last;
1974 }
1971 }
1972}
1973
1974
1975sub map_filename($) {
1976 my $file;
1977 my ($orig_file) = @_;
1978
1979 if (defined($ENV{'SRCTREE'})) {
1975 }
1976}
1977
1978
1979sub map_filename($) {
1980 my $file;
1981 my ($orig_file) = @_;
1982
1983 if (defined($ENV{'SRCTREE'})) {
1980 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1984 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1981 } else {
1985 } else {
1982 $file = $orig_file;
1986 $file = $orig_file;
1983 }
1984
1985 if (defined($source_map{$file})) {
1987 }
1988
1989 if (defined($source_map{$file})) {
1986 $file = $source_map{$file};
1990 $file = $source_map{$file};
1987 }
1988
1989 return $file;
1990}
1991
1992sub process_export_file($) {
1993 my ($orig_file) = @_;
1994 my $file = map_filename($orig_file);
1995
1996 if (!open(IN,"<$file")) {
1991 }
1992
1993 return $file;
1994}
1995
1996sub process_export_file($) {
1997 my ($orig_file) = @_;
1998 my $file = map_filename($orig_file);
1999
2000 if (!open(IN,"<$file")) {
1997 print STDERR "Error: Cannot open file $file\n";
1998 ++$errors;
1999 return;
2001 print STDERR "Error: Cannot open file $file\n";
2002 ++$errors;
2003 return;
2000 }
2001
2002 while (<IN>) {
2004 }
2005
2006 while (<IN>) {
2003 if (/$export_symbol/) {
2004 next if (defined($nosymbol_table{$2}));
2005 $function_table{$2} = 1;
2006 }
2007 if (/$export_symbol_ns/) {
2008 next if (defined($nosymbol_table{$2}));
2009 $function_table{$2} = 1;
2010 }
2007 if (/$export_symbol/) {
2008 next if (defined($nosymbol_table{$2}));
2009 $function_table{$2} = 1;
2010 }
2011 if (/$export_symbol_ns/) {
2012 next if (defined($nosymbol_table{$2}));
2013 $function_table{$2} = 1;
2014 }
2011 }
2012
2013 close(IN);
2014}
2015
2016#
2017# Parsers for the various processing states.
2018#
2019# STATE_NORMAL: looking for the /** to begin everything.
2020#
2021sub process_normal() {
2022 if (/$doc_start/o) {
2015 }
2016
2017 close(IN);
2018}
2019
2020#
2021# Parsers for the various processing states.
2022#
2023# STATE_NORMAL: looking for the /** to begin everything.
2024#
2025sub process_normal() {
2026 if (/$doc_start/o) {
2023 $state = STATE_NAME; # next line is always the function name
2024 $in_doc_sect = 0;
2025 $declaration_start_line = $. + 1;
2027 $state = STATE_NAME; # next line is always the function name
2028 $in_doc_sect = 0;
2029 $declaration_start_line = $. + 1;
2026 }
2027}
2028
2029#
2030# STATE_NAME: Looking for the "name - description" line
2031#
2032sub process_name($$) {
2033 my $file = shift;
2034 my $descr;
2035
2036 if (/$doc_block/o) {
2030 }
2031}
2032
2033#
2034# STATE_NAME: Looking for the "name - description" line
2035#
2036sub process_name($$) {
2037 my $file = shift;
2038 my $descr;
2039
2040 if (/$doc_block/o) {
2037 $state = STATE_DOCBLOCK;
2038 $contents = "";
2039 $new_start_line = $.;
2041 $state = STATE_DOCBLOCK;
2042 $contents = "";
2043 $new_start_line = $.;
2040
2044
2041 if ( $1 eq "" ) {
2042 $section = $section_intro;
2043 } else {
2044 $section = $1;
2045 }
2045 if ( $1 eq "" ) {
2046 $section = $section_intro;
2047 } else {
2048 $section = $1;
2049 }
2046 } elsif (/$doc_decl/o) {
2050 } elsif (/$doc_decl/o) {
2047 $identifier = $1;
2048 my $is_kernel_comment = 0;
2049 my $decl_start = qr{$doc_com};
2050 # test for pointer declaration type, foo * bar() - desc
2051 my $fn_type = qr{\w+\s*\*\s*};
2052 my $parenthesis = qr{\(\w*\)};
2053 my $decl_end = qr{[-:].*};
2054 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2055 $identifier = $1;
2056 }
2057 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2058 $decl_type = $1;
2059 $identifier = $2;
2060 $is_kernel_comment = 1;
2061 }
2062 # Look for foo() or static void foo() - description; or misspelt
2063 # identifier
2064 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2065 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2066 $identifier = $1;
2067 $decl_type = 'function';
2068 $identifier =~ s/^define\s+//;
2069 $is_kernel_comment = 1;
2070 }
2071 $identifier =~ s/\s+$//;
2051 $identifier = $1;
2052 my $is_kernel_comment = 0;
2053 my $decl_start = qr{$doc_com};
2054 # test for pointer declaration type, foo * bar() - desc
2055 my $fn_type = qr{\w+\s*\*\s*};
2056 my $parenthesis = qr{\(\w*\)};
2057 my $decl_end = qr{[-:].*};
2058 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2059 $identifier = $1;
2060 }
2061 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2062 $decl_type = $1;
2063 $identifier = $2;
2064 $is_kernel_comment = 1;
2065 }
2066 # Look for foo() or static void foo() - description; or misspelt
2067 # identifier
2068 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2069 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2070 $identifier = $1;
2071 $decl_type = 'function';
2072 $identifier =~ s/^define\s+//;
2073 $is_kernel_comment = 1;
2074 }
2075 $identifier =~ s/\s+$//;
2072
2076
2073 $state = STATE_BODY;
2074 # if there's no @param blocks need to set up default section
2075 # here
2076 $contents = "";
2077 $section = $section_default;
2078 $new_start_line = $. + 1;
2079 if (/[-:](.*)/) {
2080 # strip leading/trailing/multiple spaces
2081 $descr= $1;
2082 $descr =~ s/^\s*//;
2083 $descr =~ s/\s*$//;
2084 $descr =~ s/\s+/ /g;
2085 $declaration_purpose = $descr;
2086 $state = STATE_BODY_MAYBE;
2087 } else {
2088 $declaration_purpose = "";
2089 }
2077 $state = STATE_BODY;
2078 # if there's no @param blocks need to set up default section
2079 # here
2080 $contents = "";
2081 $section = $section_default;
2082 $new_start_line = $. + 1;
2083 if (/[-:](.*)/) {
2084 # strip leading/trailing/multiple spaces
2085 $descr= $1;
2086 $descr =~ s/^\s*//;
2087 $descr =~ s/\s*$//;
2088 $descr =~ s/\s+/ /g;
2089 $declaration_purpose = $descr;
2090 $state = STATE_BODY_MAYBE;
2091 } else {
2092 $declaration_purpose = "";
2093 }
2090
2094
2091 if (!$is_kernel_comment) {
2092 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_");
2093 $state = STATE_NORMAL;
2094 }
2095 if (!$is_kernel_comment) {
2096 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_");
2097 $state = STATE_NORMAL;
2098 }
2095
2099
2096 if (($declaration_purpose eq "") && $Wshort_desc) {
2097 emit_warning("${file}:$.", "missing initial short description on line:\n$_");
2098 }
2100 if (($declaration_purpose eq "") && $Wshort_desc) {
2101 emit_warning("${file}:$.", "missing initial short description on line:\n$_");
2102 }
2099
2103
2100 if ($identifier eq "" && $decl_type ne "enum") {
2101 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_");
2102 $state = STATE_NORMAL;
2103 }
2104 if ($identifier eq "" && $decl_type ne "enum") {
2105 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_");
2106 $state = STATE_NORMAL;
2107 }
2104
2108
2105 if ($verbose) {
2106 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2107 }
2109 if ($verbose) {
2110 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2111 }
2108 } else {
2112 } else {
2109 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n");
2110 $state = STATE_NORMAL;
2113 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n");
2114 $state = STATE_NORMAL;
2111 }
2112}
2113
2114
2115#
2116# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2117#
2118sub process_body($$) {
2119 my $file = shift;
2120
2121 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2115 }
2116}
2117
2118
2119#
2120# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2121#
2122sub process_body($$) {
2123 my $file = shift;
2124
2125 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2122 dump_section($file, $section, $contents);
2123 $section = $section_default;
2124 $new_start_line = $.;
2125 $contents = "";
2126 dump_section($file, $section, $contents);
2127 $section = $section_default;
2128 $new_start_line = $.;
2129 $contents = "";
2126 }
2127
2128 if (/$doc_sect/i) { # case insensitive for supported section names
2130 }
2131
2132 if (/$doc_sect/i) { # case insensitive for supported section names
2129 $in_doc_sect = 1;
2130 $newsection = $1;
2131 $newcontents = $2;
2133 $in_doc_sect = 1;
2134 $newsection = $1;
2135 $newcontents = $2;
2132
2136
2133 # map the supported section names to the canonical names
2134 if ($newsection =~ m/^description$/i) {
2135 $newsection = $section_default;
2136 } elsif ($newsection =~ m/^context$/i) {
2137 $newsection = $section_context;
2138 } elsif ($newsection =~ m/^returns?$/i) {
2139 $newsection = $section_return;
2140 } elsif ($newsection =~ m/^\@return$/) {
2141 # special: @return is a section, not a param description
2142 $newsection = $section_return;
2143 }
2137 # map the supported section names to the canonical names
2138 if ($newsection =~ m/^description$/i) {
2139 $newsection = $section_default;
2140 } elsif ($newsection =~ m/^context$/i) {
2141 $newsection = $section_context;
2142 } elsif ($newsection =~ m/^returns?$/i) {
2143 $newsection = $section_return;
2144 } elsif ($newsection =~ m/^\@return$/) {
2145 # special: @return is a section, not a param description
2146 $newsection = $section_return;
2147 }
2144
2148
2145 if (($contents ne "") && ($contents ne "\n")) {
2146 if (!$in_doc_sect && $Wcontents_before_sections) {
2147 emit_warning("${file}:$.", "contents before sections\n");
2148 }
2149 dump_section($file, $section, $contents);
2150 $section = $section_default;
2151 }
2149 if (($contents ne "") && ($contents ne "\n")) {
2150 if (!$in_doc_sect && $Wcontents_before_sections) {
2151 emit_warning("${file}:$.", "contents before sections\n");
2152 }
2153 dump_section($file, $section, $contents);
2154 $section = $section_default;
2155 }
2152
2156
2153 $in_doc_sect = 1;
2154 $state = STATE_BODY;
2155 $contents = $newcontents;
2156 $new_start_line = $.;
2157 while (substr($contents, 0, 1) eq " ") {
2158 $contents = substr($contents, 1);
2159 }
2160 if ($contents ne "") {
2161 $contents .= "\n";
2162 }
2163 $section = $newsection;
2164 $leading_space = undef;
2157 $in_doc_sect = 1;
2158 $state = STATE_BODY;
2159 $contents = $newcontents;
2160 $new_start_line = $.;
2161 while (substr($contents, 0, 1) eq " ") {
2162 $contents = substr($contents, 1);
2163 }
2164 if ($contents ne "") {
2165 $contents .= "\n";
2166 }
2167 $section = $newsection;
2168 $leading_space = undef;
2165 } elsif (/$doc_end/) {
2169 } elsif (/$doc_end/) {
2166 if (($contents ne "") && ($contents ne "\n")) {
2167 dump_section($file, $section, $contents);
2168 $section = $section_default;
2169 $contents = "";
2170 }
2171 # look for doc_com + <text> + doc_end:
2172 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2173 emit_warning("${file}:$.", "suspicious ending line: $_");
2174 }
2170 if (($contents ne "") && ($contents ne "\n")) {
2171 dump_section($file, $section, $contents);
2172 $section = $section_default;
2173 $contents = "";
2174 }
2175 # look for doc_com + <text> + doc_end:
2176 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2177 emit_warning("${file}:$.", "suspicious ending line: $_");
2178 }
2175
2179
2176 $prototype = "";
2177 $state = STATE_PROTO;
2178 $brcount = 0;
2180 $prototype = "";
2181 $state = STATE_PROTO;
2182 $brcount = 0;
2179 $new_start_line = $. + 1;
2180 } elsif (/$doc_content/) {
2183 $new_start_line = $. + 1;
2184 } elsif (/$doc_content/) {
2181 if ($1 eq "") {
2182 if ($section eq $section_context) {
2183 dump_section($file, $section, $contents);
2184 $section = $section_default;
2185 $contents = "";
2186 $new_start_line = $.;
2187 $state = STATE_BODY;
2188 } else {
2189 if ($section ne $section_default) {
2190 $state = STATE_BODY_WITH_BLANK_LINE;
2191 } else {
2192 $state = STATE_BODY;
2193 }
2194 $contents .= "\n";
2195 }
2196 } elsif ($state == STATE_BODY_MAYBE) {
2197 # Continued declaration purpose
2198 chomp($declaration_purpose);
2199 $declaration_purpose .= " " . $1;
2200 $declaration_purpose =~ s/\s+/ /g;
2201 } else {
2202 my $cont = $1;
2203 if ($section =~ m/^@/ || $section eq $section_context) {
2204 if (!defined $leading_space) {
2205 if ($cont =~ m/^(\s+)/) {
2206 $leading_space = $1;
2207 } else {
2208 $leading_space = "";
2209 }
2210 }
2211 $cont =~ s/^$leading_space//;
2212 }
2213 $contents .= $cont . "\n";
2214 }
2185 if ($1 eq "") {
2186 if ($section eq $section_context) {
2187 dump_section($file, $section, $contents);
2188 $section = $section_default;
2189 $contents = "";
2190 $new_start_line = $.;
2191 $state = STATE_BODY;
2192 } else {
2193 if ($section ne $section_default) {
2194 $state = STATE_BODY_WITH_BLANK_LINE;
2195 } else {
2196 $state = STATE_BODY;
2197 }
2198 $contents .= "\n";
2199 }
2200 } elsif ($state == STATE_BODY_MAYBE) {
2201 # Continued declaration purpose
2202 chomp($declaration_purpose);
2203 $declaration_purpose .= " " . $1;
2204 $declaration_purpose =~ s/\s+/ /g;
2205 } else {
2206 my $cont = $1;
2207 if ($section =~ m/^@/ || $section eq $section_context) {
2208 if (!defined $leading_space) {
2209 if ($cont =~ m/^(\s+)/) {
2210 $leading_space = $1;
2211 } else {
2212 $leading_space = "";
2213 }
2214 }
2215 $cont =~ s/^$leading_space//;
2216 }
2217 $contents .= $cont . "\n";
2218 }
2215 } else {
2219 } else {
2216 # i dont know - bad line? ignore.
2217 emit_warning("${file}:$.", "bad line: $_");
2220 # i dont know - bad line? ignore.
2221 emit_warning("${file}:$.", "bad line: $_");
2218 }
2219}
2220
2221
2222#
2223# STATE_PROTO: reading a function/whatever prototype.
2224#
2225sub process_proto($$) {
2226 my $file = shift;
2227
2228 if (/$doc_inline_oneline/) {
2222 }
2223}
2224
2225
2226#
2227# STATE_PROTO: reading a function/whatever prototype.
2228#
2229sub process_proto($$) {
2230 my $file = shift;
2231
2232 if (/$doc_inline_oneline/) {
2229 $section = $1;
2230 $contents = $2;
2231 if ($contents ne "") {
2232 $contents .= "\n";
2233 dump_section($file, $section, $contents);
2234 $section = $section_default;
2235 $contents = "";
2236 }
2233 $section = $1;
2234 $contents = $2;
2235 if ($contents ne "") {
2236 $contents .= "\n";
2237 dump_section($file, $section, $contents);
2238 $section = $section_default;
2239 $contents = "";
2240 }
2237 } elsif (/$doc_inline_start/) {
2241 } elsif (/$doc_inline_start/) {
2238 $state = STATE_INLINE;
2239 $inline_doc_state = STATE_INLINE_NAME;
2242 $state = STATE_INLINE;
2243 $inline_doc_state = STATE_INLINE_NAME;
2240 } elsif ($decl_type eq 'function') {
2244 } elsif ($decl_type eq 'function') {
2241 process_proto_function($_, $file);
2245 process_proto_function($_, $file);
2242 } else {
2246 } else {
2243 process_proto_type($_, $file);
2247 process_proto_type($_, $file);
2244 }
2245}
2246
2247#
2248# STATE_DOCBLOCK: within a DOC: block.
2249#
2250sub process_docblock($$) {
2251 my $file = shift;
2252
2253 if (/$doc_end/) {
2248 }
2249}
2250
2251#
2252# STATE_DOCBLOCK: within a DOC: block.
2253#
2254sub process_docblock($$) {
2255 my $file = shift;
2256
2257 if (/$doc_end/) {
2254 dump_doc_section($file, $section, $contents);
2255 $section = $section_default;
2256 $contents = "";
2257 $function = "";
2258 %parameterdescs = ();
2259 %parametertypes = ();
2260 @parameterlist = ();
2261 %sections = ();
2262 @sectionlist = ();
2263 $prototype = "";
2264 $state = STATE_NORMAL;
2258 dump_doc_section($file, $section, $contents);
2259 $section = $section_default;
2260 $contents = "";
2261 $function = "";
2262 %parameterdescs = ();
2263 %parametertypes = ();
2264 @parameterlist = ();
2265 %sections = ();
2266 @sectionlist = ();
2267 $prototype = "";
2268 $state = STATE_NORMAL;
2265 } elsif (/$doc_content/) {
2269 } elsif (/$doc_content/) {
2266 if ( $1 eq "" ) {
2267 $contents .= $blankline;
2268 } else {
2269 $contents .= $1 . "\n";
2270 }
2270 if ( $1 eq "" ) {
2271 $contents .= $blankline;
2272 } else {
2273 $contents .= $1 . "\n";
2274 }
2271 }
2272}
2273
2274#
2275# STATE_INLINE: docbook comments within a prototype.
2276#
2277sub process_inline($$) {
2278 my $file = shift;
2279
2280 # First line (state 1) needs to be a @parameter
2281 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2275 }
2276}
2277
2278#
2279# STATE_INLINE: docbook comments within a prototype.
2280#
2281sub process_inline($$) {
2282 my $file = shift;
2283
2284 # First line (state 1) needs to be a @parameter
2285 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2282 $section = $1;
2283 $contents = $2;
2284 $new_start_line = $.;
2285 if ($contents ne "") {
2286 while (substr($contents, 0, 1) eq " ") {
2287 $contents = substr($contents, 1);
2288 }
2289 $contents .= "\n";
2290 }
2291 $inline_doc_state = STATE_INLINE_TEXT;
2292 # Documentation block end */
2286 $section = $1;
2287 $contents = $2;
2288 $new_start_line = $.;
2289 if ($contents ne "") {
2290 while (substr($contents, 0, 1) eq " ") {
2291 $contents = substr($contents, 1);
2292 }
2293 $contents .= "\n";
2294 }
2295 $inline_doc_state = STATE_INLINE_TEXT;
2296 # Documentation block end */
2293 } elsif (/$doc_inline_end/) {
2297 } elsif (/$doc_inline_end/) {
2294 if (($contents ne "") && ($contents ne "\n")) {
2295 dump_section($file, $section, $contents);
2296 $section = $section_default;
2297 $contents = "";
2298 }
2299 $state = STATE_PROTO;
2300 $inline_doc_state = STATE_INLINE_NA;
2301 # Regular text
2298 if (($contents ne "") && ($contents ne "\n")) {
2299 dump_section($file, $section, $contents);
2300 $section = $section_default;
2301 $contents = "";
2302 }
2303 $state = STATE_PROTO;
2304 $inline_doc_state = STATE_INLINE_NA;
2305 # Regular text
2302 } elsif (/$doc_content/) {
2306 } elsif (/$doc_content/) {
2303 if ($inline_doc_state == STATE_INLINE_TEXT) {
2304 $contents .= $1 . "\n";
2305 # nuke leading blank lines
2306 if ($contents =~ /^\s*$/) {
2307 $contents = "";
2308 }
2309 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2310 $inline_doc_state = STATE_INLINE_ERROR;
2311 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_");
2312 }
2307 if ($inline_doc_state == STATE_INLINE_TEXT) {
2308 $contents .= $1 . "\n";
2309 # nuke leading blank lines
2310 if ($contents =~ /^\s*$/) {
2311 $contents = "";
2312 }
2313 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2314 $inline_doc_state = STATE_INLINE_ERROR;
2315 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_");
2316 }
2313 }
2314}
2315
2316
2317sub process_file($) {
2318 my $file;
2319 my $initial_section_counter = $section_counter;
2320 my ($orig_file) = @_;
2321
2322 $file = map_filename($orig_file);
2323
2324 if (!open(IN_FILE,"<$file")) {
2317 }
2318}
2319
2320
2321sub process_file($) {
2322 my $file;
2323 my $initial_section_counter = $section_counter;
2324 my ($orig_file) = @_;
2325
2326 $file = map_filename($orig_file);
2327
2328 if (!open(IN_FILE,"<$file")) {
2325 print STDERR "Error: Cannot open file $file\n";
2326 ++$errors;
2327 return;
2329 print STDERR "Error: Cannot open file $file\n";
2330 ++$errors;
2331 return;
2328 }
2329
2330 $. = 1;
2331
2332 $section_counter = 0;
2333 while (<IN_FILE>) {
2332 }
2333
2334 $. = 1;
2335
2336 $section_counter = 0;
2337 while (<IN_FILE>) {
2334 while (s/\\\s*$//) {
2335 $_ .= <IN_FILE>;
2336 }
2337 # Replace tabs by spaces
2338 while (!/^ \*/ && s/\\\s*$//) {
2339 $_ .= <IN_FILE>;
2340 }
2341 # Replace tabs by spaces
2338 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2342 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2339 # Hand this line to the appropriate state handler
2340 if ($state == STATE_NORMAL) {
2341 process_normal();
2342 } elsif ($state == STATE_NAME) {
2343 process_name($file, $_);
2344 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2345 $state == STATE_BODY_WITH_BLANK_LINE) {
2346 process_body($file, $_);
2347 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2348 process_inline($file, $_);
2349 } elsif ($state == STATE_PROTO) {
2350 process_proto($file, $_);
2351 } elsif ($state == STATE_DOCBLOCK) {
2352 process_docblock($file, $_);
2353 }
2343 # Hand this line to the appropriate state handler
2344 if ($state == STATE_NORMAL) {
2345 process_normal();
2346 } elsif ($state == STATE_NAME) {
2347 process_name($file, $_);
2348 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2349 $state == STATE_BODY_WITH_BLANK_LINE) {
2350 process_body($file, $_);
2351 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2352 process_inline($file, $_);
2353 } elsif ($state == STATE_PROTO) {
2354 process_proto($file, $_);
2355 } elsif ($state == STATE_DOCBLOCK) {
2356 process_docblock($file, $_);
2357 }
2354 }
2355
2356 # Make sure we got something interesting.
2357 if ($initial_section_counter == $section_counter && $
2358 }
2359
2360 # Make sure we got something interesting.
2361 if ($initial_section_counter == $section_counter && $
2358 output_mode ne "none") {
2359 if ($output_selection == OUTPUT_INCLUDE) {
2360 emit_warning("${file}:1", "'$_' not found\n")
2361 for keys %function_table;
2362 }
2363 else {
2364 emit_warning("${file}:1", "no structured comments found\n");
2365 }
2362 output_mode ne "none") {
2363 if ($output_selection == OUTPUT_INCLUDE) {
2364 emit_warning("${file}:1", "'$_' not found\n")
2365 for keys %function_table;
2366 } else {
2367 emit_warning("${file}:1", "no structured comments found\n");
2368 }
2366 }
2367 close IN_FILE;
2368}
2369
2370
2371if ($output_mode eq "rst") {
2369 }
2370 close IN_FILE;
2371}
2372
2373
2374if ($output_mode eq "rst") {
2372 get_sphinx_version() if (!$sphinx_major);
2375 get_sphinx_version() if (!$sphinx_major);
2373}
2374
2375$kernelversion = get_kernel_version();
2376
2377# generate a sequence of code that will splice in highlighting information
2378# using the s// operator.
2379for (my $k = 0; $k < @highlights; $k++) {
2380 my $pattern = $highlights[$k][0];
2381 my $result = $highlights[$k][1];
2382# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2383 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2384}
2385
2386# Read the file that maps relative names to absolute names for
2387# separate source and object directories and for shadow trees.
2388if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2376}
2377
2378$kernelversion = get_kernel_version();
2379
2380# generate a sequence of code that will splice in highlighting information
2381# using the s// operator.
2382for (my $k = 0; $k < @highlights; $k++) {
2383 my $pattern = $highlights[$k][0];
2384 my $result = $highlights[$k][1];
2385# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2386 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2387}
2388
2389# Read the file that maps relative names to absolute names for
2390# separate source and object directories and for shadow trees.
2391if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2389 my ($relname, $absname);
2390 while(<SOURCE_MAP>) {
2391 chop();
2392 ($relname, $absname) = (split())[0..1];
2393 $relname =~ s:^/+::;
2394 $source_map{$relname} = $absname;
2395 }
2396 close(SOURCE_MAP);
2392 my ($relname, $absname);
2393 while(<SOURCE_MAP>) {
2394 chop();
2395 ($relname, $absname) = (split())[0..1];
2396 $relname =~ s:^/+::;
2397 $source_map{$relname} = $absname;
2398 }
2399 close(SOURCE_MAP);
2397}
2398
2399if ($output_selection == OUTPUT_EXPORTED ||
2400 $output_selection == OUTPUT_INTERNAL) {
2401
2402 push(@export_file_list, @ARGV);
2403
2404 foreach (@export_file_list) {
2400}
2401
2402if ($output_selection == OUTPUT_EXPORTED ||
2403 $output_selection == OUTPUT_INTERNAL) {
2404
2405 push(@export_file_list, @ARGV);
2406
2407 foreach (@export_file_list) {
2405 chomp;
2406 process_export_file($_);
2408 chomp;
2409 process_export_file($_);
2407 }
2408}
2409
2410foreach (@ARGV) {
2411 chomp;
2412 process_file($_);
2413}
2414if ($verbose && $errors) {
2410 }
2411}
2412
2413foreach (@ARGV) {
2414 chomp;
2415 process_file($_);
2416}
2417if ($verbose && $errors) {
2415 print STDERR "$errors errors\n";
2418 print STDERR "$errors errors\n";
2416}
2417if ($verbose && $warnings) {
2419}
2420if ($verbose && $warnings) {
2418 print STDERR "$warnings warnings\n";
2421 print STDERR "$warnings warnings\n";
2419}
2420
2421if ($Werror && $warnings) {
2422 print STDERR "$warnings warnings as Errors\n";
2423 exit($warnings);
2424} else {
2425 exit($output_mode eq "none" ? 0 : $errors)
2426}

--- 114 unchanged lines hidden --- 		2422}
2423
2424if ($Werror && $warnings) {
2425 print STDERR "$warnings warnings as Errors\n";
2426 exit($warnings);
2427} else {
2428 exit($output_mode eq "none" ? 0 : $errors)
2429}

--- 114 unchanged lines hidden ---