linux-kernel - Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc

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 for Android: free password hash cracker in your pocket

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

Message-ID: <ZKu8BkQZAvAfZbSE@yilunxu-OptiPlex-7050>
Date:   Mon, 10 Jul 2023 16:06:30 +0800
From:   Xu Yilun <yilun.xu@...el.com>
To:     Marco Pagani <marpagan@...hat.com>
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Moritz Fischer <mdf@...nel.org>, Wu Hao <hao.wu@...el.com>,
        Tom Rix <trix@...hat.com>, linux-kernel@...r.kernel.org,
        linux-fpga@...r.kernel.org
Subject: Re: [RFC PATCH 2/2] fpga: bridge: fix kernel-doc

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@...hat.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@...radead.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@...el.com>

Applied.

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