Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <c5db0099-a7fd-8f1c-16ad-8388d3cf6a05@infradead.org>
Date:   Wed, 22 Mar 2023 11:50:53 -0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.8.0
Subject: Re: [PATCH] of: fix htmldocs build warnings
Content-Language: en-US
To:     Stephen Rothwell <sfr@canb.auug.org.au>,
        Rob Herring <robherring2@gmail.com>
Cc:     Frank Rowand <frowand.list@gmail.com>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Linux Next Mailing List <linux-next@vger.kernel.org>
References: <20230220163638.04e9d0c4@canb.auug.org.au>
 <20230310113258.463f836c@canb.auug.org.au>
 <20230322180032.1badd132@canb.auug.org.au>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20230322180032.1badd132@canb.auug.org.au>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk


On 3/22/23 00:00, Stephen Rothwell wrote:
> 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@canb.auug.org.au>
> Reported by: Randy Dunlap <rdunlap@infradead.org>
> Fixes: 39459ce717b8 ("of: dynamic: add lifecycle docbook info to node creation functions")
> Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au>


Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  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)

-- 
~Randy