docs/devel: add a codebase section

Present the various parts of QEMU and organization of codebase.

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
Message-Id: <20241209183104.365796-6-pierrick.bouvier@linaro.org>
[AJB: tweak commit summary, update MAINTAINERS]
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20250116160306.1709518-36-alex.bennee@linaro.org>
This commit is contained in:
Pierrick Bouvier 2025-01-16 16:03:04 +00:00 committed by Alex Bennée
parent 75dbfbad68
commit 7f6314427e
16 changed files with 257 additions and 1 deletions

View file

@ -39,6 +39,8 @@ 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
cannot find them.
.. _unit-tests:
Unit tests
~~~~~~~~~~
@ -126,6 +128,8 @@ successfully on various hosts. The following list shows some best practices:
#ifdef in the codes. If the whole test suite cannot run on Windows, disable
the build in the meson.build file.
.. _qapi-tests:
QAPI schema tests
~~~~~~~~~~~~~~~~~
@ -160,6 +164,8 @@ check-block
are in the "auto" group).
See the "QEMU iotests" section below for more information.
.. _qemu-iotests:
QEMU iotests
------------
@ -679,6 +685,8 @@ The above exitcode=0 has TSan continue without error if any warnings are found.
This allows for running the test and then checking the warnings afterwards.
If you want TSan to stop and exit with error on warnings, use exitcode=66.
.. _tsan-suppressions:
TSan Suppressions
~~~~~~~~~~~~~~~~~
Keep in mind that for any data race warning, although there might be a data race
@ -901,7 +909,6 @@ You can run the avocado tests simply by executing:
See :ref:`checkavocado-ref` for more details.
.. _checktcg-ref:
Testing with "make check-tcg"

View file

@ -1,3 +1,5 @@
.. _qtest:
========================================
QTest Device Emulation Testing Framework
========================================