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 <[email protected]>
Reported-by: kernel test robot <[email protected]>
Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
Fixes: dfa19b11385d ("reboot: Add hardware protection power-off")
---
kernel/reboot.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/kernel/reboot.c b/kernel/reboot.c
index 3bba88c7ffc6..c7790711242d 100644
--- a/kernel/reboot.c
+++ b/kernel/reboot.c
@@ -940,6 +940,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.
base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d
--
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 =]
On 10/11/23 04:08, Matti Vaittinen wrote:
> 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 <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
> Fixes: dfa19b11385d ("reboot: Add hardware protection power-off")
Acked-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> kernel/reboot.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/kernel/reboot.c b/kernel/reboot.c
> index 3bba88c7ffc6..c7790711242d 100644
> --- a/kernel/reboot.c
> +++ b/kernel/reboot.c
> @@ -940,6 +940,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.
>
> base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d
--
~Randy