Re: [PATCH v1 1/1] gpiolib: Update the kernel documentation - add Return sections

From: Randy Dunlap
Date: Fri Apr 05 2024 - 00:10:25 EST


Hi,

On 4/4/24 2:27 PM, Andy Shevchenko wrote:
> $ scripts/kernel-doc -v -none -Wall drivers/gpio/gpiolib* 2>&1 | grep -w warning | wc -l
> 67
>
> Fix these by adding Return sections. While at it, make sure all of
> Return sections use the same style.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
> ---
> drivers/gpio/gpiolib-acpi.c | 22 +++--
> drivers/gpio/gpiolib-cdev.c | 8 +-
> drivers/gpio/gpiolib-devres.c | 44 +++++++++-
> drivers/gpio/gpiolib-legacy.c | 3 +
> drivers/gpio/gpiolib-of.c | 48 ++++++++---
> drivers/gpio/gpiolib-swnode.c | 4 +-
> drivers/gpio/gpiolib-sysfs.c | 6 +-
> drivers/gpio/gpiolib.c | 157 +++++++++++++++++++++++++++-------
> 8 files changed, 233 insertions(+), 59 deletions(-)


I would use %true, %false, %NULL, %0, and %1 in a few places.

s/error-code/error code/
or
s/error-code/errno/

I would s/active-low/active low/


or it can just be merged as is. It's a nice improvement.



Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.
--
#Randy