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 /Help/envvar | |
| 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.
Diffstat (limited to 'Help/envvar')
| -rw-r--r-- | Help/envvar/CTEST_PROGRESS_OUTPUT.rst | 14 |
1 files changed, 14 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. |