diff mbox series

[13/24] usb: chipidea: core: Fix incorrectly documented function 'ci_usb_phy_exit()'

Message ID 20210526130037.856068-14-lee.jones@linaro.org
State New
Headers show
Series Rid W=1 warnings from USB | expand

Commit Message

Lee Jones May 26, 2021, 1 p.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/usb/chipidea/core.c:343: warning: expecting prototype for _ci_usb_phy_exit(). Prototype was for ci_usb_phy_exit() instead

Cc: Peter Chen <peter.chen@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: David Lopo <dlopo@chipidea.mips.com>
Cc: linux-usb@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/usb/chipidea/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.31.1

Comments

Sergei Shtylyov May 26, 2021, 2:24 p.m. UTC | #1
On 5/26/21 4:00 PM, Lee Jones wrote:

> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/usb/chipidea/core.c:343: warning: expecting prototype for _ci_usb_phy_exit(). Prototype was for ci_usb_phy_exit() instead

> 

> Cc: Peter Chen <peter.chen@kernel.org>

> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

> Cc: Liam Girdwood <lgirdwood@gmail.com>

> Cc: Mark Brown <broonie@kernel.org>

> Cc: David Lopo <dlopo@chipidea.mips.com>

> Cc: linux-usb@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/usb/chipidea/core.c | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/drivers/usb/chipidea/core.c b/drivers/usb/chipidea/core.c

> index 3f6c21406dbd2..2b18f5088ae4a 100644

> --- a/drivers/usb/chipidea/core.c

> +++ b/drivers/usb/chipidea/core.c

> @@ -335,7 +335,7 @@ static int _ci_usb_phy_init(struct ci_hdrc *ci)

>  }

>  

>  /**

> - * _ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy

> + * ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy


   I thought - shoiuld've been used as a separator. Is : good here as well?

>   * interfaces

>   * @ci: the controller

>   */


MBR, Sergei
Lee Jones May 26, 2021, 2:42 p.m. UTC | #2
On Wed, 26 May 2021, Sergei Shtylyov wrote:

> On 5/26/21 4:00 PM, Lee Jones wrote:

> 

> > Fixes the following W=1 kernel build warning(s):

> > 

> >  drivers/usb/chipidea/core.c:343: warning: expecting prototype for _ci_usb_phy_exit(). Prototype was for ci_usb_phy_exit() instead

> > 

> > Cc: Peter Chen <peter.chen@kernel.org>

> > Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

> > Cc: Liam Girdwood <lgirdwood@gmail.com>

> > Cc: Mark Brown <broonie@kernel.org>

> > Cc: David Lopo <dlopo@chipidea.mips.com>

> > Cc: linux-usb@vger.kernel.org

> > Signed-off-by: Lee Jones <lee.jones@linaro.org>

> > ---

> >  drivers/usb/chipidea/core.c | 2 +-

> >  1 file changed, 1 insertion(+), 1 deletion(-)

> > 

> > diff --git a/drivers/usb/chipidea/core.c b/drivers/usb/chipidea/core.c

> > index 3f6c21406dbd2..2b18f5088ae4a 100644

> > --- a/drivers/usb/chipidea/core.c

> > +++ b/drivers/usb/chipidea/core.c

> > @@ -335,7 +335,7 @@ static int _ci_usb_phy_init(struct ci_hdrc *ci)

> >  }

> >  

> >  /**

> > - * _ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy

> > + * ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy

> 

>    I thought - shoiuld've been used as a separator. Is : good here as well?


If I were drafting from scratch, I would *always* use '-', but
kernel-doc seems to work okay with ':' too, so I'm letting sleeping
dogs lie on this one.

> >   * interfaces

> >   * @ci: the controller

> >   */

> 

> MBR, Sergei


-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
diff mbox series

Patch

diff --git a/drivers/usb/chipidea/core.c b/drivers/usb/chipidea/core.c
index 3f6c21406dbd2..2b18f5088ae4a 100644
--- a/drivers/usb/chipidea/core.c
+++ b/drivers/usb/chipidea/core.c
@@ -335,7 +335,7 @@  static int _ci_usb_phy_init(struct ci_hdrc *ci)
 }
 
 /**
- * _ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy
+ * ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy
  * interfaces
  * @ci: the controller
  */