From: Chen-Yu Tsai <wenst@chromium.org>
To: Rob Herring <robh@kernel.org>,
Saravana Kannan <saravanak@google.com>,
Wolfram Sang <wsa@kernel.org>
Cc: Chen-Yu Tsai <wenst@chromium.org>,
devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org,
Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
linux-i2c@vger.kernel.org, kernel test robot <lkp@intel.com>
Subject: [PATCH] of: base: Document prefix argument for of_get_next_child_with_prefix()
Date: Thu, 28 Nov 2024 12:26:30 +0800 [thread overview]
Message-ID: <20241128042632.231308-1-wenst@chromium.org> (raw)
When of_get_next_child_with_prefix() was added, the prefix argument was
left undocumented. This caused a new warning to be generated during the
kerneldoc build process:
drivers/of/base.c:661: warning: Function parameter or struct member 'prefix'
not described in 'of_get_next_child_with_prefix'
Properly document the argument to fix this.
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202411280010.KGSDBOUE-lkp@intel.com/
Fixes: 1fcc67e3a354 ("of: base: Add for_each_child_of_node_with_prefix()")
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
As requested. I assume Rob would give an ack for this to go through the
I2C tree since the offending commit is there as well.
I also put this patch on git.kernel.org hoping that it gets some bot
coverage soon:
http://git.kernel.org/wens/h/of_get_next_child_with_prefix-kdoc-fix
I guess I should have put the original patches on a separate branch on
git.kernel.org for bots to run earlier. I'm sorry for not catching this
sooner.
drivers/of/base.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/drivers/of/base.c b/drivers/of/base.c
index 4cba021c89d3..7dc394255a0a 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -648,6 +648,7 @@ EXPORT_SYMBOL(of_get_next_child);
* of_get_next_child_with_prefix - Find the next child node with prefix
* @node: parent node
* @prev: previous child of the parent node, or NULL to get first
+ * @prefix: prefix that the node name should have
*
* This function is like of_get_next_child(), except that it automatically
* skips any nodes whose name doesn't have the given prefix.
--
2.47.0.338.g60cca15819-goog
next reply other threads:[~2024-11-28 4:27 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-11-28 4:26 Chen-Yu Tsai [this message]
2024-11-29 1:50 ` [PATCH] of: base: Document prefix argument for of_get_next_child_with_prefix() Wolfram Sang
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=20241128042632.231308-1-wenst@chromium.org \
--to=wenst@chromium.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=devicetree@vger.kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=robh@kernel.org \
--cc=saravanak@google.com \
--cc=wsa@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