Re: [PATCH v6 06/21] qapi/machine.json: Escape a literal '*' in doc comment

[Markus Armbruster]

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

> For rST, '*' is a kind of inline markup (for emphasis), so
> "*-softmmu" is a syntax error because of the missing closing '*'.
> Escape the '*' with a '\'.
>
> The texinfo document generator will leave the '\' in the
> output, which is not ideal, but that generator is going to
> go away in a subsequent commit.

Yes, in PATCH 09.  Tolerable.

> Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  qapi/machine.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 0ac1880e4a4..9c45b04363c 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -13,7 +13,7 @@
>  #
>  # The comprehensive enumeration of QEMU system emulation ("softmmu")
>  # targets. Run "./configure --help" in the project root directory, and
> -# look for the *-softmmu targets near the "--target-list" option. The
> +# look for the \*-softmmu targets near the "--target-list" option. The
>  # individual target constants are not documented here, for the time
>  # being.
>  #

A better markup might be 

    # The comprehensive enumeration of QEMU system emulation ("softmmu")
    # targets. Run ``./configure --help`` in the project root directory, and
    # look for the ``*-softmmu`` targets near the ``--target-list``
    # option. The individual target constants are not documented here, for
    # the time being.

But that should be done systematically, not just here, which makes it
worse than your patch at this point of the conversion.

Reviewed-by: Markus Armbruster <armbru@redhat.com>