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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-Id: <20200817.114629.1895503086750807628.davem@davemloft.net>
Date:   Mon, 17 Aug 2020 11:46:29 -0700 (PDT)
From:   David Miller <davem@...emloft.net>
To:     rdunlap@...radead.org
Cc:     linux-kernel@...r.kernel.org, linux@...linux.org.uk,
        netdev@...r.kernel.org
Subject: Re: [PATCH] phylink: <linux/phylink.h>: fix function prototype
 kernel-doc warning

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

> On 8/16/20 9:14 PM, David Miller wrote:
>> From: Randy Dunlap <rdunlap@...radead.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@...radead.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.