linux-kernel - [PATCH] x86/boot: repair kernel-doc for boot

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20221031094835.15923-1-lukas.bulwahn@gmail.com>
Date:   Mon, 31 Oct 2022 10:48:35 +0100
From:   Lukas Bulwahn <lukas.bulwahn@...il.com>
To:     Borislav Petkov <bp@...e.de>, Borislav Petkov <bp@...en8.de>,
        x86@...nel.org
Cc:     Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>,
        Dave Hansen <dave.hansen@...ux.intel.com>,
        "H . Peter Anvin" <hpa@...or.com>,
        Vamshi K Sthambamkadi <vamshi.k.sthambamkadi@...il.com>,
        kernel-janitors@...r.kernel.org, linux-kernel@...r.kernel.org,
        Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: [PATCH] x86/boot: repair kernel-doc for boot_kstrtoul()

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@...il.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