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

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

Message-ID: <20201129183309.GH2234159@lunn.ch>
Date:   Sun, 29 Nov 2020 19:33:09 +0100
From:   Andrew Lunn <andrew@...n.ch>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     linux-kernel@...r.kernel.org, Nicolas Pitre <nico@...xnic.net>,
        "David S. Miller" <davem@...emloft.net>,
        Jakub Kicinski <kuba@...nel.org>, Erik Stahlman <erik@...edu>,
        Peter Cammaert <pc@...kart.be>,
        Daris A Nevil <dnevil@...c.com>,
        Russell King <rmk@....linux.org.uk>, netdev@...r.kernel.org
Subject: Re: [PATCH 1/8] net: ethernet: smsc: smc91x: Demote non-conformant
 kernel function header

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@...xnic.net>
> Cc: "David S. Miller" <davem@...emloft.net>
> Cc: Jakub Kicinski <kuba@...nel.org>
> Cc: Erik Stahlman <erik@...edu>
> Cc: Peter Cammaert <pc@...kart.be>
> Cc: Daris A Nevil <dnevil@...c.com>
> Cc: Russell King <rmk@....linux.org.uk>
> Cc: netdev@...r.kernel.org
> Signed-off-by: Lee Jones <lee.jones@...aro.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