From: Andy Shevchenko <andriy.shevchenko@intel.com>
To: Kriish Sharma <kriish.sharma2006@gmail.com>
Cc: kees@kernel.org, andy@kernel.org,
linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] string: Fix missing kernel-doc descriptions in string.h
Date: Tue, 18 Nov 2025 20:27:24 +0200 [thread overview]
Message-ID: <aRy6jISBogIIT-0o@ashevche-desk.local> (raw)
In-Reply-To: <20251118180008.2620929-1-kriish.sharma2006@gmail.com>
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
next prev parent reply other threads:[~2025-11-18 18:27 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-18 18:00 [PATCH] string: Fix missing kernel-doc descriptions in string.h Kriish Sharma
2025-11-18 18:27 ` Andy Shevchenko [this message]
2025-11-18 18:39 ` Kriish Sharma
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aRy6jISBogIIT-0o@ashevche-desk.local \
--to=andriy.shevchenko@intel.com \
--cc=andy@kernel.org \
--cc=kees@kernel.org \
--cc=kriish.sharma2006@gmail.com \
--cc=linux-hardening@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox