summaryrefslogtreecommitdiff
path: root/drivers/core
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2021-10-24 02:26:06 +0300
committerSimon Glass <sjg@chromium.org>2021-11-29 02:51:51 +0300
commit32c6a8e1f803e2a42fa7bf76f23231736841bfc0 (patch)
tree65786b195b90683c81e8f0db8e9a210cb38ef41f /drivers/core
parent804431830593820575158aa5c4b098aab59efc88 (diff)
downloadu-boot-32c6a8e1f803e2a42fa7bf76f23231736841bfc0.tar.xz
dm: core: Fix up string-function documentation
The details for of_property_read_string_helper() and ofnode_read_string_index() are a little inaccurate. Fix up the comments to avoid confusion. Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'drivers/core')
-rw-r--r--drivers/core/of_access.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/drivers/core/of_access.c b/drivers/core/of_access.c
index 9960e6b310..3707143ae6 100644
--- a/drivers/core/of_access.c
+++ b/drivers/core/of_access.c
@@ -581,7 +581,8 @@ int of_property_match_string(const struct device_node *np, const char *propname,
* @propname: name of the property to be searched.
* @out_strs: output array of string pointers.
* @sz: number of array elements to read.
- * @skip: Number of strings to skip over at beginning of list.
+ * @skip: Number of strings to skip over at beginning of list (cannot be
+ * negative)
*
* Don't call this function directly. It is a utility helper for the
* of_property_read_string*() family of functions.