linux-kernel - drivers/infiniband/hw/hns/hns_roce_hem.c:1165: 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: <202105241740.oe2xf0Vw-lkp@intel.com>
Date:   Mon, 24 May 2021 17:53:43 +0800
From:   kernel test robot <lkp@...el.com>
To:     Aditya Srivastava <yashsri421@...il.com>
Cc:     kbuild-all@...ts.01.org, clang-built-linux@...glegroups.com,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        linux-doc@...r.kernel.org
Subject: drivers/infiniband/hw/hns/hns_roce_hem.c:1165: 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:   c4681547bcce777daf576925a966ffa824edd09d
commit: f9bbc12ccb35ac8b3fa01cec1a19cb523a7707c7 scripts: kernel-doc: improve parsing for kernel-doc comments syntax
date:   6 weeks ago
config: arm64-randconfig-r015-20210524 (attached as .config)
compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project 93d1e5822ed64abd777eb94ea9899e96c4c39fbe)
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
        # install arm64 cross compiling tool for clang build
        # apt-get install binutils-aarch64-linux-gnu
        # https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=f9bbc12ccb35ac8b3fa01cec1a19cb523a7707c7
        git remote add linus https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
        git fetch --no-tags linus master
        git checkout f9bbc12ccb35ac8b3fa01cec1a19cb523a7707c7
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=arm64 

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 >>):

>> drivers/infiniband/hw/hns/hns_roce_hem.c:1165: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * calc base address entries num
   drivers/infiniband/hw/hns/hns_roce_hem.c:1198: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * calc the root ba entries which could cover all regions


vim +1165 drivers/infiniband/hw/hns/hns_roce_hem.c

38389eaa4db1926 Lijun Ou 2019-06-08  1163  
38389eaa4db1926 Lijun Ou 2019-06-08  1164  /**
38389eaa4db1926 Lijun Ou 2019-06-08 @1165   * calc base address entries num
38389eaa4db1926 Lijun Ou 2019-06-08  1166   * @hopnum: num of mutihop addressing
38389eaa4db1926 Lijun Ou 2019-06-08  1167   * @bt_level: base address table level
38389eaa4db1926 Lijun Ou 2019-06-08  1168   * @unit: ba entries per bt page
38389eaa4db1926 Lijun Ou 2019-06-08  1169   */
38389eaa4db1926 Lijun Ou 2019-06-08  1170  static u32 hem_list_calc_ba_range(int hopnum, int bt_level, int unit)
38389eaa4db1926 Lijun Ou 2019-06-08  1171  {
38389eaa4db1926 Lijun Ou 2019-06-08  1172  	u32 step;
38389eaa4db1926 Lijun Ou 2019-06-08  1173  	int max;
38389eaa4db1926 Lijun Ou 2019-06-08  1174  	int i;
38389eaa4db1926 Lijun Ou 2019-06-08  1175  
38389eaa4db1926 Lijun Ou 2019-06-08  1176  	if (hopnum <= bt_level)
38389eaa4db1926 Lijun Ou 2019-06-08  1177  		return 0;
38389eaa4db1926 Lijun Ou 2019-06-08  1178  	/*
38389eaa4db1926 Lijun Ou 2019-06-08  1179  	 * hopnum  bt_level   range
38389eaa4db1926 Lijun Ou 2019-06-08  1180  	 * 1	      0       unit
38389eaa4db1926 Lijun Ou 2019-06-08  1181  	 * ------------
38389eaa4db1926 Lijun Ou 2019-06-08  1182  	 * 2	      0       unit * unit
38389eaa4db1926 Lijun Ou 2019-06-08  1183  	 * 2	      1       unit
38389eaa4db1926 Lijun Ou 2019-06-08  1184  	 * ------------
38389eaa4db1926 Lijun Ou 2019-06-08  1185  	 * 3	      0       unit * unit * unit
38389eaa4db1926 Lijun Ou 2019-06-08  1186  	 * 3	      1       unit * unit
38389eaa4db1926 Lijun Ou 2019-06-08  1187  	 * 3	      2       unit
38389eaa4db1926 Lijun Ou 2019-06-08  1188  	 */
38389eaa4db1926 Lijun Ou 2019-06-08  1189  	step = 1;
38389eaa4db1926 Lijun Ou 2019-06-08  1190  	max = hopnum - bt_level;
38389eaa4db1926 Lijun Ou 2019-06-08  1191  	for (i = 0; i < max; i++)
38389eaa4db1926 Lijun Ou 2019-06-08  1192  		step = step * unit;
38389eaa4db1926 Lijun Ou 2019-06-08  1193  
38389eaa4db1926 Lijun Ou 2019-06-08  1194  	return step;
38389eaa4db1926 Lijun Ou 2019-06-08  1195  }
38389eaa4db1926 Lijun Ou 2019-06-08  1196  

:::::: The code at line 1165 was first introduced by commit
:::::: 38389eaa4db192648916464b60f6086d6bbaa6de RDMA/hns: Add mtr support for mixed multihop addressing

:::::: TO: Lijun Ou <oulijun@...wei.com>
:::::: CC: Doug Ledford <dledford@...hat.com>

---
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" (42659 bytes)