diff mbox series

net: phy: fix kernel-doc for .config_intr()

Message ID 20201215083751.628794-1-ciorneiioana@gmail.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series net: phy: fix kernel-doc for .config_intr() | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Ioana Ciornei Dec. 15, 2020, 8:37 a.m. UTC 
From: Ioana Ciornei <ioana.ciornei@nxp.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@nxp.com>
---
 include/linux/phy.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Ioana Ciornei Dec. 15, 2020, 8:42 a.m. UTC | #1 
On Tue, Dec 15, 2020 at 10:37:51AM +0200, Ioana Ciornei wrote:
> From: Ioana Ciornei <ioana.ciornei@nxp.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@nxp.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
>
Jakub Kicinski Dec. 15, 2020, 6:09 p.m. UTC | #2 
On Tue, 15 Dec 2020 10:42:40 +0200 Ioana Ciornei wrote:
> On Tue, Dec 15, 2020 at 10:37:51AM +0200, Ioana Ciornei wrote:
> > From: Ioana Ciornei <ioana.ciornei@nxp.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@nxp.com>  
> 
> Sorry, I just realized that Jakub already sent a fix for this:
> 
> https://lore.kernel.org/netdev/20201215063750.3120976-1-kuba@kernel.org/

Bad timing :) Sorry for not CCing you
diff mbox series

Patch

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.
 	 */