qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v4 05/18] scripts/qapi: Move doc-comment whitespace stripping


From: Richard Henderson
Subject: Re: [PATCH v4 05/18] scripts/qapi: Move doc-comment whitespace stripping to doc.py
Date: Tue, 10 Mar 2020 23:07:38 -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:
> 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~



reply via email to

[Prev in Thread] Current Thread [Next in Thread]