Messages in this thread Patch in this message | | | Date | Mon, 20 Nov 2023 09:18:33 +0200 | From | Matti Vaittinen <> | Subject | [PATCH RESEND] kernel/reboot: document function parameter |
| |
The hw_failure_emergency_poweroff() has been documented using kernel doc. The documentation omits description of the function parameter 'int poweroff_delay_ms' - which seems like self-explatonary.
However, the build bot is nagging about the missing parameter documentation, so add the trivial documentation to shut the bot up.
Signed-off-by: Matti Vaittinen <mazziesaccount@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Reported-by: kernel test robot <lkp@intel.com> Closes: https://lore.kernel.org/oe-kbuild-all/202309040349.HLOK1O5I-lkp@intel.com/ Fixes: dfa19b11385d ("reboot: Add hardware protection power-off") --- Mark, would you pick this up? (Excuse can be that the regulator framework uses the emergency_poweroff) Or any suggestions who should I CC? This has fallen through the cracks for couple of times already and I suspect this belongs to no-one specifically.
kernel/reboot.c | 1 + 1 file changed, 1 insertion(+)
diff --git a/kernel/reboot.c b/kernel/reboot.c index 395a0ea3c7a8..2e5fd997d49c 100644 --- a/kernel/reboot.c +++ b/kernel/reboot.c @@ -944,6 +944,7 @@ static DECLARE_DELAYED_WORK(hw_failure_emergency_poweroff_work, /** * hw_failure_emergency_poweroff - Trigger an emergency system poweroff + * @poweroff_delay_ms: Time after which the system is rebooted. In milliseconds. * * This may be called from any critical situation to trigger a system shutdown * after a given period of time. If time is negative this is not scheduled. -- 2.41.0
-- Matti Vaittinen, Linux device drivers ROHM Semiconductors, Finland SWDC Kiviharjunlenkki 1E 90220 OULU FINLAND
~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~ Simon says - in Latin please. ~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~ Thanks to Simon Glass for the translation =] [unhandled content-type:application/pgp-signature] | |