linux-kernel - [PATCH] kernel: Format kernel-doc comments

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: <20250516174031.2937-1-sravankumarlpu@gmail.com>
Date: Fri, 16 May 2025 17:40:31 +0000
From: Sravan Kumar Gundu <sravankumarlpu@...il.com>
To: skhan@...uxfoundation.org,
	pmladek@...e.com,
	jani.nikula@...el.com,
	john.ogness@...utronix.de,
	gregkh@...uxfoundation.org,
	akpm@...ux-foundation.org
Cc: Sravan Kumar Gundu <sravankumarlpu@...il.com>,
	linux-kernel@...r.kernel.org
Subject: [PATCH] kernel: Format kernel-doc comments

kernel-doc function comment doesn'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

Signed-off-by: Sravan Kumar Gundu <sravankumarlpu@...il.com>
---
 kernel/panic.c | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/kernel/panic.c b/kernel/panic.c
index a3889f38153d..1f52922d1b2e 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, ...)
 {
-- 
2.43.0