From: Sravan Kumar Gundu <sravankumarlpu@gmail.com>
Date: Fri, 16 May 2025 17:40:31 +0000 (+0000)
Subject: kernel/panic.c: format kernel-doc comments
X-Git-Tag: v6.16-rc1~91^2~7
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=85915c6cabf74d1f693fd09d95c25d838b82c840;p=thirdparty%2Flinux.git

kernel/panic.c: format kernel-doc comments

kernel-doc function comment don't follows documentation commenting style
misinterpreting arguments description with function description.

Please see latest docs generated before applying this patch
https://docs.kernel.org/driver-api/basics.html#c.panic

Link: https://lkml.kernel.org/r/20250516174031.2937-1-sravankumarlpu@gmail.com
Signed-off-by: Sravan Kumar Gundu <sravankumarlpu@gmail.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: John Ogness <john.ogness@linutronix.de>
Cc: Petr Mladek <pmladek@suse.com>
Cc: Shuah Khan <shuah@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
---

diff --git a/kernel/panic.c b/kernel/panic.c
index a3889f38153d9..1f52922d1b2e5 100644
--- a/kernel/panic.c
+++ b/kernel/panic.c
@@ -277,12 +277,10 @@ static void panic_other_cpus_shutdown(bool crash_kexec)
 }
 
 /**
- *	panic - halt the system
- *	@fmt: The text string to print
+ * panic - halt the system
+ * @fmt: The text string to print
  *
- *	Display a message, then perform cleanups.
- *
- *	This function never returns.
+ * Display a message, then perform cleanups. This function never returns.
  */
 void panic(const char *fmt, ...)
 {