linux-kernel - drivers/xen/xen-front-pgdir-shbuf.c:34: 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: <202311060203.yQrpPZhm-lkp@intel.com>
Date:   Mon, 6 Nov 2023 02:32:15 +0800
From:   kernel test robot <lkp@...el.com>
To:     Oleksandr Andrushchenko <oleksandr_andrushchenko@...m.com>
Cc:     oe-kbuild-all@...ts.linux.dev, linux-kernel@...r.kernel.org,
        Boris Ostrovsky <boris.ostrovsky@...cle.com>,
        Noralf Trønnes <noralf@...nnes.org>,
        linux-doc@...r.kernel.org
Subject: drivers/xen/xen-front-pgdir-shbuf.c:34: 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:   1c41041124bd14dd6610da256a3da4e5b74ce6b1
commit: 5641f19bdfc4193f1c2d5a829896c25dd5c0ec3d drm/xen-front: Use Xen common shared buffer implementation
date:   4 years, 11 months ago
config: x86_64-randconfig-r054-20230808 (https://download.01.org/0day-ci/archive/20231106/202311060203.yQrpPZhm-lkp@intel.com/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231106/202311060203.yQrpPZhm-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@...el.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202311060203.yQrpPZhm-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/xen/xen-front-pgdir-shbuf.c:34: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * This structure represents the structure of a shared page
   drivers/xen/xen-front-pgdir-shbuf.c:45: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Shared buffer ops which are differently implemented
   drivers/xen/xen-front-pgdir-shbuf.c:73: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Get granted reference to the very first page of the
   drivers/xen/xen-front-pgdir-shbuf.c:93: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Map granted references of the shared buffer.
   drivers/xen/xen-front-pgdir-shbuf.c:114: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Unmap granted references of the shared buffer.
   drivers/xen/xen-front-pgdir-shbuf.c:135: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Free all the resources of the shared buffer.
   drivers/xen/xen-front-pgdir-shbuf.c:163: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Get the number of pages the page directory consumes itself.
   drivers/xen/xen-front-pgdir-shbuf.c:173: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Calculate the number of grant references needed to share the buffer
   drivers/xen/xen-front-pgdir-shbuf.c:185: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Calculate the number of grant references needed to share the buffer
   drivers/xen/xen-front-pgdir-shbuf.c:203: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Unmap the buffer previously mapped with grant references
   drivers/xen/xen-front-pgdir-shbuf.c:251: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Map the buffer with grant references provided by the backend.
   drivers/xen/xen-front-pgdir-shbuf.c:326: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Fill page directory with grant references to the pages of the
   drivers/xen/xen-front-pgdir-shbuf.c:356: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Fill page directory with grant references to the pages of the
   drivers/xen/xen-front-pgdir-shbuf.c:395: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Grant references to the frontend's buffer pages.
   drivers/xen/xen-front-pgdir-shbuf.c:424: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Grant all the references needed to share the buffer.
   drivers/xen/xen-front-pgdir-shbuf.c:472: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Allocate all required structures to mange shared buffer.
   drivers/xen/xen-front-pgdir-shbuf.c:512: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Allocate a new instance of a shared buffer.


vim +34 drivers/xen/xen-front-pgdir-shbuf.c

b3383974fee272 Oleksandr Andrushchenko 2018-11-30  32  
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  33  /**
b3383974fee272 Oleksandr Andrushchenko 2018-11-30 @34   * This structure represents the structure of a shared page
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  35   * that contains grant references to the pages of the shared
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  36   * buffer. This structure is common to many Xen para-virtualized
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  37   * protocols at include/xen/interface/io/
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  38   */
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  39  struct xen_page_directory {
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  40  	grant_ref_t gref_dir_next_page;
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  41  	grant_ref_t gref[1]; /* Variable length */
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  42  };
b3383974fee272 Oleksandr Andrushchenko 2018-11-30  43  

:::::: The code at line 34 was first introduced by commit
:::::: b3383974fee272ad0d444a2d083f456879447cd8 xen: Introduce shared buffer helpers for page directory...

:::::: TO: Oleksandr Andrushchenko <oleksandr_andrushchenko@...m.com>
:::::: CC: Boris Ostrovsky <boris.ostrovsky@...cle.com>

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki