| Message ID | 20220519212645.47177-1-andriy.shevchenko@linux.intel.com |
|---|---|
| State | New |
| Headers | show |
| Series | [v1,1/1] pinctrl: intel: Fix kernel doc format, i.e. add return sections | expand |
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>
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!
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) {
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(+)