linux-kernel - RE: [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <SN6PR02MB4576356531DD49BAF45FE28AC2109@SN6PR02MB4576.namprd02.prod.outlook.com>
Date:   Tue, 15 Mar 2022 11:51:57 +0000
From:   Nava kishore Manne <navam@...inx.com>
To:     Randy Dunlap <rdunlap@...radead.org>,
        "mdf@...nel.org" <mdf@...nel.org>,
        "hao.wu@...el.com" <hao.wu@...el.com>,
        "yilun.xu@...el.com" <yilun.xu@...el.com>,
        "trix@...hat.com" <trix@...hat.com>,
        Michal Simek <michals@...inx.com>,
        "linux-fpga@...r.kernel.org" <linux-fpga@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        "linux-arm-kernel@...ts.infradead.org" 
        <linux-arm-kernel@...ts.infradead.org>
Subject: RE: [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description

Hi Randy,

	Thanks for providing the review comments.
Please find response inline.

> -----Original Message-----
> From: Randy Dunlap <rdunlap@...radead.org>
> Sent: Wednesday, March 9, 2022 3:09 AM
> To: Nava kishore Manne <navam@...inx.com>; mdf@...nel.org;
> hao.wu@...el.com; yilun.xu@...el.com; trix@...hat.com; Michal Simek
> <michals@...inx.com>; linux-fpga@...r.kernel.org; linux-
> kernel@...r.kernel.org; linux-arm-kernel@...ts.infradead.org
> Subject: Re: [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description
> 
> Hi--
> 
> On 3/8/22 01:45, Nava kishore Manne wrote:
> > Fixed the warnings: Function parameter or member 'xxx' not described.
> >
> > Signed-off-by: Nava kishore Manne <nava.manne@...inx.com>
> > ---
> >  drivers/fpga/fpga-mgr.c | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c index
> > a699cc8e2fa6..354789740529 100644
> > --- a/drivers/fpga/fpga-mgr.c
> > +++ b/drivers/fpga/fpga-mgr.c
> > @@ -730,6 +730,8 @@ static void devm_fpga_mgr_unregister(struct
> device *dev, void *res)
> >   * @parent:	fpga manager device from pdev
> >   * @info:	parameters for fpga manager
> >   *
> > + * @return:  fpga manager pointer on success, negative error code
> otherwise.
> 
> Not quite. Should be:
> 
>  * Return: foo bar blah
> 

Will fix in v2

> > + *
> >   * This is the devres variant of fpga_mgr_register_full() for which the
> unregister
> >   * function will be called automatically when the managing device is
> detached.
> >   */
> > @@ -763,6 +765,8 @@
> EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full);
> >   * @mops:	pointer to structure of fpga manager ops
> >   * @priv:	fpga manager private data
> >   *
> > + * @return:  fpga manager pointer on success, negative error code
> otherwise.
> 
> ditto.
> 

Will fix in v2.

Regards,
Navakishore.