LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter
@ 2019-05-12  3:35 Zhenzhong Duan
  2019-05-14  7:09 ` Ingo Molnar
  2019-05-14 19:21 ` Steven Rostedt
  0 siblings, 2 replies; 5+ messages in thread
From: Zhenzhong Duan @ 2019-05-12  3:35 UTC (permalink / raw)
  To: linux-kernel, linux-doc
  Cc: paulmck, josh, rostedt, mathieu.desnoyers, jiangshanlai, joel,
	corbet, tglx, mingo, gregkh, keescook, srinivas.eeda,
	Zhenzhong Duan

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@oracle.com>
Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Cc: Steven Rostedt <rostedt@goodmis.org>
---
 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


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter
  2019-05-12  3:35 [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter Zhenzhong Duan
@ 2019-05-14  7:09 ` Ingo Molnar
  2019-05-14 19:21 ` Steven Rostedt
  1 sibling, 0 replies; 5+ messages in thread
From: Ingo Molnar @ 2019-05-14  7:09 UTC (permalink / raw)
  To: Zhenzhong Duan
  Cc: linux-kernel, linux-doc, paulmck, josh, rostedt,
	mathieu.desnoyers, jiangshanlai, joel, corbet, tglx, gregkh,
	keescook, srinivas.eeda


* Zhenzhong Duan <zhenzhong.duan@oracle.com> 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@oracle.com>
> Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
> Cc: Steven Rostedt <rostedt@goodmis.org>
> ---
>  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.

Acked-by: Ingo Molnar <mingo@kernel.org>

Thanks,

	Ingo

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter
  2019-05-12  3:35 [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter Zhenzhong Duan
  2019-05-14  7:09 ` Ingo Molnar
@ 2019-05-14 19:21 ` Steven Rostedt
  2019-05-21  9:42   ` Zhenzhong Duan
  1 sibling, 1 reply; 5+ messages in thread
From: Steven Rostedt @ 2019-05-14 19:21 UTC (permalink / raw)
  To: Zhenzhong Duan
  Cc: linux-kernel, linux-doc, paulmck, josh, mathieu.desnoyers,
	jiangshanlai, joel, corbet, tglx, mingo, gregkh, keescook,
	srinivas.eeda

On Sun, 12 May 2019 11:35:27 +0800
Zhenzhong Duan <zhenzhong.duan@oracle.com> 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@oracle.com>
> Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
> Cc: Steven Rostedt <rostedt@goodmis.org>

Perhaps it should have been:

 Suggested-by: Steven Rostedt (VMware) <rostedt@goodmis.org>

As the wording is what I suggested ;-)

-- 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.


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter
  2019-05-14 19:21 ` Steven Rostedt
@ 2019-05-21  9:42   ` Zhenzhong Duan
  2019-05-21 12:56     ` Steven Rostedt
  0 siblings, 1 reply; 5+ messages in thread
From: Zhenzhong Duan @ 2019-05-21  9:42 UTC (permalink / raw)
  To: Steven Rostedt
  Cc: linux-kernel, linux-doc, paulmck, josh, mathieu.desnoyers,
	jiangshanlai, joel, corbet, tglx, mingo, gregkh, keescook,
	srinivas.eeda


On 2019/5/15 3:21, Steven Rostedt wrote:
> On Sun, 12 May 2019 11:35:27 +0800
> Zhenzhong Duan <zhenzhong.duan@oracle.com> 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@oracle.com>
>> Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
>> Cc: Steven Rostedt <rostedt@goodmis.org>
> Perhaps it should have been:
>
>   Suggested-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
>
> 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.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter
  2019-05-21  9:42   ` Zhenzhong Duan
@ 2019-05-21 12:56     ` Steven Rostedt
  0 siblings, 0 replies; 5+ messages in thread
From: Steven Rostedt @ 2019-05-21 12:56 UTC (permalink / raw)
  To: Zhenzhong Duan
  Cc: linux-kernel, linux-doc, paulmck, josh, mathieu.desnoyers,
	jiangshanlai, joel, corbet, tglx, mingo, gregkh, keescook,
	srinivas.eeda

On Tue, 21 May 2019 17:42:28 +0800
Zhenzhong Duan <zhenzhong.duan@oracle.com> wrote:

> On 2019/5/15 3:21, Steven Rostedt wrote:
> > On Sun, 12 May 2019 11:35:27 +0800
> > Zhenzhong Duan <zhenzhong.duan@oracle.com> 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@oracle.com>
> >> Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
> >> Cc: Steven Rostedt <rostedt@goodmis.org>  
> > Perhaps it should have been:
> >
> >   Suggested-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
> >
> > 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?

Yep, it's fine to add both:

Suggested-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org>

-- Steve

> 
> Zhenzhong


^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2019-05-21 12:56 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-12  3:35 [PATCH v2] doc: kernel-parameters.txt: fix documentation of nmi_watchdog parameter Zhenzhong Duan
2019-05-14  7:09 ` Ingo Molnar
2019-05-14 19:21 ` Steven Rostedt
2019-05-21  9:42   ` Zhenzhong Duan
2019-05-21 12:56     ` Steven Rostedt

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).