Re: [PATCH] Documentation: Better document the softlockup_panic sysctl

From: Jonathan Corbet
Date: Tue Mar 10 2020 - 13:05:58 EST


On Tue, 10 Mar 2020 12:15:03 -0300
"Guilherme G. Piccoli" <gpiccoli@xxxxxxxxxxxxx> wrote:

> Commit 9c44bc03fff4 ("softlockup: allow panic on lockup") added the
> softlockup_panic sysctl, but didn't add information about it to the file
> Documentation/admin-guide/sysctl/kernel.rst (which in that time certainly
> wasn't rst and had other name!).
>
> This patch just adds the respective documentation and references it from
> the corresponding entry in Documentation/admin-guide/kernel-parameters.txt.
>
> This patch was strongly based on Scott Wood's commit d22881dc13b6
> ("Documentation: Better document the hardlockup_panic sysctl").
>
> Signed-off-by: Guilherme G. Piccoli <gpiccoli@xxxxxxxxxxxxx>

So this doesn't even come close to applying; could you respin it against
docs-next, please?

> Documentation/admin-guide/kernel-parameters.txt | 6 +++---
> Documentation/admin-guide/sysctl/kernel.rst | 13 +++++++++++++
> 2 files changed, 16 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index c07815d230bc..adf77ead02c3 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -4515,9 +4515,9 @@
>
> A nonzero 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.
> + is also controlled by kernel.softlockup_panic sysctl

..and while you're at it, make it "*the* kernel.softlockup_panic sysctl" :)

Thanks,

jon