mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 4/8] docs: ntb.txt: use Sphinx notation for the two ascii figures
Date: Wed, 10 Apr 2019 06:56:23 -0300	[thread overview]
Message-ID: <a4e40245a483aafeb3d820a05b44166cea11f189.1554889999.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1554889999.git.mchehab+samsung@kernel.org>

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>
---
 Documentation/ntb.txt | 10 ++++++----
 1 file 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
-- 
2.20.1


  parent reply	other threads:[~2019-04-10  9:56 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-10  9:56 [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx Mauro Carvalho Chehab
2019-04-10  9:56 ` [PATCH 1/8] docs: DMA-API-HOWTO: add a missing "=" Mauro Carvalho Chehab
2019-04-10  9:56 ` [PATCH 2/8] docs: atomic_bitops.txt: add a title for this document Mauro Carvalho Chehab
2019-04-10  9:56 ` [PATCH 3/8] docs: clearing-warn-once.txt: " Mauro Carvalho Chehab
2019-04-10  9:56 ` Mauro Carvalho Chehab [this message]
2019-04-10  9:56 ` [PATCH 5/8] docs: unaligned-memory-access.txt: use a lowercase title Mauro Carvalho Chehab
2019-04-10  9:56 ` [PATCH 6/8] docs: video-output.txt: convert it to ReST format Mauro Carvalho Chehab
2019-04-10  9:56 ` [PATCH 7/8] docs: ntb.txt: add blank lines to clean up some Sphinx warnings Mauro Carvalho Chehab
2019-04-10  9:56 ` [PATCH 8/8] docs: speculation.txt: mark example blocks as such Mauro Carvalho Chehab
2019-04-11 18:37 ` [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx Jonathan Corbet
2019-04-12 10:21 ` David Howells
2019-04-12 10:31   ` Markus Heiser
2019-04-12 12:19   ` David Howells
2019-04-12 12:34     ` Markus Heiser
2019-04-12 15:39       ` Jonathan Corbet
2019-04-12 16:45         ` Markus Heiser
2019-04-12 14:13     ` Jani Nikula

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a4e40245a483aafeb3d820a05b44166cea11f189.1554889999.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®