* [PATCH v1 1/1] pinctrl: intel: Fix kernel doc format, i.e. add return sections
@ 2022-05-19 21:26 Andy Shevchenko
2022-05-20 8:57 ` Mika Westerberg
0 siblings, 1 reply; 3+ messages in thread
From: Andy Shevchenko @ 2022-05-19 21:26 UTC (permalink / raw)
To: Andy Shevchenko, linux-gpio, linux-kernel
Cc: Mika Westerberg, Andy Shevchenko, Linus Walleij
Kernel doc validator is not happy:
pinctrl-intel.c:865: warning: No description found for return value of 'intel_gpio_to_pin'
pinctrl-intel.c:904: warning: No description found for return value of 'intel_pin_to_gpio'
2 warnings
Add return sections to the kernel documentation of the above mentioned
functions.
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
drivers/pinctrl/intel/pinctrl-intel.c | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/drivers/pinctrl/intel/pinctrl-intel.c b/drivers/pinctrl/intel/pinctrl-intel.c
index f882a31375ee..ffc045f7bf00 100644
--- a/drivers/pinctrl/intel/pinctrl-intel.c
+++ b/drivers/pinctrl/intel/pinctrl-intel.c
@@ -858,6 +858,9 @@ static const struct pinctrl_desc intel_pinctrl_desc = {
* When coming through gpiolib irqchip, the GPIO offset is not
* automatically translated to pinctrl pin number. This function can be
* used to find out the corresponding pinctrl pin.
+ *
+ * Return: a pin number and pointers to the community and pad group, which
+ * the pin belongs to, or negative error code if translation can't be done.
*/
static int intel_gpio_to_pin(struct intel_pinctrl *pctrl, unsigned int offset,
const struct intel_community **community,
@@ -899,6 +902,8 @@ static int intel_gpio_to_pin(struct intel_pinctrl *pctrl, unsigned int offset,
* @pin: pin number
*
* Translate the pin number of pinctrl to GPIO offset
+ *
+ * Return: a GPIO offset, or negative error code if translation can't be done.
*/
static __maybe_unused int intel_pin_to_gpio(struct intel_pinctrl *pctrl, int pin)
{
--
2.35.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v1 1/1] pinctrl: intel: Fix kernel doc format, i.e. add return sections
2022-05-19 21:26 [PATCH v1 1/1] pinctrl: intel: Fix kernel doc format, i.e. add return sections Andy Shevchenko
@ 2022-05-20 8:57 ` Mika Westerberg
2022-05-20 14:13 ` Andy Shevchenko
0 siblings, 1 reply; 3+ messages in thread
From: Mika Westerberg @ 2022-05-20 8:57 UTC (permalink / raw)
To: Andy Shevchenko; +Cc: linux-gpio, linux-kernel, Andy Shevchenko, Linus Walleij
On Fri, May 20, 2022 at 12:26:45AM +0300, Andy Shevchenko wrote:
> Kernel doc validator is not happy:
>
> pinctrl-intel.c:865: warning: No description found for return value of 'intel_gpio_to_pin'
> pinctrl-intel.c:904: warning: No description found for return value of 'intel_pin_to_gpio'
> 2 warnings
>
> Add return sections to the kernel documentation of the above mentioned
> functions.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v1 1/1] pinctrl: intel: Fix kernel doc format, i.e. add return sections
2022-05-20 8:57 ` Mika Westerberg
@ 2022-05-20 14:13 ` Andy Shevchenko
0 siblings, 0 replies; 3+ messages in thread
From: Andy Shevchenko @ 2022-05-20 14:13 UTC (permalink / raw)
To: Mika Westerberg; +Cc: linux-gpio, linux-kernel, Andy Shevchenko, Linus Walleij
On Fri, May 20, 2022 at 11:57:44AM +0300, Mika Westerberg wrote:
> On Fri, May 20, 2022 at 12:26:45AM +0300, Andy Shevchenko wrote:
> > Kernel doc validator is not happy:
> >
> > pinctrl-intel.c:865: warning: No description found for return value of 'intel_gpio_to_pin'
> > pinctrl-intel.c:904: warning: No description found for return value of 'intel_pin_to_gpio'
> > 2 warnings
> >
> > Add return sections to the kernel documentation of the above mentioned
> > functions.
> >
> > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
>
> Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Pushed to my review and testing queue, thanks!
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-05-20 14:13 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-05-19 21:26 [PATCH v1 1/1] pinctrl: intel: Fix kernel doc format, i.e. add return sections Andy Shevchenko
2022-05-20 8:57 ` Mika Westerberg
2022-05-20 14:13 ` Andy Shevchenko
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.