diff options
| author | Eduardo Habkost | 2020-10-05 22:52:27 +0200 |
|---|---|---|
| committer | Paolo Bonzini | 2020-10-12 17:50:22 +0200 |
| commit | f59c6de7f00e664358a9aad49248094ab1b29461 (patch) | |
| tree | b1707c305ca3c1b58a6504472a21a4f6c6dd9992 /docs | |
| parent | docs: Move QTest documentation to its own document (diff) | |
| download | qemu-f59c6de7f00e664358a9aad49248094ab1b29461.tar.gz qemu-f59c6de7f00e664358a9aad49248094ab1b29461.tar.xz qemu-f59c6de7f00e664358a9aad49248094ab1b29461.zip | |
docs/devel/qtest: Include protocol spec in document
Include the QTest Protocol doc string in docs/devel/qtest.rst,
after converting it to use Sphinx syntax.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Acked-by: Thomas Huth <thuth@redhat.com>
Message-Id: <20201005205228.697463-3-ehabkost@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devel/qtest.rst | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/devel/qtest.rst b/docs/devel/qtest.rst index 86dec84a0b..3bf9ebee7f 100644 --- a/docs/devel/qtest.rst +++ b/docs/devel/qtest.rst @@ -4,8 +4,8 @@ QTest Device Emulation Testing Framework QTest is a device emulation testing framework. It can be very useful to test device models; it could also control certain aspects of QEMU (such as virtual -clock stepping), with a special purpose "qtest" protocol. Refer to the -documentation in ``qtest.c`` for more details of the protocol. +clock stepping), with a special purpose "qtest" protocol. Refer to +:ref:`qtest-protocol` for more details of the protocol. QTest cases can be executed with @@ -56,3 +56,11 @@ from the output of which you can run manually. + +.. _qtest-protocol: + +QTest Protocol +-------------- + +.. kernel-doc:: softmmu/qtest.c + :doc: QTest Protocol |