2019-05-22 02:31:24

by Zhenzhong Duan

[permalink] [raw]
Subject: [PATCH v3] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter

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

Fix the description of nmi_watchdog to make it clear.

Suggested-by: Steven Rostedt (VMware) <[email protected]>
Signed-off-by: Zhenzhong Duan <[email protected]>
Reviewed-by: Joel Fernandes (Google) <[email protected]>
Acked-by: Ingo Molnar <[email protected]>
Acked-by: Steven Rostedt (VMware) <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: Kees Cook <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: [email protected]
---
v3: add Suggested-by and Acked-by
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.
--
1.8.3.1


2019-05-23 18:38:55

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH v3] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter

On Tue, 21 May 2019 10:32:08 +0800
Zhenzhong Duan <[email protected]> wrote:

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

Jon,

You want to take this in your tree?

-- Steve

> Fix the description of nmi_watchdog to make it clear.
>
> Suggested-by: Steven Rostedt (VMware) <[email protected]>
> Signed-off-by: Zhenzhong Duan <[email protected]>
> Reviewed-by: Joel Fernandes (Google) <[email protected]>
> Acked-by: Ingo Molnar <[email protected]>
> Acked-by: Steven Rostedt (VMware) <[email protected]>
> Cc: Thomas Gleixner <[email protected]>
> Cc: Kees Cook <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: [email protected]
> ---
> v3: add Suggested-by and Acked-by
> 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.

2019-05-23 19:04:30

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v3] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter

On Thu, 23 May 2019 14:37:03 -0400
Steven Rostedt <[email protected]> wrote:

> On Tue, 21 May 2019 10:32:08 +0800
> Zhenzhong Duan <[email protected]> wrote:
>
> > The default behavior of hardlockup depends on the config of
> > CONFIG_BOOTPARAM_HARDLOCKUP_PANIC.
> >
>
> Jon,
>
> You want to take this in your tree?

Sure, I'll take it.

Thanks,

jon