diff options
| author | Simon Glass <sjg@chromium.org> | 2021-10-24 02:26:06 +0300 |
|---|---|---|
| committer | Simon Glass <sjg@chromium.org> | 2021-11-29 02:51:51 +0300 |
| commit | 32c6a8e1f803e2a42fa7bf76f23231736841bfc0 (patch) | |
| tree | 65786b195b90683c81e8f0db8e9a210cb38ef41f /include/dm | |
| parent | 804431830593820575158aa5c4b098aab59efc88 (diff) | |
| download | u-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 'include/dm')
| -rw-r--r-- | include/dm/ofnode.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/dm/ofnode.h b/include/dm/ofnode.h index 0f680e5aa6..0eae8f9a81 100644 --- a/include/dm/ofnode.h +++ b/include/dm/ofnode.h @@ -590,11 +590,11 @@ int ofnode_stringlist_search(ofnode node, const char *propname, * * @node: node to check * @propname: name of the property containing the string list - * @index: index of the string to return + * @index: index of the string to return (cannot be negative) * @lenp: return location for the string length or an error code on failure * * @return: - * length of string, if found or -ve error value if not found + * 0 if found or -ve error value if not found */ int ofnode_read_string_index(ofnode node, const char *propname, int index, const char **outp); |