[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 15/39] docs: Move QTest documentation to its own document
From: |
Paolo Bonzini |
Subject: |
[PULL 15/39] docs: Move QTest documentation to its own document |
Date: |
Sat, 10 Oct 2020 03:57:15 -0400 |
From: Eduardo Habkost <ehabkost@redhat.com>
The qtest and libqtest doc comments will be parsed to generate
API documentation, so move QTest documentation to its own
document where the API and format documentation and will be
included.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Acked-by: Thomas Huth <thuth@redhat.com>
Message-Id: <20201005205228.697463-2-ehabkost@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
docs/devel/index.rst | 1 +
docs/devel/qtest.rst | 58 ++++++++++++++++++++++++++++++++++++++++++
docs/devel/testing.rst | 47 ++--------------------------------
3 files changed, 61 insertions(+), 45 deletions(-)
create mode 100644 docs/devel/qtest.rst
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 5fda2d3509..77baae5c77 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -21,6 +21,7 @@ Contents:
atomics
stable-process
testing
+ qtest
decodetree
secure-coding-practices
tcg
diff --git a/docs/devel/qtest.rst b/docs/devel/qtest.rst
new file mode 100644
index 0000000000..86dec84a0b
--- /dev/null
+++ b/docs/devel/qtest.rst
@@ -0,0 +1,58 @@
+========================================
+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.
+
+QTest cases can be executed with
+
+.. code::
+
+ make check-qtest
+
+The QTest library is implemented by ``tests/qtest/libqtest.c`` and the API is
+defined in ``tests/qtest/libqtest.h``.
+
+Consider adding a new QTest case when you are introducing a new virtual
+hardware, or extending one if you are adding functionalities to an existing
+virtual device.
+
+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.
+
+Steps to add a new QTest case are:
+
+1. Create a new source file for the test. (More than one file can be added as
+ necessary.) For example, ``tests/qtest/foo-test.c``.
+
+2. Write the test code with the glib and libqtest/libqos API. See also existing
+ tests and the library headers for reference.
+
+3. Register the new test in ``tests/qtest/Makefile.include``. Add the test
+ executable name to an appropriate ``check-qtest-*-y`` variable. For example:
+
+ ``check-qtest-generic-y = tests/qtest/foo-test$(EXESUF)``
+
+4. Add object dependencies of the executable in the Makefile, including the
+ test source file(s) and other interesting objects. For example:
+
+ ``tests/qtest/foo-test$(EXESUF): tests/qtest/foo-test.o $(libqos-obj-y)``
+
+Debugging a QTest failure is slightly harder than the unit test because the
+tests look up QEMU program names in the environment variables, such as
+``QTEST_QEMU_BINARY`` and ``QTEST_QEMU_IMG``, and also because it is not easy
+to attach gdb to the QEMU process spawned from the test. But manual invoking
+and using gdb on the test is still simple to do: find out the actual command
+from the output of
+
+.. code::
+
+ make check-qtest V=1
+
+which you can run manually.
+
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index bd64c1bdcd..a171494b4e 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -70,8 +70,8 @@ QTest
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
+:doc:`qtest` for more details.
QTest cases can be executed with
@@ -79,49 +79,6 @@ QTest cases can be executed with
make check-qtest
-The QTest library is implemented by ``tests/qtest/libqtest.c`` and the API is
-defined in ``tests/qtest/libqtest.h``.
-
-Consider adding a new QTest case when you are introducing a new virtual
-hardware, or extending one if you are adding functionalities to an existing
-virtual device.
-
-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.
-
-Steps to add a new QTest case are:
-
-1. Create a new source file for the test. (More than one file can be added as
- necessary.) For example, ``tests/qtest/foo-test.c``.
-
-2. Write the test code with the glib and libqtest/libqos API. See also existing
- tests and the library headers for reference.
-
-3. Register the new test in ``tests/qtest/Makefile.include``. Add the test
- executable name to an appropriate ``check-qtest-*-y`` variable. For example:
-
- ``check-qtest-generic-y = tests/qtest/foo-test$(EXESUF)``
-
-4. Add object dependencies of the executable in the Makefile, including the
- test source file(s) and other interesting objects. For example:
-
- ``tests/qtest/foo-test$(EXESUF): tests/qtest/foo-test.o $(libqos-obj-y)``
-
-Debugging a QTest failure is slightly harder than the unit test because the
-tests look up QEMU program names in the environment variables, such as
-``QTEST_QEMU_BINARY`` and ``QTEST_QEMU_IMG``, and also because it is not easy
-to attach gdb to the QEMU process spawned from the test. But manual invoking
-and using gdb on the test is still simple to do: find out the actual command
-from the output of
-
-.. code::
-
- make check-qtest V=1
-
-which you can run manually.
-
QAPI schema tests
-----------------
--
2.26.2
- [PULL 00/39] SCSI, qdev, qtest, meson patches for 2020-10-10, Paolo Bonzini, 2020/10/10
- [PULL 01/39] meson.build: Add comments to clarify code organization, Paolo Bonzini, 2020/10/10
- [PULL 05/39] migration: Move the creation of the library to the main meson.build, Paolo Bonzini, 2020/10/10
- [PULL 03/39] hw/core: Move the creation of the library to the main meson.build, Paolo Bonzini, 2020/10/10
- [PULL 02/39] meson.build: Sort sourcesets alphabetically, Paolo Bonzini, 2020/10/10
- [PULL 04/39] chardev: Move the creation of the library to the main meson.build, Paolo Bonzini, 2020/10/10
- [PULL 10/39] hw/nvram: Always register FW_CFG_DATA_GENERATOR_INTERFACE, Paolo Bonzini, 2020/10/10
- [PULL 15/39] docs: Move QTest documentation to its own document,
Paolo Bonzini <=
- [PULL 08/39] authz: Move the creation of the library to the main meson.build, Paolo Bonzini, 2020/10/10
- [PULL 16/39] docs/devel/qtest: Include protocol spec in document, Paolo Bonzini, 2020/10/10
- [PULL 06/39] io: Move the creation of the library to the main meson.build, Paolo Bonzini, 2020/10/10
- [PULL 09/39] qom: Move the creation of the library to the main meson.build, Paolo Bonzini, 2020/10/10
- [PULL 07/39] crypto: Move the creation of the library to the main meson.build, Paolo Bonzini, 2020/10/10
- [PULL 11/39] softmmu: move more files to softmmu/, Paolo Bonzini, 2020/10/10
- [PULL 13/39] qom: fix objects with improper parent type, Paolo Bonzini, 2020/10/10
- [PULL 19/39] docs/devel: update instruction on how to add new unit tests, Paolo Bonzini, 2020/10/10
- [PULL 14/39] configure: fix performance regression due to PIC objects, Paolo Bonzini, 2020/10/10
- [PULL 17/39] docs/devel/qtest: Include libqtest API reference, Paolo Bonzini, 2020/10/10