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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20211207194820.GH28560@twin.jikos.cz>
Date:   Tue, 7 Dec 2021 20:48:20 +0100
From:   David Sterba <dsterba@...e.cz>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Naohiro Aota <naohiro.aota@....com>,
        David Sterba <dsterba@...e.com>, Chris Mason <clm@...com>,
        Josef Bacik <josef@...icpanda.com>, linux-btrfs@...r.kernel.org
Subject: Re: [PATCH] btrfs: zoned: convert comment to kernel-doc format

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,
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).