doc/user: put an extra note in regarding the test suite
authorPeter Hutterer <peter.hutterer@who-t.net>
Wed, 6 Mar 2019 23:14:55 +0000 (09:14 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Tue, 12 Mar 2019 05:10:15 +0000 (15:10 +1000)
Running the test suite runner is good, but not sufficient, a full ninja test
is required to get the full coverage.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
doc/user/test-suite.rst

index aa459e7081844378d3f99429943d2a634cfc5440..1f6dc394975f8919e7f317ceb173a00aa5fc2a76 100644 (file)
@@ -7,7 +7,11 @@ libinput test suite
 libinput ships with a number of tests all run automatically on ``ninja test``.
 The primary test suite is the ``libinput-test-suite-runner``. When testing,
 the ``libinput-test-suite-runner`` should always be invoked to check for
-behavior changes.
+behavior changes. The test suite relies on the kernel and udev to function
+correctly. It is not suitable for running inside containers.
+
+.. note:: ``ninja test`` runs more than just the test suite, you **must**
+       run all tests for full coverage.
 
 The test suite runner uses
 `Check <http://check.sourceforge.net/doc/check_html/>`_ underneath the hood