From: Nam Cao <namcao@linutronix.de>
To: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Steven Rostedt <rostedt@goodmis.org>,
John Ogness <john.ogness@linutronix.de>,
Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
Gabriele Monaco <gmonaco@redhat.com>,
linux-trace-kernel@vger.kernel.org,
Josh Poimboeuf <jpoimboe@kernel.org>,
Peter Zijlstra <peterz@infradead.org>,
Petr Mladek <pmladek@suse.com>,
linux-kernel@vger.kernel.org,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH 2/2] panic: Fix up description of vpanic()
Date: Tue, 15 Jul 2025 15:31:33 +0200 [thread overview]
Message-ID: <20250715133133.XyZEBK7y@linutronix.de> (raw)
In-Reply-To: <20250715145601.2489a701c86ae48a75d1995f@kernel.org>
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@linutronix.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
next prev parent reply other threads:[~2025-07-15 13:31 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-11 11:20 [PATCH 0/2] Fix up build issues with vpanic Nam Cao
2025-07-11 11:20 ` [PATCH 1/2] objtool: Add vpanic() to the noreturn list Nam Cao
2025-07-11 11:20 ` [PATCH 2/2] panic: Fix up description of vpanic() Nam Cao
2025-07-15 5:56 ` Masami Hiramatsu
2025-07-15 13:31 ` Nam Cao [this message]
2025-07-11 11:28 ` [PATCH 0/2] Fix up build issues with vpanic Peter Zijlstra
2025-07-11 12:06 ` Nam Cao
2025-07-11 16:24 ` Steven Rostedt
2025-07-11 18:18 ` Peter Zijlstra
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250715133133.XyZEBK7y@linutronix.de \
--to=namcao@linutronix.de \
--cc=gmonaco@redhat.com \
--cc=john.ogness@linutronix.de \
--cc=jpoimboe@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=mhiramat@kernel.org \
--cc=peterz@infradead.org \
--cc=pmladek@suse.com \
--cc=rostedt@goodmis.org \
--cc=sfr@canb.auug.org.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®