[prev in list] [next in list] [prev in thread] [next in thread] 

List:       linux-fpga
Subject:    Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc
From:       Xu Yilun <yilun.xu () intel ! com>
Date:       2023-07-10 8:06:30
Message-ID: ZKu8BkQZAvAfZbSE () yilunxu-OptiPlex-7050
[Download RAW message or body]

On 2023-07-07 at 10:50:16 +0200, Marco Pagani wrote:
> 
> 
> On 2023-07-06 23:35, Randy Dunlap wrote:
> > HI--
> > 
> > On 7/6/23 07:27, Marco Pagani wrote:
> > > Fix the following warnings issued by the kernel-doc script:
> > > 
> > > drivers/fpga/fpga-bridge.c:99: warning: No description found for return value \
> > > of 'of_fpga_bridge_get' drivers/fpga/fpga-bridge.c:163: warning: No description \
> > > found for return value of 'fpga_bridges_enable' drivers/fpga/fpga-bridge.c:187: \
> > > warning: No description found for return value of 'fpga_bridges_disable' \
> > > drivers/fpga/fpga-bridge.c:238: warning: No description found for return value \
> > > of 'of_fpga_bridge_get_to_list' drivers/fpga/fpga-bridge.c:268: warning: No \
> > > description found for return value of 'fpga_bridge_get_to_list' 
> > > - Extend the return description of of_fpga_bridge_get() to include the
> > > case when try_module_get() fails.
> > > 
> > > Signed-off-by: Marco Pagani <marpagan@redhat.com>
> > > ---
> > > drivers/fpga/fpga-bridge.c | 23 ++++++++++++-----------
> > > 1 file changed, 12 insertions(+), 11 deletions(-)
> > > 
> > > diff --git a/drivers/fpga/fpga-bridge.c b/drivers/fpga/fpga-bridge.c
> > > index a6c25dee9cc1..0b76c67c50e5 100644
> > > --- a/drivers/fpga/fpga-bridge.c
> > > +++ b/drivers/fpga/fpga-bridge.c
> > > @@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device \
> > > *dev, /**
> > > * of_fpga_bridge_get - get an exclusive reference to an fpga bridge
> > > *
> > > - * @np: node pointer of an FPGA bridge
> > > - * @info: fpga image specific information
> > > + * @np: node pointer of an FPGA bridge.
> > > + * @info: fpga image specific information.
> > 
> > Those are not sentences. There is no reason that a period ('.') is needed
> > to end those lines. OTOH, the maintainers can do as they like with it.
> > 
> > The rest looks good. Thanks.
> > 
> > Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> 
> I added a period at the end of each argument description to follow
> the style recommended in the "Function documentation" section of the
> kernel-doc documentation.

I'm OK with them.

Acked-by: Xu Yilun <yilun.xu@intel.com>

Applied.

> 
> Thanks,
> Marco
> 
> [...]
> 


[prev in list] [next in list] [prev in thread] [next in thread]