mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] drivers: net: phy: Correct kernel-doc comment parameter
@ 2017-06-16 10:19 sayli karnik
  2017-06-16 21:38 ` Randy Dunlap
  0 siblings, 1 reply; 2+ messages in thread
From: sayli karnik @ 2017-06-16 10:19 UTC (permalink / raw)
  To: linux-kernel; +Cc: Andrew Lunn, Florian Fainelli, Jonathan Corbet

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>
---
 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
-- 
2.7.4

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] drivers: net: phy: Correct kernel-doc comment parameter
  2017-06-16 10:19 [PATCH] drivers: net: phy: Correct kernel-doc comment parameter sayli karnik
@ 2017-06-16 21:38 ` Randy Dunlap
  0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2017-06-16 21:38 UTC (permalink / raw)
  To: sayli karnik, linux-kernel; +Cc: Andrew Lunn, Florian Fainelli, Jonathan Corbet

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2017-06-16 21:38 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-06-16 10:19 [PATCH] drivers: net: phy: Correct kernel-doc comment parameter sayli karnik
2017-06-16 21:38 ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®