Netdev Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning
@ 2020-08-16 22:25 Randy Dunlap
2020-08-17 4:14 ` David Miller
0 siblings, 1 reply; 5+ messages in thread
From: Randy Dunlap @ 2020-08-16 22:25 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Russell King, David S . Miller, netdev
Fix a kernel-doc warning for the pcs_config() function prototype:
../include/linux/phylink.h:406: warning: Excess function parameter 'permit_pause_to_mac' description in 'pcs_config'
Fixes: 7137e18f6f88 ("net: phylink: add struct phylink_pcs")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Russell King <linux@armlinux.org.uk>
Cc: David S. Miller <davem@davemloft.net>
Cc: netdev@vger.kernel.org
---
include/linux/phylink.h | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
--- lnx-59-rc1.orig/include/linux/phylink.h
+++ lnx-59-rc1/include/linux/phylink.h
@@ -402,7 +402,8 @@ void pcs_get_state(struct phylink_pcs *p
* For most 10GBASE-R, there is no advertisement.
*/
int pcs_config(struct phylink_pcs *pcs, unsigned int mode,
- phy_interface_t interface, const unsigned long *advertising);
+ phy_interface_t interface, const unsigned long *advertising,
+ bool permit_pause_to_mac);
/**
* pcs_an_restart() - restart 802.3z BaseX autonegotiation
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning
2020-08-16 22:25 [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning Randy Dunlap
@ 2020-08-17 4:14 ` David Miller
2020-08-17 5:43 ` Randy Dunlap
2020-08-17 7:26 ` Russell King - ARM Linux admin
0 siblings, 2 replies; 5+ messages in thread
From: David Miller @ 2020-08-17 4:14 UTC (permalink / raw)
To: rdunlap; +Cc: linux-kernel, linux, netdev
From: Randy Dunlap <rdunlap@infradead.org>
Date: Sun, 16 Aug 2020 15:25:49 -0700
> Fix a kernel-doc warning for the pcs_config() function prototype:
>
> ../include/linux/phylink.h:406: warning: Excess function parameter 'permit_pause_to_mac' description in 'pcs_config'
>
> Fixes: 7137e18f6f88 ("net: phylink: add struct phylink_pcs")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
There's no definition of this function anywhere. Maybe just remove all of
this?
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning
2020-08-17 4:14 ` David Miller
@ 2020-08-17 5:43 ` Randy Dunlap
2020-08-17 18:46 ` David Miller
2020-08-17 7:26 ` Russell King - ARM Linux admin
1 sibling, 1 reply; 5+ messages in thread
From: Randy Dunlap @ 2020-08-17 5:43 UTC (permalink / raw)
To: David Miller; +Cc: linux-kernel, linux, netdev
On 8/16/20 9:14 PM, David Miller wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> Date: Sun, 16 Aug 2020 15:25:49 -0700
>
>> Fix a kernel-doc warning for the pcs_config() function prototype:
>>
>> ../include/linux/phylink.h:406: warning: Excess function parameter 'permit_pause_to_mac' description in 'pcs_config'
>>
>> Fixes: 7137e18f6f88 ("net: phylink: add struct phylink_pcs")
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>
> There's no definition of this function anywhere. Maybe just remove all of
> this?
>
It's for documentation purposes...
It's a "method" (callback) function.
--
~Randy
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning
2020-08-17 4:14 ` David Miller
2020-08-17 5:43 ` Randy Dunlap
@ 2020-08-17 7:26 ` Russell King - ARM Linux admin
1 sibling, 0 replies; 5+ messages in thread
From: Russell King - ARM Linux admin @ 2020-08-17 7:26 UTC (permalink / raw)
To: David Miller; +Cc: rdunlap, linux-kernel, netdev
On Sun, Aug 16, 2020 at 09:14:51PM -0700, David Miller wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> Date: Sun, 16 Aug 2020 15:25:49 -0700
>
> > Fix a kernel-doc warning for the pcs_config() function prototype:
> >
> > ../include/linux/phylink.h:406: warning: Excess function parameter 'permit_pause_to_mac' description in 'pcs_config'
> >
> > Fixes: 7137e18f6f88 ("net: phylink: add struct phylink_pcs")
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>
> There's no definition of this function anywhere. Maybe just remove all of
> this?
This is kerneldoc documentation for the PCS methods - there's no other
way to document the method parameters than to use "fake" function
prototypes.
--
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTP is here! 40Mbps down 10Mbps up. Decent connectivity at last!
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning
2020-08-17 5:43 ` Randy Dunlap
@ 2020-08-17 18:46 ` David Miller
0 siblings, 0 replies; 5+ messages in thread
From: David Miller @ 2020-08-17 18:46 UTC (permalink / raw)
To: rdunlap; +Cc: linux-kernel, linux, netdev
From: Randy Dunlap <rdunlap@infradead.org>
Date: Sun, 16 Aug 2020 22:43:54 -0700
> On 8/16/20 9:14 PM, David Miller wrote:
>> From: Randy Dunlap <rdunlap@infradead.org>
>> Date: Sun, 16 Aug 2020 15:25:49 -0700
>>
>>> Fix a kernel-doc warning for the pcs_config() function prototype:
>>>
>>> ../include/linux/phylink.h:406: warning: Excess function parameter 'permit_pause_to_mac' description in 'pcs_config'
>>>
>>> Fixes: 7137e18f6f88 ("net: phylink: add struct phylink_pcs")
>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>
>> There's no definition of this function anywhere. Maybe just remove all of
>> this?
>>
>
> It's for documentation purposes...
>
> It's a "method" (callback) function.
I see, that's an unfortunate shortcoming of kerneldoc.
Applied, thanks.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-08-17 18:46 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-16 22:25 [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning Randy Dunlap
2020-08-17 4:14 ` David Miller
2020-08-17 5:43 ` Randy Dunlap
2020-08-17 18:46 ` David Miller
2020-08-17 7:26 ` Russell King - ARM Linux admin
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).