[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 17/18] qapi/migration.json: Replace _this_ with *this*
From: |
Markus Armbruster |
Subject: |
[PULL 17/18] qapi/migration.json: Replace _this_ with *this* |
Date: |
Sat, 15 Feb 2020 12:41:32 +0100 |
From: Peter Maydell <address@hidden>
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 <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Philippe Mathieu-Daudé <address@hidden>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <address@hidden>
---
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
- [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place, (continued)
- [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place, Markus Armbruster, 2020/02/15
- [PULL 03/18] configure: Pick sphinx-build-3 when available, Markus Armbruster, 2020/02/15
- [PULL 18/18] qapi: Delete all the "foo: dropped in n.n" notes, Markus Armbruster, 2020/02/15
- [PULL 10/18] qapi: Fix incorrect "Not documented" claims in QMP documentation, Markus Armbruster, 2020/02/15
- [PULL 14/18] qapi/ui.json: Avoid `...' Texinfo style quoting, Markus Armbruster, 2020/02/15
- [PULL 02/18] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/15
- [PULL 16/18] qapi: Add blank lines before bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 09/18] qapi/block-core.json: Use literal block for ascii art, Markus Armbruster, 2020/02/15
- [PULL 08/18] qga/qapi-schema.json: minor format fixups for rST, Markus Armbruster, 2020/02/15
- [PULL 15/18] qapi: Use explicit bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 17/18] qapi/migration.json: Replace _this_ with *this*,
Markus Armbruster <=
- [PULL 12/18] qapi: Remove hardcoded tabs, Markus Armbruster, 2020/02/15
- [PULL 04/18] configure: Check that sphinx-build is using Python 3, Markus Armbruster, 2020/02/15
- [PULL 11/18] qapi: Fix indent level on doc comments in json files, Markus Armbruster, 2020/02/15
- Re: [PULL 00/18] QAPI patches for 2020-02-15, Peter Maydell, 2020/02/17