Skip to contentSkip to conversation

pinctrl: core: Fix kernel doc string for pin_get_name()

PATCH In review Andy Shevchenko 2 participants 2 messages Apr 15, 2021 – Apr 21, 2021

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

PATCH 1/1 pinctrl: core: Fix kernel doc string for pin_get_name()

The kernel doc string mistakenly advertises the pin_get_name_from_id(). Fix it, otherwise kernel doc validator is not happy:

.../core.c:168: warning: expecting prototype for pin_get_name_from_id(). Prototype was for pin_get_name() instead

Fixes dcb5dbc305b9 ("pinctrl: show pin name for pingroups in sysfs")
Cc Dong Aisheng <[email protected]>
---
 drivers/pinctrl/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pinctrl/core.c +1 -1
index 92955c5e0e0b..3d779fd81e7c 100644
@@ -160,7 +160,7 @@ int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name)
 }
 
 /**
- * pin_get_name_from_id() - look up a pin name from a pin id
+ * pin_get_name() - look up a pin name from a pin id
  * @pctldev: the pin control device to lookup the pin on
  * @pin: pin number/id to look up
  */
Signature · 1 line
2.30.2
#1 lore raw
Quoted 8 lines · Andy Shevchenko

The kernel doc string mistakenly advertises the pin_get_name_from_id(). Fix it, otherwise kernel doc validator is not happy:

.../core.c:168: warning: expecting prototype for pin_get_name_from_id(). Prototype was for pin_get_name() instead

Fixes dcb5dbc305b9 ("pinctrl: show pin name for pingroups in sysfs")
Cc Dong Aisheng <[email protected]>

Patch applied, thanks!

Yours,
Linus Walleij