diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-10-06 11:40:38 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-10-07 06:03:36 (GMT) |
| commit | 2154ea38f9e229fc3c9bc0c0078bb9afe533000d (patch) | |
| tree | 135f31d751994082b51ec668b13bf5efd36de3d2 | |
| parent | fb2cdf4d4c0d3b20e5b2e925be0de30a196b7a47 (diff) | |
| download | CMake-2154ea38f9e229fc3c9bc0c0078bb9afe533000d.zip CMake-2154ea38f9e229fc3c9bc0c0078bb9afe533000d.tar.gz CMake-2154ea38f9e229fc3c9bc0c0078bb9afe533000d.tar.bz2 | |
Help: Add missing docs for the ctest --progress option
These docs were missing from the changes that introduced the feature in
!2240.
| -rw-r--r-- | Help/envvar/CTEST_PROGRESS_OUTPUT.rst | 14 | ||||
| -rw-r--r-- | Help/manual/cmake-env-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/manual/ctest.1.rst | 13 |
3 files changed, 28 insertions, 0 deletions
diff --git a/Help/envvar/CTEST_PROGRESS_OUTPUT.rst b/Help/envvar/CTEST_PROGRESS_OUTPUT.rst new file mode 100644 index 0000000..a8e15bc --- /dev/null +++ b/Help/envvar/CTEST_PROGRESS_OUTPUT.rst @@ -0,0 +1,14 @@ +CTEST_PROGRESS_OUTPUT +--------------------- + +Boolean environment variable that affects how :manual:`ctest <ctest(1)>` +command output reports overall progress. When set to 1, TRUE, ON or anything +else that evaluates to boolean true, progress is reported by repeatedly +updating the same line. This greatly reduces the overall verbosity, but is +only supported when output is sent directly to a terminal. If the environment +variable is not set or has a value that evaluates to false, output is reported +normally with each test having its own start and end lines logged to the +output. + +The ``--progress`` option to :manual:`ctest <ctest(1)>` overrides this +environment variable if both are given. diff --git a/Help/manual/cmake-env-variables.7.rst b/Help/manual/cmake-env-variables.7.rst index 42aeabc..31aa723 100644 --- a/Help/manual/cmake-env-variables.7.rst +++ b/Help/manual/cmake-env-variables.7.rst @@ -53,5 +53,6 @@ Environment Variables for CTest /envvar/CTEST_INTERACTIVE_DEBUG_MODE /envvar/CTEST_OUTPUT_ON_FAILURE /envvar/CTEST_PARALLEL_LEVEL + /envvar/CTEST_PROGRESS_OUTPUT /envvar/CTEST_USE_LAUNCHERS_DEFAULT /envvar/DASHBOARD_TEST_FROM_CTEST diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 72cfed2..e24b10d 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -35,6 +35,19 @@ Options which one should be tested. Example configurations are "Debug" and "Release". +``--progress`` + Enable short progress output from tests. + + When the output of ``ctest`` is being sent directly to a terminal, the + progress through the set of tests is reported by updating the same line + rather than printing start and end messages for each test on new lines. + This can significantly reduce the verbosity of the test output. + Test completion messages are still output on their own line for failed + tests and the final test summary will also still be logged. + + This option can also be enabled by setting the environment variable + :envvar:`CTEST_PROGRESS_OUTPUT`. + ``-V,--verbose`` Enable verbose output from tests. |