[PATCH] Documentation: Improve softlockup_panic= description text

[PATCH] Documentation: Improve softlockup_panic= description text

[Borislav Petkov]

From: Borislav Petkov <bp@suse.de>

It should say what that <integer> range is and what that integer value
means. I had to look at the code...

Signed-off-by: Borislav Petkov <bp@suse.de>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/admin-guide/kernel-parameters.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 9a84483db403..c14cd2645c1f 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -3887,6 +3887,12 @@
 			[KNL] Should the soft-lockup detector generate panics.
 			Format: <integer>
 
+			A non-null value "instructs" the soft-lockup detector
+			to panic the machine when a soft-lockup occurs. This
+			is also controlled by CONFIG_BOOTPARAM_SOFTLOCKUP_PANIC
+			which is the respective build-time switch to that
+			functionality.
+
 	softlockup_all_cpu_backtrace=
 			[KNL] Should the soft-lockup detector generate
 			backtraces on all cpus.
-- 
2.13.0

Re: [PATCH] Documentation: Improve softlockup_panic= description text

[Jonathan Corbet]

On Tue,  3 Oct 2017 17:54:07 +0200
Borislav Petkov <bp@alien8.de> wrote:

> It should say what that <integer> range is and what that integer value
> means. I had to look at the code...
> 
> Signed-off-by: Borislav Petkov <bp@suse.de>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> ---
>  Documentation/admin-guide/kernel-parameters.txt | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 9a84483db403..c14cd2645c1f 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -3887,6 +3887,12 @@
>  			[KNL] Should the soft-lockup detector generate panics.
>  			Format: <integer>
>  
> +			A non-null value "instructs" the soft-lockup detector
> +			to panic the machine when a soft-lockup occurs. This
> +			is also controlled by CONFIG_BOOTPARAM_SOFTLOCKUP_PANIC
> +			which is the respective build-time switch to that
> +			functionality.

So I hate to be fussy.  (OK, perhaps I like it, but I'll act reluctant
anyway...:)  If it's an integer value, how can it be null?  Can we say "a
non-zero value" instead?  I'd take out the quotes too, but that's extra
credit...

Thanks,

jon

Re: [PATCH] Documentation: Improve softlockup_panic= description text

[Borislav Petkov]

On Tue, Oct 03, 2017 at 02:39:17PM -0600, Jonathan Corbet wrote:
> So I hate to be fussy.  (OK, perhaps I like it, but I'll act reluctant
> anyway...:)  If it's an integer value, how can it be null?  Can we say "a
> non-zero value" instead?

non-zero yap, I was looking for that version but somehow it evaded
me. Can you change it while applying or should I send a new one?

> I'd take out the quotes too, but that's extra credit...

Well, a value can't really instruct, thus the quotes...

Thx.

-- 
Regards/Gruss,
    Boris.

Good mailing practices for 400: avoid top-posting and trim the reply.

Re: [PATCH] Documentation: Improve softlockup_panic= description text

[Jonathan Corbet]

On Tue, 3 Oct 2017 22:54:29 +0200
Borislav Petkov <bp@alien8.de> wrote:

> non-zero yap, I was looking for that version but somehow it evaded
> me. Can you change it while applying or should I send a new one?

Man that's a lot of work...much easier to just whine about it on the
mailing lists...:)

(Yes, I tweaked it, thanks).

jon

Re: [PATCH] Documentation: Improve softlockup_panic= description text

[Borislav Petkov]

On Tue, Oct 03, 2017 at 03:13:23PM -0600, Jonathan Corbet wrote:
> Man that's a lot of work...much easier to just whine about it on the
> mailing lists...:)

You could've just said "nah, you do it" :)

> (Yes, I tweaked it, thanks).

Thanks!

-- 
Regards/Gruss,
    Boris.

Good mailing practices for 400: avoid top-posting and trim the reply.