linux-kernel - drivers/mailbox/mailbox-sti.c:39: 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, 22 Jul 2021 19:42:12 +0800
From:   kernel test robot <lkp@...el.com>
To:     Aditya Srivastava <yashsri421@...il.com>
Cc:     kbuild-all@...ts.01.org, linux-kernel@...r.kernel.org,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Subject: drivers/mailbox/mailbox-sti.c:39: 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: arm-buildonly-randconfig-r001-20210722 (attached as .config)
compiler: arm-linux-gnueabi-gcc (GCC) 10.3.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://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=gcc-10.3.0 make.cross ARCH=arm 

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/mailbox/mailbox-sti.c:39: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * STi Mailbox device data
   drivers/mailbox/mailbox-sti.c:63: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * STi Mailbox platform specific configuration
   drivers/mailbox/mailbox-sti.c:74: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * STi Mailbox allocated channel information


vim +39 drivers/mailbox/mailbox-sti.c

9ef4546cbd7eed Lee Jones 2015-10-16  37  
9ef4546cbd7eed Lee Jones 2015-10-16  38  /**
9ef4546cbd7eed Lee Jones 2015-10-16 @39   * STi Mailbox device data
9ef4546cbd7eed Lee Jones 2015-10-16  40   *
9ef4546cbd7eed Lee Jones 2015-10-16  41   * An IP Mailbox is currently composed of 4 instances
9ef4546cbd7eed Lee Jones 2015-10-16  42   * Each instance is currently composed of 32 channels
9ef4546cbd7eed Lee Jones 2015-10-16  43   * This means that we have 128 channels per Mailbox
9ef4546cbd7eed Lee Jones 2015-10-16  44   * A channel an be used for TX or RX
9ef4546cbd7eed Lee Jones 2015-10-16  45   *
9ef4546cbd7eed Lee Jones 2015-10-16  46   * @dev:	Device to which it is attached
9ef4546cbd7eed Lee Jones 2015-10-16  47   * @mbox:	Representation of a communication channel controller
9ef4546cbd7eed Lee Jones 2015-10-16  48   * @base:	Base address of the register mapping region
9ef4546cbd7eed Lee Jones 2015-10-16  49   * @name:	Name of the mailbox
9ef4546cbd7eed Lee Jones 2015-10-16  50   * @enabled:	Local copy of enabled channels
9ef4546cbd7eed Lee Jones 2015-10-16  51   * @lock:	Mutex protecting enabled status
9ef4546cbd7eed Lee Jones 2015-10-16  52   */
9ef4546cbd7eed Lee Jones 2015-10-16  53  struct sti_mbox_device {
9ef4546cbd7eed Lee Jones 2015-10-16  54  	struct device		*dev;
9ef4546cbd7eed Lee Jones 2015-10-16  55  	struct mbox_controller	*mbox;
9ef4546cbd7eed Lee Jones 2015-10-16  56  	void __iomem		*base;
9ef4546cbd7eed Lee Jones 2015-10-16  57  	const char		*name;
9ef4546cbd7eed Lee Jones 2015-10-16  58  	u32			enabled[STI_MBOX_INST_MAX];
9ef4546cbd7eed Lee Jones 2015-10-16  59  	spinlock_t		lock;
9ef4546cbd7eed Lee Jones 2015-10-16  60  };
9ef4546cbd7eed Lee Jones 2015-10-16  61  

:::::: The code at line 39 was first introduced by commit
:::::: 9ef4546cbd7eed2412ec6f1161c2b92362379150 mailbox: Add support for ST's Mailbox IP

:::::: TO: Lee Jones <lee.jones@...aro.org>
:::::: CC: Jassi Brar <jaswinder.singh@...aro.org>

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