Fix documentation of panic_on_warn
authorOlaf Hering <olaf@aepfle.de>
Fri, 30 Jun 2023 14:53:02 +0000 (16:53 +0200)
committerJonathan Corbet <corbet@lwn.net>
Tue, 4 Jul 2023 14:29:32 +0000 (08:29 -0600)
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: 9e3961a09798 ("kernel: add panic_on_warn")
Signed-off-by: Olaf Hering <olaf@aepfle.de>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/admin-guide/kernel-parameters.txt
tools/testing/selftests/rcutorture/bin/kvm.sh

index b0e4195..de0eb6f 100644 (file)
                        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
index 62f3b0f..d3cdc2d 100755 (executable)
@@ -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