docs: Document TIMEOUT_MULTIPLIER for raising test timeouts
Our test infrastructure allows you to set the TIMEOUT_MULTIPLIER environment variable to raise the test timeouts if you're building for a slow environment. (scripts/mtest2make.py reads it and sets the meson test -t argument accordingly.) Document this so it's not a secret feature only known to a select few. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com> Message-id: 20260427161132.1463385-1-peter.maydell@linaro.org
Peter Maydell committed
May 15, 2026 at 08:41 UTC
fbe4b3cca074cc2d2697343c445a2b1b608fd0b0
1 file changed
+18
docs/devel/testing/main.rst
+18
@@ -52,6 +52,21 @@ Before running tests, it is best to build QEMU programs first. Some tests
52
expect the executables to exist and will fail with obscure messages if they
53
cannot find them.
54
55
+The timeouts for QEMU tests are set conservatively so you should not
56
+in general find that tests time out. However, if you are running on a
57
+particularly slow host or with a slow configuration (such as a build
58
+with the clang address-sanitizer enabled) you can globally raise all
59
+the timeouts, by setting the ``TIMEOUT_MULTIPLIER`` environment
60
+variable. For instance:
61
+
62
+.. code::
63
+
64
+ TIMEOUT_MULTIPLIER=3 make check
65
+
66
+will run with all the default timeouts multiplied by three. You can
67
+also disable timeouts entirely by setting the environment variable to
68
+``0``.
69
+
70
.. _unit-tests:
71
72
Unit tests
@@ -959,6 +974,9 @@ Python. You can run the functional tests simply by executing:
974
975
See :ref:`checkfunctional-ref` for more details.
976
977
+The harness for the functional tests also honours the
978
+``TIMEOUT_MULTIPLIER`` environment variable.
979
+
980
.. _checktcg-ref:
981
982
Testing with "make check-tcg"