Commit b642e44e authored by Kars Mulder's avatar Kars Mulder Committed by Linus Torvalds
Browse files

kstrto*: correct documentation references to simple_strto*() 



The documentation of the kstrto*() functions reference the simple_strtoull
function by "used as a replacement for [the obsolete] simple_strtoull".
All these functions describes themselves as replacements for the function
simple_strtoull, even though a function like kstrtol() would be more aptly
described as a replacement of simple_strtol().

Fix these references by making the documentation of kstrto*() reference
the closest simple_strto*() equivalent available.  The functions
kstrto[u]int() do not have direct simple_strto[u]int() equivalences, so
these are made to refer to simple_strto[u]l() instead.

Furthermore, add parentheses after function names, as is standard in
kernel documentation.

Fixes: 4c925d60 ("kstrto*: add documentation")
Signed-off-by: default avatarKars Mulder <kerneldev@karsmulder.nl>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Reviewed-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: Eldad Zack <eldad@fogrefinery.com>
Cc: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Cc: Geert Uytterhoeven <geert+renesas@glider.be>
Cc: Mans Rullgard <mans@mansr.com>
Cc: Petr Mladek <pmladek@suse.com>
Link: http://lkml.kernel.org/r/1ee1-5f234c00-f3-165a6440@234394593


Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent d89775fc

include/linux/kernel.h

+2 −2
Original line number Diff line number Diff line
@@ -346,7 +346,7 @@ int __must_check kstrtoll(const char *s, unsigned int base, long long *res); 
 * @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 simple_strtoull. Return code must be checked.

 * Used as a replacement for the simple_strtoul(). Return code must be checked.

*/

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

{
@@ -374,7 +374,7 @@ static inline int __must_check kstrtoul(const char *s, unsigned int base, unsign 
 * @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 simple_strtoull. Return code must be checked.

 * Used as a replacement for the simple_strtol(). Return code must be checked.

 */

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

{

lib/kstrtox.c

+4 −4
Original line number Diff line number Diff line
@@ -115,7 +115,7 @@ static int _kstrtoull(const char *s, unsigned int base, unsigned long long *res) 
 * @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

 * 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)
@@ -139,7 +139,7 @@ EXPORT_SYMBOL(kstrtoull); 
 * @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

 * Used as a replacement for the obsolete simple_strtoll(). Return code must

 * be checked.

 */

int kstrtoll(const char *s, unsigned int base, long long *res)
@@ -211,7 +211,7 @@ EXPORT_SYMBOL(_kstrtol); 
 * @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

 * Used as a replacement for the obsolete simple_strtoul(). Return code must

 * be checked.

 */

int kstrtouint(const char *s, unsigned int base, unsigned int *res)
@@ -242,7 +242,7 @@ EXPORT_SYMBOL(kstrtouint); 
 * @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

 * Used as a replacement for the obsolete simple_strtol(). Return code must

 * be checked.

 */

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

CRA Git | Maintained and supported by SUSTech CRA and CCSE