Skip to contentSkip to conversation

doc: Clarify that nmi_watchdog param is for hardlockups

PATCH Applied Pranith Kumar 2 participants 2 messages Oct 10, 2015 – Oct 11, 2015 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

---
 Documentation/kernel-parameters.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/kernel-parameters.txt +4 -3
index 6fecc72..5b83279 100644
@@ -2329,11 +2329,12 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
 	nmi_watchdog=	[KNL,BUGS=X86] Debugging features for SMP kernels
 			Format: [panic,][nopanic,][num]
 			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
 			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
 			need the box quickly up again.
 
Signature · 1 line
2.6.0
maintainer Applied
#1 lore raw
Quoted 3 lines · On Sat, 10 Oct 2015 15:40:42 -0400 Pranith Kumar <[email protected]> wrote:

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.

Applied to the docs tree, thanks.

jon