Re: [PATCH] net: phy: fixed warning: Function parameter not described

[Russell King (Oracle)]

On Tue, Oct 26, 2021 at 06:29:57PM +0800, Luo Jie wrote:
> Fixed warning: Function parameter or member 'enable' not
> described in 'genphy_c45_fast_retrain'
> 
> Signed-off-by: Luo Jie <luoj@xxxxxxxxxxxxxx>
> ---
>  drivers/net/phy/phy-c45.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/net/phy/phy-c45.c b/drivers/net/phy/phy-c45.c
> index b01180e1f578..db709d30bf84 100644
> --- a/drivers/net/phy/phy-c45.c
> +++ b/drivers/net/phy/phy-c45.c
> @@ -614,6 +614,7 @@ EXPORT_SYMBOL_GPL(genphy_c45_loopback);
>  /**
>   * genphy_c45_fast_retrain - configure fast retrain registers
>   * @phydev: target phy_device struct
> + * @enable: enable fast retrain or not
>   *
>   * Description: If fast-retrain is enabled, we configure PHY as
>   *   advertising fast retrain capable and THP Bypass Request, then

Patch itself is fine, but I wonder why we've started getting
Description: prefixes on new functions in this file whereas the
bulk of the descriptions in the file do not use that prefix.

In any case, for this patch:

Reviewed-by: Russell King (Oracle) <rmk+kernel@xxxxxxxxxxxxxxx>

Thanks.

-- 
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTP is here! 40Mbps down 10Mbps up. Decent connectivity at last!