From: Chen-Yu Tsai <wenst@chromium.org>
To: Mark Brown <broonie@kernel.org>, Liam Girdwood <lgirdwood@gmail.com>
Cc: Chen-Yu Tsai <wenst@chromium.org>,
linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Subject: [PATCH v2 09/10] regulator: of: Fix kerneldoc format for of_regulator_bulk_get_all()
Date: Thu, 29 Aug 2024 16:51:29 +0800 [thread overview]
Message-ID: <20240829085131.1361701-10-wenst@chromium.org> (raw)
In-Reply-To: <20240829085131.1361701-1-wenst@chromium.org>
of_regulator_bulk_get_all() has a comment section that pretty much
resembles a kerneldoc block, except that the block begins with "/*"
instead of "/**".
Fix that and also rework the "Return" section and the error code
terminology so that it is the same as the other kerneldoc blocks
in the same file.
Fixes: 27b9ecc7a9ba ("regulator: Add of_regulator_bulk_get_all")
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
Changes since v1:
- New patch
---
drivers/regulator/of_regulator.c | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c
index dfa9f42d4629..cec8c3647a00 100644
--- a/drivers/regulator/of_regulator.c
+++ b/drivers/regulator/of_regulator.c
@@ -737,20 +737,21 @@ static int is_supply_name(const char *name)
return 0;
}
-/*
+/**
* of_regulator_bulk_get_all - get multiple regulator consumers
*
* @dev: Device to supply
* @np: device node to search for consumers
* @consumers: Configuration of consumers; clients are stored here.
*
- * @return number of regulators on success, an errno on failure.
- *
* This helper function allows drivers to get several regulator
* consumers in one operation. If any of the regulators cannot be
* acquired then any regulators that were allocated will be freed
* before returning to the caller, and @consumers will not be
* changed.
+ *
+ * Return: Number of regulators on success, or a negative error number
+ * on failure.
*/
int of_regulator_bulk_get_all(struct device *dev, struct device_node *np,
struct regulator_bulk_data **consumers)
--
2.46.0.295.g3b9ea8a38a-goog
next prev parent reply other threads:[~2024-08-29 8:52 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
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 ` Chen-Yu Tsai [this message]
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=20240829085131.1361701-10-wenst@chromium.org \
--to=wenst@chromium.org \
--cc=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 \
/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®