linux-kernel - Re: [PATCH v2 2/2] phy: ti: omap-usb2: Fix the kernel-doc style

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

Date:   Thu, 25 Nov 2021 10:43:51 +0530
From:   Vinod Koul <vkoul@...nel.org>
To:     Liam Beguin <liambeguin@...il.com>
Cc:     Kishon Vijay Abraham I <kishon@...com>,
        linux-phy@...ts.infradead.org, Roger Quadros <rogerq@...com>,
        Liam Beguin <lvb@...hos.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 2/2] phy: ti: omap-usb2: Fix the kernel-doc style

On 20-11-21, 12:21, Liam Beguin wrote:
> Hi Vinod,
> 
> On Sat, Nov 20, 2021 at 11:45:31AM +0530, Vinod Koul wrote:
> > The documentation uses incorrect style, so fix that.
> > 
> > drivers/phy/ti/phy-omap-usb2.c:102: warning: Function parameter or member 'comparator' not described in 'omap_usb2_set_comparator'
> > 
> > While at it, use a single line for function description
> > 
> > Signed-off-by: Vinod Koul <vkoul@...nel.org>
> > ---
> > Changes in v2: use () for function names
> > 
> >  drivers/phy/ti/phy-omap-usb2.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/drivers/phy/ti/phy-omap-usb2.c b/drivers/phy/ti/phy-omap-usb2.c
> > index ebceb1520ce8..3a505fe5715a 100644
> > --- a/drivers/phy/ti/phy-omap-usb2.c
> > +++ b/drivers/phy/ti/phy-omap-usb2.c
> > @@ -89,9 +89,9 @@ static inline void omap_usb_writel(void __iomem *addr, unsigned int offset,
> >  }
> >  
> >  /**
> > - * omap_usb2_set_comparator - links the comparator present in the system with
> > - *	this phy
> > - * @comparator - the companion phy(comparator) for this phy
> > + * omap_usb2_set_comparator() - links the comparator present in the system with this phy
> 
> My apologies for the noise, I just noticed your v2.

No worries :)
> 
> Reviewed-by: Liam Beguin <liambeguin@...il.com>

Thanks

-- 
~Vinod