dmaengine: doc: fix bullet list formatting
authorLuca Ceresoli <luca@lucaceresoli.net>
Sat, 30 Dec 2017 22:53:06 +0000 (23:53 +0100)
committerVinod Koul <vinod.koul@intel.com>
Mon, 8 Jan 2018 10:33:47 +0000 (16:03 +0530)
The bullet list documenting the 'struct dma_device' fields has several
nesting errors, making it render improperly. It also has incoherent
formatting: some fields have a description in the same bullet, some in
a sub-bullet.

Fix both to have a correct and coherent formatting.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Documentation/driver-api/dmaengine/provider.rst

index 814acb4d229475bc9c00c3ff7e47a267ea6a9dba..a257d9d6bd72a3a994b66593b9b3dcdf3069c3bf 100644 (file)
@@ -125,26 +125,22 @@ need to initialize a few fields in there:
   (i.e. excluding mem2mem transfers)
 
 - residue_granularity:
+  granularity of the transfer residue reported to dma_set_residue.
+  This can be either:
 
-  - Granularity of the transfer residue reported to dma_set_residue.
-    This can be either:
+  - Descriptor:
+    your device doesn't support any kind of residue
+    reporting. The framework will only know that a particular
+    transaction descriptor is done.
 
-  - Descriptor
+  - Segment:
+    your device is able to report which chunks have been transferred
 
-    - Your device doesn't support any kind of residue
-      reporting. The framework will only know that a particular
-      transaction descriptor is done.
+  - Burst:
+    your device is able to report which burst have been transferred
 
-      - Segment
-
-        - Your device is able to report which chunks have been transferred
-
-      - Burst
-
-        - Your device is able to report which burst have been transferred
-
-  - dev: should hold the pointer to the ``struct device`` associated
-    to your current driver instance.
+- dev: should hold the pointer to the ``struct device`` associated
+  to your current driver instance.
 
 Supported transaction types
 ---------------------------