[PATCH 1/1] lib/kstrtox: fix kstrtobool() docstring to mention enabled/disabled

[PATCH 1/1] lib/kstrtox: fix kstrtobool() docstring to mention enabled/disabled

[Chaitanya Mishra]

From: Chaitanya <chaitanyamishra.ai@gmail.com>

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.

Fixes: ae5b3500856f ("kstrtox: add support for enabled and disabled in kstrtobool()")
Signed-off-by: Chaitanya Mishra <chaitanyamishra.ai@gmail.com>
---
 lib/kstrtox.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/kstrtox.c b/lib/kstrtox.c
index bdde40cd69d7..97be2a39f537 100644
--- a/lib/kstrtox.c
+++ b/lib/kstrtox.c
@@ -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
-- 
2.50.1 (Apple Git-155)

Re: [PATCH 1/1] lib/kstrtox: fix kstrtobool() docstring to mention enabled/disabled

[Kuan-Wei Chiu]

Hi Chaitanya,

On Sat, Dec 27, 2025 at 02:52:29PM +0530, Chaitanya Mishra wrote:
> From: Chaitanya <chaitanyamishra.ai@gmail.com>
> 
> 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.
> 
> Fixes: ae5b3500856f ("kstrtox: add support for enabled and disabled in kstrtobool()")
> Signed-off-by: Chaitanya Mishra <chaitanyamishra.ai@gmail.com>

scripts/checkpatch.pl warns about this:

WARNING: From:/Signed-off-by: email name mismatch: 'From: Chaitanya <chaitanyamishra.ai@gmail.com>' != 'Signed-off-by: Chaitanya Mishra <chaitanyamishra.ai@gmail.com>'

total: 0 errors, 1 warnings, 10 lines checked

Please ensure you run checkpatch.pl before submitting any patch.

With that fixed, feel free to add:

Reviewed-by: Kuan-Wei Chiu <visitorckw@gmail.com>

Regards,
Kuan-Wei