mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-12 01:09:47 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Add 'Label and Subproject Summary' section to ctest(1) manual

Browse Source
This commit is contained in:
Betsy McPhail
2017-11-07 14:47:13 -05:00
committed by Brad King
parent 002d0a1cf9
commit 3b272ff8e4
1 changed files with 27 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Help/manual/ctest.1.rst
View File

@@ -72,6 +72,10 @@ Options
number of jobs. This option can also be set by setting the
environment variable ``CTEST_PARALLEL_LEVEL``.
This option can be used with the :prop_test:`PROCESSORS` test property.
See `Label and Subproject Summary`_.
``--test-load <level>``
While running tests in parallel (e.g. with ``-j``), try not to start
tests when they may cause the CPU load to pass above a given threshold.
@@ -252,6 +256,8 @@ Options
label associated with the tests run. If there are no labels on the
tests, nothing extra is printed.
See `Label and Subproject Summary`_.
``--no-subproject-summary``
Disable timing summary information for subprojects.
@@ -259,6 +265,8 @@ Options
subproject associated with the tests run. If there are no subprojects on the
tests, nothing extra is printed.
See `Label and Subproject Summary`_.
``--build-and-test``
See `Build and Test Mode`_.
@@ -312,6 +320,21 @@ See `Build and Test Mode`_.
.. include:: OPTIONS_HELP.txt
.. _`Label and Subproject Summary`:
Label and Subproject Summary
============================
CTest prints timing summary information for each label and subproject
associated with the tests run. The label time summary will not include labels
that are mapped to subprojects.
When the :prop_test:`PROCESSORS` test property is set, CTest will display a
weighted test timing result in label and subproject summaries. 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. The time is
reported with `sec*proc` instead of just `sec`.
.. _`Build and Test Mode`:
Build and Test Mode
@@ -749,7 +772,6 @@ Configuration settings to specify the version control tool include:
* `CTest Script`_ variable: :variable:`CTEST_UPDATE_VERSION_ONLY`
Additional configuration settings include:
``NightlyStartTime``
@@ -791,6 +813,7 @@ Configuration settings include:
* `CTest Script`_ variable: :variable:`CTEST_LABELS_FOR_SUBPROJECTS`
* :module:`CTest` module variable: ``CTEST_LABELS_FOR_SUBPROJECTS``
See `Label and Subproject Summary`_.
.. _`CTest Build Step`:
@@ -822,6 +845,8 @@ Configuration settings include:
* `CTest Script`_ variable: :variable:`CTEST_LABELS_FOR_SUBPROJECTS`
* :module:`CTest` module variable: ``CTEST_LABELS_FOR_SUBPROJECTS``
See `Label and Subproject Summary`_.
``MakeCommand``
Command-line to launch the software build process.
It will be executed in the location specified by the
@@ -865,6 +890,7 @@ Configuration settings include:
* `CTest Script`_ variable: :variable:`CTEST_LABELS_FOR_SUBPROJECTS`
* :module:`CTest` module variable: ``CTEST_LABELS_FOR_SUBPROJECTS``
See `Label and Subproject Summary`_.
``TestLoad``
While running tests in parallel (e.g. with ``-j``), try not to start