summary refs log tree commit diff
path: root/Documentation/ntb.txt
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-04-10 06:56:23 -0300
committerJonathan Corbet <corbet@lwn.net>2019-04-11 12:37:02 -0600
commit3ac10b02557361fbe5e4cd351a3594369be25774 (patch)
treec82283cbcb925b4c25b0d923b3cd3114bc5929cf /Documentation/ntb.txt
parent26187d18b8d1be18a21bd84419cf89080fecfa1f (diff)
downloadlinux-3ac10b02557361fbe5e4cd351a3594369be25774.tar.gz
docs: ntb.txt: use Sphinx notation for the two ascii figures
In order to make it to build with Sphinx, we need to fix the
notation for two ascii artwork.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/ntb.txt')
-rw-r--r--Documentation/ntb.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/ntb.txt b/Documentation/ntb.txt
index a043854d28df..344a075f81f5 100644
--- a/Documentation/ntb.txt
+++ b/Documentation/ntb.txt
@@ -41,9 +41,10 @@ mainly used to perform the proper memory window initialization. Typically
 there are two types of memory window interfaces supported by the NTB API:
 inbound translation configured on the local ntb port and outbound translation
 configured by the peer, on the peer ntb port. The first type is
-depicted on the next figure
+depicted on the next figure::
+
+ Inbound translation:
 
-Inbound translation:
  Memory:              Local NTB Port:      Peer NTB Port:      Peer MMIO:
   ____________
  | dma-mapped |-ntb_mw_set_trans(addr)  |
@@ -58,9 +59,10 @@ maps corresponding outbound memory window so to have access to the shared
 memory region.
 
 The second type of interface, that implies the shared windows being
-initialized by a peer device, is depicted on the figure:
+initialized by a peer device, is depicted on the figure::
+
+ Outbound translation:
 
-Outbound translation:
  Memory:        Local NTB Port:    Peer NTB Port:      Peer MMIO:
   ____________                      ______________
  | dma-mapped |                |   | MW base addr |<== memory-mapped IO