public inbox for linux-clk@vger.kernel.org
 help / color / mirror / Atom feed
From: Markus Schneider-Pargmann <msp@baylibre.com>
To: Russell King <linux@armlinux.org.uk>
Cc: linux-clk@vger.kernel.org, Markus Schneider-Pargmann <msp@baylibre.com>
Subject: [PATCH] clk: Fix *bulk_get* return value documentation
Date: Wed, 11 Aug 2021 09:57:19 +0200	[thread overview]
Message-ID: <20210811075719.1716886-1-msp@baylibre.com> (raw)

Some of the bulk_get variants document that the return value is a valid
IS_ERR() condition but it is not. These functions return an errno
directly if an error occures.

This patch fixes that documentation and documents that the return value
is 0 or errno.

Signed-off-by: Markus Schneider-Pargmann <msp@baylibre.com>
---
 include/linux/clk.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/linux/clk.h b/include/linux/clk.h
index 266e8de3cb51..56a741903963 100644
--- a/include/linux/clk.h
+++ b/include/linux/clk.h
@@ -340,7 +340,7 @@ struct clk *clk_get(struct device *dev, const char *id);
  * that were obtained will be freed before returning to the caller.
  *
  * Returns 0 if all clocks specified in clk_bulk_data table are obtained
- * successfully, or valid IS_ERR() condition containing errno.
+ * successfully, or an errno otherwise.
  * The implementation uses @dev and @clk_bulk_data.id to determine the
  * clock consumer, and thereby the clock producer.
  * The clock returned is stored in each @clk_bulk_data.clk field.
@@ -409,8 +409,8 @@ int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
  * NULL for given clk. It is assumed all clocks in clk_bulk_data are optional.
  *
  * Returns 0 if all clocks specified in clk_bulk_data table are obtained
- * successfully or for any clk there was no clk provider available, otherwise
- * returns valid IS_ERR() condition containing errno.
+ * successfully or for any clk there was no clk provider available, or an errno
+ * otherwise.
  * The implementation uses @dev and @clk_bulk_data.id to determine the
  * clock consumer, and thereby the clock producer.
  * The clock returned is stored in each @clk_bulk_data.clk field.
-- 
2.32.0


             reply	other threads:[~2021-08-11  7:57 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-11  7:57 Markus Schneider-Pargmann [this message]
2021-08-12 19:25 ` [PATCH] clk: Fix *bulk_get* return value documentation Stephen Boyd
2021-08-17  7:26   ` Markus Schneider-Pargmann

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=20210811075719.1716886-1-msp@baylibre.com \
    --to=msp@baylibre.com \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux@armlinux.org.uk \
    /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