Document that the default test run order is now random

This commit is contained in:
Martin Hořeňovský
2025-07-24 21:55:30 +02:00
parent 2a8a8a7210
commit bdc634e9f1

View File

@@ -398,18 +398,24 @@ use test specs to filter this list down to what you want first.
Test cases are ordered one of three ways: Test cases are ordered one of three ways:
### decl ### decl
Declaration order (this is the default order if no --order argument is provided). Declaration order.
Tests in the same translation unit are sorted using their declaration orders, Tests in the same translation unit are sorted using their declaration orders,
different TUs are sorted in an implementation (linking) dependent order. different TUs are sorted in an implementation (linking) dependent order.
### lex ### lex
Lexicographic order. Tests are sorted by their name, their tags are ignored. Lexicographic order.
Tests are sorted by their name, their tags are ignored.
### rand ### rand
Randomized order. The default order.
Randomly ordered. The order is dependent on Catch2's random seed (see > Randomized order has been made default in Catch2 X.Y.Z
The order is dependent on Catch2's random seed (see
[`--rng-seed`](#rng-seed)), and is subset invariant. What this means [`--rng-seed`](#rng-seed)), and is subset invariant. What this means
is that as long as the random seed is fixed, running only some tests is that as long as the random seed is fixed, running only some tests
(e.g. via tag) does not change their relative order. (e.g. via tag) does not change their relative order.