of: Document exactly what of_find_node_by_name() puts

Message ID 20171111014536.3592-1-sboyd@codeaurora.org
State Changes Requested
Headers show
Series
  • of: Document exactly what of_find_node_by_name() puts
Related show

Commit Message

Stephen Boyd Nov. 11, 2017, 1:45 a.m.
It isn't clear if this function of_node_put()s the 'from'
argument, or the node it finds in the search. Clearly indicate
which variable is touched.

Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
---
 drivers/of/base.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Randy Dunlap Nov. 11, 2017, 2:12 a.m. | #1
On 11/10/2017 05:45 PM, Stephen Boyd wrote:
> It isn't clear if this function of_node_put()s the 'from'
> argument, or the node it finds in the search. Clearly indicate
> which variable is touched.
> 
> Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
> ---
>  drivers/of/base.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/of/base.c b/drivers/of/base.c
> index 63897531cd75..602c5d65734a 100644
> --- a/drivers/of/base.c
> +++ b/drivers/of/base.c
> @@ -866,7 +866,7 @@ EXPORT_SYMBOL(of_find_node_opts_by_path);>   *	@from:	The node to start searching from or NULL, the node

    *	@from:	The node to start searching from or %NULL; the node

>   *		you pass will not be searched, only the next one
>   *		will; typically, you pass what the previous call

    *		will. Typically, you pass what the previous call

> - *		returned. of_node_put() will be called on it
> + *		returned. of_node_put() will be called on @from.
>   *	@name:	The name string to match against
>   *
>   *	Returns a node pointer with refcount incremented, use
>
Stephen Boyd Nov. 17, 2017, 2:44 a.m. | #2
On 11/10, Randy Dunlap wrote:
> On 11/10/2017 05:45 PM, Stephen Boyd wrote:
> > It isn't clear if this function of_node_put()s the 'from'
> > argument, or the node it finds in the search. Clearly indicate
> > which variable is touched.
> > 
> > Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
> > ---
> >  drivers/of/base.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/of/base.c b/drivers/of/base.c
> > index 63897531cd75..602c5d65734a 100644
> > --- a/drivers/of/base.c
> > +++ b/drivers/of/base.c
> > @@ -866,7 +866,7 @@ EXPORT_SYMBOL(of_find_node_opts_by_path);>   *	@from:	The node to start searching from or NULL, the node
> 
>     *	@from:	The node to start searching from or %NULL; the node
> 
> >   *		you pass will not be searched, only the next one
> >   *		will; typically, you pass what the previous call
> 
>     *		will. Typically, you pass what the previous call
> 

Rob, do you want me to fold this in?
Rob Herring Nov. 17, 2017, 2:08 p.m. | #3
On Thu, Nov 16, 2017 at 8:44 PM, Stephen Boyd <sboyd@codeaurora.org> wrote:
> On 11/10, Randy Dunlap wrote:
>> On 11/10/2017 05:45 PM, Stephen Boyd wrote:
>> > It isn't clear if this function of_node_put()s the 'from'
>> > argument, or the node it finds in the search. Clearly indicate
>> > which variable is touched.
>> >
>> > Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
>> > ---
>> >  drivers/of/base.c | 2 +-
>> >  1 file changed, 1 insertion(+), 1 deletion(-)
>> >
>> > diff --git a/drivers/of/base.c b/drivers/of/base.c
>> > index 63897531cd75..602c5d65734a 100644
>> > --- a/drivers/of/base.c
>> > +++ b/drivers/of/base.c
>> > @@ -866,7 +866,7 @@ EXPORT_SYMBOL(of_find_node_opts_by_path);>   *  @from:  The node to start searching from or NULL, the node
>>
>>     * @from:  The node to start searching from or %NULL; the node
>>
>> >   *         you pass will not be searched, only the next one
>> >   *         will; typically, you pass what the previous call
>>
>>     *         will. Typically, you pass what the previous call
>>
>
> Rob, do you want me to fold this in?

Yes, please.

Rob
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/drivers/of/base.c b/drivers/of/base.c
index 63897531cd75..602c5d65734a 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -866,7 +866,7 @@  EXPORT_SYMBOL(of_find_node_opts_by_path);
  *	@from:	The node to start searching from or NULL, the node
  *		you pass will not be searched, only the next one
  *		will; typically, you pass what the previous call
- *		returned. of_node_put() will be called on it
+ *		returned. of_node_put() will be called on @from.
  *	@name:	The name string to match against
  *
  *	Returns a node pointer with refcount incremented, use