diff --git a/doc/test-suite.dox b/doc/test-suite.dox index 83cae24b..30dd1579 100644 --- a/doc/test-suite.dox +++ b/doc/test-suite.dox @@ -25,10 +25,10 @@ resulting `/dev/input/eventX` nodes. Some tests require temporary udev rules. @section test-filtering Selective running of tests -Check enables tests to be grouped into suites and test cases, litest uses -test suites as a general feature-specific grouping (e.g. "touchpad:tap") and -instantiates one test case per device. The --list flag shows the list of -suites and tests. +litest's tests are grouped by test groups and devices. A test group is e.g. +"touchpad:tap" and incorporates all tapping-related tests for touchpads. +Each test function is (usually) run with one or more specific devices. +The `--list` commandline argument shows the list of suites and tests. @code $ ./test/test-device --list device:wheel: @@ -52,16 +52,6 @@ uinput by litest. The "no device" entry signals that litest does not instantiate a uinput device for a specific test (though the test itself may instantiate one). -Check provides two filters through environment variables: CK_RUN_SUITE -and CK_RUN_CASE. They may be used independently or combined to narrow -down the set of tests to run. For example: - -@code -$ CK_RUN_SUITE="device:wheel" ./test/test-device -$ CK_RUN_CASE="wheel only" ./test/test-device -$ CK_RUN_SUITE="device:wheel" CK_RUN_CASE="wheel only" ./test/test-device -@endcode - The `--filter-test` argument enables selective running of tests through basic shell-style function name matching. For example: