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

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

[Luo Jie]

Fixed warning: Function parameter or member 'enable' not
described in 'genphy_c45_fast_retrain'

Signed-off-by: Luo Jie <luoj@codeaurora.org>
---
 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
-- 
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project

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@codeaurora.org>
> ---
>  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@armlinux.org.uk>

Thanks.

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

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

[Jie Luo]

On 10/26/2021 6:35 PM, Russell King (Oracle) wrote:
> 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@codeaurora.org>
>> ---
>>   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.

Thanks Russell for the review. i see the prefix "Description" is also 
used in the

file phy.c.

> In any case, for this patch:
>
> Reviewed-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
>
> Thanks.
>

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

[Andrew Lunn]

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@codeaurora.org>

Reviewed-by: Andrew Lunn <andrew@lunn.ch>

    Andrew

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

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (master)
by Jakub Kicinski <kuba@kernel.org>:

On Tue, 26 Oct 2021 18:29:57 +0800 you wrote:
> Fixed warning: Function parameter or member 'enable' not
> described in 'genphy_c45_fast_retrain'
> 
> Signed-off-by: Luo Jie <luoj@codeaurora.org>
> ---
>  drivers/net/phy/phy-c45.c | 1 +
>  1 file changed, 1 insertion(+)

Here is the summary with links:
  - net: phy: fixed warning: Function parameter not described
    https://git.kernel.org/netdev/net-next/c/06338ceff925

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html