diff mbox series

[1/8] net: ethernet: smsc: smc91x: Demote non-conformant kernel function header

Message ID 20201126133853.3213268-2-lee.jones@linaro.org
State New
Headers show
Series Rid W=1 warnings in Net | expand

Commit Message

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

 drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'dev' not described in 'try_toggle_control_gpio'
 drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'desc' not described in 'try_toggle_control_gpio'
 drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'name' not described in 'try_toggle_control_gpio'
 drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'index' not described in 'try_toggle_control_gpio'
 drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'value' not described in 'try_toggle_control_gpio'
 drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'nsdelay' not described in 'try_toggle_control_gpio'

Cc: Nicolas Pitre <nico@fluxnic.net>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Erik Stahlman <erik@vt.edu>
Cc: Peter Cammaert <pc@denkart.be>
Cc: Daris A Nevil <dnevil@snmc.com>
Cc: Russell King <rmk@arm.linux.org.uk>
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/net/ethernet/smsc/smc91x.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.25.1

Comments

Andrew Lunn Nov. 29, 2020, 6:33 p.m. UTC | #1
On Thu, Nov 26, 2020 at 01:38:46PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'dev' not described in 'try_toggle_control_gpio'

>  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'desc' not described in 'try_toggle_control_gpio'

>  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'name' not described in 'try_toggle_control_gpio'

>  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'index' not described in 'try_toggle_control_gpio'

>  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'value' not described in 'try_toggle_control_gpio'

>  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'nsdelay' not described in 'try_toggle_control_gpio'

> 

> Cc: Nicolas Pitre <nico@fluxnic.net>

> Cc: "David S. Miller" <davem@davemloft.net>

> Cc: Jakub Kicinski <kuba@kernel.org>

> Cc: Erik Stahlman <erik@vt.edu>

> Cc: Peter Cammaert <pc@denkart.be>

> Cc: Daris A Nevil <dnevil@snmc.com>

> Cc: Russell King <rmk@arm.linux.org.uk>

> Cc: netdev@vger.kernel.org

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

> ---

>  drivers/net/ethernet/smsc/smc91x.c | 2 +-

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

> 

> diff --git a/drivers/net/ethernet/smsc/smc91x.c b/drivers/net/ethernet/smsc/smc91x.c

> index 56c36798cb111..3b90dc065ff2d 100644

> --- a/drivers/net/ethernet/smsc/smc91x.c

> +++ b/drivers/net/ethernet/smsc/smc91x.c

> @@ -2191,7 +2191,7 @@ static const struct of_device_id smc91x_match[] = {

>  MODULE_DEVICE_TABLE(of, smc91x_match);

>  

>  #if defined(CONFIG_GPIOLIB)

> -/**

> +/*

>   * of_try_set_control_gpio - configure a gpio if it exists

>   * @dev: net device

>   * @desc: where to store the GPIO descriptor, if it exists


Hi Lee

This is the wrong fix. The name of the function in the documentation
should be corrected. The rest looks correct.

       Andrew
Lee Jones Nov. 30, 2020, 8:59 a.m. UTC | #2
On Sun, 29 Nov 2020, Andrew Lunn wrote:

> On Thu, Nov 26, 2020 at 01:38:46PM +0000, Lee Jones wrote:

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

> > 

> >  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'dev' not described in 'try_toggle_control_gpio'

> >  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'desc' not described in 'try_toggle_control_gpio'

> >  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'name' not described in 'try_toggle_control_gpio'

> >  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'index' not described in 'try_toggle_control_gpio'

> >  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'value' not described in 'try_toggle_control_gpio'

> >  drivers/net/ethernet/smsc/smc91x.c:2200: warning: Function parameter or member 'nsdelay' not described in 'try_toggle_control_gpio'

> > 

> > Cc: Nicolas Pitre <nico@fluxnic.net>

> > Cc: "David S. Miller" <davem@davemloft.net>

> > Cc: Jakub Kicinski <kuba@kernel.org>

> > Cc: Erik Stahlman <erik@vt.edu>

> > Cc: Peter Cammaert <pc@denkart.be>

> > Cc: Daris A Nevil <dnevil@snmc.com>

> > Cc: Russell King <rmk@arm.linux.org.uk>

> > Cc: netdev@vger.kernel.org

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

> > ---

> >  drivers/net/ethernet/smsc/smc91x.c | 2 +-

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

> > 

> > diff --git a/drivers/net/ethernet/smsc/smc91x.c b/drivers/net/ethernet/smsc/smc91x.c

> > index 56c36798cb111..3b90dc065ff2d 100644

> > --- a/drivers/net/ethernet/smsc/smc91x.c

> > +++ b/drivers/net/ethernet/smsc/smc91x.c

> > @@ -2191,7 +2191,7 @@ static const struct of_device_id smc91x_match[] = {

> >  MODULE_DEVICE_TABLE(of, smc91x_match);

> >  

> >  #if defined(CONFIG_GPIOLIB)

> > -/**

> > +/*

> >   * of_try_set_control_gpio - configure a gpio if it exists

> >   * @dev: net device

> >   * @desc: where to store the GPIO descriptor, if it exists

> 

> Hi Lee

> 

> This is the wrong fix. The name of the function in the documentation

> should be corrected. The rest looks correct.


Yes, you're right.  Will fix.

-- 
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/net/ethernet/smsc/smc91x.c b/drivers/net/ethernet/smsc/smc91x.c
index 56c36798cb111..3b90dc065ff2d 100644
--- a/drivers/net/ethernet/smsc/smc91x.c
+++ b/drivers/net/ethernet/smsc/smc91x.c
@@ -2191,7 +2191,7 @@  static const struct of_device_id smc91x_match[] = {
 MODULE_DEVICE_TABLE(of, smc91x_match);
 
 #if defined(CONFIG_GPIOLIB)
-/**
+/*
  * of_try_set_control_gpio - configure a gpio if it exists
  * @dev: net device
  * @desc: where to store the GPIO descriptor, if it exists