From: Changbin Du <changbin.du@gmail.com>
To: Matthew Wilcox <willy@infradead.org>
Cc: Changbin Du <changbin.du@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
Jiri Kosina <trivial@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] kernel-doc: trivial improvement for warning message
Date: Wed, 23 Oct 2019 19:27:11 +0800 [thread overview]
Message-ID: <20191023112709.dpc64xc3g3e7wks3@mail.google.com> (raw)
In-Reply-To: <20191021185406.GC9214@bombadil.infradead.org>
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
prev parent reply other threads:[~2019-10-23 11:27 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-20 13:23 Changbin Du
2019-10-21 18:54 ` Matthew Wilcox
2019-10-23 11:27 ` Changbin Du [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191023112709.dpc64xc3g3e7wks3@mail.google.com \
--to=changbin.du@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=trivial@kernel.org \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®