linux-kernel - [ogabbay:next 11/13] drivers/misc/habanalabs/common/state_dump.c:12: 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: <202107042254.KTsmA7Ww-lkp@intel.com>
Date:   Sun, 4 Jul 2021 22:30:57 +0800
From:   kernel test robot <lkp@...el.com>
To:     Yuri Nudelman <ynudelman@...ana.ai>
Cc:     clang-built-linux@...glegroups.com, kbuild-all@...ts.01.org,
        linux-kernel@...r.kernel.org, Oded Gabbay <ogabbay@...nel.org>,
        linux-doc@...r.kernel.org
Subject: [ogabbay:next 11/13] drivers/misc/habanalabs/common/state_dump.c:12:
 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/ogabbay/linux.git next
head:   e07c3e2148e472868aa22cffb5e4b0b2c7b73be8
commit: 41a0f1e2bd12cb274dec431c9904612c61bdf21f [11/13] habanalabs: expose state dump
config: x86_64-randconfig-a006-20210704 (attached as .config)
compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project 89c1c64cc3170a05a881bb9954feafc3edca6704)
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 x86_64 cross compiling tool for clang build
        # apt-get install binutils-x86-64-linux-gnu
        # https://git.kernel.org/pub/scm/linux/kernel/git/ogabbay/linux.git/commit/?id=41a0f1e2bd12cb274dec431c9904612c61bdf21f
        git remote add ogabbay https://git.kernel.org/pub/scm/linux/kernel/git/ogabbay/linux.git
        git fetch --no-tags ogabbay next
        git checkout 41a0f1e2bd12cb274dec431c9904612c61bdf21f
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64 

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/misc/habanalabs/common/state_dump.c:12: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * A helper function, format an integer as binary using supplied scratch buffer,


vim +12 drivers/misc/habanalabs/common/state_dump.c

    10	
    11	/**
  > 12	 * A helper function, format an integer as binary using supplied scratch buffer,
    13	 * return the pointer to the buffer.
    14	 * @buf: the buffer to use
    15	 * @buf_len: buffer capacity
    16	 * @n: number to format
    17	 *
    18	 * Returns pointer to buf
    19	 */
    20	char *hl_format_as_binary(char *buf, size_t buf_len, u32 n)
    21	{
    22		int i;
    23		u32 bit;
    24		bool leading0 = true;
    25		char *wrptr = buf;
    26	
    27		if (buf_len > 0 && buf_len < 3) {
    28			*wrptr = '\0';
    29			return buf;
    30		}
    31	
    32		wrptr[0] = '0';
    33		wrptr[1] = 'b';
    34		wrptr += 2;
    35		/* Remove 3 characters from length for '0b' and '\0' termination */
    36		buf_len -= 3;
    37	
    38		for (i = 0; i < sizeof(n) * BITS_PER_BYTE && buf_len; ++i, n <<= 1) {
    39			/* Writing bit calculation in one line would cause a false
    40			 * positive static code analysis error, so splitting.
    41			 */
    42			bit = n & (1 << (sizeof(n) * BITS_PER_BYTE - 1));
    43			bit = !!bit;
    44			leading0 &= !bit;
    45			if (!leading0) {
    46				*wrptr = '0' + bit;
    47				++wrptr;
    48			}
    49		}
    50	
    51		*wrptr = '\0';
    52	
    53		return buf;
    54	}
    55	

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