Commit 4c925d60 authored by Eldad Zack's avatar Eldad Zack Committed by Linus Torvalds
Browse files

kstrto*: add documentation 



As Bruce Fields pointed out, kstrto* is currently lacking kerneldoc
comments.  This patch adds kerneldoc comments to common variants of
kstrto*: kstrto(u)l, kstrto(u)ll and kstrto(u)int.

Signed-off-by: default avatarEldad Zack <eldad@fogrefinery.com>
Cc: J. Bruce Fields <bfields@fieldses.org>
Cc: Joe Perches <joe@perches.com>
Cc: Randy Dunlap <rdunlap@xenotime.net>
Cc: Alexey Dobriyan <adobriyan@gmail.com>
Cc: Rob Landley <rob@landley.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 543f56c1

Documentation/DocBook/kernel-api.tmpl

+3 −0
Original line number Diff line number Diff line
@@ -58,6 +58,9 @@ 


     <sect1><title>String Conversions</title>

!Elib/vsprintf.c

!Finclude/linux/kernel.h kstrtol

!Finclude/linux/kernel.h kstrtoul

!Elib/kstrtox.c

     </sect1>

     <sect1><title>String Manipulation</title>

<!-- All functions are exported at now

include/linux/kernel.h

+33 −0
Original line number Diff line number Diff line
@@ -220,6 +220,23 @@ int __must_check _kstrtol(const char *s, unsigned int base, long *res); 


int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);

int __must_check kstrtoll(const char *s, unsigned int base, long long *res);



/**

 * kstrtoul - convert a string to an unsigned long

 * @s: The start of the string. The string must be null-terminated, and may also

 *  include a single newline before its terminating null. The first character

 *  may also be a plus sign, but not a minus sign.

 * @base: The number base to use. The maximum supported base is 16. If base is

 *  given as 0, then the base of the string is automatically detected with the

 *  conventional semantics - If it begins with 0x the number will be parsed as a

 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be

 *  parsed as an octal number. Otherwise it will be parsed as a decimal.

 * @res: Where to write the result of the conversion on success.

 *

 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.

 * Used as a replacement for the obsolete simple_strtoull. Return code must

 * be checked.

*/

static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)

{

	/*
@@ -233,6 +250,22 @@ static inline int __must_check kstrtoul(const char *s, unsigned int base, unsign 
		return _kstrtoul(s, base, res);

}



/**

 * kstrtol - convert a string to a long

 * @s: The start of the string. The string must be null-terminated, and may also

 *  include a single newline before its terminating null. The first character

 *  may also be a plus sign or a minus sign.

 * @base: The number base to use. The maximum supported base is 16. If base is

 *  given as 0, then the base of the string is automatically detected with the

 *  conventional semantics - If it begins with 0x the number will be parsed as a

 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be

 *  parsed as an octal number. Otherwise it will be parsed as a decimal.

 * @res: Where to write the result of the conversion on success.

 *

 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.

 * Used as a replacement for the obsolete simple_strtoull. Return code must

 * be checked.

 */

static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)

{

	/*

lib/kstrtox.c

+64 −0
Original line number Diff line number Diff line
@@ -104,6 +104,22 @@ static int _kstrtoull(const char *s, unsigned int base, unsigned long long *res) 
	return 0;

}



/**

 * kstrtoull - convert a string to an unsigned long long

 * @s: The start of the string. The string must be null-terminated, and may also

 *  include a single newline before its terminating null. The first character

 *  may also be a plus sign, but not a minus sign.

 * @base: The number base to use. The maximum supported base is 16. If base is

 *  given as 0, then the base of the string is automatically detected with the

 *  conventional semantics - If it begins with 0x the number will be parsed as a

 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be

 *  parsed as an octal number. Otherwise it will be parsed as a decimal.

 * @res: Where to write the result of the conversion on success.

 *

 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.

 * Used as a replacement for the obsolete simple_strtoull. Return code must

 * be checked.

 */

int kstrtoull(const char *s, unsigned int base, unsigned long long *res)

{

	if (s[0] == '+')
@@ -112,6 +128,22 @@ int kstrtoull(const char *s, unsigned int base, unsigned long long *res) 
}

EXPORT_SYMBOL(kstrtoull);



/**

 * kstrtoll - convert a string to a long long

 * @s: The start of the string. The string must be null-terminated, and may also

 *  include a single newline before its terminating null. The first character

 *  may also be a plus sign or a minus sign.

 * @base: The number base to use. The maximum supported base is 16. If base is

 *  given as 0, then the base of the string is automatically detected with the

 *  conventional semantics - If it begins with 0x the number will be parsed as a

 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be

 *  parsed as an octal number. Otherwise it will be parsed as a decimal.

 * @res: Where to write the result of the conversion on success.

 *

 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.

 * Used as a replacement for the obsolete simple_strtoull. Return code must

 * be checked.

 */

int kstrtoll(const char *s, unsigned int base, long long *res)

{

	unsigned long long tmp;
@@ -168,6 +200,22 @@ int _kstrtol(const char *s, unsigned int base, long *res) 
}

EXPORT_SYMBOL(_kstrtol);



/**

 * kstrtouint - convert a string to an unsigned int

 * @s: The start of the string. The string must be null-terminated, and may also

 *  include a single newline before its terminating null. The first character

 *  may also be a plus sign, but not a minus sign.

 * @base: The number base to use. The maximum supported base is 16. If base is

 *  given as 0, then the base of the string is automatically detected with the

 *  conventional semantics - If it begins with 0x the number will be parsed as a

 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be

 *  parsed as an octal number. Otherwise it will be parsed as a decimal.

 * @res: Where to write the result of the conversion on success.

 *

 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.

 * Used as a replacement for the obsolete simple_strtoull. Return code must

 * be checked.

 */

int kstrtouint(const char *s, unsigned int base, unsigned int *res)

{

	unsigned long long tmp;
@@ -183,6 +231,22 @@ int kstrtouint(const char *s, unsigned int base, unsigned int *res) 
}

EXPORT_SYMBOL(kstrtouint);



/**

 * kstrtoint - convert a string to an int

 * @s: The start of the string. The string must be null-terminated, and may also

 *  include a single newline before its terminating null. The first character

 *  may also be a plus sign or a minus sign.

 * @base: The number base to use. The maximum supported base is 16. If base is

 *  given as 0, then the base of the string is automatically detected with the

 *  conventional semantics - If it begins with 0x the number will be parsed as a

 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be

 *  parsed as an octal number. Otherwise it will be parsed as a decimal.

 * @res: Where to write the result of the conversion on success.

 *

 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.

 * Used as a replacement for the obsolete simple_strtoull. Return code must

 * be checked.

 */

int kstrtoint(const char *s, unsigned int base, int *res)

{

	long long tmp;

CRA Git | Maintained and supported by SUSTech CRA and CCSE