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

[Jonathan Corbet]

On Tue,  3 Oct 2017 17:54:07 +0200
Borislav Petkov <bp@xxxxxxxxx> 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@xxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> ---
>  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