diff options
| author | Bill Hoffman <bill.hoffman@kitware.com> | 2017-09-06 13:51:12 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-09-08 10:03:53 -0400 |
| commit | b2242ea9641cd09d94aaf77a33345100cc3a3def (patch) | |
| tree | a5e52cb1d7b606102eb3babca4dead180a20e793 | |
| parent | 5b829c89b8cdb5b8f908dcd4849a37a183b0971c (diff) | |
| download | cmake-b2242ea9641cd09d94aaf77a33345100cc3a3def.tar.gz | |
Help: Update documentation for PROCESSORS test property
This updates the documentation for the PROCESSORS test property to show
how it will affect the summary output for labels and sub projects.
| -rw-r--r-- | Help/prop_test/PROCESSORS.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Help/prop_test/PROCESSORS.rst b/Help/prop_test/PROCESSORS.rst index 763b6d0036..a1211fb69c 100644 --- a/Help/prop_test/PROCESSORS.rst +++ b/Help/prop_test/PROCESSORS.rst @@ -1,8 +1,13 @@ PROCESSORS ---------- -How many process slots this test requires +Set to specify how many process slots this test requires. Denotes the number of processors that this test will require. This is typically used for MPI tests, and should be used in conjunction with -the ctest_test PARALLEL_LEVEL option. +the :command:`ctest_test` ``PARALLEL_LEVEL`` option. + +This will also be used to display a weighted test timing result in label and +subproject summaries in the command line output of :manual:`ctest(1)`. The wall +clock time for the test run will be multiplied by this property to give a +better idea of how much cpu resource CTest allocated for the test. |