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

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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20250715145601.2489a701c86ae48a75d1995f@kernel.org>
Date: Tue, 15 Jul 2025 14:56:01 +0900
From: Masami Hiramatsu (Google) <mhiramat@...nel.org>
To: Nam Cao <namcao@...utronix.de>
Cc: Steven Rostedt <rostedt@...dmis.org>, John Ogness
 <john.ogness@...utronix.de>, Mathieu Desnoyers
 <mathieu.desnoyers@...icios.com>, Gabriele Monaco <gmonaco@...hat.com>,
 linux-trace-kernel@...r.kernel.org, Josh Poimboeuf <jpoimboe@...nel.org>,
 Peter Zijlstra <peterz@...radead.org>, Petr Mladek <pmladek@...e.com>,
 linux-kernel@...r.kernel.org, Stephen Rothwell <sfr@...b.auug.org.au>
Subject: Re: [PATCH 2/2] panic: Fix up description of vpanic()

On Fri, 11 Jul 2025 13:20:43 +0200
Nam Cao <namcao@...utronix.de> wrote:

> The description above vpanic() has the wrong function name. Fix it up.
> 
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Closes: https://lore.kernel.org/lkml/20250711183802.2d8c124d@canb.auug.org.au/
> Signed-off-by: Nam Cao <namcao@...utronix.de>
> ---
>  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) <mhiramat@...nel.org>