summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2018-08-31 08:39:18 (GMT)
committerKitware Robot <kwrobot@kitware.com>2018-08-31 08:39:27 (GMT)
commit16225c28d09c9ec220ed481dc2a4567bcdc02639 (patch)
treef6b7f23efc0a2a24e9560c03a51a1f4c0eacbefc /Help
parent4af79b6825ba89e6041fc6d85f426dca14119231 (diff)
parent5fc11b34e49009aa743c5b30e9b1bf9d51d2f417 (diff)
downloadCMake-16225c28d09c9ec220ed481dc2a4567bcdc02639.zip
CMake-16225c28d09c9ec220ed481dc2a4567bcdc02639.tar.gz
CMake-16225c28d09c9ec220ed481dc2a4567bcdc02639.tar.bz2
Merge topic 'capture_camke_error-update-docs'
5fc11b34e4 Help: Add CAPTURE_CMAKE_ERROR to ctest_submit and ctest_update documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2324
Diffstat (limited to 'Help')
-rw-r--r--Help/command/ctest_submit.rst5
-rw-r--r--Help/command/ctest_update.rst9
2 files changed, 13 insertions, 1 deletions
diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst
index a412792..2ba6bef 100644
--- a/Help/command/ctest_submit.rst
+++ b/Help/command/ctest_submit.rst
@@ -10,6 +10,7 @@ Perform the :ref:`CTest Submit Step` as a :ref:`Dashboard Client`.
[RETRY_COUNT <count>]
[RETRY_DELAY <delay>]
[RETURN_VALUE <result-var>]
+ [CAPTURE_CMAKE_ERROR <result-var>]
[QUIET]
)
@@ -52,6 +53,10 @@ The options are:
Store in the ``<result-var>`` variable ``0`` for success and
non-zero on failure.
+``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 all non-error messages that would have otherwise been
printed to the console.
diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst
index b205bca..df1a4e5 100644
--- a/Help/command/ctest_update.rst
+++ b/Help/command/ctest_update.rst
@@ -5,7 +5,10 @@ Perform the :ref:`CTest Update Step` as a :ref:`Dashboard Client`.
::
- ctest_update([SOURCE <source-dir>] [RETURN_VALUE <result-var>] [QUIET])
+ ctest_update([SOURCE <source-dir>]
+ [RETURN_VALUE <result-var>]
+ [CAPTURE_CMAKE_ERROR <result-var>]
+ [QUIET])
Update the source tree from version control and record results in
``Update.xml`` for submission with the :command:`ctest_submit` command.
@@ -20,6 +23,10 @@ The options are:
Store in the ``<result-var>`` variable the number of files
updated or ``-1`` on error.
+``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``
Tell CTest to suppress most non-error messages that it would
have otherwise printed to the console. CTest will still report