Skip to contentSkip to conversation

drivers: net: phy: Correct kernel-doc comment parameter

PATCH In review sayli karnik 2 participants 2 messages Jun 16, 2017

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

PATCH 1/1 drivers: net: phy: Correct kernel-doc comment parameter

Correct function parameter in kernel-doc comment to fix following warnings in the sphinx build:

.//drivers/net/phy/phy.c:259: warning: No description found for parameter 'features'
.//drivers/net/phy/phy.c:259: warning: Excess function parameter 'feature' description in 'phy_lookup_setting'

---
 drivers/net/phy/phy.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/phy/phy.c +1 -1
index 82ab8fb..7524caa 100644
@@ -241,7 +241,7 @@ static const struct phy_setting settings[] = {
  * phy_lookup_setting - lookup a PHY setting
  * @speed: speed to match
  * @duplex: duplex to match
- * @feature: allowed link modes
+ * @features: allowed link modes
  * @exact: an exact match is required
  *
  * Search the settings array for a setting that matches the speed and
Signature · 1 line
2.7.4
#1 lore raw
Quoted 9 lines · sayli karnik

Correct function parameter in kernel-doc comment to fix following warnings in the sphinx build:

.//drivers/net/phy/phy.c:259: warning: No description found for parameter 'features'
.//drivers/net/phy/phy.c:259: warning: Excess function parameter 'feature' description in 'phy_lookup_setting'

Already fixed. See commit 6c6ab3e73b391b38c9749c77775bf21479ed7d60.

What tree did you make this patch against?

Quoted 18 lines
---
 drivers/net/phy/phy.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/phy/phy.c +1 -1
index 82ab8fb..7524caa 100644
@@ -241,7 +241,7 @@ static const struct phy_setting settings[] = {
  * phy_lookup_setting - lookup a PHY setting
  * @speed: speed to match
  * @duplex: duplex to match
- * @feature: allowed link modes
+ * @features: allowed link modes
  * @exact: an exact match is required
  *
  * Search the settings array for a setting that matches the speed and
Signature · 1 line
~Randy