motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-06 09:13:55 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

tests/qapi-schema: Add test of the rST QAPI doc-comment output

Browse source 
Add a test of the rST output from the QAPI doc-comment generator,
similar to what we currently have that tests the Texinfo output.

This is a bit more awkward with Sphinx, because the generated output
is not 100% under our control the way the QAPI-to-Texinfo generator
was. We can't observe the data we generate, only the Sphinx
output. Two issues.

One, the output can vary with the Sphinx version. In practice Sphinx's
plaintext output generation has been identical between at least Sphinx
1.6 and 3.0, so we use that. (The HTML output has had changes across
versions). We use an exact-match comparison check, with the
understanding that perhaps changes in a future Sphinx version might
require us to implement something more clever to cope with variation
in the output.

Two, the test can only protect us from changes in the data we generate
that are visible in plain text.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-16-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message improved]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Peter Maydell 2020-09-25 17:23:10 +01:00 • committed by Markus Armbruster
parent b3f4830ab3
commit ca1145ee88
3 changed files with 348 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
tests/qapi-schema/doc-good.rst Normal file
View file

@ -0,0 +1,5 @@
..
Test Sphinx manual that pulls in the test schema file. We will generate
a plain-text output file and compare it against a reference.
.. qapi-doc:: tests/qapi-schema/doc-good.json