mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Michael Walle <michael@walle.cc>
To: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Rob Herring <robh+dt@kernel.org>,
	Frank Rowand <frowand.list@gmail.com>,
	Michael Walle <michael@walle.cc>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH] of: base: add parameter doc to of_parse_phandle_with_optional_args()
Date: Sat, 15 Jan 2022 12:31:56 +0100	[thread overview]
Message-ID: <20220115113156.435037-1-michael@walle.cc> (raw)

htmldocs produces warnings about the missing documentation. Add them.
While at it, fix the typo in the referenced function name.

Fixes: 952c4865d27a ("of: base: add of_parse_phandle_with_optional_args()")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Michael Walle <michael@walle.cc>
---
 include/linux/of.h | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/include/linux/of.h b/include/linux/of.h
index eeb2910b51da..062a0d899403 100644
--- a/include/linux/of.h
+++ b/include/linux/of.h
@@ -1021,9 +1021,14 @@ static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
 
 /**
  * of_parse_phandle_with_optional_args() - Find a node pointed by phandle in a list
+ * @np:		pointer to a device tree node containing a list
+ * @list_name:	property name that contains a list
+ * @cells_name:	property name that specifies phandles' arguments count
+ * @index:	index of a phandle to parse out
+ * @out_args:	optional pointer to output arguments structure (will be filled)
  *
- * Same as of_parse_phandle_args() except that if the cells_name property is
- * not found, cell_count of 0 is assumed.
+ * Same as of_parse_phandle_with_args() except that if the cells_name property
+ * is not found, cell_count of 0 is assumed.
  *
  * This is used to useful, if you have a phandle which didn't have arguments
  * before and thus doesn't have a '#*-cells' property but is now migrated to
-- 
2.30.2


             reply	other threads:[~2022-01-15 11:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-15 11:31 Michael Walle [this message]
2022-01-15 17:30 ` Rob Herring

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=20220115113156.435037-1-michael@walle.cc \
    --to=michael@walle.cc \
    --cc=devicetree@vger.kernel.org \
    --cc=frowand.list@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh+dt@kernel.org \
    --cc=sfr@canb.auug.org.au \
    /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®