linux-kernel - [PATCH] kernel/reboot: document function parameter

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <ZPbhzchX59rwEj2L@dc78bmyyyyyyyyyyyyybt-3.rev.dnainternet.fi>
Date:   Tue, 5 Sep 2023 11:07:41 +0300
From:   Matti Vaittinen <mazziesaccount@...il.com>
To:     Matti Vaittinen <mazziesaccount@...il.com>,
        Matti Vaittinen <matti.vaittinen@...rohmeurope.com>
Cc:     Kai-Heng Feng <kai.heng.feng@...onical.com>,
        Dmitry Osipenko <dmitry.osipenko@...labora.com>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Matti Vaittinen <mazziesaccount@...il.com>,
        Mark Brown <broonie@...nel.org>,
        Daniel Lezcano <daniel.lezcano@...aro.org>,
        linux-kernel@...r.kernel.org
Subject: [PATCH] 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@...il.com>
Reported-by: kernel test robot <lkp@...el.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202309040349.HLOK1O5I-lkp@intel.com/
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.
-- 
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 =] 

Download attachment "signature.asc" of type "application/pgp-signature" (489 bytes)