diff options
| author | Craig Scott <craig.scott@crascit.com> | 2019-05-30 00:57:52 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2019-06-02 11:08:56 (GMT) |
| commit | 774102aaec1a74ea069be9b10a2c846cdbfa609f (patch) | |
| tree | 2f218cd3c2ef344d5149582902d1f0b6fabd4e76 /Help | |
| parent | 067a4f484b1e2f650918d90051653b5c434c77a2 (diff) | |
| download | CMake-774102aaec1a74ea069be9b10a2c846cdbfa609f.zip CMake-774102aaec1a74ea069be9b10a2c846cdbfa609f.tar.gz CMake-774102aaec1a74ea069be9b10a2c846cdbfa609f.tar.bz2 | |
Help: Clarify the default value for test property COST
Co-Authored-By: Steve Mokris <smokris@softpixel.com>
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. |