From: Randy Dunlap <rdunlap@infradead.org>
To: dsterba@suse.cz, linux-kernel@vger.kernel.org,
kernel test robot <lkp@intel.com>,
Naohiro Aota <naohiro.aota@wdc.com>,
David Sterba <dsterba@suse.com>, Chris Mason <clm@fb.com>,
Josef Bacik <josef@toxicpanda.com>,
linux-btrfs@vger.kernel.org
Subject: Re: [PATCH] btrfs: zoned: convert comment to kernel-doc format
Date: Tue, 7 Dec 2021 16:43:15 -0800 [thread overview]
Message-ID: <28105cc3-88b0-763d-5bc5-06eb67ee130f@infradead.org> (raw)
In-Reply-To: <20211207194820.GH28560@twin.jikos.cz>
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
next prev parent reply other threads:[~2021-12-08 0:45 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-03 6:48 [PATCH] btrfs: zoned: convert comment to kernel-doc format Randy Dunlap
2021-12-07 19:48 ` David Sterba
2021-12-08 0:43 ` Randy Dunlap [this message]
2021-12-08 13:56 ` David Sterba
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=28105cc3-88b0-763d-5bc5-06eb67ee130f@infradead.org \
--to=rdunlap@infradead.org \
--cc=clm@fb.com \
--cc=dsterba@suse.com \
--cc=dsterba@suse.cz \
--cc=josef@toxicpanda.com \
--cc=linux-btrfs@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=naohiro.aota@wdc.com \
/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;
as well as URLs for NNTP newsgroup(s).