[akpm-mm:mm-nonmm-unstable 80/82] kernel/watchdog_perf.c:282: warning: Function parameter or struct member 'str' not described in 'hardlockup_config_perf_event'

[akpm-mm:mm-nonmm-unstable 80/82] kernel/watchdog_perf.c:282: warning: Function parameter or struct member 'str' not described in 'hardlockup_config_perf_event'

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git mm-nonmm-unstable
head:   2ce87845f9106e693ba6d72cc95af6c86dc52d98
commit: 96dca662f6d64b4d31ad186ea1464e9b25d749c3 [80/82] watchdog: allow nmi watchdog to use raw perf event
config: x86_64-buildonly-randconfig-003-20240504 (https://download.01.org/0day-ci/archive/20240504/202405040851.2EgypmL1-lkp@intel.com/config)
compiler: gcc-13 (Ubuntu 13.2.0-4ubuntu3) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240504/202405040851.2EgypmL1-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/202405040851.2EgypmL1-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> kernel/watchdog_perf.c:282: warning: Function parameter or struct member 'str' not described in 'hardlockup_config_perf_event'


vim +282 kernel/watchdog_perf.c

   277	
   278	/**
   279	 * hardlockup_config_perf_event - Overwrite config of wd_hw_attr.
   280	 */
   281	void __init hardlockup_config_perf_event(const char *str)
 > 282	{

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

Re: [akpm-mm:mm-nonmm-unstable 80/82] kernel/watchdog_perf.c:282: warning: Function parameter or struct member 'str' not described in 'hardlockup_config_perf_event'

[Andrew Morton]

On Sat, 4 May 2024 08:38:45 +0800 kernel test robot <lkp@intel.com> wrote:

> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git mm-nonmm-unstable
> head:   2ce87845f9106e693ba6d72cc95af6c86dc52d98
> commit: 96dca662f6d64b4d31ad186ea1464e9b25d749c3 [80/82] watchdog: allow nmi watchdog to use raw perf event
> config: x86_64-buildonly-randconfig-003-20240504 (https://download.01.org/0day-ci/archive/20240504/202405040851.2EgypmL1-lkp@intel.com/config)
> compiler: gcc-13 (Ubuntu 13.2.0-4ubuntu3) 13.2.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240504/202405040851.2EgypmL1-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/202405040851.2EgypmL1-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
> >> kernel/watchdog_perf.c:282: warning: Function parameter or struct member 'str' not described in 'hardlockup_config_perf_event'
> 
> 
> vim +282 kernel/watchdog_perf.c
> 
>    277	
>    278	/**
>    279	 * hardlockup_config_perf_event - Overwrite config of wd_hw_attr.
>    280	 */
>    281	void __init hardlockup_config_perf_event(const char *str)
>  > 282	{

Thanks, how does this look?

--- a/kernel/watchdog_perf.c~watchdog-allow-nmi-watchdog-to-use-raw-perf-event-fix
+++ a/kernel/watchdog_perf.c
@@ -277,6 +277,8 @@ int __init watchdog_hardlockup_probe(voi
 
 /**
  * hardlockup_config_perf_event - Overwrite config of wd_hw_attr.
+ *
+ * @str: number which identifies the raw perf event to use
  */
 void __init hardlockup_config_perf_event(const char *str)
 {
_

Re: [akpm-mm:mm-nonmm-unstable 80/82] kernel/watchdog_perf.c:282: warning: Function parameter or struct member 'str' not described in 'hardlockup_config_perf_event'

[Matthew Wilcox]

On Sat, May 04, 2024 at 03:44:55PM -0700, Andrew Morton wrote:
> +++ a/kernel/watchdog_perf.c
> @@ -277,6 +277,8 @@ int __init watchdog_hardlockup_probe(voi
>  
>  /**
>   * hardlockup_config_perf_event - Overwrite config of wd_hw_attr.
> + *
> + * @str: number which identifies the raw perf event to use
>   */
>  void __init hardlockup_config_perf_event(const char *str)

We don't usually put a blank line between the name of the function and
the arguments, but other than that, looks good.