Re: [PATCH 18/29] qapi/migration.json: Replace _this_ with *this*

[Markus Armbruster]

Peter Maydell <address@hidden> writes:

> The MigrationInfo::setup-time documentation is the only place where
> we use _this_ inline markup to mean italics.

Nitpick: _this_ does not mean italics, it means emphasis.  See
qapi-code-gen.txt section "Documentation markup".  doc.py maps it to
@emph{this}, which Texinfo commonly renders in italics when the output
format supports that.

>                                               rST doesn't recognize
> that markup and emits literal underscores.  Switch to *this* instead;
> for the texinfo output this will be bold, and for rST it will go back
> to being italics.

Likewise, *this* doesn't mean italics in rST, it means emphasis.

With the Texinfo doc pipeline, the patch changes the markup of this from
emphasis to strong.

The change will be undone when we switch to rST, where it means emphasis
again.

>
> Signed-off-by: Peter Maydell <address@hidden>
> ---
>  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)

I don't like the commit message, but that's not enough to withhold my
Reviewed-by: Markus Armbruster <address@hidden>