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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200817072633.GX1551@shell.armlinux.org.uk>
Date:   Mon, 17 Aug 2020 08:26:33 +0100
From:   Russell King - ARM Linux admin <linux@...linux.org.uk>
To:     David Miller <davem@...emloft.net>
Cc:     rdunlap@...radead.org, linux-kernel@...r.kernel.org,
        netdev@...r.kernel.org
Subject: Re: [PATCH] phylink: <linux/phylink.h>: fix function prototype
 kernel-doc warning

On Sun, Aug 16, 2020 at 09:14:51PM -0700, 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?

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!