From: "Guilherme G. Piccoli" <gpiccoli@canonical.com>
To: linux-doc@vger.kernel.org
Cc: corbet@lwn.net, linux-kernel@vger.kernel.org, swood@redhat.com,
mcgrof@kernel.org, keescook@chromium.org, yzaikin@google.com,
gpiccoli@canonical.com, kernel@gpiccoli.net
Subject: [PATCH] Documentation: Better document the softlockup_panic sysctl
Date: Thu, 19 Mar 2020 16:18:06 -0300 [thread overview]
Message-ID: <20200319191806.11453-1-gpiccoli@canonical.com> (raw)
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@canonical.com>
---
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 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
diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index def074807cee..95b2f3256323 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -95,6 +95,7 @@ show up in /proc/sys/kernel:
- shmmax [ sysv ipc ]
- shmmni
- softlockup_all_cpu_backtrace
+- softlockup_panic
- soft_watchdog
- stack_erasing
- stop-a [ SPARC only ]
@@ -1029,6 +1030,18 @@ NMI.
1: on detection capture more debug information.
+softlockup_panic:
+=================
+
+This parameter can be used to control whether the kernel panics when
+a soft lockup is detected.
+
+0: don't panic on soft lockup
+1: panic on soft lockup
+
+This can also be set using the softlockup_panic kernel parameter.
+
+
soft_watchdog:
==============
--
2.24.1
next reply other threads:[~2020-03-19 19:18 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-19 19:18 Guilherme G. Piccoli [this message]
2020-03-19 19:33 ` [PATCH] Documentation: Better document the softlockup_panic sysctl Guilherme Piccoli
-- strict thread matches above, loose matches on Subject: below --
2020-03-10 15:15 Guilherme G. Piccoli
2020-03-10 16:03 ` Kees Cook
2020-03-10 17:05 ` Jonathan Corbet
2020-03-10 18:20 ` Guilherme Piccoli
2020-03-10 18:49 ` Jonathan Corbet
2020-03-10 19:04 ` Guilherme Piccoli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200319191806.11453-1-gpiccoli@canonical.com \
--to=gpiccoli@canonical.com \
--cc=corbet@lwn.net \
--cc=keescook@chromium.org \
--cc=kernel@gpiccoli.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mcgrof@kernel.org \
--cc=swood@redhat.com \
--cc=yzaikin@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).