netdev - Re: [PATCH] net: phy: fix kernel-doc for .config

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20201215084240.lgg7tcq5tgbufqfr@skbuf>
Date:   Tue, 15 Dec 2020 10:42:40 +0200
From:   Ioana Ciornei <ciorneiioana@...il.com>
To:     Ioana Ciornei <ciorneiioana@...il.com>
Cc:     davem@...emloft.net, kuba@...nel.org, netdev@...r.kernel.org,
        sfr@...b.auug.org.au, linux-next@...r.kernel.org,
        Ioana Ciornei <ioana.ciornei@....com>
Subject: Re: [PATCH] net: phy: fix kernel-doc for .config_intr()

On Tue, Dec 15, 2020 at 10:37:51AM +0200, Ioana Ciornei wrote:
> From: Ioana Ciornei <ioana.ciornei@....com>
> 
> Fix the kernel-doc for .config_intr() so that we do not trigger a
> warning like below.
> 
> include/linux/phy.h:869: warning: Function parameter or member 'config_intr' not described in 'phy_driver'
> 
> Fixes: 6527b938426f ("net: phy: remove the .did_interrupt() and .ack_interrupt() callback")
> Signed-off-by: Ioana Ciornei <ioana.ciornei@....com>

Sorry, I just realized that Jakub already sent a fix for this:

https://lore.kernel.org/netdev/20201215063750.3120976-1-kuba@kernel.org/

Ioana


> ---
>  include/linux/phy.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/include/linux/phy.h b/include/linux/phy.h
> index 381a95732b6a..9effb511acde 100644
> --- a/include/linux/phy.h
> +++ b/include/linux/phy.h
> @@ -743,7 +743,8 @@ struct phy_driver {
>  	/** @read_status: Determines the negotiated speed and duplex */
>  	int (*read_status)(struct phy_device *phydev);
>  
> -	/** @config_intr: Enables or disables interrupts.
> +	/**
> +	 * @config_intr: Enables or disables interrupts.
>  	 * It should also clear any pending interrupts prior to enabling the
>  	 * IRQs and after disabling them.
>  	 */
> -- 
> 2.28.0
>