Re: [PATCH 2/2] panic: Fix up description of vpanic()

From
Masami Hiramatsu (Google) <mhiramat@kernel.org>
Date
2025-07-15 05:56:04
Also in
lkml
Reply to
Nam Cao, 2025-07-11
On Fri, 11 Jul 2025 13:20:43 +0200
Nam Cao [off-list ref] wrote:
quoted hunk ↗ jump to hunk
The description above vpanic() has the wrong function name. Fix it up.

Reported-by: Stephen Rothwell <redacted>
Closes: https://lore.kernel.org/lkml/20250711183802.2d8c124d@canb.auug.org.au/ (local)
Signed-off-by: Nam Cao <redacted>
---
 kernel/panic.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/kernel/panic.c b/kernel/panic.c
index 6a1823c383d0..2a499facde13 100644
--- a/kernel/panic.c
+++ b/kernel/panic.c
@@ -307,7 +307,7 @@ static void panic_other_cpus_shutdown(bool crash_kexec)
 }
 
 /**
- * panic - halt the system
+ * vpanic - halt the system
Shouldn't we make a copy the doc for the panic() (keep the text as it is)
and change the short explanation?

panic - halt the system
@fmt: ...

vpanic - halt the system with va_list
@fmt: ...
@args: ...

 From the newbie's viewpoint, as far as we keep providing the same
function, it is better to keep the same document to avoid confusion.

Thanks,

  * @fmt: The text string to print
  * @args: Arguments for the format string
  *
-- 
2.39.5

-- 
Masami Hiramatsu (Google) [off-list ref]
Thread (9 messages) 9 messages, 4 authors, last reply 2025-07-15
Keyboard shortcuts
hback out one level
jnext message in thread / next series-diff position
kprevious message in thread / previous series-diff position
ldrill in
Escclose help / fold thread tree
?toggle this help