2021-10-26 13:53:50

by Luo Jie

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

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

Signed-off-by: Luo Jie <[email protected]>
---
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


2021-10-26 14:14:13

by Russell King (Oracle)

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

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 <[email protected]>
> ---
> 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) <[email protected]>

Thanks.

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

2021-10-26 16:04:34

by Andrew Lunn

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

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 <[email protected]>

Reviewed-by: Andrew Lunn <[email protected]>

Andrew

2021-10-26 16:38:21

by Luo Jie

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


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 <[email protected]>
>> ---
>> 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) <[email protected]>
>
> Thanks.
>

2021-10-27 11:04:18

by patchwork-bot+netdevbpf

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

Hello:

This patch was applied to netdev/net-next.git (master)
by Jakub Kicinski <[email protected]>:

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 <[email protected]>
> ---
> 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