linux-kernel - drivers/platform/mellanox/mlxbf-pmc.c:82: 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: <202107221601.OI3Ebmjl-lkp@intel.com>
Date:   Thu, 22 Jul 2021 16:46:06 +0800
From:   kernel test robot <lkp@...el.com>
To:     Aditya Srivastava <yashsri421@...il.com>
Cc:     clang-built-linux@...glegroups.com, kbuild-all@...ts.01.org,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        linux-doc@...r.kernel.org
Subject: drivers/platform/mellanox/mlxbf-pmc.c:82: warning: This comment
 starts with '/**', but isn't a kernel-doc comment. Refer
 Documentation/doc-guide/kernel-doc.rst

Hi Aditya,

FYI, the error/warning still remains.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   3d5895cd351757f69c9a66fb5fc8cf19f454d773
commit: f9bbc12ccb35ac8b3fa01cec1a19cb523a7707c7 scripts: kernel-doc: improve parsing for kernel-doc comments syntax
date:   3 months ago
config: arm64-randconfig-r015-20210722 (attached as .config)
compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project 9625ca5b602616b2f5584e8a49ba93c52c141e40)
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/platform/mellanox/mlxbf-pmc.c:82: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Structure to hold attribute and block info for each sysfs entry
   drivers/platform/mellanox/mlxbf-pmc.c:94: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Structure to hold info for each HW block
   drivers/platform/mellanox/mlxbf-pmc.c:121: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Structure to hold PMC context info
   drivers/platform/mellanox/mlxbf-pmc.c:148: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Structure to hold supported events for each block


vim +82 drivers/platform/mellanox/mlxbf-pmc.c

1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  80  
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  81  /**
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08 @82   * Structure to hold attribute and block info for each sysfs entry
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  83   * @dev_attr: Device attribute struct
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  84   * @index: index to identify counter number within a block
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  85   * @nr: block number to which the sysfs belongs
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  86   */
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  87  struct mlxbf_pmc_attribute {
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  88  	struct device_attribute dev_attr;
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  89  	int index;
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  90  	int nr;
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  91  };
1a218d312e65ec3 Shravan Kumar Ramani 2020-10-08  92  

:::::: The code at line 82 was first introduced by commit
:::::: 1a218d312e65ec396b2739056a8ea78493015f21 platform/mellanox: mlxbf-pmc: Add Mellanox BlueField PMC driver

:::::: TO: Shravan Kumar Ramani <shravankr@...dia.com>
:::::: CC: Hans de Goede <hdegoede@...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" (43558 bytes)