[PATCH 24/32] Documentation/oops-tracing.txt: convert to ReST markup

[Mauro Carvalho Chehab]

- Add a document title;
- use .. note:: markup;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- replace _foo_ by **foo**;
- while here, remove whitespaces at the end of paragraph;
- add it to the user's book.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/oops-tracing.txt  | 255 +++-
 Documentation/user/index.rst|   1 +
 Documentation/user/oops-tracing.rst |   1 +
 3 files changed, 140 insertions(+), 117 deletions(-)
 create mode 12 Documentation/user/oops-tracing.rst

diff --git a/Documentation/oops-tracing.txt b/Documentation/oops-tracing.txt
index f3ac05cc23e4..3e25ea7349ee 100644
--- a/Documentation/oops-tracing.txt
+++ b/Documentation/oops-tracing.txt
@@ -1,7 +1,13 @@
-NOTE: ksymoops is useless on 2.6.  Please use the Oops in its original format
-(from dmesg, etc).  Ignore any references in this or other docs to "decoding
-the Oops" or "running it through ksymoops".  If you post an Oops from 2.6 that
-has been run through ksymoops, people will just tell you to repost it.
+OOPS tracing
+
+
+.. note::
+
+  ``ksymoops`` is useless on 2.6 or upper.  Please use the Oops in its original
+  format (from ``dmesg``, etc).  Ignore any references in this or other docs to
+  "decoding the Oops" or "running it through ksymoops".
+  If you post an Oops from 2.6+ that has been run through ``ksymoops``,
+  people will just tell you to repost it.
 
 Quick Summary
 -
@@ -12,7 +18,7 @@ If you are unsure send it to the person responsible for the 
code relevant to
 what you were doing.  If it occurs repeatably try and describe how to recreate
 it.  That's worth even more than the oops.
 
-If you are totally stumped as to whom to send the report, send it to 
+If you are totally stumped as to whom to send the report, send it to
 linux-kernel@vger.kernel.org. Thanks for your help in making Linux as
 stable as humanly possible.
 
@@ -20,24 +26,25 @@ Where is the Oops?
 --
 
 Normally the Oops text is read from the kernel buffers by klogd and
-handed to syslogd which writes it to a syslog file, typically
-/var/log/messages (depends on /etc/syslog.conf).  Sometimes klogd dies,
-in which case you can run dmesg > file to read the data from the kernel
-buffers and save it.  Or you can cat /proc/kmsg > file, however you
-have to break in to stop the transfer, kmsg is a "never ending file".
+handed to ``syslogd`` which writes it to a syslog file, typically
+``/var/log/messages`` (depends on ``/etc/syslog.conf``).  Sometimes ``klogd``
+dies, in which case you can run ``dmesg > file`` to read the data from the
+kernel buffers and save it.  Or you can ``cat /proc/kmsg > file``, however you
+have to break in to stop the transfer, ``kmsg`` is a "never ending file".
 If the machine has crashed so badly that you cannot enter commands or
-the disk is not available then you have three options :-
+the disk is not available then you have three options :
 
 (1) Hand copy the text from the screen and type it in after the machine
 has restarted.  Messy but it is the only option if you have not
 planned for a crash. Alternatively, you can take a picture of
 the screen with a digital camera - not nice, but better than
 nothing.  If the messages scroll off the top of the console, you
