Re: [PATCHv2] of: Document exactly what of_find_node_by_name() puts

From: Randy Dunlap
Date: Fri Nov 17 2017 - 12:19:34 EST


On 11/17/2017 08:53 AM, Stephen Boyd wrote:
> It isn't clear if this function of_node_put()s the 'from'
> argument, or the node it searches. Clearly indicate which
> variable is touched. Fold in some more fixes from Randy too
> because we're in the area.
>
> Cc: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Signed-off-by: Stephen Boyd <sboyd@xxxxxxxxxxxxxx>
> ---
>
> Changes from v1:
> * Fold in Randy's fixes
>
> drivers/of/base.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/of/base.c b/drivers/of/base.c
> index 63897531cd75..4368a878df88 100644
> --- a/drivers/of/base.c
> +++ b/drivers/of/base.c
> @@ -863,10 +863,10 @@ EXPORT_SYMBOL(of_find_node_opts_by_path);
>
> /**
> * of_find_node_by_name - Find a node by its "name" property
> - * @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
> - * returned. of_node_put() will be called on it
> + * will. Typically, you pass what the previous call
> + * returned. of_node_put() will be called on @from.
> * @name: The name string to match against
> *
> * Returns a node pointer with refcount incremented, use
>

Looks good. Thanks.

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>


--
~Randy