linux-kernel - Re: [kdave-btrfs-devel:misc-next 147/154] fs/btrfs/zoned.c:1697: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

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] [day] [month] [year] [list]

Message-ID: <20210830094550.GA3379@suse.cz>
Date:   Mon, 30 Aug 2021 11:45:51 +0200
From:   David Sterba <dsterba@...e.cz>
To:     kernel test robot <lkp@...el.com>
Cc:     Naohiro Aota <naohiro.aota@....com>, llvm@...ts.linux.dev,
        kbuild-all@...ts.01.org, linux-kernel@...r.kernel.org,
        David Sterba <dsterba@...e.com>, linux-doc@...r.kernel.org
Subject: Re: [kdave-btrfs-devel:misc-next 147/154] fs/btrfs/zoned.c:1697:
 warning: This comment starts with '/**', but isn't a kernel-doc comment.
 Refer Documentation/doc-guide/kernel-doc.rst

On Sat, Aug 28, 2021 at 07:10:47AM +0800, kernel test robot wrote:
> tree:   https://github.com/kdave/btrfs-devel.git misc-next
> head:   18f0c5bda0dd67dedb8df3d7faf856dffa8f78d3
> commit: 770a7b4f5bd01ee953b538064068e814285df79b [147/154] btrfs: zoned: implement active zone tracking
> config: x86_64-randconfig-a005-20210827 (attached as .config)
> compiler: clang version 14.0.0 (https://github.com/llvm/llvm-project 1076082a0d97bd5c16a25ee7cf3dbb6ee4b5a9fe)
> reproduce (this is a W=1 build):
>         wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
>         chmod +x ~/bin/make.cross
>         # https://github.com/kdave/btrfs-devel/commit/770a7b4f5bd01ee953b538064068e814285df79b
>         git remote add kdave-btrfs-devel https://github.com/kdave/btrfs-devel.git
>         git fetch --no-tags kdave-btrfs-devel misc-next
>         git checkout 770a7b4f5bd01ee953b538064068e814285df79b
>         # save the attached .config to linux build tree
>         COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64 
> 
> If you fix the issue, kindly add following tag as appropriate
> Reported-by: kernel test robot <lkp@...el.com>
> 
> All warnings (new ones prefixed by >>):
> 
> >> fs/btrfs/zoned.c:1697: 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
> 
> 
> vim +1697 fs/btrfs/zoned.c
> 
>   1695	
>   1696	/**
> > 1697	 * Activate block group and underlying device zones

This is from my edit, I'm dropping the function name because it's just a
few lines below so it does not bring much value and only we want the
kernel doc style to verify the parameters and keep the comment human
readable.  That the kdoc warns about the missing function name is some
recent addition.