diff options
| author | Craig Scott <craig.scott@crascit.com> | 2019-06-03 12:20:13 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2019-06-03 12:20:22 (GMT) |
| commit | 3cb5a8d9b3add4394b12d61b5ce83ea6ca148fd1 (patch) | |
| tree | aa6a671ebdd32ea26e08b9ff69a6f5ac49bce9cb /Help | |
| parent | 18d6bdb42d6fceb2b753430e74a4d6076e321f03 (diff) | |
| parent | 774102aaec1a74ea069be9b10a2c846cdbfa609f (diff) | |
| download | CMake-3cb5a8d9b3add4394b12d61b5ce83ea6ca148fd1.zip CMake-3cb5a8d9b3add4394b12d61b5ce83ea6ca148fd1.tar.gz CMake-3cb5a8d9b3add4394b12d61b5ce83ea6ca148fd1.tar.bz2 | |
Merge topic 'doc-test-cost-default'
774102aaec Help: Clarify the default value for test property COST
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !3397
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/prop_test/COST.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/Help/prop_test/COST.rst b/Help/prop_test/COST.rst index 0c0fca7..9300d7b 100644 --- a/Help/prop_test/COST.rst +++ b/Help/prop_test/COST.rst @@ -1,8 +1,14 @@ COST ---- -Set this to a floating point value. Tests in a test set will be run -in descending order of cost. +This property describes the cost of a test. When parallel testing is +enabled, tests in the test set will be run in descending order of cost. +Projects can explicitly define the cost of a test by setting this property +to a floating point value. -This property describes the cost of a test. You can explicitly set -this value; tests with higher ``COST`` values will run first. +When the cost of a test is not defined by the project, +:manual:`ctest <ctest(1)>` will initially use a default cost of ``0``. +It computes a weighted average of the cost each time a test is run and +uses that as an improved estimate of the cost for the next run. The more +a test is re-run in the same build directory, the more representative the +cost should become. |