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

kstrto*: do not describe simple_strto*() as obsolete/replaced 



The documentation of the kstrto*() functions describes kstrto*() as
"replacements" of the "obsolete" simple_strto*() functions.  Both of these
terms are inaccurate: they're not replacements because they have different
behaviour, and the simple_strto*() are not obsolete because there are
cases where they have benefits over kstrto*().

Remove usage of the terms "replacement" and "obsolete" in reference to
simple_strto*(), and instead use the term "preferred over".

Fixes: 4c925d60 ("kstrto*: add documentation")
Fixes: 885e68e8 ("kernel.h: update comment about simple_strto<foo>() functions")
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/29b9-5f234c80-13-4e3aa200@244003027


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

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_strtoul(). Return code must be checked.

 * Preferred over 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_strtol(). Return code must be checked.

 * Preferred over 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 −8
Original line number Diff line number Diff line
@@ -115,8 +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

 * be checked.

 * Preferred over simple_strtoull(). Return code must be checked.

 */

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

{
@@ -139,8 +138,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_strtoll(). Return code must

 * be checked.

 * Preferred over simple_strtoll(). Return code must be checked.

 */

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

{
@@ -211,8 +209,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_strtoul(). Return code must

 * be checked.

 * Preferred over simple_strtoul(). Return code must be checked.

 */

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

{
@@ -242,8 +239,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_strtol(). Return code must

 * be checked.

 * Preferred over 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