-may find that booting with a higher resolution (eg, vga=791)
-will allow you to read more of the text. (Caveat: This needs vesafb,
+may find that booting with a higher resolution (eg, ``vga=791``)
+will allow you to read more of the text. (Caveat: This needs ``vesafb``,
 so won't help for 'early' oopses)
 
-(2) Boot with a serial console (see Documentation/serial-console.txt),
+(2) Boot with a serial console (see
+:ref:`Documentation/serial-console.txt `),
 run a null modem to a second machine and capture the output there
 using your favourite communication program.  Minicom works well.
 
@@ -49,117 +56,126 @@ the disk is not available then you have three options :-
 Full Information
 
 
-NOTE: the message from Linus below applies to 2.4 kernel.  I have preserved it
-for historical reasons, and because some of the information in it still
-applies.  Especially, please ignore any references to ksymoops. 
+.. note::
 
-From: Linus Torvalds 
+  the message from Linus below applies to 2.4 kernel.  I have preserved it
+  for historical reasons, and because some of the information in it still
+  applies.  Especially, please ignore any references to ksymoops.
 
-How to track down an Oops.. [originally a mail to linux-kernel]
+  ::
 
-The main trick is having 5 years of experience with those pesky oops 
-messages ;-)
+   From: Linus Torvalds 
 
-Actually, there are things you can do that make this easier. I have two 
-separate approaches:
+   How to track down 

[PATCH 24/32] Documentation/oops-tracing.txt: convert to ReST markup

[Mauro Carvalho Chehab]

- Add a document title;
- use .. note:: markup;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- replace _foo_ by **foo**;
- while here, remove whitespaces at the end of paragraph;
- add it to the user's book.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/oops-tracing.txt  | 255 +++-
 Documentation/user/index.rst|   1 +
 Documentation/user/oops-tracing.rst |   1 +
 3 files changed, 140 insertions(+), 117 deletions(-)
 create mode 12 Documentation/user/oops-tracing.rst

diff --git a/Documentation/oops-tracing.txt b/Documentation/oops-tracing.txt
index f3ac05cc23e4..3e25ea7349ee 100644
--- a/Documentation/oops-tracing.txt
+++ b/Documentation/oops-tracing.txt
@@ -1,7 +1,13 @@
-NOTE: ksymoops is useless on 2.6.  Please use the Oops in its original format
-(from dmesg, etc).  Ignore any references in this or other docs to "decoding
-the Oops" or "running it through ksymoops".  If you post an Oops from 2.6 that
-has been run through ksymoops, people will just tell you to repost it.
+OOPS tracing
+
+
+.. note::
+
+  ``ksymoops`` is useless on 2.6 or upper.  Please use the Oops in its original
+  format (from ``dmesg``, etc).  Ignore any references in this or other docs to
+  "decoding the Oops" or "running it through ksymoops".
+  If you post an Oops from 2.6+ that has been run through ``ksymoops``,
+  people will just tell you to repost it.
 
 Quick Summary
 -
@@ -12,7 +18,7 @@ If you are unsure send it to the person responsible for the 
code relevant to
 what you were doing.  If it occurs repeatably try and describe how to recreate
 it.  That's worth even more than the oops.
 
-If you are totally stumped as to whom to send the report, send it to 
+If you are totally stumped as to whom to send the report, send it to
 linux-kernel@vger.kernel.org. Thanks for your help in making Linux as
 stable as humanly possible.
 
@@ -20,24 +26,25 @@ Where is the Oops?
 --
 
 Normally the Oops text is read from the kernel buffers by klogd and
-handed to syslogd which writes it to a syslog file, typically
-/var/log/messages (depends on /etc/syslog.conf).  Sometimes klogd dies,
-in which case you can run dmesg > file to read the data from the kernel
-buffers and save it.  Or you can cat /proc/kmsg > file, however you
-have to break in to stop the transfer, kmsg is a "never ending file".
+handed to ``syslogd`` which writes it to a syslog file, typically
+``/var/log/messages`` (depends on ``/etc/syslog.conf``).  Sometimes ``klogd``
+dies, in which case you can run ``dmesg > file`` to read the data from the
+kernel buffers and save it.  Or you can ``cat /proc/kmsg > file``, however you
+have to break in to stop the transfer, ``kmsg`` is a "never ending file".
 If the machine has crashed so badly that you cannot enter commands or
-the disk is not available then you have three options :-
+the disk is not available then you have three options :
 
 (1) Hand copy the text from the screen and type it in after the machine
 has restarted.  Messy but it is the only option if you have not
 planned for a crash. Alternatively, you can take a picture of
 the screen with a digital camera - not nice, but better than
 nothing.  If the messages scroll off the top of the console, you
-may find that booting with a higher resolution (eg, vga=791)
-will allow you to read more of the text. (Caveat: This needs vesafb,
+may find that booting with a higher resolution (eg, ``vga=791``)
+will allow you to read more of the text. (Caveat: This needs ``vesafb``,
 so won't help for 'early' oopses)
 
-(2) Boot with a serial console (see Documentation/serial-console.txt),
+(2) Boot with a serial console (see
+:ref:`Documentation/serial-console.txt `),
 run a null modem to a second machine and capture the output there
 using your favourite communication program.  Minicom works well.
 
@@ -49,117 +56,126 @@ the disk is not available then you have three options :-
 Full Information
 
 
-NOTE: the message from Linus below applies to 2.4 kernel.  I have preserved it
-for historical reasons, and because some of the information in it still
-applies.  Especially, please ignore any references to ksymoops. 
+.. note::
 
-From: Linus Torvalds 
+  the message from Linus below applies to 2.4 kernel.  I have preserved it
+  for historical reasons, and because some of the information in it still
+  applies.  Especially, please ignore any references to ksymoops.
 
-How to track down an Oops.. [originally a mail to linux-kernel]
+  ::
 
-The main trick is having 5 years of experience with those pesky oops 
-messages ;-)
+   From: Linus Torvalds 
 
-Actually, there are things you can do that make this easier. I have two 
-separate approaches:
+   How to track down an Oops.. [originally a mail to linux-kernel]
+
+   The main