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

Nava kishore Manne navam at xilinx.com
Tue Mar 15 04:51:57 PDT 2022


Hi Randy,

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

> -----Original Message-----
> From: Randy Dunlap <rdunlap at infradead.org>
> Sent: Wednesday, March 9, 2022 3:09 AM
> To: Nava kishore Manne <navam at xilinx.com>; mdf at kernel.org;
> hao.wu at intel.com; yilun.xu at intel.com; trix at redhat.com; Michal Simek
> <michals at xilinx.com>; linux-fpga at vger.kernel.org; linux-
> kernel at vger.kernel.org; linux-arm-kernel at lists.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 at xilinx.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.


More information about the linux-arm-kernel mailing list