From: "Philippe Mathieu-Daudé" <philmd@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>, qemu-devel@nongnu.org
Cc: "John Snow" <jsnow@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Michael Roth" <mdroth@linux.vnet.ibm.com>
Subject: Re: [PATCH v2 17/30] qapi/migration.json: Replace _this_ with *this*
Date: Thu, 13 Feb 2020 20:02:31 +0100 [thread overview]
Message-ID: <41398e32-fc7f-21d4-2318-18e6453d4fee@redhat.com> (raw)
In-Reply-To: <20200213175647.17628-18-peter.maydell@linaro.org>
On 2/13/20 6:56 PM, Peter Maydell wrote:
> 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 <peter.maydell@linaro.org>
> Reviewed-by: Markus Armbruster <armbru@redhat.com>
> ---
> 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)
>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
next prev parent reply other threads:[~2020-02-13 19:03 UTC|newest]
Thread overview: 69+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-13 17:56 [PATCH v2 00/30] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
2020-02-13 17:56 ` [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary Peter Maydell
2020-02-14 6:33 ` Markus Armbruster
2020-02-14 9:21 ` Peter Maydell
2020-02-14 12:20 ` Markus Armbruster
2020-02-14 12:39 ` Peter Maydell
2020-02-14 17:18 ` Markus Armbruster
2020-02-14 17:36 ` Peter Maydell
2020-02-15 10:37 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 02/30] configure: Check that sphinx-build is using Python 3 Peter Maydell
2020-02-13 17:56 ` [PATCH v2 03/30] Makefile: Fix typo in dependency list for interop manpages Peter Maydell
2020-02-13 17:56 ` [PATCH v2 04/30] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Peter Maydell
2020-02-13 17:56 ` [PATCH v2 05/30] qga/qapi-schema.json: Fix indent level on doc comments Peter Maydell
2020-02-14 12:36 ` Markus Armbruster
2020-02-14 12:40 ` Peter Maydell
2020-02-14 14:26 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 06/30] qga/qapi-schema.json: minor format fixups for rST Peter Maydell
2020-02-14 12:46 ` Markus Armbruster
2020-02-14 14:33 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 07/30] qapi/block-core.json: Use literal block for ascii art Peter Maydell
2020-02-13 22:59 ` Aleksandar Markovic
2020-02-15 20:56 ` Philippe Mathieu-Daudé
2020-02-15 21:01 ` Aleksandar Markovic
2020-02-17 0:44 ` Philippe Mathieu-Daudé
2020-02-17 5:53 ` Samuel Thibault
2020-02-14 12:53 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 08/30] qapi: Use ':' after @argument in doc comments Peter Maydell
2020-02-14 13:02 ` Markus Armbruster
2020-02-14 13:28 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 09/30] qapi: Fix indent level on doc comments in json files Peter Maydell
2020-02-14 13:45 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 10/30] qapi: Remove hardcoded tabs Peter Maydell
2020-02-13 17:56 ` [PATCH v2 11/30] qapi/ui.json: Put input-send-event body text in the right place Peter Maydell
2020-02-13 17:56 ` [PATCH v2 12/30] qapi/ui.json: Avoid `...' texinfo style quoting Peter Maydell
2020-02-13 17:56 ` [PATCH v2 13/30] qapi/block-core.json: Use explicit bulleted lists Peter Maydell
2020-02-13 17:56 ` [PATCH v2 14/30] qapi/ui.json: " Peter Maydell
2020-02-14 14:20 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 15/30] qapi/{block, misc, tmp, net}.json: " Peter Maydell
2020-02-14 14:23 ` Markus Armbruster
2020-02-14 14:28 ` Peter Maydell
2020-02-14 15:46 ` Markus Armbruster
2020-02-14 15:48 ` Peter Maydell
2020-02-13 17:56 ` [PATCH v2 16/30] qapi: Add blank lines before " Peter Maydell
2020-02-14 14:33 ` Markus Armbruster
2020-02-14 16:02 ` Markus Armbruster
2020-02-14 16:16 ` Peter Maydell
2020-02-14 17:11 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 17/30] qapi/migration.json: Replace _this_ with *this* Peter Maydell
2020-02-13 19:02 ` Philippe Mathieu-Daudé [this message]
2020-02-14 14:35 ` Markus Armbruster
2020-02-13 17:56 ` [PATCH v2 18/30] qapi: Delete all the "foo: dropped in n.n" notes Peter Maydell
2020-02-14 6:55 ` Markus Armbruster
2020-02-14 15:13 ` Markus Armbruster
2020-02-14 15:20 ` Peter Maydell
2020-02-13 17:56 ` [PATCH v2 19/30] qapi/qapi-schema.json: Put headers in their own doc-comment blocks Peter Maydell
2020-02-13 17:56 ` [PATCH v2 20/30] qapi/machine.json: Escape a literal '*' in doc comment Peter Maydell
2020-02-13 19:01 ` Philippe Mathieu-Daudé
2020-02-13 17:56 ` [PATCH v2 21/30] tests/qapi/doc-good.json: Clean up markup Peter Maydell
2020-02-13 17:56 ` [PATCH v2 22/30] scripts/qapi: Move doc-comment whitespace stripping to doc.py Peter Maydell
2020-02-13 17:56 ` [PATCH v2 23/30] scripts/qapi/parser.py: improve doc comment indent handling Peter Maydell
2020-02-13 17:56 ` [PATCH v2 24/30] docs/sphinx: Add new qapi-doc Sphinx extension Peter Maydell
2020-02-13 17:56 ` [PATCH v2 25/30] docs/interop: Convert qemu-ga-ref to rST Peter Maydell
2020-02-13 17:56 ` [PATCH v2 26/30] docs/interop: Convert qemu-qmp-ref " Peter Maydell
2020-02-17 15:10 ` Peter Maydell
2020-02-13 17:56 ` [PATCH v2 27/30] qapi: Use rST markup for literal blocks Peter Maydell
2020-02-13 17:56 ` [PATCH v2 28/30] qga/qapi-schema.json: Add some headings Peter Maydell
2020-02-13 17:56 ` [PATCH v2 29/30] scripts/qapi: Remove texinfo generation support Peter Maydell
2020-02-13 17:56 ` [PATCH v2 30/30] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions Peter Maydell
2020-02-13 20:51 ` [PATCH v2 00/30] Convert QAPI doc comments to generate rST instead of texinfo no-reply
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=41398e32-fc7f-21d4-2318-18e6453d4fee@redhat.com \
--to=philmd@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=jsnow@redhat.com \
--cc=mdroth@linux.vnet.ibm.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/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;
as well as URLs for NNTP newsgroup(s).