lkml.org 
[lkml]   [2019]   [Oct]   [23]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] kernel-doc: trivial improvement for warning message
On Mon, Oct 21, 2019 at 11:54:06AM -0700, Matthew Wilcox wrote:
> On Sun, Oct 20, 2019 at 09:23:23PM +0800, Changbin Du wrote:
> > The message "Function parameter or member ..." looks weird.
> >
> > Signed-off-by: Changbin Du <changbin.du@gmail.com>
> > ---
> > scripts/kernel-doc | 9 +++++++--
> > 1 file changed, 7 insertions(+), 2 deletions(-)
> >
> > diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> > index 81dc91760b23..cd3d2ca52c34 100755
> > --- a/scripts/kernel-doc
> > +++ b/scripts/kernel-doc
> > @@ -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;
>
> 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)
This removes some duplicated characters, but need to decalare a extra variable.
I am okay for both approaches. :)

--
Cheers,
Changbin Du

\
 
 \ /
  Last update: 2019-10-23 13:27    [W:0.114 / U:0.052 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site