Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Wed, 23 Oct 2019 19:27:11 +0800
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
Message-ID: <20191023112709.dpc64xc3g3e7wks3@mail.google.com>
References: <20191020132323.29658-1-changbin.du@gmail.com>
 <20191021185406.GC9214@bombadil.infradead.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20191021185406.GC9214@bombadil.infradead.org>
User-Agent: NeoMutt/20180716
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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