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

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> (permalink)
References	<tSWFQ-7co-35@gated-at.bofh.it>
X-Original-To	sayli karnik <karniksayli1995@gmail.com>, linux-kernel@vger.kernel.org
Dkim-Signature	v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=merlin.20170209; h=Content-Transfer-Encoding:Content-Type: In-Reply-To:MIME-Version:Date:Message-ID:From:References:Cc:To:Subject:Sender :Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=R9/pGAp9v+SfpohocHnVKLg/OJ9Xz72pLxE0KLzpCRc=; b=3bQNBQAw6YNv4nHpl/O4Jg7dix dzXP6AIukvUduBZF6e7xuSW17BfArmJnRkMBS8ziYJjiV15hFCf+xDVYuZ5KCRLaTdy3M3UxDKWeQ dEsxPzL2mg+0TAJ7Wg9qfVBVrCYXjgu8m39d/uhhQ1XN3O0TWzVxvOQtGEO0L8PU83c5xoYVL3zRz DUK0KCsV4mkOr49nKODTXCY5rMu51mhgl0639CYASasoE7owCnQ27Q7+vISUoI+ySLbtbcX9Nmlji wbosRn32vsnkqj1yzI+25KfB1ekrwOZAcJJuY/yKraiqFUsndHlP6sa+88cisy4f/9D23FgnGbwdW 3YnAdzLg==;
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
List-ID	<linux-kernel.vger.kernel.org>
X-Mailing-List	linux-kernel@vger.kernel.org
Approved	robomod@news.nic.it
Lines	38
Organization	linux.* mail to news gateway
X-Original-Cc	Andrew Lunn <andrew@lunn.ch>, Florian Fainelli <f.fainelli@gmail.com>, Jonathan Corbet <corbet@lwn.net>
X-Original-Date	Fri, 16 Jun 2017 14:38:43 -0700
X-Original-Message-ID	<59a054b1-3d19-cc51-ec59-75f248f97a03@infradead.org>
X-Original-References	<20170616101943.GA2964@sayli-HP-15-Notebook-PC>
X-Original-Sender	linux-kernel-owner@vger.kernel.org
Xref	csiph.com linux.kernel:1668072

Show key headers only | View raw

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

Back to linux.kernel | Previous | Next — Previous in thread | Find similar | Unroll thread

Thread

[PATCH] drivers: net: phy: Correct kernel-doc comment parameter sayli karnik <karniksayli1995@gmail.com> - 2017-06-16 12:30 +0200
  Re: [PATCH] drivers: net: phy: Correct kernel-doc comment parameter Randy Dunlap <rdunlap@infradead.org> - 2017-06-16 23:40 +0200

csiph-web