Re: [PATCH] phylink: <linux/phylink.h>: fix function prototype kernel-doc warning

From: Russell King - ARM Linux admin
Date: Mon Aug 17 2020 - 03:27:13 EST


On Sun, Aug 16, 2020 at 09:14:51PM -0700, David Miller wrote:
> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> 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@xxxxxxxxxxxxx>
>
> 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!