[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 17/30] qapi/migration.json: Replace _this_ with *this*
From: |
Peter Maydell |
Subject: |
[PATCH v2 17/30] qapi/migration.json: Replace _this_ with *this* |
Date: |
Thu, 13 Feb 2020 17:56:34 +0000 |
The MigrationInfo::setup-time documentation is the only place where
we use _this_ inline markup for emphasis, commonly rendered in
italics. 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>
---
v1->v2: updated commit message. Paras 1 and 2 are from Markus;
paras 3 and 4 are new, and mention a non-change agreed in
the thread off the cover letter of the v1 patch series.
---
qapi/migration.json | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/qapi/migration.json b/qapi/migration.json
index 11033b7a8e6..52f34299698 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.20.1
- [PATCH v2 14/30] qapi/ui.json: Use explicit bulleted lists, (continued)
- [PATCH v2 14/30] qapi/ui.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 16/30] qapi: Add blank lines before bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 18/30] qapi: Delete all the "foo: dropped in n.n" notes, Peter Maydell, 2020/02/13
- [PATCH v2 15/30] qapi/{block, misc, tmp, net}.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 19/30] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/13
- [PATCH v2 17/30] qapi/migration.json: Replace _this_ with *this*,
Peter Maydell <=
- [PATCH v2 22/30] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/13
- [PATCH v2 20/30] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/13
- [PATCH v2 21/30] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/02/13
- [PATCH v2 28/30] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/02/13
- [PATCH v2 25/30] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/02/13
- [PATCH v2 09/30] qapi: Fix indent level on doc comments in json files, Peter Maydell, 2020/02/13