linux-kernel - Re: [PATCH] string: Fix missing kernel-doc descriptions in string.h

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-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <aRy6jISBogIIT-0o@ashevche-desk.local>
Date: Tue, 18 Nov 2025 20:27:24 +0200
From: Andy Shevchenko <andriy.shevchenko@...el.com>
To: Kriish Sharma <kriish.sharma2006@...il.com>
Cc: kees@...nel.org, andy@...nel.org, linux-hardening@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] string: Fix missing kernel-doc descriptions in string.h

On Tue, Nov 18, 2025 at 06:00:08PM +0000, Kriish Sharma wrote:
> While running kernel-doc validation, several warnings were emitted for
> functions in include/linux/string.h due to missing return value
> documentation or missing parameter descriptions:
> 
>     Warning: include/linux/string.h:375 No description found for return value of 'kbasename'
>     Warning: include/linux/string.h:560 No description found for return value of 'strstarts'
>     WARNING: include/linux/string.h:573 function parameter 'str' not described in 'strends'
>     WARNING: include/linux/string.h:573 function parameter 'suffix' not described in 'strends'
> 
> This patch adds the missing "Returns:" sections for kbasename() and
> strstarts(), and provides parameter descriptions for strends().
> These changes resolve all kernel-doc warnings in this header.

strends() fixes are in Bart's tree, will be soon in Linux Next I suppose.
The rest seems good.

-- 
With Best Regards,
Andy Shevchenko