linux-kernel - Re: [PATCH v2] string: Add missing kernel-doc return descriptions

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

Message-ID: <CAHp75VfEUL=BVVFX24hShev+LFPKNToDhpgHf4Z-C8KAG_UJmg@mail.gmail.com>
Date: Tue, 18 Nov 2025 21:00:59 +0200
From: Andy Shevchenko <andy.shevchenko@...il.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 v2] string: Add missing kernel-doc return descriptions

On Tue, Nov 18, 2025 at 8:50 PM Kriish Sharma
<kriish.sharma2006@...il.com> wrote:
>
> While running kernel-doc validation on linux-next, warnings were emitted
> for functions in include/linux/string.h due to missing return value
> documentation:
>
>     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'
>
> This patch adds the missing return value descriptions for both functions
> and clears the related kernel-doc warnings.

Reviewed-by: Andy Shevchenko <andy@...nel.org>

...

>   * kbasename - return the last part of a pathname.
>   *

This blank line can be removed, while at it, but I leave it to you and
maintainers.

>   * @path: path to extract the filename from.

-- 
With Best Regards,
Andy Shevchenko