x86/boot: repair kernel-doc for boot_kstrtoul()

Message ID 20221031094835.15923-1-lukas.bulwahn@gmail.com
State New
Headers
Series x86/boot: repair kernel-doc for boot_kstrtoul() |

Commit Message

Lukas Bulwahn Oct. 31, 2022, 9:48 a.m. UTC
  Commit 5fafbebc86a0 ("x86/boot: Add kstrtoul() from lib/") temporarily adds
a copy of kstrtoul() to arch/x86/boot/string.c. While massaging the
provided patch, Borislav renames the kstrtoul() to boot_kstrtoul(), but
misses to adjust the corresponding kernel-doc comment.

Adjust the kernel-doc comment for boot_kstrtoul() for make W=1 happiness.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
Boris, please pick this quick kernel-doc cleanup patch. Thanks.

 arch/x86/boot/string.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Patch

diff --git a/arch/x86/boot/string.c b/arch/x86/boot/string.c
index 8a3fff9128bb..1c8541ae3b3a 100644
--- a/arch/x86/boot/string.c
+++ b/arch/x86/boot/string.c
@@ -350,7 +350,7 @@  static int _kstrtoul(const char *s, unsigned int base, unsigned long *res)
 }
 
 /**
- * kstrtoul - convert a string to an unsigned long
+ * boot_kstrtoul - convert a string to an unsigned long
  * @s: The start of the string. The string must be null-terminated, and may also
  *  include a single newline before its terminating null. The first character
  *  may also be a plus sign, but not a minus sign.