[PATCH] of: fix htmldocs build warnings

From: Stephen Rothwell
Date: Wed Mar 22 2023 - 03:00:46 EST


Fix these htmldoc build warnings:

include/linux/of.h:115: warning: cannot understand function prototype: 'const struct kobj_type of_node_ktype; '
include/linux/of.h:118: warning: Excess function parameter 'phandle_name' description in 'of_node_init'

Reported by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
Reported by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Fixes: 39459ce717b8 ("of: dynamic: add lifecycle docbook info to node creation functions")
Signed-off-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
---
include/linux/of.h | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)

Replaces "[PATCH] of: fix htmldocs build warning" and additionally
fixes the new warning about phandle that Randy reported.

diff --git a/include/linux/of.h b/include/linux/of.h
index 9b7a99499ef3..d55dab9ad728 100644
--- a/include/linux/of.h
+++ b/include/linux/of.h
@@ -100,10 +100,12 @@ struct of_reconfig_data {
struct property *old_prop;
};

+extern const struct kobj_type of_node_ktype;
+extern const struct fwnode_operations of_fwnode_ops;
+
/**
* of_node_init - initialize a devicetree node
* @node: Pointer to device node that has been created by kzalloc()
- * @phandle_name: Name of property holding a phandle value
*
* On return the device_node refcount is set to one. Use of_node_put()
* on @node when done to free the memory allocated for it. If the node
@@ -111,9 +113,6 @@ struct of_reconfig_data {
* whether to free the memory will be done by node->release(), which is
* of_node_release().
*/
-/* initialize a node */
-extern const struct kobj_type of_node_ktype;
-extern const struct fwnode_operations of_fwnode_ops;
static inline void of_node_init(struct device_node *node)
{
#if defined(CONFIG_OF_KOBJ)
--
2.39.2

Attachment: pgpwXYxnePCVH.pgp
Description: OpenPGP digital signature