Path: csiph.com!news.redatomik.org!aioe.org!bofh.it!news.nic.it!robomod
From: Randy Dunlap <rdunlap@infradead.org>
Newsgroups: linux.kernel
Subject: Re: [PATCH] drivers: net: phy: Correct kernel-doc comment parameter
Date: Fri, 16 Jun 2017 23:40:02 +0200
Message-ID: <tT78e-5MB-11@gated-at.bofh.it>
References: <tSWFQ-7co-35@gated-at.bofh.it>
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.1.1
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Sender: robomod@news.nic.it
Approved: robomod@news.nic.it
Lines: 38
Organization: linux.* mail to news gateway
Xref: csiph.com linux.kernel:1668072

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@gmail.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