Re: [PATCH v1] Fix documentation of panic_on_warn

From: Jonathan Corbet
Date: Mon Jul 03 2023 - 10:36:37 EST


Olaf Hering <olaf@xxxxxxxxx> writes:

> The kernel cmdline option panic_on_warn expects an integer, it is not a
> plain option as documented. A number of uses in the tree figured this
> already, and use panic_on_warn=1 for their purpose.
>
> Adjust a comment which otherwise may mislead people in the future.
>
> Fixes: 9e3961a097 ("kernel: add panic_on_warn")
>
> Signed-off-by: Olaf Hering <olaf@xxxxxxxxx>
> ---
> Documentation/admin-guide/kernel-parameters.txt | 2 +-
> tools/testing/selftests/rcutorture/bin/kvm.sh | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 9e5bab29685f..15196f84df49 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -4049,7 +4049,7 @@
> extra details on the taint flags that users can pick
> to compose the bitmask to assign to panic_on_taint.
>
> - panic_on_warn panic() instead of WARN(). Useful to cause kdump
> + panic_on_warn=1 panic() instead of WARN(). Useful to cause kdump
> on a WARN().

Applied, thanks.

jon