Browse Source

doc: Clarify that nmi_watchdog param is for hardlockups

The kernel NMI watchdog acts as both a hardlockup and softlockup detector.
However, the kernel parameter nmi_watchdog can only enable or disable the
hardlockup detector. Clarify that in the documentation.

Signed-off-by: Pranith Kumar <bobby.prani@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Pranith Kumar 9 years ago
parent
commit
334bb79c18
1 changed files with 4 additions and 3 deletions
  1. 4 3
      Documentation/kernel-parameters.txt

+ 4 - 3
Documentation/kernel-parameters.txt

@@ -2320,11 +2320,12 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
 	nmi_watchdog=	[KNL,BUGS=X86] Debugging features for SMP kernels
 	nmi_watchdog=	[KNL,BUGS=X86] Debugging features for SMP kernels
 			Format: [panic,][nopanic,][num]
 			Format: [panic,][nopanic,][num]
 			Valid num: 0 or 1
 			Valid num: 0 or 1
-			0 - turn nmi_watchdog off
-			1 - turn nmi_watchdog on
+			0 - turn hardlockup detector in nmi_watchdog off
+			1 - turn hardlockup detector in nmi_watchdog on
 			When panic is specified, panic when an NMI watchdog
 			When panic is specified, panic when an NMI watchdog
 			timeout occurs (or 'nopanic' to override the opposite
 			timeout occurs (or 'nopanic' to override the opposite
-			default).
+			default). To disable both hard and soft lockup detectors,
+			please see 'nowatchdog'.
 			This is useful when you use a panic=... timeout and
 			This is useful when you use a panic=... timeout and
 			need the box quickly up again.
 			need the box quickly up again.