Skip to content

Commit

Permalink
dmaengine: doc: fix bullet list formatting
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Vinod Koul <[email protected]>
  • Loading branch information
lucaceresoli authored and Vinod Koul committed Jan 8, 2018
1 parent 4fbd8d1 commit a5d3320
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions Documentation/driver-api/dmaengine/provider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------
Expand Down

0 comments on commit a5d3320

Please sign in to comment.