Skip to contentSkip to conversation

net: sfp: fix sfp_bus_put() kernel documentation

PATCH Applied Russell King 3 participants 3 messages Nov 10, 2019 – Nov 12, 2019

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

PATCH 1/1 net: sfp: fix sfp_bus_put() kernel documentation

The kbuild test robot found a problem with htmldocs with the recent change to the SFP interfaces. Fix the kernel documentation for sfp_bus_put() which was missing an '@' before the argument name description.

Fixes 727b3668b730 ("net: sfp: rework upstream interface")
---
 drivers/net/phy/sfp-bus.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/phy/sfp-bus.c +1 -1
index 715d45214e18..c5398a023440 100644
@@ -331,7 +331,7 @@ static void sfp_bus_release(struct kref *kref)
 
 /**
  * sfp_bus_put() - put a reference on the &struct sfp_bus
- * bus: the &struct sfp_bus found via sfp_bus_find_fwnode()
+ * @bus: the &struct sfp_bus found via sfp_bus_find_fwnode()
  *
  * Put a reference on the &struct sfp_bus and free the underlying structure
  * if this was the last reference.
Signature · 1 line
2.20.1
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 7 lines · Russell King

The kbuild test robot found a problem with htmldocs with the recent change to the SFP interfaces. Fix the kernel documentation for sfp_bus_put() which was missing an '@' before the argument name description.

Fixes 727b3668b730 ("net: sfp: rework upstream interface")

Andrew

maintainer Applied
#2 lore raw
In reply to Russell King

From: Russell King <[email protected]>
Date: Sun, 10 Nov 2019 14:04:11 +0000

Quoted 7 lines

The kbuild test robot found a problem with htmldocs with the recent change to the SFP interfaces. Fix the kernel documentation for sfp_bus_put() which was missing an '@' before the argument name description.

Fixes 727b3668b730 ("net: sfp: rework upstream interface")

Applied to net-next.

Please mark the target tree in your Subj, thank you :-)