Re: [PATCH v4 27/27] scripts: kernel-doc: validate kernel-doc markup with the actual names

[kernel test robot <lkp@intel.com>]

[-- Attachment #1: Type: text/plain, Size: 11571 bytes --]

Hi Mauro,

I love your patch! Perhaps something to improve:

[auto build test WARNING on next-20201116]
[cannot apply to drm-intel/for-linux-next s390/features tip/timers/core tip/irq/core tip/sched/core linus/master hnaz-linux-mm/master v5.10-rc4 v5.10-rc3 v5.10-rc2 v5.10-rc4]
[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/Mauro-Carvalho-Chehab/net-phy-fix-kernel-doc-markups/20201116-191847
base:    034307507118f7e1b18f8403c85af2216da2dc94
config: x86_64-randconfig-r024-20201116 (attached as .config)
compiler: clang version 12.0.0 (https://github.com/llvm/llvm-project c044709b8fbea2a9a375e4173a6bd735f6866c0c)
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://github.com/0day-ci/linux/commit/11cd9cdaab434fff7a5edbee8d8d4ce9ef11acf4
        git remote add linux-review https://github.com/0day-ci/linux
        git fetch --no-tags linux-review Mauro-Carvalho-Chehab/net-phy-fix-kernel-doc-markups/20201116-191847
        git checkout 11cd9cdaab434fff7a5edbee8d8d4ce9ef11acf4
        # 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@intel.com>

All warnings (new ones prefixed by >>):

>> drivers/staging/gasket/gasket_core.c:1556: warning: wrong kernel-doc identifier on line:
    * Lookup a name by number in a num_name table.
   drivers/staging/gasket/gasket_core.c:1655: warning: wrong kernel-doc identifier on line:
    * Asynchronously waits on device.
--
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:46: warning: Enum value 'LOADER_CMD_XFER_QUERY' not described in enum 'ish_loader_commands'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:46: warning: Enum value 'LOADER_CMD_XFER_FRAGMENT' not described in enum 'ish_loader_commands'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:46: warning: Enum value 'LOADER_CMD_START' not described in enum 'ish_loader_commands'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:108: warning: Function parameter or member 'reserved' not described in 'loader_msg_hdr'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'data' not described in 'response_info'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'max_size' not described in 'response_info'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'size' not described in 'response_info'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'error' not described in 'response_info'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'received' not described in 'response_info'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:196: warning: Function parameter or member 'wait_queue' not described in 'response_info'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'loader_ishtp_cl' not described in 'ishtp_cl_data'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'cl_device' not described in 'ishtp_cl_data'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'response' not described in 'ishtp_cl_data'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'flag_retry' not described in 'ishtp_cl_data'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:233: warning: Function parameter or member 'retry_count' not described in 'ishtp_cl_data'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:252: warning: Function parameter or member 'client_data' not described in 'get_firmware_variant'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:252: warning: Function parameter or member 'filename' not described in 'get_firmware_variant'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:281: warning: Function parameter or member 'out_msg' not described in 'loader_cl_send'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:281: warning: Function parameter or member 'out_size' not described in 'loader_cl_send'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:281: warning: Function parameter or member 'in_msg' not described in 'loader_cl_send'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:281: warning: Function parameter or member 'in_size' not described in 'loader_cl_send'
>> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:281: warning: expecting prototype for Send message from host to firmware(). Prototype was for loader_cl_send() instead
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:445: warning: Function parameter or member 'cl_device' not described in 'loader_cl_event_cb'
   drivers/hid/intel-ish-hid/ishtp-fw-loader.c:445: warning: Excess function parameter 'device' description in 'loader_cl_event_cb'
>> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:551: warning: expecting prototype for Loads ISH firmware using ishtp interface(). Prototype was for ish_fw_xfer_ishtp() instead
>> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:745: warning: expecting prototype for Start executing ISH main firmware(). Prototype was for ish_fw_start() instead
>> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:767: warning: expecting prototype for Loads ISH firmware from host(). Prototype was for load_fw_from_host() instead
--
>> drivers/gpu/drm/gma500/intel_gmbus.c:386: warning: expecting prototype for intel_gmbus_setup(). Prototype was for gma_intel_setup_gmbus() instead
--
   drivers/gpu/drm/gma500/intel_bios.c:581: warning: Function parameter or member 'dev' not described in 'psb_intel_destroy_bios'
>> drivers/gpu/drm/gma500/intel_bios.c:581: warning: expecting prototype for Destroy and free VBT data(). Prototype was for psb_intel_destroy_bios() instead
--
   drivers/gpu/drm/gma500/gma_display.c:27: warning: Function parameter or member 'crtc' not described in 'gma_pipe_has_type'
   drivers/gpu/drm/gma500/gma_display.c:27: warning: Function parameter or member 'type' not described in 'gma_pipe_has_type'
>> drivers/gpu/drm/gma500/gma_display.c:27: warning: expecting prototype for Returns whether any output on the specified pipe is of the specified type(). Prototype was for gma_pipe_has_type() instead
>> drivers/gpu/drm/gma500/gma_display.c:184: warning: wrong kernel-doc identifier on line:
    * Sets the power management mode of the pipe and plane.
   drivers/gpu/drm/gma500/gma_display.c:573: warning: Function parameter or member 'crtc' not described in 'gma_crtc_save'
>> drivers/gpu/drm/gma500/gma_display.c:573: warning: expecting prototype for Save HW states of given crtc(). Prototype was for gma_crtc_save() instead
   drivers/gpu/drm/gma500/gma_display.c:616: warning: Function parameter or member 'crtc' not described in 'gma_crtc_restore'
>> drivers/gpu/drm/gma500/gma_display.c:616: warning: expecting prototype for Restore HW states of given crtc(). Prototype was for gma_crtc_restore() instead
--
>> drivers/gpu/drm/gma500/psb_irq.c:130: warning: wrong kernel-doc identifier on line:
    * Display controller interrupt handler for pipe event.
--
>> drivers/gpu/drm/gma500/psb_intel_display.c:75: warning: wrong kernel-doc identifier on line:
    * Return the pipe currently connected to the panel fitter,
--
   drivers/gpu/drm/gma500/psb_intel_sdvo.c:230: warning: Function parameter or member 'psb_intel_sdvo' not described in 'psb_intel_sdvo_write_sdvox'
   drivers/gpu/drm/gma500/psb_intel_sdvo.c:230: warning: Function parameter or member 'val' not described in 'psb_intel_sdvo_write_sdvox'
>> drivers/gpu/drm/gma500/psb_intel_sdvo.c:230: warning: expecting prototype for but always writes both(). Prototype was for psb_intel_sdvo_write_sdvox() instead
>> drivers/gpu/drm/gma500/psb_intel_sdvo.c:592: warning: wrong kernel-doc identifier on line:
    * Return whether each input is trained.
   drivers/gpu/drm/gma500/psb_intel_sdvo.c:1831: warning: Function parameter or member 'dev_priv' not described in 'psb_intel_sdvo_select_ddc_bus'
   drivers/gpu/drm/gma500/psb_intel_sdvo.c:1831: warning: Function parameter or member 'sdvo' not described in 'psb_intel_sdvo_select_ddc_bus'
   drivers/gpu/drm/gma500/psb_intel_sdvo.c:1831: warning: Function parameter or member 'reg' not described in 'psb_intel_sdvo_select_ddc_bus'
>> drivers/gpu/drm/gma500/psb_intel_sdvo.c:1831: warning: expecting prototype for Choose the appropriate DDC bus for control bus switch command for this(). Prototype was for psb_intel_sdvo_select_ddc_bus() instead
--
   drivers/gpu/drm/mga/mga_ioc32.c:2: warning: Cannot understand  * \file mga_ioc32.c
    on line 2 - I thought it was a doc line
   drivers/gpu/drm/mga/mga_ioc32.c:171: warning: Function parameter or member 'filp' not described in 'mga_compat_ioctl'
   drivers/gpu/drm/mga/mga_ioc32.c:171: warning: Function parameter or member 'cmd' not described in 'mga_compat_ioctl'
   drivers/gpu/drm/mga/mga_ioc32.c:171: warning: Function parameter or member 'arg' not described in 'mga_compat_ioctl'
>> drivers/gpu/drm/mga/mga_ioc32.c:171: warning: expecting prototype for Called whenever a 32(). Prototype was for mga_compat_ioctl() instead

vim +1556 drivers/staging/gasket/gasket_core.c

80666096eb78f0e Todd Poynor 2018-07-31  1554  
80666096eb78f0e Todd Poynor 2018-07-31  1555  /**
80666096eb78f0e Todd Poynor 2018-07-31 @1556   * Lookup a name by number in a num_name table.
80666096eb78f0e Todd Poynor 2018-07-31  1557   * @num: Number to lookup.
80666096eb78f0e Todd Poynor 2018-07-31  1558   * @table: Array of num_name structures, the table for the lookup.
80666096eb78f0e Todd Poynor 2018-07-31  1559   *
80666096eb78f0e Todd Poynor 2018-07-31  1560   * Description: Searches for num in the table.  If found, the
80666096eb78f0e Todd Poynor 2018-07-31  1561   *		corresponding name is returned; otherwise NULL
80666096eb78f0e Todd Poynor 2018-07-31  1562   *		is returned.
80666096eb78f0e Todd Poynor 2018-07-31  1563   *
80666096eb78f0e Todd Poynor 2018-07-31  1564   *		The table must have a NULL name pointer at the end.
80666096eb78f0e Todd Poynor 2018-07-31  1565   */
88c8a377c00ff3a Todd Poynor 2018-07-31  1566  const char *gasket_num_name_lookup(uint num,
88c8a377c00ff3a Todd Poynor 2018-07-31  1567  				   const struct gasket_num_name *table)
80666096eb78f0e Todd Poynor 2018-07-31  1568  {
80666096eb78f0e Todd Poynor 2018-07-31  1569  	uint i = 0;
80666096eb78f0e Todd Poynor 2018-07-31  1570  
80666096eb78f0e Todd Poynor 2018-07-31  1571  	while (table[i].snn_name) {
80666096eb78f0e Todd Poynor 2018-07-31  1572  		if (num == table[i].snn_num)
9a69f5087ccc20b Simon Que   2018-06-29  1573  			break;
80666096eb78f0e Todd Poynor 2018-07-31  1574  		++i;
9a69f5087ccc20b Simon Que   2018-06-29  1575  	}
9a69f5087ccc20b Simon Que   2018-06-29  1576  
80666096eb78f0e Todd Poynor 2018-07-31  1577  	return table[i].snn_name;
80666096eb78f0e Todd Poynor 2018-07-31  1578  }
80666096eb78f0e Todd Poynor 2018-07-31  1579  EXPORT_SYMBOL(gasket_num_name_lookup);
80666096eb78f0e Todd Poynor 2018-07-31  1580  

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org

[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 32328 bytes --]