openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

scripts: kernel-doc: print the declaration name on warnings 

The logic at create_parameterlist()'s ancillary push_parameter()
function has already a way to output the declaration name, with
would help to discover what declaration is missing.

However, currently, the logic is utterly broken, as it uses
the var $type with a wrong meaning. With the current code,
it will never print anything. I suspect that originally
it was using the second argument of output_declaration().

I opted to not rely on a globally defined $declaration_name,
but, instead, to pass it explicitly as a parameter.

While here, I removed a unaligned check for !$anon_struct_union.
This is not needed, as, if $anon_struct_union is not zero,
$parameterdescs{$param} will be defined.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2017-12-18 10:30:15 -02:00 committed by Jonathan Corbet
parent 1081de2d2f
commit 151c468b44
1 changed files with 16 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
scripts/kernel-doc
View File

@ -1063,7 +1063,7 @@ sub dump_struct($$) {
# Ignore other nested elements, like enums # Ignore other nested elements, like enums
$members =~ s/({[^\{\}]*})//g; $members =~ s/({[^\{\}]*})//g;
create_parameterlist($members, ';', $file); create_parameterlist($members, ';', $file, $declaration_name);
check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual); check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
# Adjust declaration for better display # Adjust declaration for better display
@ -1172,7 +1172,7 @@ sub dump_typedef($$) {
$declaration_name = $2; $declaration_name = $2;
my $args = $3; my $args = $3;
create_parameterlist($args, ',', $file); create_parameterlist($args, ',', $file, $declaration_name);
output_declaration($declaration_name, output_declaration($declaration_name,
'function', 'function',
@ -1221,10 +1221,11 @@ sub save_struct_actual($) {
$struct_actual = $struct_actual . $actual . " "; $struct_actual = $struct_actual . $actual . " ";
} }
sub create_parameterlist($$$) { sub create_parameterlist($$$$) {
my $args = shift; my $args = shift;
my $splitter = shift; my $splitter = shift;
my $file = shift; my $file = shift;
my $declaration_name = shift;
my $type; my $type;
my $param; my $param;
@ -1254,7 +1255,7 @@ sub create_parameterlist($$$) {
$type = $arg; $type = $arg;
$type =~ s/([^\(]+\(\*?)\s*$param/$1/; $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
save_struct_actual($param); save_struct_actual($param);
push_parameter($param, $type, $file); push_parameter($param, $type, $file, $declaration_name);
} elsif ($arg) { } elsif ($arg) {
$arg =~ s/\s*:\s*/:/g; $arg =~ s/\s*:\s*/:/g;
$arg =~ s/\s*\[/\[/g; $arg =~ s/\s*\[/\[/g;
@ -1279,27 +1280,28 @@ sub create_parameterlist($$$) {
foreach $param (@args) { foreach $param (@args) {
if ($param =~ m/^(\*+)\s*(.*)/) { if ($param =~ m/^(\*+)\s*(.*)/) {
save_struct_actual($2); save_struct_actual($2);
push_parameter($2, "$type $1", $file); push_parameter($2, "$type $1", $file, $declaration_name);
} }
elsif ($param =~ m/(.*?):(\d+)/) { elsif ($param =~ m/(.*?):(\d+)/) {
if ($type ne "") { # skip unnamed bit-fields if ($type ne "") { # skip unnamed bit-fields
save_struct_actual($1); save_struct_actual($1);
push_parameter($1, "$type:$2", $file) push_parameter($1, "$type:$2", $file, $declaration_name)
} }
} }
else { else {
save_struct_actual($param); save_struct_actual($param);
push_parameter($param, $type, $file); push_parameter($param, $type, $file, $declaration_name);
} }
} }
} }
} }
} }
sub push_parameter($$$) { sub push_parameter($$$$) {
my $param = shift; my $param = shift;
my $type = shift; my $type = shift;
my $file = shift; my $file = shift;
my $declaration_name = shift;
if (($anon_struct_union == 1) && ($type eq "") && if (($anon_struct_union == 1) && ($type eq "") &&
($param eq "}")) { ($param eq "}")) {
@ -1336,21 +1338,13 @@ sub push_parameter($$$) {
# warn if parameter has no description # warn if parameter has no description
# (but ignore ones starting with # as these are not parameters # (but ignore ones starting with # as these are not parameters
# but inline preprocessor statements); # but inline preprocessor statements);
# also ignore unnamed structs/unions; # Note: It will also ignore void params and unnamed structs/unions
if (!$anon_struct_union) {
if (!defined $parameterdescs{$param} && $param !~ /^#/) { if (!defined $parameterdescs{$param} && $param !~ /^#/) {
$parameterdescs{$param} = $undescribed;
$parameterdescs{$param} = $undescribed; print STDERR
"${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
if (($type eq 'function') || ($type eq 'enum')) { ++$warnings;
print STDERR "${file}:$.: warning: Function parameter ".
"or member '$param' not " .
"described in '$declaration_name'\n";
}
print STDERR "${file}:$.: warning:" .
" No description found for parameter '$param'\n";
++$warnings;
}
} }
$param = xml_escape($param); $param = xml_escape($param);
@ -1507,7 +1501,7 @@ sub dump_function($$) {
$declaration_name = $2; $declaration_name = $2;
my $args = $3; my $args = $3;
create_parameterlist($args, ',', $file); create_parameterlist($args, ',', $file, $declaration_name);
} else { } else {
print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n"; print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
return; return;