Skip to contentSkip to conversation

Documentation: Improve softlockup_panic= description text

PATCH In review Borislav Petkov 2 participants 5 messages Oct 3, 2017 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: Improve softlockup_panic= description text

From: Borislav Petkov <[email protected]>

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

---
 Documentation/admin-guide/kernel-parameters.txt | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/admin-guide/kernel-parameters.txt +6 -0
index 9a84483db403..c14cd2645c1f 100644
@@ -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.
Signature · 1 line
2.13.0
maintainer
#1 lore raw
Quoted 15 lines · On Tue, 3 Oct 2017 17:54:07 +0200 Borislav Petkov <[email protected]> wrote:

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

---
 Documentation/admin-guide/kernel-parameters.txt | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/admin-guide/kernel-parameters.txt +0 -0
index 9a84483db403..c14cd2645c1f 100644

Documentation/admin-guide/kernel-parameters.txt line 3894

Quoted 8 lines
Documentation/admin-guide/kernel-parameters.txt +5 -0
@@ -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

#2 lore raw
Quoted 3 lines · Jonathan Corbet

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?

Quoted 1 line

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

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

Thx.

Signature · 4 lines
Regards/Gruss,
    Boris.

Good mailing practices for 400: avoid top-posting and trim the reply.
maintainer
#3 lore raw
Quoted 2 lines · On Tue, 3 Oct 2017 22:54:29 +0200 Borislav Petkov <[email protected]> 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

#4 lore raw
Quoted 2 lines · Jonathan Corbet

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" :)

Quoted 1 line

(Yes, I tweaked it, thanks).

Thanks!

Signature · 4 lines
Regards/Gruss,
    Boris.

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