]> www.infradead.org Git - users/willy/pagecache.git/commitdiff
of: base: Document prefix argument for of_get_next_child_with_prefix()
authorChen-Yu Tsai <wenst@chromium.org>
Thu, 28 Nov 2024 04:26:30 +0000 (12:26 +0800)
committerWolfram Sang <wsa+renesas@sang-engineering.com>
Fri, 29 Nov 2024 01:48:59 +0000 (02:48 +0100)
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>
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
drivers/of/base.c

index 4cba021c89d3e8ff452b827bbb4ba2d970c20b08..7dc394255a0a14cd1aed02ec79c2f787a222b44c 100644 (file)
@@ -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.