[PATCH v2] drivers/of: Improve documentation for match_string

[PATCH v2] drivers/of: Improve documentation for match_string

[Miquel Sabaté Solà]

The description of the function now explicitly states that it's
an *exact* match for the given string (i.e. not a submatch). It also
better states all the possible return values.

Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
---
 drivers/of/property.c | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/drivers/of/property.c b/drivers/of/property.c
index 164d77cb9445..d66ea8a83562 100644
--- a/drivers/of/property.c
+++ b/drivers/of/property.c
@@ -452,12 +452,17 @@ EXPORT_SYMBOL_GPL(of_property_read_string);

 /**
  * of_property_match_string() - Find string in a list and return index
- * @np: pointer to node containing string list property
+ * @np: pointer to the node containing the string list property
  * @propname: string list property name
- * @string: pointer to string to search for in string list
+ * @string: pointer to the string to search for in the string list
  *
- * This function searches a string list property and returns the index
- * of a specific string value.
+ * Search for an exact match of string in a device node property which is a
+ * string of lists.
+ *
+ * Return: the index of the first occurrence of the string on success, -EINVAL
+ * if the property does not exist, -ENODATA if the property does not have a
+ * value, and -EILSEQ if the string is not null-terminated within the length of
+ * the property data.
  */
 int of_property_match_string(const struct device_node *np, const char *propname,
 			     const char *string)
--
2.46.0

Re: [PATCH v2] drivers/of: Improve documentation for match_string

[Rob Herring (Arm)]

On Wed, 11 Sep 2024 22:49:38 +0200, Miquel Sabaté Solà wrote:
> The description of the function now explicitly states that it's
> an *exact* match for the given string (i.e. not a submatch). It also
> better states all the possible return values.
> 
> Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
> ---
>  drivers/of/property.c | 13 +++++++++----
>  1 file changed, 9 insertions(+), 4 deletions(-)
> 

Applied, thanks!

Re: [PATCH v2] drivers/of: Improve documentation for match_string

[Miquel Sabaté Solà]

[-- Attachment #1: Type: text/plain, Size: 532 bytes --]

On dj., de set. 12 2024, Rob Herring (Arm) wrote:

> On Wed, 11 Sep 2024 22:49:38 +0200, Miquel Sabaté Solà wrote:
>> The description of the function now explicitly states that it's
>> an *exact* match for the given string (i.e. not a submatch). It also
>> better states all the possible return values.
>> 
>> Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
>> ---
>>  drivers/of/property.c | 13 +++++++++----
>>  1 file changed, 9 insertions(+), 4 deletions(-)
>> 
>
> Applied, thanks!

Great, thanks!

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 861 bytes --]