[PATCH 08/32] Documentation/bad_memory.txt: convert it to ReST markup

2016-10-17 Thread Mauro Carvalho Chehab
- promote the section level of the document name;
- add/remove spaces/new lines where needed to format the output;
- use quote blocks.
- add it to the user book.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/bad_memory.txt  | 26 --
 Documentation/user/bad_memory.rst |  1 +
 Documentation/user/index.rst  |  1 +
 3 files changed, 18 insertions(+), 10 deletions(-)
 create mode 12 Documentation/user/bad_memory.rst

diff --git a/Documentation/bad_memory.txt b/Documentation/bad_memory.txt
index df8416213202..5cac93e27a97 100644
--- a/Documentation/bad_memory.txt
+++ b/Documentation/bad_memory.txt
@@ -1,9 +1,10 @@
+How to deal with bad memory e.g. reported by memtest86+ ?
+=
+
 March 2008
 Jan-Simon Moeller, dl...@gmx.de
 
 
-How to deal with bad memory e.g. reported by memtest86+ ?
-#
 
 There are three possibilities I know of:
 
@@ -19,6 +20,7 @@ This Howto is about number 3) .
 
 BadRAM
 ##
+
 BadRAM is the actively developed and available as kernel-patch
 here:  http://rick.vanrein.org/linux/badram/
 
@@ -31,15 +33,19 @@ memmap is already in the kernel and usable as 
kernel-parameter at
 boot-time.  Its syntax is slightly strange and you may need to
 calculate the values by yourself!
 
-Syntax to exclude a memory area (see kernel-parameters.txt for details):
-memmap=$
+Syntax to exclude a memory area (see kernel-parameters.txt for details)::
+
+   memmap=$
 
 Example: memtest86+ reported here errors at address 0x18691458, 0x18698424 and
- some others. All had 0x1869 in common, so I chose a pattern of
- 0x1869,0x.
+some others. All had 0x1869 in common, so I chose a pattern of
+0x1869,0x.
 
-With the numbers of the example above:
-memmap=64K$0x1869
- or
-memmap=0x1$0x1869
+With the numbers of the example above::
+
+   memmap=64K$0x1869
+
+or::
+
+   memmap=0x1$0x1869
 
diff --git a/Documentation/user/bad_memory.rst 
b/Documentation/user/bad_memory.rst
new file mode 12
index ..c5ffc33348f2
--- /dev/null
+++ b/Documentation/user/bad_memory.rst
@@ -0,0 +1 @@
+../bad_memory.txt
\ No newline at end of file
diff --git a/Documentation/user/index.rst b/Documentation/user/index.rst
index 280e62f21efa..d4886e366b5a 100644
--- a/Documentation/user/index.rst
+++ b/Documentation/user/index.rst
@@ -11,3 +11,4 @@ Contents:
REPORTING-BUGS
SecurityBugs
kernel-parameters
+   bad_memory
-- 
2.7.4




[PATCH 08/32] Documentation/bad_memory.txt: convert it to ReST markup

2016-10-17 Thread Mauro Carvalho Chehab
- promote the section level of the document name;
- add/remove spaces/new lines where needed to format the output;
- use quote blocks.
- add it to the user book.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/bad_memory.txt  | 26 --
 Documentation/user/bad_memory.rst |  1 +
 Documentation/user/index.rst  |  1 +
 3 files changed, 18 insertions(+), 10 deletions(-)
 create mode 12 Documentation/user/bad_memory.rst

diff --git a/Documentation/bad_memory.txt b/Documentation/bad_memory.txt
index df8416213202..5cac93e27a97 100644
--- a/Documentation/bad_memory.txt
+++ b/Documentation/bad_memory.txt
@@ -1,9 +1,10 @@
+How to deal with bad memory e.g. reported by memtest86+ ?
+=
+
 March 2008
 Jan-Simon Moeller, dl...@gmx.de
 
 
-How to deal with bad memory e.g. reported by memtest86+ ?
-#
 
 There are three possibilities I know of:
 
@@ -19,6 +20,7 @@ This Howto is about number 3) .
 
 BadRAM
 ##
+
 BadRAM is the actively developed and available as kernel-patch
 here:  http://rick.vanrein.org/linux/badram/
 
@@ -31,15 +33,19 @@ memmap is already in the kernel and usable as 
kernel-parameter at
 boot-time.  Its syntax is slightly strange and you may need to
 calculate the values by yourself!
 
-Syntax to exclude a memory area (see kernel-parameters.txt for details):
-memmap=$
+Syntax to exclude a memory area (see kernel-parameters.txt for details)::
+
+   memmap=$
 
 Example: memtest86+ reported here errors at address 0x18691458, 0x18698424 and
- some others. All had 0x1869 in common, so I chose a pattern of
- 0x1869,0x.
+some others. All had 0x1869 in common, so I chose a pattern of
+0x1869,0x.
 
-With the numbers of the example above:
-memmap=64K$0x1869
- or
-memmap=0x1$0x1869
+With the numbers of the example above::
+
+   memmap=64K$0x1869
+
+or::
+
+   memmap=0x1$0x1869
 
diff --git a/Documentation/user/bad_memory.rst 
b/Documentation/user/bad_memory.rst
new file mode 12
index ..c5ffc33348f2
--- /dev/null
+++ b/Documentation/user/bad_memory.rst
@@ -0,0 +1 @@
+../bad_memory.txt
\ No newline at end of file
diff --git a/Documentation/user/index.rst b/Documentation/user/index.rst
index 280e62f21efa..d4886e366b5a 100644
--- a/Documentation/user/index.rst
+++ b/Documentation/user/index.rst
@@ -11,3 +11,4 @@ Contents:
REPORTING-BUGS
SecurityBugs
kernel-parameters
+   bad_memory
-- 
2.7.4