[lwn:docs-next 80/97] drivers/hid/hid-logitech-hidpp.c:265: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



tree:   git://git.lwn.net/linux-2.6 docs-next
head:   a4f413348f268c4313f58ca383173ee5986d968a
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf [80/97] scripts: kernel-doc: add warning for comment not following kernel-doc syntax
config: x86_64-randconfig-a005-20210405 (attached as .config)
compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project 2760a808b9916a2839513b7fd7314a464f52481e)
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
        git remote add lwn git://git.lwn.net/linux-2.6
        git fetch --no-tags lwn docs-next
        git checkout 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf
        # 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@xxxxxxxxx>

All warnings (new ones prefixed by >>):

>> drivers/hid/hid-logitech-hidpp.c:265: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * hidpp_send_message_sync() returns 0 in case of success, and something else
   drivers/hid/hid-logitech-hidpp.c:427: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * hidpp_prefix_name() prefixes the current given name with "Logitech ".
   drivers/hid/hid-logitech-hidpp.c:470: warning: Function parameter or member 'input_dev' not described in 'hidpp_scroll_counter_handle_scroll'
   drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'hidpp' not described in 'hidpp_touchpad_fw_items_set'
   drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'feature_index' not described in 'hidpp_touchpad_fw_items_set'
   drivers/hid/hid-logitech-hidpp.c:1894: warning: Function parameter or member 'items' not described in 'hidpp_touchpad_fw_items_set'
   drivers/hid/hid-logitech-hidpp.c:1894: warning: expecting prototype for send a set state command to the device by reading the current items(). Prototype was for hidpp_touchpad_fw_items_set() instead
--
>> drivers/ipack/carriers/tpci200.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * tpci200.c
--
>> drivers/iio/light/stk3310.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Sensortek STK3310/STK3311 Ambient Light and Proximity Sensor
--
>> drivers/phy/qualcomm/phy-qcom-usb-hs.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Copyright (C) 2016 Linaro Ltd
--
   drivers/scsi/megaraid/megaraid_sas_base.c:483: warning: expecting prototype for megasas_clear_interrupt_xscale(). Prototype was for megasas_clear_intr_xscale() instead
   drivers/scsi/megaraid/megaraid_sas_base.c:666: warning: expecting prototype for megasas_clear_interrupt_ppc(). Prototype was for megasas_clear_intr_ppc() instead
   drivers/scsi/megaraid/megaraid_sas_base.c:795: warning: expecting prototype for megasas_clear_interrupt_skinny(). Prototype was for megasas_clear_intr_skinny() instead
   drivers/scsi/megaraid/megaraid_sas_base.c:943: warning: expecting prototype for megasas_clear_interrupt_gen2(). Prototype was for megasas_clear_intr_gen2() instead
>> drivers/scsi/megaraid/megaraid_sas_base.c:4887: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * dcmd.opcode            - MR_DCMD_CTRL_DEVICE_LIST_GET
   drivers/scsi/megaraid/megaraid_sas_base.c:5173: warning: expecting prototype for megasas_get_controller_info(). Prototype was for megasas_get_ctrl_info() instead
--
>> sound/pci/ctxfi/ctresource.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
--
>> sound/pci/ctxfi/ctamixer.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
--
>> sound/pci/ctxfi/ctvmem.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
--
>> sound/pci/ctxfi/ctdaio.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
--
>> sound/pci/ctxfi/ctsrc.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
--
>> sound/pci/ctxfi/ctatc.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.


vim +265 drivers/hid/hid-logitech-hidpp.c

