Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1667624 > unrolled thread

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

Back to article view | Back to linux.kernel

Contents

  [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

#1667624 — [PATCH] drivers: net: phy: Correct kernel-doc comment parameter

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

[toc] | [next] | [standalone]

#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

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web