Skip to content

Commit bc1287b

Browse files
andy-shevJonathan Corbet
authored andcommitted
dmaengine: Make dmatest.rst indeed reST compatible
Make dmatest.rst indeed reST compatible. Achieve this by fixing several formatting issues. Signed-off-by: Andy Shevchenko <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent a6cd771 commit bc1287b

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

Documentation/driver-api/dmaengine/dmatest.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Part 1 - How to build the test module
1515
=====================================
1616

1717
The menuconfig contains an option that could be found by following path:
18+
1819
Device Drivers -> DMA Engine support -> DMA Test client
1920

2021
In the configuration file the option called CONFIG_DMATEST. The dmatest could
@@ -23,26 +24,24 @@ be built as module or inside kernel. Let's consider those cases.
2324
Part 2 - When dmatest is built as a module
2425
==========================================
2526

26-
Example of usage: ::
27+
Example of usage::
2728

2829
% modprobe dmatest channel=dma0chan0 timeout=2000 iterations=1 run=1
2930

30-
...or: ::
31+
...or::
3132

3233
% modprobe dmatest
3334
% echo dma0chan0 > /sys/module/dmatest/parameters/channel
3435
% echo 2000 > /sys/module/dmatest/parameters/timeout
3536
% echo 1 > /sys/module/dmatest/parameters/iterations
3637
% echo 1 > /sys/module/dmatest/parameters/run
3738

38-
...or on the kernel command line: ::
39+
...or on the kernel command line::
3940

4041
dmatest.channel=dma0chan0 dmatest.timeout=2000 dmatest.iterations=1 dmatest.run=1
4142

42-
..hint:: available channel list could be extracted by running the following
43-
command:
44-
45-
::
43+
.. hint::
44+
available channel list could be extracted by running the following command::
4645

4746
% ls -1 /sys/class/dma/
4847

@@ -64,12 +63,12 @@ before returning. For example, the following scripts wait for 42 tests
6463
to complete before exiting. Note that if 'iterations' is set to 'infinite' then
6564
waiting is disabled.
6665

67-
Example: ::
66+
Example::
6867

6968
% modprobe dmatest run=1 iterations=42 wait=1
7069
% modprobe -r dmatest
7170

72-
...or: ::
71+
...or::
7372

7473
% modprobe dmatest run=1 iterations=42
7574
% cat /sys/module/dmatest/parameters/wait
@@ -81,7 +80,7 @@ Part 3 - When built-in in the kernel
8180
The module parameters that is supplied to the kernel command line will be used
8281
for the first performed test. After user gets a control, the test could be
8382
re-run with the same or different parameters. For the details see the above
84-
section "Part 2 - When dmatest is built as a module..."
83+
section `Part 2 - When dmatest is built as a module`_.
8584

8685
In both cases the module parameters are used as the actual values for the test
8786
case. You always could check them at run-time by running ::
@@ -91,12 +90,11 @@ case. You always could check them at run-time by running ::
9190
Part 4 - Gathering the test results
9291
===================================
9392

94-
Test results are printed to the kernel log buffer with the format: ::
93+
Test results are printed to the kernel log buffer with the format::
9594

9695
"dmatest: result <channel>: <test id>: '<error msg>' with src_off=<val> dst_off=<val> len=<val> (<err code>)"
9796

98-
Example of output: ::
99-
97+
Example of output::
10098

10199
% dmesg | tail -n 1
102100
dmatest: result dma0chan0-copy0: #1: No errors with src_off=0x7bf dst_off=0x8ad len=0x3fea (0)
@@ -106,7 +104,7 @@ the parens represents additional information, e.g. error code, error counter,
106104
or status. A test thread also emits a summary line at completion listing the
107105
number of tests executed, number that failed, and a result code.
108106

109-
Example: ::
107+
Example::
110108

111109
% dmesg | tail -n 1
112110
dmatest: dma0chan0-copy0: summary 1 test, 0 failures 1000 iops 100000 KB/s (0)

0 commit comments

Comments
 (0)