linux-kernel - [kdave-btrfs-devel:misc-next 122/137] fs/btrfs/ctree.c:2302: 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: <202203151609.xUNBpLp7-lkp@intel.com>
Date:   Tue, 15 Mar 2022 16:57:24 +0800
From:   kernel test robot <lkp@...el.com>
To:     Gabriel Niebler <gniebler@...e.com>
Cc:     kbuild-all@...ts.01.org, linux-kernel@...r.kernel.org,
        David Sterba <dsterba@...e.com>,
        Marcos Paulo de Souza <mpdesouza@...e.com>,
        linux-doc@...r.kernel.org
Subject: [kdave-btrfs-devel:misc-next 122/137] fs/btrfs/ctree.c:2302:
 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:   534513d9f513c4b9a622b34c8fb11281d9ee5a06
commit: 3be2b28d45e8f37457d0d9efa5af6a97fab060c9 [122/137] btrfs: introduce btrfs_for_each_slot iterator macro
config: parisc64-defconfig (https://download.01.org/0day-ci/archive/20220315/202203151609.xUNBpLp7-lkp@intel.com/config)
compiler: hppa64-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/3be2b28d45e8f37457d0d9efa5af6a97fab060c9
        git remote add kdave-btrfs-devel https://github.com/kdave/btrfs-devel.git
        git fetch --no-tags kdave-btrfs-devel misc-next
        git checkout 3be2b28d45e8f37457d0d9efa5af6a97fab060c9
        # save the config file to linux build tree
        mkdir build_dir
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-11.2.0 make.cross O=build_dir ARCH=parisc64 SHELL=/bin/bash fs/btrfs/

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/ctree.c:2302: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Search for a valid slot for the given path.


vim +2302 fs/btrfs/ctree.c

  2300	
  2301	/**
> 2302	 * Search for a valid slot for the given path.
  2303	 *
  2304	 * @root:	The root node of the tree.
  2305	 * @key:	Will contain a valid item if found.
  2306	 * @path:	The starting point to validate the slot.
  2307	 *
  2308	 * Return: 0  if the item is valid
  2309	 *         1  if not found
  2310	 *         <0 if error.
  2311	 */
  2312	int btrfs_get_next_valid_item(struct btrfs_root *root, struct btrfs_key *key,
  2313				      struct btrfs_path *path)
  2314	{
  2315		while (1) {
  2316			int ret;
  2317			const int slot = path->slots[0];
  2318			const struct extent_buffer *leaf = path->nodes[0];
  2319	
  2320			/* This is where we start walking the path. */
  2321			if (slot >= btrfs_header_nritems(leaf)) {
  2322				/*
  2323				 * If we've reached the last slot in this leaf we need
  2324				 * to go to the next leaf and reset the path.
  2325				 */
  2326				ret = btrfs_next_leaf(root, path);
  2327				if (ret)
  2328					return ret;
  2329				continue;
  2330			}
  2331			/* Store the found, valid item in @key. */
  2332			btrfs_item_key_to_cpu(leaf, key, slot);
  2333			break;
  2334		}
  2335		return 0;
  2336	}
  2337	

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