scripts/qapi: Move doc-comment whitespace stripping to doc.py
commit99dff36d3a5fb38bd3d079cd16b811bbfcb3ad07
authorPeter Maydell <peter.maydell@linaro.org>
Fri, 25 Sep 2020 16:22:59 +0000 (25 17:22 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 29 Sep 2020 15:55:39 +0000 (29 17:55 +0200)
tree989408475a695fdc04dd5d2daee2bb498ef82605
parent63a97cf5a0aeaaafc6597a196581f4cfee9b8940
scripts/qapi: Move doc-comment whitespace stripping to doc.py

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.

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-5-peter.maydell@linaro.org>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
scripts/qapi/doc.py
scripts/qapi/parser.py
tests/qapi-schema/doc-good.out