2021-08-27 23:12:16

by kernel test robot

[permalink] [raw]
Subject: [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

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 <[email protected]>

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
1698 *
1699 * @block_group: the block group to activate
1700 *
1701 * Return: true on success, false otherwise
1702 */
1703 bool btrfs_zone_activate(struct btrfs_block_group *block_group)
1704 {
1705 struct btrfs_fs_info *fs_info = block_group->fs_info;
1706 struct map_lookup *map;
1707 struct btrfs_device *device;
1708 u64 physical;
1709 bool ret;
1710
1711 if (!btrfs_is_zoned(block_group->fs_info))
1712 return true;
1713
1714 map = block_group->physical_map;
1715 /* Currently support SINGLE profile only */
1716 ASSERT(map->num_stripes == 1);
1717 device = map->stripes[0].dev;
1718 physical = map->stripes[0].physical;
1719
1720 if (device->zone_info->max_active_zones == 0)
1721 return true;
1722
1723 spin_lock(&block_group->lock);
1724
1725 if (block_group->zone_is_active) {
1726 ret = true;
1727 goto out_unlock;
1728 }
1729
1730 /* No space left */
1731 if (block_group->alloc_offset == block_group->zone_capacity) {
1732 ret = false;
1733 goto out_unlock;
1734 }
1735
1736 if (!btrfs_dev_set_active_zone(device, physical)) {
1737 /* Cannot activate the zone */
1738 ret = false;
1739 goto out_unlock;
1740 }
1741
1742 /* Successfully activated all the zones */
1743 block_group->zone_is_active = 1;
1744
1745 spin_unlock(&block_group->lock);
1746
1747 /* For the active block group list */
1748 btrfs_get_block_group(block_group);
1749
1750 spin_lock(&fs_info->zone_active_bgs_lock);
1751 ASSERT(list_empty(&block_group->active_bg_list));
1752 list_add_tail(&block_group->active_bg_list, &fs_info->zone_active_bgs);
1753 spin_unlock(&fs_info->zone_active_bgs_lock);
1754
1755 return true;
1756
1757 out_unlock:
1758 spin_unlock(&block_group->lock);
1759 return ret;
1760 }
1761

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/[email protected]


Attachments:
(No filename) (3.47 kB)
.config.gz (37.82 kB)
Download all attachments

2021-08-30 09:49:59

by David Sterba

[permalink] [raw]
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 <[email protected]>
>
> 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.