From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Kees Cook <kees@kernel.org>, Andy Shevchenko <andy@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: [PATCH v1 1/1] string: Add missing Return sections
Date: Wed, 3 Jun 2026 10:43:10 +0300 [thread overview]
Message-ID: <ah_bDg7tr6iDpDWA@ashevche-desk.local> (raw)
In-Reply-To: <20260603071648.106679-2-andriy.shevchenko@linux.intel.com>
On Wed, Jun 03, 2026 at 09:15:52AM +0200, Andy Shevchenko wrote:
> The kernel-doc unfortunately can't catch some corner cases. Hence
> the commit 645b9ad2dc6b ("string: Add missing kernel-doc return descriptions")
> missed that. On top there is no consistency in use of Return/Returns.
> Address both problems here. Choose Returns over Return as it will be
> less invasive change.
>
> Fixes: 645b9ad2dc6b ("string: Add missing kernel-doc return descriptions")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
>
> Cc'ed to the Documentation and kernel-doc people to point out on this
> kernel-doc corner cases. It didn't complain on the macros that return
> a value. Also it would be nice to have file level consistency on
> the naming of the same type of sections, e.g., Returns vs. Return.
>
> Kees, feel free to drop Fixes whilst applying in case you think it not
> worth it. The commit message still has a pointer.
...
> * Helper for __sysfs_match_string(). Calculates the size of @a automatically.
Oh, and it should spell @_a in the above... (however it's not quite related it
seems okay to address while at it). Kees, can you also fix that? Or would you
like to see a v2 or a separate change for that?
> + * Returns:
> + * The index of the matching string in the array or negative error code
> + * otherwise.
--
With Best Regards,
Andy Shevchenko
prev parent reply other threads:[~2026-06-03 7:43 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-06-03 7:15 Andy Shevchenko
2026-06-03 7:43 ` Andy Shevchenko [this message]
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=ah_bDg7tr6iDpDWA@ashevche-desk.local \
--to=andriy.shevchenko@linux.intel.com \
--cc=andy@kernel.org \
--cc=corbet@lwn.net \
--cc=kees@kernel.org \
--cc=linux-hardening@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@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
all inboxes | Powered by JetHome®