From: Randy Dunlap <rdunlap@infradead.org>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
Bartosz Golaszewski <bartosz.golaszewski@linaro.org>,
Kent Gibson <warthog618@gmail.com>,
linux-gpio@vger.kernel.org, linux-acpi@vger.kernel.org,
linux-kernel@vger.kernel.org
Cc: Mika Westerberg <mika.westerberg@linux.intel.com>,
Linus Walleij <linus.walleij@linaro.org>,
Bartosz Golaszewski <brgl@bgdev.pl>
Subject: Re: [PATCH v1 1/1] gpiolib: Update the kernel documentation - add Return sections
Date: Thu, 4 Apr 2024 21:10:09 -0700 [thread overview]
Message-ID: <2df0e132-5599-4cb5-93f8-4ed664a5d1cc@infradead.org> (raw)
In-Reply-To: <20240404212706.3587456-1-andriy.shevchenko@linux.intel.com>
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@linux.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@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
--
#Randy
next prev parent reply other threads:[~2024-04-05 4:10 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-04 21:27 [PATCH v1 1/1] gpiolib: Update the kernel documentation - add Return sections Andy Shevchenko
2024-04-05 4:10 ` Randy Dunlap [this message]
2024-04-05 7:23 ` Dan Carpenter
2024-04-05 15:27 ` Andy Shevchenko
2024-04-05 15:33 ` Randy Dunlap
2024-04-05 15:40 ` Andy Shevchenko
2024-04-08 18:21 ` Andy Shevchenko
2024-04-08 21:19 ` Andy Shevchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2df0e132-5599-4cb5-93f8-4ed664a5d1cc@infradead.org \
--to=rdunlap@infradead.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=bartosz.golaszewski@linaro.org \
--cc=brgl@bgdev.pl \
--cc=linus.walleij@linaro.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mika.westerberg@linux.intel.com \
--cc=warthog618@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).