summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-10-19 11:45:11 -0400
committerBrad King <brad.king@kitware.com>2015-10-19 11:45:11 -0400
commit22bfb39dea2476df8f7aa5ed5c773a7a6720c4bc (patch)
treecc821dbe7f665a9b6c9112d1b3be126dd33fc3e1
parent7d94947a68e76c39cfbeaa14eeb69050afe1363d (diff)
parentf19d6a2c953aef79a9b807a51c6b7a7379d888cb (diff)
downloadcmake-22bfb39dea2476df8f7aa5ed5c773a7a6720c4bc.tar.gz
Merge branch 'doc-add_test-requirements' into release
-rw-r--r--Help/command/add_test.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst
index 7e7e6bddd7..d8a96e9b98 100644
--- a/Help/command/add_test.rst
+++ b/Help/command/add_test.rst
@@ -28,6 +28,13 @@ quotes, or other characters special in CMake syntax. The options are:
directory set to the build directory corresponding to the
current source directory.
+The given test command is expected to exit with code ``0`` to pass and
+non-zero to fail, or vice-versa if the :prop_test:`WILL_FAIL` test
+property is set. Any output written to stdout or stderr will be
+captured by :manual:`ctest(1)` but does not affect the pass/fail status
+unless the :prop_test:`PASS_REGULAR_EXPRESSION` or
+:prop_test:`FAIL_REGULAR_EXPRESSION` test property is used.
+
The ``COMMAND`` and ``WORKING_DIRECTORY`` options may use "generator
expressions" with the syntax ``$<...>``. See the
:manual:`cmake-generator-expressions(7)` manual for available expressions.