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

From
Nam Cao <hidden>
Date
2025-07-15 13:31:36
Also in
lkml
Reply to
Masami Hiramatsu (Google), 2025-07-15
On Tue, Jul 15, 2025 at 02:56:01PM +0900, Masami Hiramatsu wrote:
On Fri, 11 Jul 2025 13:20:43 +0200
Nam Cao [off-list ref] wrote:
quoted
 /**
- * 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
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