[rafael-pm:bleeding-edge 86/94] drivers/acpi/utils.c:427: warning: Function parameter or member 'list2' not described in 'acpi_handle_list_equal'

[rafael-pm:bleeding-edge 86/94] drivers/acpi/utils.c:427: warning: Function parameter or member 'list2' not described in 'acpi_handle_list_equal'

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git bleeding-edge
head:   2cff74feed4a2a3a1c220e0ee2838b85b08d4999
commit: 2f5042ef239e43d2b02f7724714673e5e604bd6f [86/94] ACPI: utils: Dynamically determine acpi_handle_list size
config: loongarch-allyesconfig (https://download.01.org/0day-ci/archive/20230929/202309290642.18zicoLj-lkp@intel.com/config)
compiler: loongarch64-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20230929/202309290642.18zicoLj-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@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202309290642.18zicoLj-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/acpi/utils.c:427: warning: Function parameter or member 'list2' not described in 'acpi_handle_list_equal'
>> drivers/acpi/utils.c:427: warning: Excess function parameter 'List2' description in 'acpi_handle_list_equal'


vim +427 drivers/acpi/utils.c

   416	
   417	/**
   418	 * acpi_handle_list_equal - Check if two ACPI handle lists are the same
   419	 * @list1: First list to compare.
   420	 * @List2: Second list to compare.
   421	 *
   422	 * Return true if the given ACPI handle lists are of the same size and
   423	 * contain the same ACPI handles in the same order.  Otherwise, return false.
   424	 */
   425	bool acpi_handle_list_equal(struct acpi_handle_list *list1,
   426				    struct acpi_handle_list *list2)
 > 427	{
   428		return list1->count == list2->count &&
   429			!memcmp(list1->handles, list2->handles,
   430			        list1->count * sizeof(acpi_handle));
   431	}
   432	EXPORT_SYMBOL_GPL(acpi_handle_list_equal);
   433	

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

Re: [rafael-pm:bleeding-edge 86/94] drivers/acpi/utils.c:427: warning: Function parameter or member 'list2' not described in 'acpi_handle_list_equal'

[Rafael J. Wysocki]

On Fri, Sep 29, 2023 at 12:26 AM kernel test robot <lkp@intel.com> wrote:
>
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git bleeding-edge
> head:   2cff74feed4a2a3a1c220e0ee2838b85b08d4999
> commit: 2f5042ef239e43d2b02f7724714673e5e604bd6f [86/94] ACPI: utils: Dynamically determine acpi_handle_list size
> config: loongarch-allyesconfig (https://download.01.org/0day-ci/archive/20230929/202309290642.18zicoLj-lkp@intel.com/config)
> compiler: loongarch64-linux-gcc (GCC) 13.2.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20230929/202309290642.18zicoLj-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@intel.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202309290642.18zicoLj-lkp@intel.com/
>
> All warnings (new ones prefixed by >>):
>
> >> drivers/acpi/utils.c:427: warning: Function parameter or member 'list2' not described in 'acpi_handle_list_equal'
> >> drivers/acpi/utils.c:427: warning: Excess function parameter 'List2' description in 'acpi_handle_list_equal'

Typo in a kerneldoc comment - fixed up in the tree.

Thanks!

> vim +427 drivers/acpi/utils.c
>
>    416
>    417  /**
>    418   * acpi_handle_list_equal - Check if two ACPI handle lists are the same
>    419   * @list1: First list to compare.
>    420   * @List2: Second list to compare.
>    421   *
>    422   * Return true if the given ACPI handle lists are of the same size and
>    423   * contain the same ACPI handles in the same order.  Otherwise, return false.
>    424   */
>    425  bool acpi_handle_list_equal(struct acpi_handle_list *list1,
>    426                              struct acpi_handle_list *list2)
>  > 427  {
>    428          return list1->count == list2->count &&
>    429                  !memcmp(list1->handles, list2->handles,
>    430                          list1->count * sizeof(acpi_handle));
>    431  }
>    432  EXPORT_SYMBOL_GPL(acpi_handle_list_equal);
>    433
>
> --
> 0-DAY CI Kernel Test Service
> https://github.com/intel/lkp-tests/wiki