All of lore.kernel.org
 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 09/10] docs: speculation.rst: mark example blocks as such
Date: Mon,  8 Apr 2019 13:58:25 -0300	[thread overview]
Message-ID: <0aa821b9a14f61755e97007562e84c66a3c13f3d.1554742526.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1554742526.git.mchehab+samsung@kernel.org>

Identify the example blocks there, in order to avoid Sphinx
warnings.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/other/speculation.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/other/speculation.rst b/Documentation/other/speculation.rst
index e9e6cbae2841..50d7ea857cff 100644
--- a/Documentation/other/speculation.rst
+++ b/Documentation/other/speculation.rst
@@ -17,7 +17,7 @@ observed to extract secret information.
 
 For example, in the presence of branch prediction, it is possible for bounds
 checks to be ignored by code which is speculatively executed. Consider the
-following code:
+following code::
 
 	int load_array(int *array, unsigned int index)
 	{
@@ -27,7 +27,7 @@ following code:
 			return array[index];
 	}
 
-Which, on arm64, may be compiled to an assembly sequence such as:
+Which, on arm64, may be compiled to an assembly sequence such as::
 
 	CMP	<index>, #MAX_ARRAY_ELEMS
 	B.LT	less
@@ -44,7 +44,7 @@ microarchitectural state which can be subsequently measured.
 
 More complex sequences involving multiple dependent memory accesses may
 result in sensitive information being leaked. Consider the following
-code, building on the prior example:
+code, building on the prior example::
 
 	int load_dependent_arrays(int *arr1, int *arr2, int index)
 	{
@@ -77,7 +77,7 @@ A call to array_index_nospec(index, size) returns a sanitized index
 value that is bounded to [0, size) even under cpu speculation
 conditions.
 
-This can be used to protect the earlier load_array() example:
+This can be used to protect the earlier load_array() example::
 
 	int load_array(int *array, unsigned int index)
 	{
-- 
2.20.1


  parent reply	other threads:[~2019-04-08 16:59 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-08 16:58 [PATCH 00/10] Add all documentation files to an html/pdf produced book Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 01/10] docs: DMA-API-HOWTO: add a missing "=" Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 02/10] docs: atomic_bitops.txt: add a title for this document Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 03/10] docs: clearing-warn-once.txt: " Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 04/10] docs: ntb.txt: use Sphinx notation for the two ascii figures Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 05/10] docs: unaligned-memory-access.txt: use a lowercase title Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 06/10] docs: video-output.txt: convert it to ReST format Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 07/10] docs: Add all txt files to documentation Mauro Carvalho Chehab
2019-04-09 16:47   ` Joe Perches
2019-04-08 16:58 ` [PATCH 08/10] docs: ntb.rst: add blank lines to clean up some Sphinx warnings Mauro Carvalho Chehab
2019-04-08 16:58 ` Mauro Carvalho Chehab [this message]
2019-04-08 16:58 ` [PATCH 10/10] docs: add plain text files to ReST output from subdirs Mauro Carvalho Chehab
2019-04-08 22:18 ` [PATCH 00/10] Add all documentation files to an html/pdf produced book Jonathan Corbet
2019-04-10  9:49   ` Mauro Carvalho Chehab
2019-04-11 18:49     ` Jonathan Corbet
2019-04-12  9:28       ` Mauro Carvalho Chehab
2019-04-13  0:30         ` Mauro Carvalho Chehab

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=0aa821b9a14f61755e97007562e84c66a3c13f3d.1554742526.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.