Re: [PATCH] btrfs: zoned: convert comment to kernel-doc format

From: Randy Dunlap
Date: Tue Dec 07 2021 - 19:45:25 EST




On 12/7/21 11:48, David Sterba wrote:
> On Thu, Dec 02, 2021 at 10:48:20PM -0800, Randy Dunlap wrote:
>> Complete kernel-doc notation for btrfs_zone_activate() to prevent
>> kernel-doc warnings:
>>
>> zoned.c:1784: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>> * Activate block group and underlying device zones
>> zoned.c:1784: warning: missing initial short description on line:
>> * Activate block group and underlying device zones
>
> We've been using a slightly different format than the strict kernel-doc,

I'm sorry to hear that.

> in this cas the function name is not repeated (because it's right under
> the comment), what we want is the argument list checks (order and
> completeness).

Please just eliminate/prevent the warning then.
I don't care how it's done.

thanks.
--
~Randy