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

[Lee Jones]

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@xxxxxxxxxxx>
> > Cc: "David S. Miller" <davem@xxxxxxxxxxxxx>
> > Cc: Jakub Kicinski <kuba@xxxxxxxxxx>
> > Cc: Erik Stahlman <erik@xxxxxx>
> > Cc: Peter Cammaert <pc@xxxxxxxxxx>
> > Cc: Daris A Nevil <dnevil@xxxxxxxx>
> > Cc: Russell King <rmk@xxxxxxxxxxxxxxxx>
> > Cc: netdev@xxxxxxxxxxxxxxx
> > Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> > ---
> >  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