| Message ID | 20211120061531.410771-2-vkoul@kernel.org |
|---|---|
| State | Accepted |
| Commit | 7947113fd07a372de813edddfce6cb0a38ab66e0 |
| Headers | show |
| Series | [v2,1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style | expand |
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@kernel.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. Reviewed-by: Liam Beguin <liambeguin@gmail.com> > + * > + * @comparator: the companion phy(comparator) for this phy > * > * The phy companion driver should call this API passing the phy_companion > * filled with set_vbus and start_srp to be used by usb phy. > -- > 2.31.1 >
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@kernel.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@gmail.com> Thanks
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 + * + * @comparator: the companion phy(comparator) for this phy * * The phy companion driver should call this API passing the phy_companion * filled with set_vbus and start_srp to be used by usb phy.
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@kernel.org> --- Changes in v2: use () for function names drivers/phy/ti/phy-omap-usb2.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)