Browse Source

dmaengine: doc: format struct fields using monospace

Monospace is more readable and is also used elsewhere in the docs.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Luca Ceresoli 7 years ago
parent
commit
881053f73f
1 changed files with 6 additions and 6 deletions
  1. 6 6
      Documentation/driver-api/dmaengine/provider.rst

+ 6 - 6
Documentation/driver-api/dmaengine/provider.rst

@@ -111,20 +111,20 @@ The first thing you need to do in your driver is to allocate this
 structure. Any of the usual memory allocators will do, but you'll also
 structure. Any of the usual memory allocators will do, but you'll also
 need to initialize a few fields in there:
 need to initialize a few fields in there:
 
 
-- channels: should be initialized as a list using the
+- ``channels``: should be initialized as a list using the
   INIT_LIST_HEAD macro for example
   INIT_LIST_HEAD macro for example
 
 
-- src_addr_widths:
+- ``src_addr_widths``:
   should contain a bitmask of the supported source transfer width
   should contain a bitmask of the supported source transfer width
 
 
-- dst_addr_widths:
+- ``dst_addr_widths``:
   should contain a bitmask of the supported destination transfer width
   should contain a bitmask of the supported destination transfer width
 
 
-- directions:
+- ``directions``:
   should contain a bitmask of the supported slave directions
   should contain a bitmask of the supported slave directions
   (i.e. excluding mem2mem transfers)
   (i.e. excluding mem2mem transfers)
 
 
-- residue_granularity:
+- ``residue_granularity``:
   granularity of the transfer residue reported to dma_set_residue.
   granularity of the transfer residue reported to dma_set_residue.
   This can be either:
   This can be either:
 
 
@@ -139,7 +139,7 @@ need to initialize a few fields in there:
   - Burst:
   - Burst:
     your device is able to report which burst have been transferred
     your device is able to report which burst have been transferred
 
 
-- dev: should hold the pointer to the ``struct device`` associated
+- ``dev``: should hold the pointer to the ``struct device`` associated
   to your current driver instance.
   to your current driver instance.
 
 
 Supported transaction types
 Supported transaction types