linux-kernel - Re: [PATCH] scripts: kernel-doc: add warning for comment not following kernel-doc syntax

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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 29 Mar 2021 22:57:39 +0800
From:   kernel test robot <lkp@...el.com>
To:     Aditya Srivastava <yashsri421@...il.com>, corbet@....net
Cc:     kbuild-all@...ts.01.org, yashsri421@...il.com,
        lukas.bulwahn@...il.com,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] scripts: kernel-doc: add warning for comment not
 following kernel-doc syntax

Hi Aditya,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on lwn/docs-next]
[also build test WARNING on linus/master v5.12-rc5 next-20210329]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Aditya-Srivastava/scripts-kernel-doc-add-warning-for-comment-not-following-kernel-doc-syntax/20210329-173213
base:   git://git.lwn.net/linux-2.6 docs-next
config: csky-randconfig-r023-20210329 (attached as .config)
compiler: csky-linux-gcc (GCC) 9.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://github.com/0day-ci/linux/commit/274a7b0af9aa2846ed0a5b2096e07fe76e47fe29
        git remote add linux-review https://github.com/0day-ci/linux
        git fetch --no-tags linux-review Aditya-Srivastava/scripts-kernel-doc-add-warning-for-comment-not-following-kernel-doc-syntax/20210329-173213
        git checkout 274a7b0af9aa2846ed0a5b2096e07fe76e47fe29
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=csky 

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/scsi/pm8001/pm8001_ctl.c:313: warning: expecting prototype for pm8001_ctl_sas_address_show(). Prototype was for pm8001_ctl_host_sas_address_show() instead
   drivers/scsi/pm8001/pm8001_ctl.c:530: warning: expecting prototype for pm8001_ctl_aap_log_show(). Prototype was for pm8001_ctl_iop_log_show() instead
>> drivers/scsi/pm8001/pm8001_ctl.c:559: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    ** pm8001_ctl_fatal_log_show - fatal error logging
   drivers/scsi/pm8001/pm8001_ctl.c:579: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    ** non_fatal_log_show - non fatal error logging
   drivers/scsi/pm8001/pm8001_ctl.c:624: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    ** pm8001_ctl_gsm_log_show - gsm dump collection


vim +559 drivers/scsi/pm8001/pm8001_ctl.c

dbf9bfe615717d jack wang             2009-10-14  557  
d078b5117f18dc Anand Kumar Santhanam 2013-09-04  558  /**
d078b5117f18dc Anand Kumar Santhanam 2013-09-04 @559   ** pm8001_ctl_fatal_log_show - fatal error logging
d078b5117f18dc Anand Kumar Santhanam 2013-09-04  560   ** @cdev:pointer to embedded class device
e1c3e0f8a2ae15 Lee Jones             2020-07-13  561   ** @attr: device attribute
d078b5117f18dc Anand Kumar Santhanam 2013-09-04  562   ** @buf: the buffer returned
d078b5117f18dc Anand Kumar Santhanam 2013-09-04  563   **
d078b5117f18dc Anand Kumar Santhanam 2013-09-04  564   ** A sysfs 'read-only' shost attribute.
d078b5117f18dc Anand Kumar Santhanam 2013-09-04  565   **/
d078b5117f18dc Anand Kumar Santhanam 2013-09-04  566  

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