diff mbox series

[v1] Fix documentation of panic_on_warn

Message ID 20230630145307.25865-1-olaf@aepfle.de
State New
Headers
Series [v1] Fix documentation of panic_on_warn |

Commit Message

Olaf Hering June 30, 2023, 2:53 p.m. UTC 
  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@aepfle.de>
---
 Documentation/admin-guide/kernel-parameters.txt | 2 +-
 tools/testing/selftests/rcutorture/bin/kvm.sh   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Randy Dunlap June 30, 2023, 9:58 p.m. UTC | #1 
Hi Olaf,

On 6/30/23 07:53, Olaf Hering wrote:
> 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@aepfle.de>
> ---
>  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().
>  

It's declared as an int instead of a boolean, but it's only tested for 0 or
non-0.

In any case, this update needs to be done. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

>  	parkbd.port=	[HW] Parallel port number the keyboard adapter is
> diff --git a/tools/testing/selftests/rcutorture/bin/kvm.sh b/tools/testing/selftests/rcutorture/bin/kvm.sh
> index 62f3b0f56e4d..d3cdc2d33d4b 100755
> --- a/tools/testing/selftests/rcutorture/bin/kvm.sh
> +++ b/tools/testing/selftests/rcutorture/bin/kvm.sh
> @@ -655,4 +655,4 @@ fi
>  # Control buffer size: --bootargs trace_buf_size=3k
>  # Get trace-buffer dumps on all oopses: --bootargs ftrace_dump_on_oops
>  # Ditto, but dump only the oopsing CPU: --bootargs ftrace_dump_on_oops=orig_cpu
> -# Heavy-handed way to also dump on warnings: --bootargs panic_on_warn
> +# Heavy-handed way to also dump on warnings: --bootargs panic_on_warn=1
Jonathan Corbet July 3, 2023, 2:36 p.m. UTC | #2 
Olaf Hering <olaf@aepfle.de> 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@aepfle.de>
> ---
>  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
diff mbox series

Patch

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().
 
 	parkbd.port=	[HW] Parallel port number the keyboard adapter is
diff --git a/tools/testing/selftests/rcutorture/bin/kvm.sh b/tools/testing/selftests/rcutorture/bin/kvm.sh
index 62f3b0f56e4d..d3cdc2d33d4b 100755
--- a/tools/testing/selftests/rcutorture/bin/kvm.sh
+++ b/tools/testing/selftests/rcutorture/bin/kvm.sh
@@ -655,4 +655,4 @@  fi
 # Control buffer size: --bootargs trace_buf_size=3k
 # Get trace-buffer dumps on all oopses: --bootargs ftrace_dump_on_oops
 # Ditto, but dump only the oopsing CPU: --bootargs ftrace_dump_on_oops=orig_cpu
-# Heavy-handed way to also dump on warnings: --bootargs panic_on_warn
+# Heavy-handed way to also dump on warnings: --bootargs panic_on_warn=1