From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: Chen-Yu Tsai <wenst@chromium.org>
Cc: Mark Brown <broonie@kernel.org>,
Liam Girdwood <lgirdwood@gmail.com>,
linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH v2 05/10] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections
Date: Thu, 29 Aug 2024 15:48:37 +0300 [thread overview]
Message-ID: <ZtBuJbQozUnp6z_0@smile.fi.intel.com> (raw)
In-Reply-To: <20240829085131.1361701-6-wenst@chromium.org>
On Thu, Aug 29, 2024 at 04:51:25PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for many documented
> functions in the regulator OF-specific code. These all have descriptions
> about the return values, just not in the format kernel-doc wants.
>
> Convert these to use the proper "Return:" section header. The existing
> descriptions have been reworded and moved around to fit the grammar and
> formatting.
...
> - * Returns true if all conditions are met.
> + * Return: True if all conditions are met; false otherwise.
You used %NULL elsewhere, so this also can use references to the boolean
constants.
* Return: %true if all conditions are met; %false otherwise.
--
With Best Regards,
Andy Shevchenko
next prev parent reply other threads:[~2024-08-29 12:48 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-29 8:51 [PATCH v2 00/10] regulator: kerneldoc section fixes Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 01/10] regulator: core: Fix short description for _regulator_check_status_enabled() Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 02/10] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value Chen-Yu Tsai
2024-08-29 12:46 ` Andy Shevchenko
2024-08-29 22:59 ` Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 03/10] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 04/10] regulator: core: Add missing " Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 05/10] regulator: of: Fix incorrectly formatted " Chen-Yu Tsai
2024-08-29 12:48 ` Andy Shevchenko [this message]
2024-08-29 8:51 ` [PATCH v2 06/10] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 07/10] regulator: fixed-helper: Add missing "Return" kerneldoc section Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 08/10] regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc Chen-Yu Tsai
2024-08-29 12:49 ` Andy Shevchenko
2024-08-29 8:51 ` [PATCH v2 09/10] regulator: of: Fix kerneldoc format for of_regulator_bulk_get_all() Chen-Yu Tsai
2024-08-29 8:51 ` [PATCH v2 10/10] regulator: Unify "negative error number" terminology in comments Chen-Yu Tsai
2024-08-29 12:54 ` [PATCH v2 00/10] regulator: kerneldoc section fixes Andy Shevchenko
2024-08-29 16:07 ` Mark Brown
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=ZtBuJbQozUnp6z_0@smile.fi.intel.com \
--to=andriy.shevchenko@linux.intel.com \
--cc=broonie@kernel.org \
--cc=lgirdwood@gmail.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=wenst@chromium.org \
/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
all inboxes | Powered by JetHome®