浏览代码

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.
Bill Hoffman 8 年之前
父节点
当前提交
b2242ea964
共有 1 个文件被更改,包括 7 次插入2 次删除
  1. 7 2
      Help/prop_test/PROCESSORS.rst

+ 7 - 2
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.