[PATCH 08/24] tests: qemucapabilitiesdata: Add README file

[Martin Kletzander]

On Thu, Mar 16, 2023 at 05:11:37PM +0100, Peter Krempa wrote:
>Explain what the purpose of these files is as well as how they are
>named, captured, used and modified.
>
>Signed-off-by: Peter Krempa <pkrempa at redhat.com>
>---
> tests/qemucapabilitiesdata/README.rst | 94 +++++++++++++++++++++++++++
> tests/qemucapabilitiestest.c          | 18 +----
> 2 files changed, 95 insertions(+), 17 deletions(-)
> create mode 100644 tests/qemucapabilitiesdata/README.rst
>
>diff --git a/tests/qemucapabilitiesdata/README.rst b/tests/qemucapabilitiesdata/README.rst
>new file mode 100644
>index 0000000000..0bf6c97284
>--- /dev/null
>+++ b/tests/qemucapabilitiesdata/README.rst
>@@ -0,0 +1,94 @@
>+=========================
>+QEMU capabilities testing
>+=========================
>+
>+Purpose
>+=======
>+
>+The test data is used to excercise the capability parsing code in
>+``qemucapabilitiestest`` but also provides "real" capabilities data for test
>+suites such as ``domaincapstest`` and ``qemuxml2(argv|xml)test``.
>+
>+It also provides the required data to validate the QMP commands used by libvirt
>+against qemu's QMP schema.
>+

Could you put these in a list, e.g.:

Test data in this directory is used:

* to excercise the capability parsing code in ``qemucapabilitiestest``

* provides "real" capabilities data for test suites such as
   ``domaincapstest`` and ``qemuxml2(argv|xml)test``

* provides the required data to validate the QMP commands used by
   libvirt against qemu's QMP schema.

? it seems more readable to me, but that's just a random idea, apply it
if you like it too

[...]

>+Manual modifications the ``.replies`` file
>+==========================================
>+
>+In certain cases it's impractical or impossible to re-generate the ``.replies``
>+file on a code change causing a change to the actual QMP query process.
>+
>+In such case a careful manual modification of the ``.repliess`` is tolerated.
>+

s/ess/es/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20230321/f0b32e2c/attachment.sig>