linux-kernel - Re: [PATCH] drivers: net: phy: Correct kernel-doc comment parameter

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

Date:   Fri, 16 Jun 2017 14:38:43 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     sayli karnik <karniksayli1995@...il.com>,
        linux-kernel@...r.kernel.org
Cc:     Andrew Lunn <andrew@...n.ch>,
        Florian Fainelli <f.fainelli@...il.com>,
        Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] drivers: net: phy: Correct kernel-doc comment parameter

On 06/16/2017 03:19 AM, sayli karnik wrote:
> Correct function parameter in kernel-doc comment to fix following
> warnings in the sphinx build:
> 
> .//drivers/net/phy/phy.c:259: warning: No description found for
> parameter 'features'
> .//drivers/net/phy/phy.c:259: warning: Excess function parameter
> 'feature' description in 'phy_lookup_setting'
> 
> Signed-off-by: sayli karnik <karniksayli1995@...il.com>

Already fixed. See commit 6c6ab3e73b391b38c9749c77775bf21479ed7d60.

What tree did you make this patch against?


> ---
>  drivers/net/phy/phy.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/phy/phy.c b/drivers/net/phy/phy.c
> index 82ab8fb..7524caa 100644
> --- a/drivers/net/phy/phy.c
> +++ b/drivers/net/phy/phy.c
> @@ -241,7 +241,7 @@ static const struct phy_setting settings[] = {
>   * phy_lookup_setting - lookup a PHY setting
>   * @speed: speed to match
>   * @duplex: duplex to match
> - * @feature: allowed link modes
> + * @features: allowed link modes
>   * @exact: an exact match is required
>   *
>   * Search the settings array for a setting that matches the speed and
> 


-- 
~Randy