linux-kernel - [kdave-btrfs-devel:for-next 138/150] fs/btrfs/volumes.c:2334: 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>] [day] [month] [year] [list]

Message-ID: <202110150719.9MwgCyNk-lkp@intel.com>
Date:   Fri, 15 Oct 2021 07:15:27 +0800
From:   kernel test robot <lkp@...el.com>
To:     Josef Bacik <josef@...icpanda.com>
Cc:     kbuild-all@...ts.01.org, linux-kernel@...r.kernel.org,
        David Sterba <dsterba@...e.com>,
        Nikolay Borisov <nborisov@...e.com>,
        Anand Jain <anand.jain@...cle.com>, linux-doc@...r.kernel.org
Subject: [kdave-btrfs-devel:for-next 138/150] fs/btrfs/volumes.c:2334:
 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 for-next
head:   00c9626f46bece739cb413d1399ead6473809c54
commit: ea57e6e833a234ebe22efbb68e31c252f2478d15 [138/150] btrfs: add a btrfs_get_dev_args_from_path helper
config: riscv-allyesconfig (attached as .config)
compiler: riscv64-linux-gcc (GCC) 11.2.0
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/ea57e6e833a234ebe22efbb68e31c252f2478d15
        git remote add kdave-btrfs-devel https://github.com/kdave/btrfs-devel.git
        git fetch --no-tags kdave-btrfs-devel for-next
        git checkout ea57e6e833a234ebe22efbb68e31c252f2478d15
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-11.2.0 make.cross ARCH=riscv 

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/volumes.c:2334: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Populate args from device at path


vim +2334 fs/btrfs/volumes.c

  2332	
  2333	/**
> 2334	 * Populate args from device at path
  2335	 *
  2336	 * @fs_info:	the filesystem
  2337	 * @args:	the args to populate
  2338	 * @path:	the path to the device
  2339	 *
  2340	 * This will read the super block of the device at @path and populate @args with
  2341	 * the devid, fsid, and uuid.  This is meant to be used for ioctls that need to
  2342	 * lookup a device to operate on, but need to do it before we take any locks.
  2343	 * This properly handles the special case of "missing" that a user may pass in,
  2344	 * and does some basic sanity checks.  The caller must make sure that @path is
  2345	 * properly NUL terminated before calling in, and must call
  2346	 * btrfs_put_dev_args_from_path() in order to free up the temporary fsid and
  2347	 * uuid buffers.
  2348	 *
  2349	 * Return: 0 for success, -errno for failure
  2350	 */
  2351	int btrfs_get_dev_args_from_path(struct btrfs_fs_info *fs_info,
  2352					 struct btrfs_dev_lookup_args *args,
  2353					 const char *path)
  2354	{
  2355		struct btrfs_super_block *disk_super;
  2356		struct block_device *bdev;
  2357		int ret;
  2358	
  2359		if (!path || !path[0])
  2360			return -EINVAL;
  2361		if (!strcmp(path, "missing")) {
  2362			args->missing = true;
  2363			return 0;
  2364		}
  2365	
  2366		args->uuid = kzalloc(BTRFS_UUID_SIZE, GFP_KERNEL);
  2367		args->fsid = kzalloc(BTRFS_FSID_SIZE, GFP_KERNEL);
  2368		if (!args->uuid || !args->fsid) {
  2369			btrfs_put_dev_args_from_path(args);
  2370			return -ENOMEM;
  2371		}
  2372	
  2373		ret = btrfs_get_bdev_and_sb(path, FMODE_READ, fs_info->bdev_holder, 0,
  2374					    &bdev, &disk_super);
  2375		if (ret)
  2376			return ret;
  2377		args->devid = btrfs_stack_device_id(&disk_super->dev_item);
  2378		memcpy(args->uuid, disk_super->dev_item.uuid, BTRFS_UUID_SIZE);
  2379		if (btrfs_fs_incompat(fs_info, METADATA_UUID))
  2380			memcpy(args->fsid, disk_super->metadata_uuid, BTRFS_FSID_SIZE);
  2381		else
  2382			memcpy(args->fsid, disk_super->fsid, BTRFS_FSID_SIZE);
  2383		btrfs_release_disk_super(disk_super);
  2384		blkdev_put(bdev, FMODE_READ);
  2385		return 0;
  2386	}
  2387	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org

Download attachment ".config.gz" of type "application/gzip" (71101 bytes)