[PATCH 16/32] Documentation/dynamic-debug-howto.txt: convert it to ReST markup

[Mauro Carvalho Chehab]

- use a quote blocks where needed;
- fix the chapter/section/subsection markups;
- use ``foo`` for monotonic;
- use .. note:: for the line-range note;
- cleanup whitespaces;
- add it to the user's book.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/dynamic-debug-howto.txt  | 297 +++--
 Documentation/user/dynamic-debug-howto.rst |   1 +
 Documentation/user/index.rst   |   1 +
 3 files changed, 157 insertions(+), 142 deletions(-)
 create mode 12 Documentation/user/dynamic-debug-howto.rst

diff --git a/Documentation/dynamic-debug-howto.txt 
b/Documentation/dynamic-debug-howto.txt
index 9417871b8758..88adcfdf5b2b 100644
--- a/Documentation/dynamic-debug-howto.txt
+++ b/Documentation/dynamic-debug-howto.txt
@@ -1,3 +1,6 @@
+Dynamic debug
++
+
 
 Introduction
 
@@ -6,16 +9,16 @@ This document describes how to use the dynamic debug (dyndbg) 
feature.
 
 Dynamic debug is designed to allow you to dynamically enable/disable
 kernel code to obtain additional kernel information.  Currently, if
-CONFIG_DYNAMIC_DEBUG is set, then all pr_debug()/dev_dbg() and
-print_hex_dump_debug()/print_hex_dump_bytes() calls can be dynamically
+``CONFIG_DYNAMIC_DEBUG`` is set, then all ``pr_debug()``/``dev_dbg()`` and
+``print_hex_dump_debug()``/``print_hex_dump_bytes()`` calls can be dynamically
 enabled per-callsite.
 
-If CONFIG_DYNAMIC_DEBUG is not set, print_hex_dump_debug() is just
-shortcut for print_hex_dump(KERN_DEBUG).
+If ``CONFIG_DYNAMIC_DEBUG`` is not set, ``print_hex_dump_debug()`` is just
+shortcut for ``print_hex_dump(KERN_DEBUG)``.
 
-For print_hex_dump_debug()/print_hex_dump_bytes(), format string is
-its 'prefix_str' argument, if it is constant string; or "hexdump"
-in case 'prefix_str' is build dynamically.
+For ``print_hex_dump_debug()``/``print_hex_dump_bytes()``, format string is
+its ``prefix_str`` argument, if it is constant string; or ``hexdump``
+in case ``prefix_str`` is build dynamically.
 
 Dynamic debug has even more useful features:
 
@@ -28,96 +31,95 @@ Dynamic debug has even more useful features:
- module name
- format string
 
- * Provides a debugfs control file: /dynamic_debug/control
+ * Provides a debugfs control file: ``/dynamic_debug/control``
which can be read to display the complete list of known debug
statements, to help guide you
 
 Controlling dynamic debug Behaviour
 ===
 
-The behaviour of pr_debug()/dev_dbg()s are controlled via writing to a
+The behaviour of ``pr_debug()``/``dev_dbg()`` are controlled via writing to a
 control file in the 'debugfs' filesystem. Thus, you must first mount
 the debugfs filesystem, in order to make use of this feature.
 Subsequently, we refer to the control file as:
-/dynamic_debug/control. For example, if you want to enable
-printing from source file 'svcsock.c', line 1603 you simply do:
+``/dynamic_debug/control``. For example, if you want to enable
+printing from source file ``svcsock.c``, line 1603 you simply do::
 
-nullarbor:~ # echo 'file svcsock.c line 1603 +p' >
+  nullarbor:~ # echo 'file svcsock.c line 1603 +p' >
/dynamic_debug/control
 
-If you make a mistake with the syntax, the write will fail thus:
+If you make a mistake with the syntax, the write will fail thus::
 
-nullarbor:~ # echo 'file svcsock.c wtf 1 +p' >
+  nullarbor:~ # echo 'file svcsock.c wtf 1 +p' >
/dynamic_debug/control
--bash: echo: write error: Invalid argument
+  -bash: echo: write error: Invalid argument
 
 Viewing Dynamic Debug Behaviour
-===
+===
 
 You can view the currently configured behaviour of all the debug
-statements via:
+statements via::
 
-nullarbor:~ # cat /dynamic_debug/control
-# filename:lineno [module]function flags format
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:323 
[svcxprt_rdma]svc_rdma_cleanup =_ "SVCRDMA Module Removed, deregister RPC RDMA 
transport\012"
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:341 
[svcxprt_rdma]svc_rdma_init =_ "\011max_inline   : %d\012"
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:340 
[svcxprt_rdma]svc_rdma_init =_ "\011sq_depth : %d\012"
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:338 
[svcxprt_rdma]svc_rdma_init =_ "\011max_requests : %d\012"
-...
+  nullarbor:~ # cat /dynamic_debug/control
+  # filename:lineno [module]function flags format
+  
/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:323 
[svcxprt_rdma]svc_rdma_cleanup =_ "SVCRDMA Module Removed, deregister RPC RDMA 
transport\012"
+  
/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:341 
[svcxprt_rdma]svc_rdma_init =_ "\011max_inline   : %d\012"
+  

[PATCH 16/32] Documentation/dynamic-debug-howto.txt: convert it to ReST markup

