public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH v3 1/2] kernel.h: Update comment about simple_strto<foo>() functions
@ 2019-07-04 11:55 Andy Shevchenko
  2019-07-04 11:55 ` [PATCH v3 2/2] auxdisplay: charlcd: Deduplicate simple_strtoul() Andy Shevchenko
  2019-07-08 13:01 ` [PATCH v3 1/2] kernel.h: Update comment about simple_strto<foo>() functions Petr Mladek
  0 siblings, 2 replies; 9+ messages in thread
From: Andy Shevchenko @ 2019-07-04 11:55 UTC (permalink / raw)
  To: Miguel Ojeda Sandonis, linux-kernel, Geert Uytterhoeven,
	Mans Rullgard, Andrew Morton, Petr Mladek
  Cc: Andy Shevchenko

There were discussions in the past about use cases for
simple_strto<foo>() functions and, in some rare cases,
they have a benefit over kstrto<foo>() ones.

Update a comment to reduce confusion about special use cases.

Suggested-by: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
- update comment based on Geert's input
 include/linux/kernel.h | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/include/linux/kernel.h b/include/linux/kernel.h
index 0c9bc231107f..63663c44933d 100644
--- a/include/linux/kernel.h
+++ b/include/linux/kernel.h
@@ -332,8 +332,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 obsolete simple_strtoull. Return code must
- * be checked.
+ * Used as a replacement for the simple_strtoull. Return code must be checked.
 */
 static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
 {
@@ -361,8 +360,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 obsolete simple_strtoull. Return code must
- * be checked.
+ * Used as a replacement for the simple_strtoull. Return code must be checked.
  */
 static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
 {
@@ -438,7 +436,16 @@ static inline int __must_check kstrtos32_from_user(const char __user *s, size_t
 	return kstrtoint_from_user(s, count, base, res);
 }
 
-/* Obsolete, do not use.  Use kstrto<foo> instead */
+/*
+ * Use kstrto<foo> instead.
+ *
+ * NOTE: The simple_strto<foo> does not check for overflow and,
+ *	 depending on the input, may give interesting results.
+ *
+ * Use these functions if and only if you cannot use kstrto<foo>, because
+ * the number is not immediately followed by a NUL-character in the buffer.
+ * Keep in mind above caveat.
+ */
 
 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
 extern long simple_strtol(const char *,char **,unsigned int);
-- 
2.20.1


^ permalink raw reply related	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2019-07-08 13:56 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-07-04 11:55 [PATCH v3 1/2] kernel.h: Update comment about simple_strto<foo>() functions Andy Shevchenko
2019-07-04 11:55 ` [PATCH v3 2/2] auxdisplay: charlcd: Deduplicate simple_strtoul() Andy Shevchenko
2019-07-08 13:16   ` Petr Mladek
2019-07-08 13:35     ` Andy Shevchenko
2019-07-08 13:42       ` David Laight
2019-07-08 13:56       ` Petr Mladek
2019-07-08 13:01 ` [PATCH v3 1/2] kernel.h: Update comment about simple_strto<foo>() functions Petr Mladek
2019-07-08 13:13   ` Geert Uytterhoeven
2019-07-08 13:48     ` Petr Mladek

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox