linux-kernel - Re: [PATCH] fpga: dfl: fme: fix kernel-doc comments for some functions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <a5145b2cd2c36e3efd78985c51366b082949cfe5.camel@intel.com>
Date: Tue, 2 Apr 2024 20:17:17 +0000
From: "Colberg, Peter" <peter.colberg@...el.com>
To: "rdunlap@...radead.org" <rdunlap@...radead.org>,
	"yilun.xu@...ux.intel.com" <yilun.xu@...ux.intel.com>
CC: lkp <lkp@...el.com>, "enno.luebbers@...el.com" <enno.luebbers@...el.com>,
	"Xu, Yilun" <yilun.xu@...el.com>, "linux-fpga@...r.kernel.org"
	<linux-fpga@...r.kernel.org>, "mdf@...nel.org" <mdf@...nel.org>,
	"luwei.kang@...el.com" <luwei.kang@...el.com>, "Wu, Hao" <hao.wu@...el.com>,
	"atull@...nel.org" <atull@...nel.org>, "shiva.rao@...el.com"
	<shiva.rao@...el.com>, "russ.weight@...ux.dev" <russ.weight@...ux.dev>, "Rix,
 Tom" <trix@...hat.com>, "Pagani, Marco" <marpagan@...hat.com>,
	"matthew.gerlach@...ux.intel.com" <matthew.gerlach@...ux.intel.com>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] fpga: dfl: fme: fix kernel-doc comments for some
 functions

On Mon, 2024-04-01 at 21:42 -0700, Randy Dunlap wrote:
> 
> On 4/1/24 8:47 PM, Xu Yilun wrote:
> > On Thu, Mar 28, 2024 at 08:15:42PM -0400, Peter Colberg wrote:
> > > From: Xu Yilun <yilun.xu@...el.com>
> > 
> > I didn't remember I wrote this exact patch, but anyway the patch itself
> > is confusing.

My apology, the original patch was indeed rebased incorrectly onto
commit 782d8e61b5d6 ("fpga: dfl: kernel-doc corrections").

> > 
> > > 
> > > lkp reported 2 build warnings:
> > > 
> > >    drivers/fpga/dfl/dfl-fme-pr.c:175: warning: Function parameter or member 'feature' not described in 'dfl_fme_create_mgr'
> > > 
> > > > > drivers/fpga/dfl/dfl-fme-pr.c:280: warning: expecting prototype for
> > > > > dfl_fme_destroy_bridge(). Prototype was for dfl_fme_destroy_bridges()
> > > > > instead
> > > 
> > > Fixes: 29de76240e86 ("fpga: dfl: fme: add partial reconfiguration sub feature support")
> > > Reported-by: kernel test robot <lkp@...el.com>
> > > Signed-off-by: Xu Yilun <yilun.xu@...el.com>
> > > Signed-off-by: Peter Colberg <peter.colberg@...el.com>
> 
> All kernel-doc issues with this source file are already fixed in linux-next
> by this commit:
> 
> commit 782d8e61b5d6
> Author: Randy Dunlap <rdunlap@...radead.org>
> Date:   Thu Jan 12 22:37:20 2023 -0800
> 
>     fpga: dfl: kernel-doc corrections
>     
>     Fix W=1 kernel-doc warnings in drivers/fpga/:
> 
> 
> > > ---
> > >  drivers/fpga/dfl-fme-pr.c | 3 ++-
> > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/drivers/fpga/dfl-fme-pr.c b/drivers/fpga/dfl-fme-pr.c
> > > index cdcf6dea4cc9..96cb24787ab1 100644
> > > --- a/drivers/fpga/dfl-fme-pr.c
> > > +++ b/drivers/fpga/dfl-fme-pr.c
> > > @@ -166,6 +166,7 @@ static int fme_pr(struct platform_device *pdev, unsigned long arg)
> > >   * dfl_fme_create_mgr - create fpga mgr platform device as child device
> > >   * @feature: sub feature info
> > 
> > The member 'feature' is described here. It still causes build warning?
> > 
> > >   * @pdata: fme platform_device's pdata
> > > + * @feature: the dfl fme PR sub feature
> > 
> > Why adding a duplicated item would fix the warning?

Apologies for the confusion; commit 782d8e61b5d6 only changed the
function name to plural, which addresses the kernel-doc warning;
whereas your original patch also changed the description to plural.

I will send a revised, correctly rebased patch.

Thanks,
Peter

> > 
> > >   *
> > >   * Return: mgr platform device if successful, and error code otherwise.
> > >   */
> > > @@ -273,7 +274,7 @@ static void dfl_fme_destroy_bridge(struct dfl_fme_bridge *fme_br)
> > >  }
> > >  
> > >  /**
> > > - * dfl_fme_destroy_bridges - destroy all fpga bridge platform device
> > 
> > The prototype is for dfl_fme_destroy_bridges(), why the warning?
> > 
> > > + * dfl_fme_destroy_bridges - destroy all fpga bridge platform devices
> > 
> > Correct the plural form in description would fix the warning?
> > 
> > >   * @pdata: fme platform device's pdata
> > >   */
> > >  static void dfl_fme_destroy_bridges(struct dfl_feature_platform_data *pdata)
> > > -- 
> > > 2.44.0
> > > 
> > > 
> > 
>