]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
kernel/panic.c: format kernel-doc comments
authorSravan Kumar Gundu <sravankumarlpu@gmail.com>
Fri, 16 May 2025 17:40:31 +0000 (17:40 +0000)
committerAndrew Morton <akpm@linux-foundation.org>
Wed, 21 May 2025 17:48:24 +0000 (10:48 -0700)
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>
kernel/panic.c

index a3889f38153d965c36dbad5e73d2bd8151fab283..1f52922d1b2e535752b8b2fbe7f8b4ddfab53c3a 100644 (file)
@@ -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, ...)
 {