lkml.org 
[lkml]   [2022]   [Mar]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRE: [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description
Date
Hi Randy,

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

> -----Original Message-----
> From: Randy Dunlap <rdunlap@infradead.org>
> Sent: Wednesday, March 9, 2022 3:09 AM
> To: Nava kishore Manne <navam@xilinx.com>; mdf@kernel.org;
> hao.wu@intel.com; yilun.xu@intel.com; trix@redhat.com; Michal Simek
> <michals@xilinx.com>; linux-fpga@vger.kernel.org; linux-
> kernel@vger.kernel.org; linux-arm-kernel@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@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.
\
 
 \ /
  Last update: 2022-03-15 12:52    [W:0.048 / U:1.684 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site