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

From: David Miller
Date: Mon Aug 17 2020 - 14:46:50 EST


From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Date: Sun, 16 Aug 2020 22:43:54 -0700

> On 8/16/20 9:14 PM, 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?
>>
>
> It's for documentation purposes...
>
> It's a "method" (callback) function.

I see, that's an unfortunate shortcoming of kerneldoc.

Applied, thanks.