[4/5] dmaengine: doc: ReSTize dmatest doc

Commit Message

Vinod Koul Oct. 25, 2017, 6:32 a.m. UTC

This converts dmatest file with some format changes for RST style

Signed-off-by: Vinod Koul <[e-mail]>
---
 .../dmaengine/{dmatest.txt => dmatest.rst}         | 58 ++++++++++++++++++----
 Documentation/dmaengine/index.rst                  | 10 ++++
 2 files changed, 57 insertions(+), 11 deletions(-)
 rename Documentation/dmaengine/{dmatest.txt => dmatest.rst} (80%)

Patch

diff --git a/Documentation/dmaengine/dmatest.txt b/Documentation/dmaengine/dmatest.rst
similarity index 80%
rename from Documentation/dmaengine/dmatest.txt
rename to Documentation/dmaengine/dmatest.rst
index fb683c72dea8..923b343ef1c1 100644
--- a/Documentation/dmaengine/dmatest.txt
+++ b/Documentation/dmaengine/dmatest.rst
@@ -1,11 +1,12 @@ 
-				DMA Test Guide
-				==============
+DMA Test Guide
+==============
 
-		Andy Shevchenko <[e-mail]>
+Andy Shevchenko <[e-mail]>
 
 This small document introduces how to test DMA drivers using dmatest module.
 
-	Part 1 - How to build the test module
+Part 1 - How to build the test module
+-------------------------------------
 
 The menuconfig contains an option that could be found by following path:
 	Device Drivers -> DMA Engine support -> DMA Test client
@@ -13,12 +14,19 @@  The menuconfig contains an option that could be found by following path:
 In the configuration file the option called CONFIG_DMATEST. The dmatest could
 be built as module or inside kernel. Let's consider those cases.
 
-	Part 2 - When dmatest is built as a module...
+Part 2 - When dmatest is built as a module
+------------------------------------------
 
 Example of usage:
-	% modprobe dmatest channel=dma0chan0 timeout=2000 iterations=1 run=1
+
+::
+
+    % modprobe dmatest channel=dma0chan0 timeout=2000 iterations=1 run=1
 
 ...or:
+
+::
+
 	% modprobe dmatest
 	% echo dma0chan0 > /sys/module/dmatest/parameters/channel
 	% echo 2000 > /sys/module/dmatest/parameters/timeout
@@ -27,10 +35,15 @@  Example of usage:
 
 ...or on the kernel command line:
 
+::
+
 	dmatest.channel=dma0chan0 dmatest.timeout=2000 dmatest.iterations=1 dmatest.run=1
 
-Hint: available channel list could be extracted by running the following
-command:
+..hint:: available channel list could be extracted by running the following
+         command:
+
+::
+
 	% ls -1 /sys/class/dma/
 
 Once started a message like "dmatest: Started 1 threads using dma0chan0" is
@@ -40,6 +53,9 @@  stops.
 Note that running a new test will not stop any in progress test.
 
 The following command returns the state of the test.
+
+::
+
 	% cat /sys/module/dmatest/parameters/run
 
 To wait for test completion userpace can poll 'run' until it is false, or use
@@ -51,14 +67,22 @@  to complete before exiting. Note that if 'iterations' is set to 'infinite' then
 waiting is disabled.
 
 Example:
+
+::
+
 	% modprobe dmatest run=1 iterations=42 wait=1
 	% modprobe -r dmatest
+
 ...or:
+
+::
+
 	% modprobe dmatest run=1 iterations=42
 	% cat /sys/module/dmatest/parameters/wait
 	% modprobe -r dmatest
 
-	Part 3 - When built-in in the kernel...
+Part 3 - When built-in in the kernel
+------------------------------------
 
 The module parameters that is supplied to the kernel command line will be used
 for the first performed test. After user gets a control, the test could be
@@ -67,15 +91,24 @@  section "Part 2 - When dmatest is built as a module..."
 
 In both cases the module parameters are used as the actual values for the test
 case. You always could check them at run-time by running
+
+::
+
 	% grep -H . /sys/module/dmatest/parameters/*
 
-	Part 4 - Gathering the test results
+Part 4 - Gathering the test results
+-----------------------------------
 
 Test results are printed to the kernel log buffer with the format:
 
-"dmatest: result <channel>: <test id>: '<error msg>' with src_off=<val> dst_off=<val> len=<val> (<err code>)"
+::
+
+	"dmatest: result <channel>: <test id>: '<error msg>' with src_off=<val> dst_off=<val> len=<val> (<err code>)"
 
 Example of output:
+
+::
+
 	% dmesg | tail -n 1
 	dmatest: result dma0chan0-copy0: #1: No errors with src_off=0x7bf dst_off=0x8ad len=0x3fea (0)
 
@@ -85,6 +118,9 @@  or status. A test thread also emits a summary line at completion listing the
 number of tests executed, number that failed, and a result code.
 
 Example:
+
+::
+
 	% dmesg | tail -n 1
 	dmatest: dma0chan0-copy0: summary 1 test, 0 failures 1000 iops 100000 KB/s (0)
 
diff --git a/Documentation/dmaengine/index.rst b/Documentation/dmaengine/index.rst
index ffc2b797938c..fae852922a49 100644
--- a/Documentation/dmaengine/index.rst
+++ b/Documentation/dmaengine/index.rst
@@ -27,6 +27,16 @@  API of the DMAEngine. This is applicable only for slave DMA usage only.
 
    client
 
+DMA Test documentation
+----------------------
+
+This book introduces how to test DMA drivers using dmatest module.
+
+.. toctree::
+   :maxdepth: 1
+
+   dmatest
+
 .. only::  subproject
 
    Indices