[Mauro Carvalho Chehab]

- use a quote blocks where needed;
- fix the chapter/section/subsection markups;
- use ``foo`` for monotonic;
- use .. note:: for the line-range note;
- cleanup whitespaces;
- add it to the user's book.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/dynamic-debug-howto.txt  | 297 +++--
 Documentation/user/dynamic-debug-howto.rst |   1 +
 Documentation/user/index.rst   |   1 +
 3 files changed, 157 insertions(+), 142 deletions(-)
 create mode 12 Documentation/user/dynamic-debug-howto.rst

diff --git a/Documentation/dynamic-debug-howto.txt 
b/Documentation/dynamic-debug-howto.txt
index 9417871b8758..88adcfdf5b2b 100644
--- a/Documentation/dynamic-debug-howto.txt
+++ b/Documentation/dynamic-debug-howto.txt
@@ -1,3 +1,6 @@
+Dynamic debug
++
+
 
 Introduction
 
@@ -6,16 +9,16 @@ This document describes how to use the dynamic debug (dyndbg) 
feature.
 
 Dynamic debug is designed to allow you to dynamically enable/disable
 kernel code to obtain additional kernel information.  Currently, if
-CONFIG_DYNAMIC_DEBUG is set, then all pr_debug()/dev_dbg() and
-print_hex_dump_debug()/print_hex_dump_bytes() calls can be dynamically
+``CONFIG_DYNAMIC_DEBUG`` is set, then all ``pr_debug()``/``dev_dbg()`` and
+``print_hex_dump_debug()``/``print_hex_dump_bytes()`` calls can be dynamically
 enabled per-callsite.
 
-If CONFIG_DYNAMIC_DEBUG is not set, print_hex_dump_debug() is just
-shortcut for print_hex_dump(KERN_DEBUG).
+If ``CONFIG_DYNAMIC_DEBUG`` is not set, ``print_hex_dump_debug()`` is just
+shortcut for ``print_hex_dump(KERN_DEBUG)``.
 
-For print_hex_dump_debug()/print_hex_dump_bytes(), format string is
-its 'prefix_str' argument, if it is constant string; or "hexdump"
-in case 'prefix_str' is build dynamically.
+For ``print_hex_dump_debug()``/``print_hex_dump_bytes()``, format string is
+its ``prefix_str`` argument, if it is constant string; or ``hexdump``
+in case ``prefix_str`` is build dynamically.
 
 Dynamic debug has even more useful features:
 
@@ -28,96 +31,95 @@ Dynamic debug has even more useful features:
- module name
- format string
 
- * Provides a debugfs control file: /dynamic_debug/control
+ * Provides a debugfs control file: ``/dynamic_debug/control``
which can be read to display the complete list of known debug
statements, to help guide you
 
 Controlling dynamic debug Behaviour
 ===
 
-The behaviour of pr_debug()/dev_dbg()s are controlled via writing to a
+The behaviour of ``pr_debug()``/``dev_dbg()`` are controlled via writing to a
 control file in the 'debugfs' filesystem. Thus, you must first mount
 the debugfs filesystem, in order to make use of this feature.
 Subsequently, we refer to the control file as:
-/dynamic_debug/control. For example, if you want to enable
-printing from source file 'svcsock.c', line 1603 you simply do:
+``/dynamic_debug/control``. For example, if you want to enable
+printing from source file ``svcsock.c``, line 1603 you simply do::
 
-nullarbor:~ # echo 'file svcsock.c line 1603 +p' >
+  nullarbor:~ # echo 'file svcsock.c line 1603 +p' >
/dynamic_debug/control
 
-If you make a mistake with the syntax, the write will fail thus:
+If you make a mistake with the syntax, the write will fail thus::
 
-nullarbor:~ # echo 'file svcsock.c wtf 1 +p' >
+  nullarbor:~ # echo 'file svcsock.c wtf 1 +p' >
/dynamic_debug/control
--bash: echo: write error: Invalid argument
+  -bash: echo: write error: Invalid argument
 
 Viewing Dynamic Debug Behaviour
-===
+===
 
 You can view the currently configured behaviour of all the debug
-statements via:
+statements via::
 
-nullarbor:~ # cat /dynamic_debug/control
-# filename:lineno [module]function flags format
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:323 
[svcxprt_rdma]svc_rdma_cleanup =_ "SVCRDMA Module Removed, deregister RPC RDMA 
transport\012"
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:341 
[svcxprt_rdma]svc_rdma_init =_ "\011max_inline   : %d\012"
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:340 
[svcxprt_rdma]svc_rdma_init =_ "\011sq_depth : %d\012"
-/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:338 
[svcxprt_rdma]svc_rdma_init =_ "\011max_requests : %d\012"
-...
+  nullarbor:~ # cat /dynamic_debug/control
+  # filename:lineno [module]function flags format
+  
/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:323 
[svcxprt_rdma]svc_rdma_cleanup =_ "SVCRDMA Module Removed, deregister RPC RDMA 
transport\012"
+  
/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:341 
[svcxprt_rdma]svc_rdma_init =_ "\011max_inline   : %d\012"
+  
/usr/src/packages/BUILD/sgi-enhancednfs-1.4/default/net/sunrpc/svc_rdma.c:340