Re: [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter

From: Zhenzhong Duan
Date: Tue May 21 2019 - 05:46:14 EST



On 2019/5/15 3:21, Steven Rostedt wrote:
On Sun, 12 May 2019 11:35:27 +0800
Zhenzhong Duan <zhenzhong.duan@xxxxxxxxxx> wrote:

The default behavior of hardlockup depends on the config of
CONFIG_BOOTPARAM_HARDLOCKUP_PANIC.

Fix the description of nmi_watchdog to make it clear.

Signed-off-by: Zhenzhong Duan <zhenzhong.duan@xxxxxxxxxx>
Reviewed-by: Joel Fernandes (Google) <joel@xxxxxxxxxxxxxxxxx>
Cc: Steven Rostedt <rostedt@xxxxxxxxxxx>
Perhaps it should have been:

Suggested-by: Steven Rostedt (VMware) <rostedt@xxxxxxxxxxx>

As the wording is what I suggested ;-)

Sure, I should have done that. Just not familiar with which one is better.

Not clear if I should send a v3 adding Suggested-by and Acked-by?

Zhenzhong


-- Steve

---
v2: fix description using words suggested by Steven Rostedt

Documentation/admin-guide/kernel-parameters.txt | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 08df588..b9d4358 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -2805,8 +2805,9 @@
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). To disable both hard and soft lockup detectors,
+ timeout occurs (or 'nopanic' to not panic on an NMI
+ watchdog, if CONFIG_BOOTPARAM_HARDLOCKUP_PANIC is set)
+ 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.