summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBill Hoffman <bill.hoffman@kitware.com>2016-07-28 19:12:43 (GMT)
committerBrad King <brad.king@kitware.com>2016-09-20 17:14:20 (GMT)
commitd328dc6853e211dc05c4abcf62cc64b9c91235a2 (patch)
tree188238fc8ae3c7a85dc3edf1eae3a70b85b6197f /Help
parent9ac2e189607433b45b252a1e2261ccfaf11e492b (diff)
downloadCMake-d328dc6853e211dc05c4abcf62cc64b9c91235a2.zip
CMake-d328dc6853e211dc05c4abcf62cc64b9c91235a2.tar.gz
CMake-d328dc6853e211dc05c4abcf62cc64b9c91235a2.tar.bz2
CTest: Add CAPTURE_CMAKE_ERROR val to `ctest_*` commands
If a `ctest_*` command has CAPTURE_CMAKE_ERROR then any errors generated by cmake during that command will cause the value to be assigned `-1`. This will prevent a `ctest -S` script from returning non-zero unless the script explicitly calls `message(FATAL_ERROR)`.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/ctest_build.rst5
-rw-r--r--Help/command/ctest_configure.rst7
-rw-r--r--Help/command/ctest_coverage.rst5
-rw-r--r--Help/command/ctest_test.rst5
-rw-r--r--Help/command/ctest_upload.rst6
5 files changed, 26 insertions, 2 deletions
diff --git a/Help/command/ctest_build.rst b/Help/command/ctest_build.rst
index e1b7793..d3ceb2d 100644
--- a/Help/command/ctest_build.rst
+++ b/Help/command/ctest_build.rst
@@ -13,6 +13,7 @@ Perform the :ref:`CTest Build Step` as a :ref:`Dashboard Client`.
[NUMBER_ERRORS <num-err-var>]
[NUMBER_WARNINGS <num-warn-var>]
[RETURN_VALUE <result-var>]
+ [CAPTURE_CMAKE_ERROR <result-var>]
)
Build the project and store results in ``Build.xml``
@@ -66,6 +67,10 @@ The options are:
``RETURN_VALUE <result-var>``
Store the return value of the native build tool in the given variable.
+``CAPTURE_CMAKE_ERROR <result-var>``
+ Store in the ``<result-var>`` variable -1 if there are any errors running
+ the command and prevent ctest from returning non-zero if an error occurs.
+
``QUIET``
Suppress any CTest-specific non-error output that would have been
printed to the console otherwise. The summary of warnings / errors,
diff --git a/Help/command/ctest_configure.rst b/Help/command/ctest_configure.rst
index 851c292..b11e77c 100644
--- a/Help/command/ctest_configure.rst
+++ b/Help/command/ctest_configure.rst
@@ -6,7 +6,8 @@ Perform the :ref:`CTest Configure Step` as a :ref:`Dashboard Client`.
::
ctest_configure([BUILD <build-dir>] [SOURCE <source-dir>] [APPEND]
- [OPTIONS <options>] [RETURN_VALUE <result-var>] [QUIET])
+ [OPTIONS <options>] [RETURN_VALUE <result-var>] [QUIET]
+ [CAPTURE_CMAKE_ERROR <result-var>])
Configure the project build tree and record results in ``Configure.xml``
for submission with the :command:`ctest_submit` command.
@@ -33,6 +34,10 @@ The options are:
Store in the ``<result-var>`` variable the return value of the native
configuration tool.
+``CAPTURE_CMAKE_ERROR <result-var>``
+ Store in the ``<result-var>`` variable -1 if there are any errors running
+ the command and prevent ctest from returning non-zero if an error occurs.
+
``QUIET``
Suppress any CTest-specific non-error messages that would have
otherwise been printed to the console. Output from the underlying
diff --git a/Help/command/ctest_coverage.rst b/Help/command/ctest_coverage.rst
index 12429b9..ec1ee25 100644
--- a/Help/command/ctest_coverage.rst
+++ b/Help/command/ctest_coverage.rst
@@ -8,6 +8,7 @@ Perform the :ref:`CTest Coverage Step` as a :ref:`Dashboard Client`.
ctest_coverage([BUILD <build-dir>] [APPEND]
[LABELS <label>...]
[RETURN_VALUE <result-var>]
+ [CAPTURE_CMAKE_ERROR <result-var]
[QUIET]
)
@@ -33,6 +34,10 @@ The options are:
Store in the ``<result-var>`` variable ``0`` if coverage tools
ran without error and non-zero otherwise.
+``CAPTURE_CMAKE_ERROR <result-var>``
+ Store in the ``<result-var>`` variable -1 if there are any errors running
+ the command and prevent ctest from returning non-zero if an error occurs.
+
``QUIET``
Suppress any CTest-specific non-error output that would have been
printed to the console otherwise. The summary indicating how many
diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst
index 412e323..551bc58 100644
--- a/Help/command/ctest_test.rst
+++ b/Help/command/ctest_test.rst
@@ -18,6 +18,7 @@ Perform the :ref:`CTest Test Step` as a :ref:`Dashboard Client`.
[SCHEDULE_RANDOM <ON|OFF>]
[STOP_TIME <time-of-day>]
[RETURN_VALUE <result-var>]
+ [CAPTURE_CMAKE_ERROR <result-var>]
[QUIET]
)
@@ -80,6 +81,10 @@ The options are:
Store in the ``<result-var>`` variable ``0`` if all tests passed.
Store non-zero if anything went wrong.
+``CAPTURE_CMAKE_ERROR <result-var>``
+ Store in the ``<result-var>`` variable -1 if there are any errors running
+ the command and prevent ctest from returning non-zero if an error occurs.
+
``QUIET``
Suppress any CTest-specific non-error messages that would have otherwise
been printed to the console. Output from the underlying test command is not
diff --git a/Help/command/ctest_upload.rst b/Help/command/ctest_upload.rst
index d9630d2..39d9de1 100644
--- a/Help/command/ctest_upload.rst
+++ b/Help/command/ctest_upload.rst
@@ -5,7 +5,7 @@ Upload files to a dashboard server as a :ref:`Dashboard Client`.
::
- ctest_upload(FILES <file>... [QUIET])
+ ctest_upload(FILES <file>... [QUIET] [CAPTURE_CMAKE_ERROR <result-var>])
The options are:
@@ -16,3 +16,7 @@ The options are:
``QUIET``
Suppress any CTest-specific non-error output that would have been
printed to the console otherwise.
+
+``CAPTURE_CMAKE_ERROR <result-var>``
+ Store in the ``<result-var>`` variable -1 if there are any errors running
+ the command and prevent ctest from returning non-zero if an error occurs.