[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v4 03/18] qapi/machine.json: Escape a literal '*' in doc comm
From: |
Richard Henderson |
Subject: |
Re: [PATCH v4 03/18] qapi/machine.json: Escape a literal '*' in doc comment |
Date: |
Tue, 10 Mar 2020 23:06:52 -0700 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.4.1 |
On 3/9/20 8:43 AM, Peter Maydell wrote:
> 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.
>
> Signed-off-by: Peter Maydell <address@hidden>
> ---
> qapi/machine.json | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by: Richard Henderson <address@hidden>
r~
- [PATCH v4 00/18] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/03/09
- [PATCH v4 02/18] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/03/09
- [PATCH v4 03/18] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/03/09
- Re: [PATCH v4 03/18] qapi/machine.json: Escape a literal '*' in doc comment,
Richard Henderson <=
- [PATCH v4 05/18] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/03/09
- [PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/03/09
- [PATCH v4 01/18] qapi/migration.json: Fix indentation, Peter Maydell, 2020/03/09
- [PATCH v4 06/18] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/03/09
- [PATCH v4 07/18] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/03/09