lkml.org 
[lkml]   [2022]   [Oct]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v1 1/1] device property: Fix documentation for *_match_string() APIs
On Thu, Oct 06, 2022 at 03:55:05PM +0300, Andy Shevchenko wrote:
> 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?).

It's a fix in documentation. It's perhaps unlikely a bug would have been
introduced because of what was missing.

>
> > Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com>
>
> Thanks!

You're welcome!

--
Sakari Ailus

\
 
 \ /
  Last update: 2022-10-06 16:06    [W:0.042 / U:0.076 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site