Messages in this thread | | | Date | Thu, 6 Oct 2022 12:45:41 +0000 | From | Sakari Ailus <> | Subject | Re: [PATCH v1 1/1] device property: Fix documentation for *_match_string() APIs |
| |
Hi Andy,
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()") > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> > --- > drivers/base/property.c | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/drivers/base/property.c b/drivers/base/property.c > index 617007a25783..bfed224c5724 100644 > --- a/drivers/base/property.c > +++ b/drivers/base/property.c > @@ -236,7 +236,7 @@ EXPORT_SYMBOL_GPL(device_property_read_string); > * Find a given string in a string array and if it is found return the > * index back. > * > - * 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.
Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> @@ -457,7 +457,7 @@ EXPORT_SYMBOL_GPL(fwnode_property_read_string); > * Find a given string in a string array and if it is found return the > * index back. > * > - * 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,
-- Kind regards,
Sakari Ailus
| |