[PATCH 04/15] lib: Comment the base parameter with simple_strtoul/l()

Simon Glass
2021-07-20T13:30:35Z

This parameter is not documented properly since it does not cover the
meaning when the base is 0. Update this in both functions.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

include/vsprintf.h | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/include/vsprintf.h b/include/vsprintf.h
index 2b0e15f84a3..0e112b5d5ba 100644
--- a/include/vsprintf.h
+++ b/include/vsprintf.h
@@ -15,12 +15,15 @@
*
* @param cp The string to be converted
* @param endp Updated to point to the first character not converted
- * @param base The number base to use
+ * @param base The number base to use (0 for the default)
* @return value decoded from string (0 if invalid)
*
* Converts a string to an unsigned long. If there are invalid characters at
* the end these are ignored. In the worst case, if all characters are invalid,
* 0 is returned
+ *
+ * If @base is 0, octal or hex prefixes are supported (e.g. 0777, 0x123) to
+ * select a particular base. By default decimal is used.
*/
ulong simple_strtoul(const char *cp, char **endp, unsigned int base);

@@ -53,7 +56,7 @@ unsigned long dectoul(const char *cp, char **endp);
/**
* strict_strtoul - convert a string to an unsigned long strictly
* @param cp The string to be converted
- * @param base The number base to use
+ * @param base The number base to use (0 for the default)
* @param res The converted result value
* @return 0 if conversion is successful and *res is set to the converted
* value, otherwise it returns -EINVAL and *res is set to 0.
@@ -68,6 +71,9 @@ unsigned long dectoul(const char *cp, char **endp);
*
* echo will append a newline to the tail.
*
+ * If @base is 0, octal or hex prefixes are supported (e.g. 0777, 0x123) to
+ * select a particular base. By default decimal is used.
+ *
* Copied this function from Linux 2.6.38 commit ID:
* 521cb40b0c44418a4fd36dc633f575813d59a43d
*
--
2.32.0.402.g57bb445576-goog