[v1,1/1] pinctrl: core: Fix kernel doc string for pin_get_name()

Message ID 20210415123521.86894-1-andriy.shevchenko@linux.intel.com
State New
Headers show
Series
  • [v1,1/1] pinctrl: core: Fix kernel doc string for pin_get_name()
Related show

Commit Message

Andy Shevchenko April 15, 2021, 12:35 p.m.
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 <dong.aisheng@linaro.org>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/pinctrl/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Linus Walleij April 21, 2021, 11:56 p.m. | #1
On Thu, Apr 15, 2021 at 2:35 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:

> 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 <dong.aisheng@linaro.org>

> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>


Patch applied, thanks!

Yours,
Linus Walleij

Patch

diff --git a/drivers/pinctrl/core.c b/drivers/pinctrl/core.c
index 92955c5e0e0b..3d779fd81e7c 100644
--- a/drivers/pinctrl/core.c
+++ b/drivers/pinctrl/core.c
@@ -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
  */