Skip to content

Commit 0a07bef

Browse files
Guilherme G. PiccoliJonathan Corbet
authored andcommitted
Documentation: Better document the softlockup_panic sysctl
Commit 9c44bc0 ("softlockup: allow panic on lockup") added the softlockup_panic sysctl, but didn't add information about it to the file Documentation/admin-guide/sysctl/kernel.rst (which in that time certainly wasn't rst and had other name!). This patch just adds the respective documentation and references it from the corresponding entry in Documentation/admin-guide/kernel-parameters.txt. This patch was strongly based on Scott Wood's commit d22881d ("Documentation: Better document the hardlockup_panic sysctl"). Reviewed-by: Kees Cook <[email protected]> Signed-off-by: Guilherme G. Piccoli <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 23f03fe commit 0a07bef

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

Documentation/admin-guide/kernel-parameters.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4516,10 +4516,10 @@
45164516
Format: <integer>
45174517

45184518
A nonzero value instructs the soft-lockup detector
4519-
to panic the machine when a soft-lockup occurs. This
4520-
is also controlled by CONFIG_BOOTPARAM_SOFTLOCKUP_PANIC
4521-
which is the respective build-time switch to that
4522-
functionality.
4519+
to panic the machine when a soft-lockup occurs. It is
4520+
also controlled by the kernel.softlockup_panic sysctl
4521+
and CONFIG_BOOTPARAM_SOFTLOCKUP_PANIC, which is the
4522+
respective build-time switch to that functionality.
45234523

45244524
softlockup_all_cpu_backtrace=
45254525
[KNL] Should the soft-lockup detector generate

Documentation/admin-guide/sysctl/kernel.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,6 +1036,20 @@ NMI.
10361036
= ============================================
10371037

10381038

1039+
softlockup_panic
1040+
=================
1041+
1042+
This parameter can be used to control whether the kernel panics
1043+
when a soft lockup is detected.
1044+
1045+
= ============================================
1046+
0 Don't panic on soft lockup.
1047+
1 Panic on soft lockup.
1048+
= ============================================
1049+
1050+
This can also be set using the softlockup_panic kernel parameter.
1051+
1052+
10391053
soft_watchdog
10401054
=============
10411055

0 commit comments

Comments
 (0)