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

Message-ID: <20250715133133.XyZEBK7y@linutronix.de>
Date: Tue, 15 Jul 2025 15:31:33 +0200
From: Nam Cao <namcao@...utronix.de>
To: Masami Hiramatsu <mhiramat@...nel.org>
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 Tue, Jul 15, 2025 at 02:56:01PM +0900, Masami Hiramatsu wrote:
> On Fri, 11 Jul 2025 13:20:43 +0200
> Nam Cao <namcao@...utronix.de> wrote:
> >  /**
> > - * 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.

That would be nice for sure. But I think the counter arguments are
stronger:

  - Two copies need to be maintained

  - panic() is only a few lines, and it is obvious at first glance that it
    is simply a thin wrapper around vpanic()

So I think it is better to leave it as is.

Best regards,
Nam