docs/vm: hwpoison.rst: Fix quote formatting [Linux 5.3]

This Linux kernel change "docs/vm: hwpoison.rst: Fix quote formatting" is included in the Linux 5.3 release. This change is authored by Valentin Schneider <valentin.schneider [at] arm.com> on Tue Jun 18 15:56:05 2019 +0100. The commit for this change in Linux stable tree is 22aac85 (patch).

docs/vm: hwpoison.rst: Fix quote formatting

The asterisks prepended to the quoted text currently get translated to
bullet points, which gets increasingly confusing the smaller your
screen is (when viewing the sphinx output, that is).

Convert the whole quote to a literal block.

Signed-off-by: Valentin Schneider <valentin.schneider@arm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

There are 52 lines of Linux source code added/deleted in this change. Code changes to Linux kernel are as follows.

 Documentation/vm/hwpoison.rst | 52 +++++++++++++++++++++----------------------
 1 file changed, 26 insertions(+), 26 deletions(-)

diff --git a/Documentation/vm/hwpoison.rst b/Documentation/vm/hwpoison.rst
index 09bd24a..a5c8842 100644
--- a/Documentation/vm/hwpoison.rst
+++ b/Documentation/vm/hwpoison.rst
@@ -13,32 +13,32 @@ kill the processes associated with it and avoid using it in the future.

 This patchkit implements the necessary infrastructure in the VM.

-To quote the overview comment:
-
- * High level machine check handler. Handles pages reported by the
- * hardware as being corrupted usually due to a 2bit ECC memory or cache
- * failure.
- *
- * This focusses on pages detected as corrupted in the background.
- * When the current CPU tries to consume corruption the currently
- * running process can just be killed directly instead. This implies
- * that if the error cannot be handled for some reason it's safe to
- * just ignore it because no corruption has been consumed yet. Instead
- * when that happens another machine check will happen.
- *
- * Handles page cache pages in various states. The tricky part
- * here is that we can access any page asynchronous to other VM
- * users, because memory failures could happen anytime and anywhere,
- * possibly violating some of their assumptions. This is why this code
- * has to be extremely careful. Generally it tries to use normal locking
- * rules, as in get the standard locks, even if that means the
- * error handling takes potentially a long time.
- *
- * Some of the operations here are somewhat inefficient and have non
- * linear algorithmic complexity, because the data structures have not
- * been optimized for this case. This is in particular the case
- * 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.
+To quote the overview comment::
+
+   High level machine check handler. Handles pages reported by the
+   hardware as being corrupted usually due to a 2bit ECC memory or cache
+   failure.
+
+   This focusses on pages detected as corrupted in the background.
+   When the current CPU tries to consume corruption the currently
+   running process can just be killed directly instead. This implies
+   that if the error cannot be handled for some reason it's safe to
+   just ignore it because no corruption has been consumed yet. Instead
+   when that happens another machine check will happen.
+
+   Handles page cache pages in various states. The tricky part
+   here is that we can access any page asynchronous to other VM
+   users, because memory failures could happen anytime and anywhere,
+   possibly violating some of their assumptions. This is why this code
+   has to be extremely careful. Generally it tries to use normal locking
+   rules, as in get the standard locks, even if that means the
+   error handling takes potentially a long time.
+
+   Some of the operations here are somewhat inefficient and have non
+   linear algorithmic complexity, because the data structures have not
+   been optimized for this case. This is in particular the case
+   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,
 a new page poison bit and various checks in the VM to handle poisoned

Leave a Reply

Your email address will not be published. Required fields are marked *