Skip to content

Commit 92e1046

Browse files
andy-shevrafaeljw
authored andcommitted
device property: Fix documentation for *_match_string() APIs
The returned value on success is an index of the matching string, starting from 0. Reflect this in the documentation. Fixes: 3f5c8d3 ("device property: Add fwnode_property_match_string()") Signed-off-by: Andy Shevchenko <[email protected]> Reviewed-by: Sakari Ailus <[email protected]> Signed-off-by: Rafael J. Wysocki <[email protected]>
1 parent 247f34f commit 92e1046

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

drivers/base/property.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ EXPORT_SYMBOL_GPL(device_property_read_string);
229229
* Find a given string in a string array and if it is found return the
230230
* index back.
231231
*
232-
* Return: %0 if the property was found (success),
232+
* Return: index, starting from %0, if the property was found (success),
233233
* %-EINVAL if given arguments are not valid,
234234
* %-ENODATA if the property does not have a value,
235235
* %-EPROTO if the property is not an array of strings,
@@ -450,7 +450,7 @@ EXPORT_SYMBOL_GPL(fwnode_property_read_string);
450450
* Find a given string in a string array and if it is found return the
451451
* index back.
452452
*
453-
* Return: %0 if the property was found (success),
453+
* Return: index, starting from %0, if the property was found (success),
454454
* %-EINVAL if given arguments are not valid,
455455
* %-ENODATA if the property does not have a value,
456456
* %-EPROTO if the property is not an array of strings,

0 commit comments

Comments
 (0)