[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v4 10/18] qapi: Use rST markup for literal blocks
From: |
Richard Henderson |
Subject: |
Re: [PATCH v4 10/18] qapi: Use rST markup for literal blocks |
Date: |
Tue, 10 Mar 2020 23:22:08 -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:
> There are exactly two places in our json doc comments where we
> use the markup accepted by the texi doc generator where a '|' in
> the first line of a doc comment means the line should be emitted
> as a literal block (fixed-width font, whitespace preserved).
>
> Since we use this syntax so rarely, instead of making the rST
> generator support it, instead just convert the two uses to
> rST-format literal blocks, which are indented and introduced
> with '::'.
>
> (The rST generator doesn't complain about the old style syntax,
> it just emits it with the '|' and with the whitespace not
> preserved, which looks odd, but means we can safely leave this
> change until after we've stopped generating texinfo.)
>
> Signed-off-by: Peter Maydell <address@hidden>
> ---
> qapi/block-core.json | 16 +++++++++-------
> qapi/qapi-schema.json | 6 ++++--
> 2 files changed, 13 insertions(+), 9 deletions(-)
Reviewed-by: Richard Henderson <address@hidden>
r~
- [PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup, (continued)
- [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
- [PATCH v4 08/18] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/03/09
- [PATCH v4 10/18] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/03/09
- Re: [PATCH v4 10/18] qapi: Use rST markup for literal blocks,
Richard Henderson <=
- [PATCH v4 09/18] docs/interop: Convert qemu-qmp-ref to rST, Peter Maydell, 2020/03/09
- [PATCH v4 13/18] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/03/09
- [PATCH v4 12/18] scripts/qapi: Remove texinfo generation support, Peter Maydell, 2020/03/09
- [PATCH v4 11/18] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/03/09
- [PATCH v4 14/18] Makefile: Remove redundant Texinfo related rules, Peter Maydell, 2020/03/09