diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2020-09-24 19:23:17 +0100 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2020-09-24 20:18:47 +0100 |
| commit | ccf06f3cdaedb62820ab82cbee79dbfd807a3601 (patch) | |
| tree | 946773af4cb6ebfe17b3bf2ca30cd8f6e459113a /tests/qapi-schema/doc-good.rst | |
| parent | efc84ee62791927f14ddfc61878bd3525d928df8 (diff) | |
| download | qemu-arm-ninjatool-barf.tar.gz | |
tests/qapi-schema: Add test of the rST QAPI doc-comment outputnninjatool-barf
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. However, 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.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'tests/qapi-schema/doc-good.rst')
| -rw-r--r-- | tests/qapi-schema/doc-good.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/tests/qapi-schema/doc-good.rst b/tests/qapi-schema/doc-good.rst new file mode 100644 index 0000000000..1e4c23305a --- /dev/null +++ b/tests/qapi-schema/doc-good.rst @@ -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 |