linux-kernel - Re: [PATCH v1 1/1] gpiolib: Update the kernel documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <2df0e132-5599-4cb5-93f8-4ed664a5d1cc@infradead.org>
Date: Thu, 4 Apr 2024 21:10:09 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
 Bartosz Golaszewski <bartosz.golaszewski@...aro.org>,
 Kent Gibson <warthog618@...il.com>, linux-gpio@...r.kernel.org,
 linux-acpi@...r.kernel.org, linux-kernel@...r.kernel.org
Cc: Mika Westerberg <mika.westerberg@...ux.intel.com>,
 Linus Walleij <linus.walleij@...aro.org>, Bartosz Golaszewski <brgl@...ev.pl>
Subject: Re: [PATCH v1 1/1] gpiolib: Update the kernel documentation - add
 Return sections

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@...ux.intel.com>
> ---
>  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@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.
-- 
#Randy