2f31c52529103d Benjamin Tissoires 2014-09-30  263  
8c9952b26b2be2 Benjamin Tissoires 2014-11-03  264  /**
8c9952b26b2be2 Benjamin Tissoires 2014-11-03 @265   * hidpp_send_message_sync() returns 0 in case of success, and something else
8c9952b26b2be2 Benjamin Tissoires 2014-11-03  266   * in case of a failure.
8c9952b26b2be2 Benjamin Tissoires 2014-11-03  267   * - If ' something else' is positive, that means that an error has been raised
8c9952b26b2be2 Benjamin Tissoires 2014-11-03  268   *   by the protocol itself.
8c9952b26b2be2 Benjamin Tissoires 2014-11-03  269   * - If ' something else' is negative, that means that we had a classic error
8c9952b26b2be2 Benjamin Tissoires 2014-11-03  270   *   (-ENOMEM, -EPIPE, etc...)
8c9952b26b2be2 Benjamin Tissoires 2014-11-03  271   */
2f31c52529103d Benjamin Tissoires 2014-09-30  272  static int hidpp_send_message_sync(struct hidpp_device *hidpp,
2f31c52529103d Benjamin Tissoires 2014-09-30  273  	struct hidpp_report *message,
2f31c52529103d Benjamin Tissoires 2014-09-30  274  	struct hidpp_report *response)
2f31c52529103d Benjamin Tissoires 2014-09-30  275  {
2f31c52529103d Benjamin Tissoires 2014-09-30  276  	int ret;
2f31c52529103d Benjamin Tissoires 2014-09-30  277  
2f31c52529103d Benjamin Tissoires 2014-09-30  278  	mutex_lock(&hidpp->send_mutex);
2f31c52529103d Benjamin Tissoires 2014-09-30  279  
2f31c52529103d Benjamin Tissoires 2014-09-30  280  	hidpp->send_receive_buf = response;
2f31c52529103d Benjamin Tissoires 2014-09-30  281  	hidpp->answer_available = false;
2f31c52529103d Benjamin Tissoires 2014-09-30  282  
2f31c52529103d Benjamin Tissoires 2014-09-30  283  	/*
2f31c52529103d Benjamin Tissoires 2014-09-30  284  	 * So that we can later validate the answer when it arrives
2f31c52529103d Benjamin Tissoires 2014-09-30  285  	 * in hidpp_raw_event
2f31c52529103d Benjamin Tissoires 2014-09-30  286  	 */
2f31c52529103d Benjamin Tissoires 2014-09-30  287  	*response = *message;
2f31c52529103d Benjamin Tissoires 2014-09-30  288  
2f31c52529103d Benjamin Tissoires 2014-09-30  289  	ret = __hidpp_send_report(hidpp->hid_dev, message);
2f31c52529103d Benjamin Tissoires 2014-09-30  290  
2f31c52529103d Benjamin Tissoires 2014-09-30  291  	if (ret) {
2f31c52529103d Benjamin Tissoires 2014-09-30  292  		dbg_hid("__hidpp_send_report returned err: %d\n", ret);
2f31c52529103d Benjamin Tissoires 2014-09-30  293  		memset(response, 0, sizeof(struct hidpp_report));
2f31c52529103d Benjamin Tissoires 2014-09-30  294  		goto exit;
2f31c52529103d Benjamin Tissoires 2014-09-30  295  	}
2f31c52529103d Benjamin Tissoires 2014-09-30  296  
2f31c52529103d Benjamin Tissoires 2014-09-30  297  	if (!wait_event_timeout(hidpp->wait, hidpp->answer_available,
2f31c52529103d Benjamin Tissoires 2014-09-30  298  				5*HZ)) {
2f31c52529103d Benjamin Tissoires 2014-09-30  299  		dbg_hid("%s:timeout waiting for response\n", __func__);
2f31c52529103d Benjamin Tissoires 2014-09-30  300  		memset(response, 0, sizeof(struct hidpp_report));
2f31c52529103d Benjamin Tissoires 2014-09-30  301  		ret = -ETIMEDOUT;
2f31c52529103d Benjamin Tissoires 2014-09-30  302  	}
2f31c52529103d Benjamin Tissoires 2014-09-30  303  
2f31c52529103d Benjamin Tissoires 2014-09-30  304  	if (response->report_id == REPORT_ID_HIDPP_SHORT &&
f677bb150c2f7b Peter Wu           2014-12-16  305  	    response->rap.sub_id == HIDPP_ERROR) {
f677bb150c2f7b Peter Wu           2014-12-16  306  		ret = response->rap.params[1];
f677bb150c2f7b Peter Wu           2014-12-16  307  		dbg_hid("%s:got hidpp error %02X\n", __func__, ret);
f677bb150c2f7b Peter Wu           2014-12-16  308  		goto exit;
f677bb150c2f7b Peter Wu           2014-12-16  309  	}
f677bb150c2f7b Peter Wu           2014-12-16  310  
a5ce8f5b12966d Simon Wood         2015-11-19  311  	if ((response->report_id == REPORT_ID_HIDPP_LONG ||
a5ce8f5b12966d Simon Wood         2015-11-19  312  			response->report_id == REPORT_ID_HIDPP_VERY_LONG) &&
f677bb150c2f7b Peter Wu           2014-12-16  313  			response->fap.feature_index == HIDPP20_ERROR) {
2f31c52529103d Benjamin Tissoires 2014-09-30  314  		ret = response->fap.params[1];
f677bb150c2f7b Peter Wu           2014-12-16  315  		dbg_hid("%s:got hidpp 2.0 error %02X\n", __func__, ret);
2f31c52529103d Benjamin Tissoires 2014-09-30  316  		goto exit;
2f31c52529103d Benjamin Tissoires 2014-09-30  317  	}
2f31c52529103d Benjamin Tissoires 2014-09-30  318  
2f31c52529103d Benjamin Tissoires 2014-09-30  319  exit:
2f31c52529103d Benjamin Tissoires 2014-09-30  320  	mutex_unlock(&hidpp->send_mutex);
2f31c52529103d Benjamin Tissoires 2014-09-30  321  	return ret;
2f31c52529103d Benjamin Tissoires 2014-09-30  322  

:::::: The code at line 265 was first introduced by commit
:::::: 8c9952b26b2be25311706082598e5e176eb92748 HID: logitech-hidpp: fix negated returns

:::::: TO: Benjamin Tissoires <benjamin.tissoires@xxxxxxxxxx>
:::::: CC: Jiri Kosina <jkosina@xxxxxxx>

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

Attachment: .config.gz
Description: application/gzip


[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux