mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Thierry Reding <thierry.reding@gmail.com>
To: Michael Turquette <mturquette@baylibre.com>,
	Stephen Boyd <sboyd@kernel.org>
Cc: linux-clk@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] clk: Make kerneldoc consistent
Date: Thu, 27 Aug 2020 17:28:27 +0200	[thread overview]
Message-ID: <20200827152827.1661050-1-thierry.reding@gmail.com> (raw)

From: Thierry Reding <treding@nvidia.com>

The kerneldoc comment for of_parse_clkspec() mentions in one place that
the value of the index parameter dictates how name is used, whereas in
reality it's the name parameter that dictates whether or not the index
parameter is used.

In a later paragraph the kerneldoc comment does mention that the index
will be ignored if the name is non-NULL, so make the parameter
description consistent.

Signed-off-by: Thierry Reding <treding@nvidia.com>
---
 drivers/clk/clk.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/clk/clk.c b/drivers/clk/clk.c
index 0a9261a099bd..cf6774abebb0 100644
--- a/drivers/clk/clk.c
+++ b/drivers/clk/clk.c
@@ -4600,7 +4600,7 @@ EXPORT_SYMBOL(devm_of_clk_del_provider);
 /**
  * of_parse_clkspec() - Parse a DT clock specifier for a given device node
  * @np: device node to parse clock specifier from
- * @index: index of phandle to parse clock out of. If index < 0, @name is used
+ * @index: index of phandle to parse clock out of; ignored if @name is non-NULL
  * @name: clock name to find and parse. If name is NULL, the index is used
  * @out_args: Result of parsing the clock specifier
  *
-- 
2.28.0


             reply	other threads:[~2020-08-27 15:28 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-27 15:28 Thierry Reding [this message]
2020-09-08 21:47 ` Stephen Boyd

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=20200827152827.1661050-1-thierry.reding@gmail.com \
    --to=thierry.reding@gmail.com \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mturquette@baylibre.com \
    --cc=sboyd@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®