Skip to contentSkip to conversation

Fix documentation of panic_on_warn

PATCH Applied Olaf Hering 3 participants 3 messages Jun 30, 2023 – Jul 3, 2023

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Fix documentation of panic_on_warn

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")
---
 Documentation/admin-guide/kernel-parameters.txt | 2 +-
 tools/testing/selftests/rcutorture/bin/kvm.sh   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/admin-guide/kernel-parameters.txt +1 -1
index 9e5bab29685f..15196f84df49 100644
@@ -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
tools/testing/selftests/rcutorture/bin/kvm.sh +1 -1
index 62f3b0f56e4d..d3cdc2d33d4b 100755
@@ -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
reviewer Reviewed-by on v1 1/1
#1 lore raw

Hi Olaf,

Quoted 19 lines · Olaf Hering

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")
---
 Documentation/admin-guide/kernel-parameters.txt | 2 +-
 tools/testing/selftests/rcutorture/bin/kvm.sh   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/admin-guide/kernel-parameters.txt +0 -0
index 9e5bab29685f..15196f84df49 100644

Documentation/admin-guide/kernel-parameters.txt line 4054

Quoted 7 lines
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -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.

Quoted 11 lines
Documentation/admin-guide/kernel-parameters.txt +0 -0
 	parkbd.port=	[HW] Parallel port number the keyboard adapter is
tools/testing/selftests/rcutorture/bin/kvm.sh +1 -1
index 62f3b0f56e4d..d3cdc2d33d4b 100755
@@ -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
Signature · 1 line
~Randy
maintainer Applied
#2 lore raw
In reply to Olaf Hering
Quoted 19 lines · Olaf Hering

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")
---
 Documentation/admin-guide/kernel-parameters.txt | 2 +-
 tools/testing/selftests/rcutorture/bin/kvm.sh   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/admin-guide/kernel-parameters.txt +0 -0
index 9e5bab29685f..15196f84df49 100644

Documentation/admin-guide/kernel-parameters.txt line 4053

Quoted 6 lines
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -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