diff mbox series

net: phy: linux/phy.h: fix Excess kernel-doc description warning

Message ID 20231223050613.13978-1-rdunlap@infradead.org
State New
Headers
Series net: phy: linux/phy.h: fix Excess kernel-doc description warning |

Commit Message

Randy Dunlap Dec. 23, 2023, 5:06 a.m. UTC 
  Remove the @phy_timer: line to prevent the kernel-doc warning:

include/linux/phy.h:768: warning: Excess struct member 'phy_timer' description in 'phy_device'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Heiner Kallweit <hkallweit1@gmail.com>
Cc: Russell King <linux@armlinux.org.uk>
Cc: netdev@vger.kernel.org
---
 include/linux/phy.h |    1 -
 1 file changed, 1 deletion(-)

Comments

Russell King (Oracle) Jan. 2, 2024, 11:45 a.m. UTC | #1 
On Fri, Dec 22, 2023 at 09:06:13PM -0800, Randy Dunlap wrote:
> Remove the @phy_timer: line to prevent the kernel-doc warning:
> 
> include/linux/phy.h:768: warning: Excess struct member 'phy_timer' description in 'phy_device'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Andrew Lunn <andrew@lunn.ch>
> Cc: Heiner Kallweit <hkallweit1@gmail.com>
> Cc: Russell King <linux@armlinux.org.uk>
> Cc: netdev@vger.kernel.org
> ---

Reviewed-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>

Thanks!
patchwork-bot+netdevbpf@kernel.org Jan. 2, 2024, 2:20 p.m. UTC | #2 
Hello:

This patch was applied to netdev/net.git (main)
by David S. Miller <davem@davemloft.net>:

On Fri, 22 Dec 2023 21:06:13 -0800 you wrote:
> Remove the @phy_timer: line to prevent the kernel-doc warning:
> 
> include/linux/phy.h:768: warning: Excess struct member 'phy_timer' description in 'phy_device'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Andrew Lunn <andrew@lunn.ch>
> Cc: Heiner Kallweit <hkallweit1@gmail.com>
> Cc: Russell King <linux@armlinux.org.uk>
> Cc: netdev@vger.kernel.org
> 
> [...]

Here is the summary with links:
  - net: phy: linux/phy.h: fix Excess kernel-doc description warning
    https://git.kernel.org/netdev/net/c/059d37b718d3

You are awesome, thank you!
diff mbox series

Patch

diff -- a/include/linux/phy.h b/include/linux/phy.h
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -569,7 +569,6 @@  struct macsec_ops;
  *      - Bits [31:24] are reserved for defining generic
  *        PHY driver behavior.
  * @irq: IRQ number of the PHY's interrupt (-1 if none)
- * @phy_timer: The timer for handling the state machine
  * @phylink: Pointer to phylink instance for this PHY
  * @sfp_bus_attached: Flag indicating whether the SFP bus has been attached
  * @sfp_bus: SFP bus attached to this PHY's fiber port