QEMU-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Peter Maydell" <peter.maydell@linaro.org>,
	"Philippe Mathieu-Daudé" <philmd@redhat.com>
Subject: [PULL 17/18] qapi/migration.json: Replace _this_ with *this*
Date: Sat, 15 Feb 2020 12:41:32 +0100
Message-ID: <20200215114133.15097-18-armbru@redhat.com> (raw)
In-Reply-To: <20200215114133.15097-1-armbru@redhat.com>

From: Peter Maydell <peter.maydell@linaro.org>

The MigrationInfo::setup-time documentation is the only place where we
use _this_ inline markup for emphasis, commonly rendered in italics.
We would like to switch the doc comments to rST format, but rST
doesn't recognize that markup and emits literal underscores.

Switch to *this* instead.  Changes markup to strong emphasis with
Texinfo, commonly rendered as bold.  With rST, it will go right back
to emphasis / italics.

rST also uses **this** for strong (commonly rendered bold) where
Texinfo uses *this*. We have one place in the doc comments
which uses strong/bold markup, in qapi/introspect.json:
    Note: the QAPI schema is also used to help define *internal*

When we switch to rST that will be rendered as emphasis / italics.
Markus (who wrote that) thinks that using emphasis / italics
there is an improvement, so we leave that markup alone.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200213175647.17628-18-peter.maydell@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/migration.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qapi/migration.json b/qapi/migration.json
index 11033b7a8e..52f3429969 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -178,8 +178,8 @@
 #                     expected downtime in milliseconds for the guest in last walk
 #                     of the dirty bitmap. (since 1.3)
 #
-# @setup-time: amount of setup time in milliseconds _before_ the
-#              iterations begin but _after_ the QMP command is issued. This is designed
+# @setup-time: amount of setup time in milliseconds *before* the
+#              iterations begin but *after* the QMP command is issued. This is designed
 #              to provide an accounting of any activities (such as RDMA pinning) which
 #              may be expensive, but do not actually occur during the iterative
 #              migration rounds themselves. (since 1.6)
-- 
2.21.1



  parent reply index

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-15 11:41 [PULL 00/18] QAPI patches for 2020-02-15 Markus Armbruster
2020-02-15 11:41 ` [PULL 01/18] qapi: Expand documentation for LostTickPolicy Markus Armbruster
2020-02-15 11:41 ` [PULL 02/18] configure: Allow user to specify sphinx-build binary Markus Armbruster
2020-02-15 11:41 ` [PULL 03/18] configure: Pick sphinx-build-3 when available Markus Armbruster
2020-02-15 11:41 ` [PULL 04/18] configure: Check that sphinx-build is using Python 3 Markus Armbruster
2020-02-15 11:41 ` [PULL 05/18] Makefile: Fix typo in dependency list for interop manpages Markus Armbruster
2020-02-15 11:41 ` [PULL 06/18] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Markus Armbruster
2020-02-15 11:41 ` [PULL 07/18] qga/qapi-schema.json: Fix indent level on doc comments Markus Armbruster
2020-02-15 11:41 ` [PULL 08/18] qga/qapi-schema.json: minor format fixups for rST Markus Armbruster
2020-02-15 11:41 ` [PULL 09/18] qapi/block-core.json: Use literal block for ascii art Markus Armbruster
2020-02-15 11:41 ` [PULL 10/18] qapi: Fix incorrect "Not documented" claims in QMP documentation Markus Armbruster
2020-02-15 11:41 ` [PULL 11/18] qapi: Fix indent level on doc comments in json files Markus Armbruster
2020-02-15 11:41 ` [PULL 12/18] qapi: Remove hardcoded tabs Markus Armbruster
2020-02-15 11:41 ` [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place Markus Armbruster
2020-02-15 11:41 ` [PULL 14/18] qapi/ui.json: Avoid `...' Texinfo style quoting Markus Armbruster
2020-02-15 11:41 ` [PULL 15/18] qapi: Use explicit bulleted lists Markus Armbruster
2020-02-15 11:41 ` [PULL 16/18] qapi: Add blank lines before " Markus Armbruster
2020-02-15 11:41 ` Markus Armbruster [this message]
2020-02-15 11:41 ` [PULL 18/18] qapi: Delete all the "foo: dropped in n.n" notes Markus Armbruster
2020-02-17  9:57 ` [PULL 00/18] QAPI patches for 2020-02-15 Peter Maydell

Reply instructions:

You may reply publically 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=20200215114133.15097-18-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=philmd@redhat.com \
    --cc=qemu-devel@nongnu.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

QEMU-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/qemu-devel/0 qemu-devel/git/0.git
	git clone --mirror https://lore.kernel.org/qemu-devel/1 qemu-devel/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 qemu-devel qemu-devel/ https://lore.kernel.org/qemu-devel \
		qemu-devel@nongnu.org
	public-inbox-index qemu-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.nongnu.qemu-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git