Re: [PATCH v3 05/12] scripts/qapi/parser.py: improve doc comment indent handling

[Richard Henderson <richard.henderson@linaro.org>]

On 2/25/20 6:04 AM, Peter Maydell wrote:
> Make the handling of indentation in doc comments more sophisticated,
> so that when we see a section like:
> 
> Notes: some text
>        some more text
>           indented line 3
> 
> we save it for the doc-comment processing code as:
> 
> some text
> some more text
>    indented line 3
> 
> and when we see a section with the heading on its own line:
> 
> Notes:
> 
> some text
> some more text
>    indented text
> 
> we also accept that and save it in the same form.
> 
> The exception is that we always retain indentation as-is for Examples
> sections, because these are literal text.
> 
> If we detect that the comment document text is not indented as much
> as we expect it to be, we throw a parse error.  (We don't complain
> about over-indented sections, because for rST this can be legitimate
> markup.)
> 
> The golden reference for the doc comment text is updated to remove
> the two 'wrong' indents; these now form a test case that we correctly
> stripped leading whitespace from an indented multi-line argument
> definition.
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> v1->v2: Update doc-good.out as per final para.
> ---
>  scripts/qapi/parser.py         | 82 +++++++++++++++++++++++++++-------
>  tests/qapi-schema/doc-good.out |  4 +-
>  2 files changed, 67 insertions(+), 19 deletions(-)

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>


r~