| Message ID | 20241128042632.231308-1-wenst@chromium.org |
|---|---|
| State | New |
| Headers | show |
| Series | of: base: Document prefix argument for of_get_next_child_with_prefix() | expand |
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.
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(+)