Skip to content

Commit

Permalink
of: base: Document prefix argument for of_get_next_child_with_prefix()
Browse files Browse the repository at this point in the history
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: 1fcc67e ("of: base: Add for_each_child_of_node_with_prefix()")
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
  • Loading branch information
Chen-Yu Tsai authored and Wolfram Sang committed Nov 29, 2024
1 parent 44b6826 commit 0d40daa
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions drivers/of/base.c
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 0d40daa

Please sign in to comment.