Skip to contentSkip to conversation

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

PATCH In review Ioana Ciornei 2 participants 3 messages Dec 15, 2020

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

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

From: Ioana Ciornei <[email protected]>

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")
---
 include/linux/phy.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
include/linux/phy.h +2 -1
index 381a95732b6a..9effb511acde 100644
@@ -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.
 	 */
Signature · 1 line
2.28.0
#1 lore raw
Quoted 9 lines · Ioana Ciornei

From: Ioana Ciornei <[email protected]>

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")

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

https://lore.kernel.org/netdev/[email protected]/

Ioana

Quoted 21 lines
---
 include/linux/phy.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
include/linux/phy.h +2 -1
index 381a95732b6a..9effb511acde 100644
@@ -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.
 	 */
Signature · 1 line
2.28.0
maintainer
#2 lore raw
Quoted 6 lines · On Tue, 15 Dec 2020 10:42:40 +0200 Ioana Ciornei wrote:
Quoted 5 lines · Ioana Ciornei

From: Ioana Ciornei <[email protected]>

Fix the kernel-doc for .config_intr() so that we do not trigger a warning like below.

Quoted 8 lines
Quoted 4 lines

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")

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

https://lore.kernel.org/netdev/[email protected]/

Bad timing :) Sorry for not CCing you