Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-11-11 15:37:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

lib: Comment the base parameter with simple_strtoul/l()

Browse source 
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>
This commit is contained in:
Simon Glass 2021-07-24 09:03:31 -06:00 committed by Tom Rini
parent 0b1284eb52
commit 18546f2982
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/vsprintf.h
View file

@ -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
*