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

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

[Lukas Bulwahn]

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(-)

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.
-- 
2.17.1

[tip: x86/cleanups] x86/boot: Repair kernel-doc for boot_kstrtoul()

[tip-bot2 for Lukas Bulwahn]

The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID:     d632bf6ff1f6f733e1de9c5331fd643f4ecbe483
Gitweb:        https://git.kernel.org/tip/d632bf6ff1f6f733e1de9c5331fd643f4ecbe483
Author:        Lukas Bulwahn <lukas.bulwahn@gmail.com>
AuthorDate:    Mon, 31 Oct 2022 10:48:35 +01:00
Committer:     Borislav Petkov <bp@suse.de>
CommitterDate: Wed, 02 Nov 2022 10:20:02 +01:00

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

Adjust the kernel-doc comment to have the proper function name:
boot_kstrtoul().

  [ bp: Massage commit message. ]

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Borislav Petkov <bp@suse.de>
Link: https://lore.kernel.org/r/20221031094835.15923-1-lukas.bulwahn@gmail.com
---
 arch/x86/boot/string.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/boot/string.c b/arch/x86/boot/string.c
index 8a3fff9..1c8541a 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.