diff options
| author | Emanuele Giuseppe Esposito <eesposit@redhat.com> | 2021-03-08 08:32:40 +0100 |
|---|---|---|
| committer | Thomas Huth <thuth@redhat.com> | 2021-03-09 11:26:31 +0100 |
| commit | 222455ef814935b1ecc6c9a75acbc0e97e31d8a7 (patch) | |
| tree | 2abbd4a63cdd4967ecc01da343b343978c69541b /docs/devel/qtest.rst | |
| parent | 6179f32eeb6b13574ef65c85f836c681d213e577 (diff) | |
libqos/qgraph: format qgraph comments for sphinx documentation
Change documentation style and fix minor typos in tests/qtest/libqos/qgraph.h
to automatically generate sphinx documentation in docs/devel/qgraph.rst
The mechanism explanation that once was in qgraph.h is now moved to qgraph.rst
There is no functional change intended.
Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
Message-Id: <20210308073240.6363-1-eesposit@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
Diffstat (limited to 'docs/devel/qtest.rst')
| -rw-r--r-- | docs/devel/qtest.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/devel/qtest.rst b/docs/devel/qtest.rst index 97c5a75626..c3dceb6c8a 100644 --- a/docs/devel/qtest.rst +++ b/docs/devel/qtest.rst @@ -2,6 +2,11 @@ QTest Device Emulation Testing Framework ======================================== +.. toctree:: + :hidden: + + qgraph + 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 @@ -24,6 +29,9 @@ On top of libqtest, a higher level library, ``libqos``, was created to encapsulate common tasks of device drivers, such as memory management and communicating with system buses or devices. Many virtual device tests use libqos instead of directly calling into libqtest. +Libqos also offers the Qgraph API to increase each test coverage and +automate QEMU command line arguments and devices setup. +Refer to :ref:`qgraph` for Qgraph explanation and API. Steps to add a new QTest case are: |