[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v5 06/20] tests/qapi/doc-good.json: Prepare for qapi-doc Sphi
From: |
Markus Armbruster |
Subject: |
Re: [PATCH v5 06/20] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension |
Date: |
Fri, 04 Sep 2020 10:10:27 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) |
Peter Maydell <peter.maydell@linaro.org> writes:
> doc-good.json tests doc comment parser corner cases. We're about to
> largely replace it by a Sphinx extension, which will have different
> corner cases. Tweak the test so it passes both with the old parser
> and the Sphinx extension, by making it match the more restrictive
> rST syntax:
>
> * in a single list the bullet types must all match
> * lists must have leading and following blank lines
> * indentation is important
Actually, indentation has always been important, but the conversion to
rST changes where and how it matters. Perhaps:
* the rules on when and where indentation matters differ
> * the '|' example syntax is going to go away entirely, so stop
> testing it
>
> This will avoid the tests spuriously breaking when we tighten up the
> parser code in the following commits.
>
> Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
> Reviewed-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
- Re: [PATCH v5 06/20] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension,
Markus Armbruster <=