Re: kernel/reboot.c:226: warning: Function parameter or struct member 'cmd' not described in 'do_kernel_restart'

[Philip Li <philip.li@intel.com>]

On Sun, Dec 15, 2024 at 08:57:39PM +0800, kernel test robot wrote:
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head:   2d8308bf5b67dff50262d8a9260a50113b3628c6
> commit: 0c3ebff535956d2718594dc90aa9cc87521ec9fd scripts: kernel-doc: Clarify missing struct member description
> date:   1 year ago
> config: arm-allnoconfig (https://download.01.org/0day-ci/archive/20241215/202412152053.KeJr8B5f-lkp@intel.com/config)
> compiler: arm-linux-gnueabi-gcc (GCC) 12.4.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20241215/202412152053.KeJr8B5f-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/202412152053.KeJr8B5f-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):

Sorry, kindly ignore this, the commit is not the actual cause of
the issue.

> 
> >> kernel/reboot.c:226: warning: Function parameter or struct member 'cmd' not described in 'do_kernel_restart'
> >> kernel/reboot.c:952: warning: Function parameter or struct member 'poweroff_delay_ms' not described in 'hw_failure_emergency_poweroff'
> --
> >> lib/hweight.c:14: warning: Function parameter or struct member 'w' not described in '__sw_hweight32'
>    lib/hweight.c:14: warning: expecting prototype for hweightN(). Prototype was for __sw_hweight32() instead
> 
> 
> vim +226 kernel/reboot.c
> 
> b63adb979583ef Guenter Roeck 2014-09-26  213  
> b63adb979583ef Guenter Roeck 2014-09-26  214  /**
> b63adb979583ef Guenter Roeck 2014-09-26  215   *	do_kernel_restart - Execute kernel restart handler call chain
> b63adb979583ef Guenter Roeck 2014-09-26  216   *
> b63adb979583ef Guenter Roeck 2014-09-26  217   *	Calls functions registered with register_restart_handler.
> b63adb979583ef Guenter Roeck 2014-09-26  218   *
> b63adb979583ef Guenter Roeck 2014-09-26  219   *	Expected to be called from machine_restart as last step of the restart
> b63adb979583ef Guenter Roeck 2014-09-26  220   *	sequence.
> b63adb979583ef Guenter Roeck 2014-09-26  221   *
> b63adb979583ef Guenter Roeck 2014-09-26  222   *	Restarts the system immediately if a restart handler function has been
> b63adb979583ef Guenter Roeck 2014-09-26  223   *	registered. Otherwise does nothing.
> b63adb979583ef Guenter Roeck 2014-09-26  224   */
> b63adb979583ef Guenter Roeck 2014-09-26  225  void do_kernel_restart(char *cmd)
> b63adb979583ef Guenter Roeck 2014-09-26 @226  {
> b63adb979583ef Guenter Roeck 2014-09-26  227  	atomic_notifier_call_chain(&restart_handler_list, reboot_mode, cmd);
> b63adb979583ef Guenter Roeck 2014-09-26  228  }
> b63adb979583ef Guenter Roeck 2014-09-26  229  
> 
> :::::: The code at line 226 was first introduced by commit
> :::::: b63adb979583ef185718d774d8162387db5589c0 kernel: add support for kernel restart handler call chain
> 
> :::::: TO: Guenter Roeck <linux@roeck-us.net>
> :::::: CC: Guenter Roeck <linux@roeck-us.net>
> 
> -- 
> 0-DAY CI Kernel Test Service
> https://github.com/intel/lkp-tests/wiki
>