[PATCH v2 04/12] reboot: describe do_kernel_restart's cmd argument in kernel-doc

Ahmad Fatoum posted 12 patches 11 months, 1 week ago
There is a newer version of this series
[PATCH v2 04/12] reboot: describe do_kernel_restart's cmd argument in kernel-doc
Posted by Ahmad Fatoum 11 months, 1 week ago
A W=1 build rightfully complains about the function's kernel-doc
being incomplete.

Describe its single parameter to fix this.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 kernel/reboot.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/kernel/reboot.c b/kernel/reboot.c
index 222b63dfd31020d0e2bc1b1402dbfa82adc71990..21a85cf95413979322d3183af1a378f5ddd8e780 100644
--- a/kernel/reboot.c
+++ b/kernel/reboot.c
@@ -229,6 +229,9 @@ EXPORT_SYMBOL(unregister_restart_handler);
 /**
  *	do_kernel_restart - Execute kernel restart handler call chain
  *
+ *	@cmd: pointer to buffer containing command to execute for restart
+ *		or %NULL
+ *
  *	Calls functions registered with register_restart_handler.
  *
  *	Expected to be called from machine_restart as last step of the restart

-- 
2.39.5
Re: [PATCH v2 04/12] reboot: describe do_kernel_restart's cmd argument in kernel-doc
Posted by Tzung-Bi Shih 11 months ago
On Mon, Jan 13, 2025 at 05:25:29PM +0100, Ahmad Fatoum wrote:
> A W=1 build rightfully complains about the function's kernel-doc
> being incomplete.
> 
> Describe its single parameter to fix this.
> 
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>

Reviewed-by: Tzung-Bi Shih <tzungbi@kernel.org>