linux-kernel - Re: [PATCH] btrfs: zstd: add missing function name in zstd_reclaim_timer

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: <YluGmERvtQY9ju7Y@casper.infradead.org>
Date:   Sun, 17 Apr 2022 04:16:40 +0100
From:   Matthew Wilcox <willy@...radead.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     linux-doc@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Chris Mason <clm@...com>, Josef Bacik <josef@...icpanda.com>,
        David Sterba <dsterba@...e.com>,
        Nick Terrell <terrelln@...com>, Schspa Shi <schspa@...il.com>,
        linux-btrfs@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] btrfs: zstd: add missing function name in
 zstd_reclaim_timer_fn() comment

On Sat, Apr 16, 2022 at 03:15:34PM +0700, Bagas Sanjaya wrote:
> kernel test robot reports kernel-doc warning:
> 
> >> fs/btrfs/zstd.c:98: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

This is the wrong fix.  Static functions should not have kernel-doc
comments.  Just delete the second '*' at the head of the comment.

Also, btrfs developers should be testing with W=1.  That will catch
these problems before the code is integrated.