Commit 0d40daa1 authored by Chen-Yu Tsai's avatar Chen-Yu Tsai Committed by Wolfram Sang
Browse files

of: base: Document prefix argument for of_get_next_child_with_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: default avatarkernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202411280010.KGSDBOUE-lkp@intel.com/


Fixes: 1fcc67e3 ("of: base: Add for_each_child_of_node_with_prefix()")
Signed-off-by: default avatarChen-Yu Tsai <wenst@chromium.org>
Signed-off-by: default avatarWolfram Sang <wsa+renesas@sang-engineering.com>
parent 44b68269

drivers/of/base.c

+1 −0
Original line number Diff line number Diff line
@@ -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.