Skip to contentSkip to conversation

of: base: Add missing parameter description to of_get_next_child_with_prefix()

PATCH In review Yang Li 2 participants 2 messages Nov 29, 2024 – Dec 4, 2024 Device tree

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 of: base: Add missing parameter description to of_get_next_child_with_prefix()

The function of_get_next_child_with_prefix() lacked a description for the prefix parameter in its documentation. This patch adds the missing description to ensure all parameters are properly documented.

---
 drivers/of/base.c | 1 +
 1 file changed, 1 insertion(+)
drivers/of/base.c +1 -0
index 4cba021c89d3..600236abb5d6 100644
@@ -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 string to match in child node names
  *
  * This function is like of_get_next_child(), except that it automatically
  * skips any nodes whose name doesn't have the given prefix.
Signature · 1 line
2.32.0.3.g01195cf9f
maintainer
#1 lore raw
Quoted 10 lines · Yang Li

The function of_get_next_child_with_prefix() lacked a description for the prefix parameter in its documentation. This patch adds the missing description to ensure all parameters are properly documented.

---
 drivers/of/base.c | 1 +
 1 file changed, 1 insertion(+)

Thanks, but already fixed in upstream commit 0d40daa1c136 ("of: base:
Document prefix argument for of_get_next_child_with_prefix()").