[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping
From: |
Richard Henderson |
Subject: |
Re: [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py |
Date: |
Thu, 27 Feb 2020 05:59:47 -0800 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.4.1 |
On 2/25/20 6:04 AM, Peter Maydell wrote:
> As we accumulate lines from doc comments when parsing the JSON, the
> QAPIDoc class generally strips leading and trailing whitespace using
> line.strip() when it calls _append_freeform(). This is fine for
> texinfo, but for rST leading whitespace is significant. We'd like to
> move to having the text in doc comments be rST format rather than a
> custom syntax, so move the removal of leading whitespace from the
> QAPIDoc class to the texinfo-specific processing code in
> texi_format() in qapi/doc.py.
>
> (Trailing whitespace will always be stripped by the rstrip() in
> Section::append regardless.)
>
> In a followup commit we will make the whitespace in the lines of doc
> comment sections more consistently follow the input source.
>
> There is no change to the generated .texi files before and after this
> commit.
>
> Because the qapi-schema test checks the exact values of the
> documentation comments against a reference, we need to update that
> reference to match the new whitespace. In the first four places this
> is now correctly checking that we did put in the amount of whitespace
> to pass a rST-formatted list to the backend; in the last two places
> the extra whitespace is 'wrong' and will go away again in the
> following commit.
>
> Signed-off-by: Peter Maydell <address@hidden>
> ---
> New in v2: update doc-good.out as noted in final para of commit msg
> ---
> scripts/qapi/doc.py | 1 +
> scripts/qapi/parser.py | 12 ++++--------
> tests/qapi-schema/doc-good.out | 12 ++++++------
> 3 files changed, 11 insertions(+), 14 deletions(-)
Reviewed-by: Richard Henderson <address@hidden>
r~
- [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/02/25
- [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/25
- [PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/25
- [PATCH v3 03/12] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/02/25
- [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/25
- Re: [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py,
Richard Henderson <=
- [PATCH v3 05/12] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/02/25
- [PATCH v3 09/12] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/02/25
- [PATCH v3 06/12] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/02/25
- [PATCH v3 07/12] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/02/25
- [PATCH v3 10/12] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/02/25
- [PATCH v3 08/12] docs/interop: Convert qemu-qmp-ref to rST, Peter Maydell, 2020/02/25
- [PATCH v3 12/12] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/02/25
- [PATCH v3 11/12] scripts/qapi: Remove texinfo generation support, Peter Maydell, 2020/02/25
- Re: [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Markus Armbruster, 2020/02/26