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

From: Randy Dunlap
Date: Fri Jun 16 2017 - 17:38:56 EST


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@xxxxxxxxx>

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