Re: [PATCH v1 1/1] device property: Fix documentation for *_match_string() APIs

[Andy Shevchenko]

On Thu, Oct 06, 2022 at 12:45:41PM +0000, Sakari Ailus wrote:
> On Thu, Oct 06, 2022 at 03:38:07PM +0300, Andy Shevchenko wrote:
> > The returned value on success is an index of the matching string,
> > starting from 0. Reflect this in the documentation.

> > Fixes: 3f5c8d318785 ("device property: Add fwnode_property_match_string()")

...

> > - * Return: %0 if the property was found (success),
> > + * Return: index, starting from %0, if the property was found (success),
> >   *	   %-EINVAL if given arguments are not valid,
> >   *	   %-ENODATA if the property does not have a value,
> >   *	   %-EPROTO if the property is not an array of strings,
> 
> There are other error codes that can be returned such as -ENOMEM or what
> else may be returned by fwnode_property_read_string_array().
> 
> I might just refer to fwnode_property_read_string_array() and document here
> those specific to these functions.
> 
> Just FYI... I guess this could be a separate patch, too.

Right, I think we would rather do an incremental change since that will be
more intrusive and would not be exactly the fix (improvement?).

> Reviewed-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>

Thanks!

-- 
With Best Regards,
Andy Shevchenko