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 <[email protected]>
> ---
> 
> 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



Reply via email to