From: Simon Glass <sjg@chromium.org>
To: U-Boot Mailing List <u-boot@lists.denx.de>
Cc: "Michal Simek" <michal.simek@xilinx.com>,
"Heinrich Schuchardt" <xypron.glpk@gmx.de>,
"Tom Rini" <trini@konsulko.com>,
"Ilias Apalodimas" <ilias.apalodimas@linaro.org>,
"Daniel Schwierzeck" <daniel.schwierzeck@gmail.com>,
"Steffen Jaeckel" <jaeckel-floss@eyet-services.de>,
"Marek Behún" <marek.behun@nic.cz>,
"Lukas Auer" <lukas.auer@aisec.fraunhofer.de>,
"Dennis Gilmore" <dennis@ausil.us>,
"Simon Glass" <sjg@chromium.org>, "Marek Vasut" <marex@denx.de>,
"Pavel Herrmann" <morpheus.ibis@gmail.com>
Subject: [PATCH v2 12/41] dm: core: Fix up string-function documentation
Date: Sat, 23 Oct 2021 17:26:06 -0600 [thread overview]
Message-ID: <20211023232635.9195-11-sjg@chromium.org> (raw)
In-Reply-To: <20211023232635.9195-1-sjg@chromium.org>
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>
---
(no changes since v1)
drivers/core/of_access.c | 3 ++-
include/dm/ofnode.h | 4 ++--
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/drivers/core/of_access.c b/drivers/core/of_access.c
index 9960e6b310b..3707143ae66 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.
diff --git a/include/dm/ofnode.h b/include/dm/ofnode.h
index 6a714d0c7b5..4faa9bfa563 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);
--
2.33.0.1079.g6e70778dc9-goog
next prev parent reply other threads:[~2021-10-23 23:31 UTC|newest]
Thread overview: 116+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CAPnjgZ2TFOQGoQ1+Vt6LRMk+nULj9joS0C7fMMiXfg7JNien7g@mail.gmail.com>
2021-10-23 23:25 ` [PATCH v2 00/41] Initial implementation of standard boot Simon Glass
2021-10-23 23:25 ` [PATCH v2 01/41] lib: Add a way to find the postiion of a trailing number Simon Glass
2021-10-27 12:13 ` Heinrich Schuchardt
2021-10-23 23:25 ` [PATCH v2 02/41] Makefile: Allow LTO to be disabled for a build Simon Glass
2021-10-27 8:50 ` Ilias Apalodimas
2021-10-27 12:21 ` Heinrich Schuchardt
2021-10-27 13:13 ` Tom Rini
2021-10-31 23:46 ` Simon Glass
2021-11-01 21:58 ` Tom Rini
2021-11-04 2:49 ` Simon Glass
2021-11-04 14:55 ` Tom Rini
2021-11-04 15:12 ` Simon Glass
2021-11-04 16:44 ` Tom Rini
2021-10-31 23:45 ` Simon Glass
2021-10-23 23:25 ` [PATCH v2 03/41] test/py: Allow passing input to a program Simon Glass
2021-10-23 23:25 ` [PATCH v2 04/41] sandbox: Support unmapping a file Simon Glass
2021-10-23 23:25 ` [PATCH v2 05/41] sandbox: mmc: Support a backing file Simon Glass
2021-10-23 23:26 ` [PATCH v2 06/41] mmc: Allow for children other than the block device Simon Glass
2021-10-23 23:26 ` [PATCH v2 07/41] mbr: Correct verification check Simon Glass
2021-10-27 7:41 ` Ilias Apalodimas
2021-11-24 22:22 ` Simon Glass
2021-10-23 23:26 ` [PATCH v2 08/41] disk: part_dos: Fix a NULL pointer error Simon Glass
2021-10-23 23:26 ` [PATCH v2 09/41] common: Allow a smaller console-recording pre-reloc Simon Glass
2021-10-23 23:26 ` [PATCH v2 10/41] dm: core: Add tests for stringlist functions Simon Glass
2021-10-23 23:26 ` [PATCH v2 11/41] dm: core: Fix handling of uclass pre_unbind method Simon Glass
2021-10-23 23:26 ` Simon Glass [this message]
2021-10-23 23:26 ` [PATCH v2 13/41] dm: core: Add a way to obtain a string list Simon Glass
2021-10-26 19:20 ` Ilias Apalodimas
2021-11-24 22:22 ` Simon Glass
2021-11-24 22:23 ` Simon Glass
2021-10-23 23:26 ` [PATCH v2 14/41] dm: core: Allow finding children / uclasses by partial name Simon Glass
2021-10-23 23:26 ` [PATCH v2 15/41] dm: core: Add a way to count the devices in a uclass Simon Glass
2021-10-23 23:26 ` [PATCH v2 16/41] sandbox: Enable HEXDUMP for sandbox_flattree Simon Glass
2021-10-23 23:26 ` [PATCH v2 17/41] test/py: Relax the naming rules for unit tests Simon Glass
2021-10-23 23:26 ` [PATCH v2 18/41] test/py: Raise a ValueError if a command fails Simon Glass
2021-10-23 23:26 ` [PATCH v2 19/41] bootstd: Add the concept of a bootflow Simon Glass
2021-10-23 23:26 ` [PATCH v2 20/41] bootstd: Add the bootstd uclass and core implementation Simon Glass
2021-10-23 23:26 ` [PATCH v2 21/41] bootstd: Add the bootdev uclass Simon Glass
2021-10-23 23:26 ` [PATCH v2 22/41] bootstd: Add the bootmeth uclass and helpers Simon Glass
2021-10-23 23:26 ` [PATCH v2 23/41] bootstd: Add support for bootflows Simon Glass
2021-10-27 7:37 ` Ilias Apalodimas
2022-03-12 2:24 ` Simon Glass
2021-10-23 23:26 ` [PATCH v2 24/41] bootstd: Add a bootdev command Simon Glass
2021-10-23 23:26 ` [PATCH v2 25/41] bootstd: Add a bootflow ommand Simon Glass
2021-10-23 23:26 ` [PATCH v2 26/41] bootstd: Add a bootmeth command Simon Glass
2021-10-23 23:26 ` [PATCH v2 27/41] bootstd: Add an implementation of distro boot Simon Glass
2021-10-23 23:26 ` [PATCH v2 28/41] bootstd: mmc: Add a bootdev driver Simon Glass
2021-10-23 23:26 ` [PATCH v2 29/41] bootstd: ethernet: " Simon Glass
2021-10-23 23:26 ` [PATCH v2 30/41] bootstd: Add an implementation of distro PXE boot Simon Glass
2021-10-23 23:26 ` [PATCH v2 31/41] bootstd: Add an implementation of EFI boot Simon Glass
2021-10-27 8:35 ` Ilias Apalodimas
2021-10-27 14:09 ` Simon Glass
2021-10-27 14:47 ` Ilias Apalodimas
2021-10-27 18:34 ` Simon Glass
2021-10-29 5:45 ` Ilias Apalodimas
2021-10-29 12:39 ` Tom Rini
2021-10-29 13:42 ` Ilias Apalodimas
2021-10-29 14:03 ` AKASHI Takahiro
2021-10-29 14:39 ` Ilias Apalodimas
2021-10-29 16:37 ` Mark Kettenis
2021-10-29 17:08 ` Ilias Apalodimas
2021-10-27 11:57 ` Heinrich Schuchardt
2021-10-27 14:08 ` Simon Glass
2021-10-23 23:26 ` [PATCH v2 32/41] bootstd: Add a system bootdev for strange boot methods Simon Glass
2021-10-23 23:26 ` [PATCH v2 33/41] bootstd: Add an implementation of EFI bootmgr Simon Glass
2021-10-23 23:26 ` [PATCH v2 34/41] bootstd: Add a sandbox bootmeth driver Simon Glass
2021-10-23 23:26 ` [PATCH v2 35/41] bootstd: usb: Add a bootdev driver Simon Glass
2021-10-23 23:26 ` [PATCH v2 36/41] test: fastboot: Avoid using mmc1 Simon Glass
2021-10-23 23:26 ` [PATCH v2 37/41] test: dm: Restart USB before assuming it is stopped Simon Glass
2021-10-23 23:26 ` [PATCH v2 38/41] bootstd: Add tests for bootstd including all uclasses Simon Glass
2021-10-23 23:26 ` [PATCH v2 39/41] bootstd: Add setup for the bootflow tests Simon Glass
2021-10-23 23:26 ` [PATCH v2 40/41] bootstd: doc: Add documentation Simon Glass
2021-10-23 23:26 ` [PATCH v2 41/41] RFC: Switch rpi over to use bootstd Simon Glass
2021-10-28 15:13 ` Tom Rini
2021-10-28 16:43 ` Tom Rini
2021-10-28 17:16 ` Simon Glass
2021-10-28 17:29 ` Tom Rini
2021-10-23 23:27 ` [PATCH v2 00/41] Initial implementation of standard boot Simon Glass
2021-10-27 11:38 ` Heinrich Schuchardt
2021-10-27 14:11 ` Simon Glass
2021-10-28 17:37 ` Peter Robinson
2021-10-28 17:47 ` Tom Rini
2021-10-28 17:50 ` Peter Robinson
2021-10-28 17:59 ` Tom Rini
2021-10-28 18:09 ` Heinrich Schuchardt
2021-10-28 18:13 ` Tom Rini
2021-10-28 18:17 ` François Ozog
2021-10-28 18:27 ` Tom Rini
2021-10-28 18:28 ` François Ozog
2021-10-28 21:40 ` Mark Kettenis
2021-10-27 15:20 ` François Ozog
2021-10-27 18:33 ` Simon Glass
2021-10-28 16:27 ` Tom Rini
2021-10-28 17:29 ` Simon Glass
2021-10-28 17:52 ` Tom Rini
2021-10-28 18:13 ` Simon Glass
2021-10-28 18:36 ` Tom Rini
2021-10-28 18:48 ` Simon Glass
2021-10-28 19:19 ` Tom Rini
2021-10-28 22:22 ` Simon Glass
2021-10-28 22:50 ` Tom Rini
2021-10-29 1:13 ` Simon Glass
2021-11-24 22:22 ` [PATCH v2 17/41] test/py: Relax the naming rules for unit tests Simon Glass
2021-11-24 22:22 ` [PATCH v2 18/41] test/py: Raise a ValueError if a command fails Simon Glass
2021-11-24 22:22 ` [PATCH v2 16/41] sandbox: Enable HEXDUMP for sandbox_flattree Simon Glass
2021-11-24 22:22 ` [PATCH v2 15/41] dm: core: Add a way to count the devices in a uclass Simon Glass
2021-11-24 22:22 ` [PATCH v2 14/41] dm: core: Allow finding children / uclasses by partial name Simon Glass
2021-11-24 22:22 ` [PATCH v2 11/41] dm: core: Fix handling of uclass pre_unbind method Simon Glass
2021-11-24 22:22 ` [PATCH v2 12/41] dm: core: Fix up string-function documentation Simon Glass
2021-11-24 22:22 ` [PATCH v2 08/41] disk: part_dos: Fix a NULL pointer error Simon Glass
2021-11-24 22:22 ` [PATCH v2 09/41] common: Allow a smaller console-recording pre-reloc Simon Glass
2021-11-24 22:22 ` [PATCH v2 10/41] dm: core: Add tests for stringlist functions Simon Glass
2021-11-24 22:22 ` [PATCH v2 06/41] mmc: Allow for children other than the block device Simon Glass
2021-11-24 22:22 ` [PATCH v2 05/41] sandbox: mmc: Support a backing file Simon Glass
2021-11-24 22:22 ` [PATCH v2 04/41] sandbox: Support unmapping a file Simon Glass
2021-11-24 22:22 ` [PATCH v2 03/41] test/py: Allow passing input to a program Simon Glass
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211023232635.9195-11-sjg@chromium.org \
--to=sjg@chromium.org \
--cc=daniel.schwierzeck@gmail.com \
--cc=dennis@ausil.us \
--cc=ilias.apalodimas@linaro.org \
--cc=jaeckel-floss@eyet-services.de \
--cc=lukas.auer@aisec.fraunhofer.de \
--cc=marek.behun@nic.cz \
--cc=marex@denx.de \
--cc=michal.simek@xilinx.com \
--cc=morpheus.ibis@gmail.com \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=xypron.glpk@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.