kernel-doc: trivial improvement for warning message
PATCH 1/1 kernel-doc: trivial improvement for warning message
The message "Function parameter or member ..." looks weird.
Signed-off-by Changbin Du <[email protected]>
--- scripts/kernel-doc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)
scripts/kernel-doc +7 -2
@@ -1475,8 +1475,13 @@ sub push_parameter($$$$) { $parameterdescs{$param} = $undescribed; if (show_warnings($type, $declaration_name) && $param !~ /\./) { - print STDERR - "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n"; + if ($decl_type eq "struct" or $decl_type eq 'union') { + print STDERR + "${file}:$.: warning: $decl_type member '$param' not described in '$declaration_name'\n"; + } else { + print STDERR + "${file}:$.: warning: $decl_type parameter '$param' not described in '$declaration_name'\n"; + } ++$warnings; } }
Signature · 1 line
2.20.1
Quoted 15 lines · Changbin Du
The message "Function parameter or member ..." looks weird.
Signed-off-by Changbin Du <[email protected]>--- scripts/kernel-doc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)scripts/kernel-doc +0
-0@@ -1475,8 +1475,13 @@ sub push_parameter($$$$) { $parameterdescs{$param} = $undescribed; if (show_warnings($type, $declaration_name) && $param !~ /\./) {
scripts/kernel-doc sub push_parameter($$$$) { · line 1485
Quoted 10 lines
scripts/kernel-doc +7
-2- print STDERR - "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n"; + if ($decl_type eq "struct" or $decl_type eq 'union') { + print STDERR + "${file}:$.: warning: $decl_type member '$param' not described in '$declaration_name'\n"; + } else { + print STDERR + "${file}:$.: warning: $decl_type parameter '$param' not described in '$declaration_name'\n"; + } ++$warnings;
How about instead ...
if (show_warnings($type, $declaration_name) && $param !~ /\./) { if ($decl_type eq "struct")
$msg = "struct member";
elif ($decl_type eq "union")
$msg = "union member";
else
$msg = "function parameter";
print STDERR "${file}:$.: warning: $msg '$param' not described in '$declaration_name'\n";(please excuse my perl, i am not a native speaker)
Quoted 37 lines · Matthew Wilcox
Quoted 15 lines · Changbin Du
The message "Function parameter or member ..." looks weird.
Signed-off-by Changbin Du <[email protected]>--- scripts/kernel-doc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)scripts/kernel-doc +0
-0@@ -1475,8 +1475,13 @@ sub push_parameter($$$$) { $parameterdescs{$param} = $undescribed; if (show_warnings($type, $declaration_name) && $param !~ /\./) {scripts/kernel-doc sub push_parameter($$$$) { · line 1485
Quoted 10 lines
scripts/kernel-doc +7
-2- print STDERR - "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n"; + if ($decl_type eq "struct" or $decl_type eq 'union') { + print STDERR + "${file}:$.: warning: $decl_type member '$param' not described in '$declaration_name'\n"; + } else { + print STDERR + "${file}:$.: warning: $decl_type parameter '$param' not described in '$declaration_name'\n"; + } ++$warnings;How about instead ...
if (show_warnings($type, $declaration_name) && $param !~ /\./) { if ($decl_type eq "struct") $msg = "struct member"; elif ($decl_type eq "union") $msg = "union member"; else $msg = "function parameter"; print STDERR "${file}:$.: warning: $msg '$param' not described in '$declaration_name'\n";
Quoted 1 line
(please excuse my perl, i am not a native speaker)
This removes some duplicated characters, but need to decalare a extra variable. I am okay for both approaches. :)
Signature · 2 lines
Cheers, Changbin Du