linux-kernel - fs/btrfs/raid56.c:1000: 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]

Date:   Thu, 4 Aug 2022 02:49:24 +0800
From:   kernel test robot <lkp@...el.com>
To:     Qu Wenruo <wqu@...e.com>
Cc:     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: fs/btrfs/raid56.c:1000: warning: This comment starts with '/**', but
 isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   e2b542100719a93f8cdf6d90185410d38a57a4c1
commit: 3e77605d6a81efd39278a5ca2ee57737eb2659d2 btrfs: raid56: make rbio_add_io_page() subpage compatible
date:   3 months ago
config: hexagon-randconfig-r002-20220803 (https://download.01.org/0day-ci/archive/20220804/202208040217.jYokbVy6-lkp@intel.com/config)
compiler: clang version 16.0.0 (https://github.com/llvm/llvm-project 495519e5f8232d144ed26e9c18dbcbac6a5f25eb)
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://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3e77605d6a81efd39278a5ca2ee57737eb2659d2
        git remote add linus https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
        git fetch --no-tags linus master
        git checkout 3e77605d6a81efd39278a5ca2ee57737eb2659d2
        # save the config file
        mkdir build_dir && cp config build_dir/.config
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=hexagon SHELL=/bin/bash fs/btrfs/

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <lkp@...el.com>

All warnings (new ones prefixed by >>):

>> fs/btrfs/raid56.c:1000: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Get a sector pointer specified by its @stripe_nr and @sector_nr


vim +1000 fs/btrfs/raid56.c

   998	
   999	/**
> 1000	 * Get a sector pointer specified by its @stripe_nr and @sector_nr
  1001	 *
  1002	 * @rbio:               The raid bio
  1003	 * @stripe_nr:          Stripe number, valid range [0, real_stripe)
  1004	 * @sector_nr:		Sector number inside the stripe,
  1005	 *			valid range [0, stripe_nsectors)
  1006	 * @bio_list_only:      Whether to use sectors inside the bio list only.
  1007	 *
  1008	 * The read/modify/write code wants to reuse the original bio page as much
  1009	 * as possible, and only use stripe_sectors as fallback.
  1010	 */
  1011	static struct sector_ptr *sector_in_rbio(struct btrfs_raid_bio *rbio,
  1012						 int stripe_nr, int sector_nr,
  1013						 bool bio_list_only)
  1014	{
  1015		struct sector_ptr *sector;
  1016		int index;
  1017	
  1018		ASSERT(stripe_nr >= 0 && stripe_nr < rbio->real_stripes);
  1019		ASSERT(sector_nr >= 0 && sector_nr < rbio->stripe_nsectors);
  1020	
  1021		index = stripe_nr * rbio->stripe_nsectors + sector_nr;
  1022		ASSERT(index >= 0 && index < rbio->nr_sectors);
  1023	
  1024		spin_lock_irq(&rbio->bio_list_lock);
  1025		sector = &rbio->bio_sectors[index];
  1026		if (sector->page || bio_list_only) {
  1027			/* Don't return sector without a valid page pointer */
  1028			if (!sector->page)
  1029				sector = NULL;
  1030			spin_unlock_irq(&rbio->bio_list_lock);
  1031			return sector;
  1032		}
  1033		spin_unlock_irq(&rbio->bio_list_lock);
  1034	
  1035		return &rbio->stripe_sectors[index];
  1036	}
  1037	

-- 
0-DAY CI Kernel Test Service
https://01.org/lkp