Message-ID: <28105cc3-88b0-763d-5bc5-06eb67ee130f@infradead.org>
Date:   Tue, 7 Dec 2021 16:43:15 -0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.3.2
Subject: Re: [PATCH] btrfs: zoned: convert comment to kernel-doc format
Content-Language: en-US
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
References: <20211203064820.27033-1-rdunlap@infradead.org>
 <20211207194820.GH28560@twin.jikos.cz>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20211207194820.GH28560@twin.jikos.cz>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk


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