]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
lib/kstrtox: fix kstrtobool() docstring to mention enabled/disabled
authorChaitanya Mishra <chaitanyamishra.ai@gmail.com>
Sat, 27 Dec 2025 09:22:29 +0000 (14:52 +0530)
committerAndrew Morton <akpm@linux-foundation.org>
Tue, 27 Jan 2026 03:07:10 +0000 (19:07 -0800)
Commit ae5b3500856f ("kstrtox: add support for enabled and disabled in
kstrtobool()") added support for 'e'/'E' (enabled) and 'd'/'D' (disabled)
inputs, but did not update the docstring accordingly.

Update the docstring to include 'Ee' (for true) and 'Dd' (for false) in
the list of accepted first characters.

Link: https://lkml.kernel.org/r/20251227092229.57330-1-chaitanyamishra.ai@gmail.com
Fixes: ae5b3500856f ("kstrtox: add support for enabled and disabled in kstrtobool()")
Signed-off-by: Chaitanya Mishra <chaitanyamishra.ai@gmail.com>
Cc: Mario Limonciello <mario.limonciello@amd.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
lib/kstrtox.c

index bdde40cd69d789600ad0c39cc0f61cc146e40db9..97be2a39f537105af99f3c4a2044db76743e3f54 100644 (file)
@@ -340,8 +340,8 @@ EXPORT_SYMBOL(kstrtos8);
  * @s: input string
  * @res: result
  *
- * This routine returns 0 iff the first character is one of 'YyTt1NnFf0', or
- * [oO][NnFf] for "on" and "off". Otherwise it will return -EINVAL.  Value
+ * This routine returns 0 iff the first character is one of 'EeYyTt1DdNnFf0',
+ * or [oO][NnFf] for "on" and "off". Otherwise it will return -EINVAL.  Value
  * pointed to by res is updated upon finding a match.
  */
 noinline