Thread (4 messages) 4 messages, 2 authors, 2021-12-08

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

From: Randy Dunlap <hidden>
Date: 2021-12-08 00:45:24
Also in: lkml


On 12/7/21 11:48, David Sterba wrote:
On Thu, Dec 02, 2021 at 10:48:20PM -0800, Randy Dunlap wrote:
quoted
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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help