Re: [PATCH v1 1/1] device property: Clarify description on returned value in some functions

Sakari Ailus
2023-02-17T11:18:51Z

Hi Andy,

On Fri, Feb 17, 2023 at 01:01:39PM +0200, Andy Shevchenko wrote:
> 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?

Ah, indeed. This is achieved by putting the previous child. Generally this
function is used via the loop helper macro and not called directly, hence
the documentation there matters the most. Those functions appear to be
without any documentation though.

--
Regards,

Sakari Ailus