Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
From: Misono Tomohiro <misono.tomohiro@jp.fujitsu.com>
To: <corbet@lwn.net>
Cc: <linux-doc@vger.kernel.org>, <misono.tomohiro@jp.fujitsu.com>
Subject: [PATCH] docs: vm/hwpoison: link/style/typo fixes
Date: Tue, 30 Jun 2020 15:39:14 +0900
Message-ID: <20200630063914.969-1-misono.tomohiro@jp.fujitsu.com> (raw)

Just some link/style/typo fixes as follows:
 - fix location of admin-guide file
 - fix prctl arg number to match prctl man page
 - fix typos and add some words

Signed-off-by: Misono Tomohiro <misono.tomohiro@jp.fujitsu.com>
---
 Documentation/vm/hwpoison.rst | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/Documentation/vm/hwpoison.rst b/Documentation/vm/hwpoison.rst
index a5c884293dac..f163bf49cfde 100644
--- a/Documentation/vm/hwpoison.rst
+++ b/Documentation/vm/hwpoison.rst
@@ -40,7 +40,7 @@ To quote the overview comment::
 	for the mapping from a vma to a process. Since this case is expected
 	to be rare we hope we can get away with this.
 
-The code consists of a the high level handler in mm/memory-failure.c,
+The code consists of a high level handler in mm/memory-failure.c,
 a new page poison bit and various checks in the VM to handle poisoned
 pages.
 
@@ -50,7 +50,7 @@ of applications. KVM support requires a recent qemu-kvm release.
 For the KVM use there was need for a new signal type so that
 KVM can inject the machine check into the guest with the proper
 address. This in theory allows other applications to handle
-memory failures too. The expection is that near all applications
+memory failures too. The expectation is that near all applications
 won't do that, but some very specialized ones might.
 
 Failure recovery modes
@@ -67,30 +67,31 @@ early kill
 	(can be controlled globally and per process)
 	Send SIGBUS to the application as soon as the error is detected
 	This allows applications who can process memory errors in a gentle
-	way (e.g. drop affected object)
+	way (e.g. drop affected object).
 	This is the mode used by KVM qemu.
 
 late kill
 	Send SIGBUS when the application runs into the corrupted page.
-	This is best for memory error unaware applications and default
+	This is best for memory error unaware applications and default.
 	Note some pages are always handled as late kill.
 
 User control
 ============
 
 vm.memory_failure_recovery
-	See sysctl.txt
+	Enable memory failure recovery instead of panic.
+	See admin-guide/sysctl/vm.rst
 
 vm.memory_failure_early_kill
-	Enable early kill mode globally
+	Enable early kill mode globally. See admin-guide/sysctl/vm.rst
 
-PR_MCE_KILL
+prctl PR_MCE_KILL
 	Set early/late kill mode/revert to system default
 
-	arg1: PR_MCE_KILL_CLEAR:
+	arg2: PR_MCE_KILL_CLEAR:
 		Revert to system default
-	arg1: PR_MCE_KILL_SET:
-		arg2 defines thread specific mode
+	arg2: PR_MCE_KILL_SET:
+		arg3 defines thread specific mode
 
 		PR_MCE_KILL_EARLY:
 			Early kill
@@ -104,7 +105,7 @@ PR_MCE_KILL
 	call prctl(PR_MCE_KILL_EARLY) on the designated thread. Otherwise,
 	the SIGBUS is sent to the main thread.
 
-PR_MCE_KILL_GET
+prctl PR_MCE_KILL_GET
 	return current mode
 
 Testing
-- 
2.21.3


                 reply index

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20200630063914.969-1-misono.tomohiro@jp.fujitsu.com \
    --to=misono.tomohiro@jp.fujitsu.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    /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

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git