qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Thomas Huth <thuth@redhat.com>
To: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Subject: [PULL 03/13] docs/devel: Fix qtest paths and info about check-block in testing.rst
Date: Mon,  3 Feb 2020 13:38:01 +0100	[thread overview]
Message-ID: <20200203123811.8651-4-thuth@redhat.com> (raw)
In-Reply-To: <20200203123811.8651-1-thuth@redhat.com>

The qtests have recently been moved to a separate subdirectory, so
the paths that are mentioned in the documentation have to be adjusted
accordingly. And some of the iotests are now always run as part of
"make check", so this information has to be adjusted here, too.

Message-Id: <20200122134511.23806-1-thuth@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 docs/devel/testing.rst | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index ab5be0c729..770a987ea4 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -16,8 +16,8 @@ The usual way to run these tests is:
 
   make check
 
-which includes QAPI schema tests, unit tests, and QTests. Different sub-types
-of "make check" tests will be explained below.
+which includes QAPI schema tests, unit tests, QTests and some iotests.
+Different sub-types of "make check" tests will be explained below.
 
 Before running tests, it is best to build QEMU programs first. Some tests
 expect the executables to exist and will fail with obscure messages if they
@@ -79,8 +79,8 @@ QTest cases can be executed with
 
    make check-qtest
 
-The QTest library is implemented by ``tests/libqtest.c`` and the API is defined
-in ``tests/libqtest.h``.
+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
@@ -94,20 +94,20 @@ 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/test-foo-device.c``.
+   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/Makefile.include``. Add the test executable
-   name to an appropriate ``check-qtest-*-y`` variable. For example:
+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/test-foo-device$(EXESUF)``
+   ``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/test-foo-device$(EXESUF): tests/test-foo-device.o $(libqos-obj-y)``
+   ``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
@@ -152,8 +152,9 @@ parser (either fixing a bug or extending/modifying the syntax). To do this:
 check-block
 -----------
 
-``make check-block`` is a legacy command to invoke block layer iotests and is
-rarely used. See "QEMU iotests" section below for more information.
+``make check-block`` runs a subset of the block layer iotests (the tests that
+are in the "auto" group in ``tests/qemu-iotests/group``).
+See the "QEMU iotests" section below for more information.
 
 GCC gcov support
 ----------------
-- 
2.18.1



  parent reply	other threads:[~2020-02-03 12:41 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-03 12:37 [PULL 00/13] qtests, kconfig and misc patches Thomas Huth
2020-02-03 12:37 ` [PULL 01/13] test-logging: Fix -Werror=maybe-uninitialized warning Thomas Huth
2020-02-03 12:38 ` [PULL 02/13] tests/vhost-user-bridge: Fix build Thomas Huth
2020-02-03 12:38 ` Thomas Huth [this message]
2020-02-03 12:38 ` [PULL 04/13] tests/Makefile: Fix inclusion of the qos dependency files Thomas Huth
2020-02-03 12:38 ` [PULL 05/13] boot-order-test: fix memleaks in boot-order-test Thomas Huth
2020-02-03 12:38 ` [PULL 06/13] tests/qtest: update comments about bios-tables-test-allowed-diff.h Thomas Huth
2020-02-03 12:38 ` [PULL 07/13] gitlab-ci: Refresh the list of iotests Thomas Huth
2020-02-03 12:38 ` [PULL 08/13] hw/bt: Remove empty Kconfig file Thomas Huth
2020-02-03 12:38 ` [PULL 09/13] hw/input: Do not enable CONFIG_PCKBD by default Thomas Huth
2020-02-03 12:38 ` [PULL 10/13] hw/hppa/Kconfig: LASI chipset requires PARALLEL port Thomas Huth
2020-02-03 12:38 ` [PULL 11/13] hw/*/Makefile.objs: Move many .o files to common-objs Thomas Huth
2020-02-03 12:38 ` [PULL 12/13] include/sysemu/sysemu.h: Remove usused variable no_quit Thomas Huth
2020-02-03 12:38 ` [PULL 13/13] trivial: Remove xenfb_enabled from sysemu.h Thomas Huth
2020-02-03 14:04 ` [PULL 00/13] qtests, kconfig and misc patches Peter Maydell
2020-02-03 14:30   ` Thomas Huth
2020-02-03 14:43     ` Thomas Huth
2020-02-03 14:50     ` Peter Maydell
2020-02-03 14:57       ` Thomas Huth
2020-02-03 15:02         ` Thomas Huth
2020-02-03 15:17       ` Paolo Bonzini
2020-02-03 15:29         ` Paolo Bonzini
2020-02-03 15:38           ` Thomas Huth
2020-02-03 15:35       ` Daniel P. Berrangé

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200203123811.8651-4-thuth@redhat.com \
    --to=thuth@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).