summaryrefslogtreecommitdiff
path: root/Help/prop_test/PROCESSORS.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/prop_test/PROCESSORS.rst')
-rw-r--r--Help/prop_test/PROCESSORS.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/Help/prop_test/PROCESSORS.rst b/Help/prop_test/PROCESSORS.rst
index 763b6d003..a927c1078 100644
--- a/Help/prop_test/PROCESSORS.rst
+++ b/Help/prop_test/PROCESSORS.rst
@@ -1,8 +1,16 @@
PROCESSORS
----------
-How many process slots this test requires
+Set to specify how many process slots this test requires.
+If not set, the default is ``1`` processor.
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.
+
+See also the :prop_test:`PROCESSOR_AFFINITY` test property.