Re: [PATCH v1 1/1] device property: Clarify description on returned value in some functions
From: Andy Shevchenko
Date: Fri Feb 17 2023 - 06:02:24 EST
On Fri, Feb 17, 2023 at 12:27:53PM +0200, Sakari Ailus wrote:
> On Thu, Feb 16, 2023 at 10:57:08PM +0200, Andy Shevchenko wrote:
...
> > * fwnode_get_next_child_node - Return the next child node handle for a node
> > * @fwnode: Firmware node to find the next child node for.
> > * @child: Handle to one of the node's child nodes or a %NULL handle.
> > + *
> > + * Caller is responsible to call fwnode_handle_put() on the returned fwnode
> > + * pointer.
>
> The loop itself will also put the child node, so this is only relevant
> outside the loop.
Yes and this is exactly what people stumbled over. Hence this note.
This call per se doesn't loop, so I didn't get how your comment can
be transformed to anything here. Care to elaborate a bit more on
what I have to add here or reword?
...
> > + * Among other cases this has to be used when terminating device_for_each_child_node()
>
> I don't think device_for_each_child_node() should be mentioned here. This
> isn't really related to that in particular.
Okay, I will drop this change. It's anyway out of the scope of this patch.
> With these:
>
> Acked-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>
Thanks, but due to above I can't apply it right away.
--
With Best Regards,
Andy Shevchenko