diff options
| author | Brad King <brad.king@kitware.com> | 2015-10-19 15:07:01 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-10-19 15:07:01 (GMT) |
| commit | f19d6a2c953aef79a9b807a51c6b7a7379d888cb (patch) | |
| tree | cd056cf43332344966201afeb3913be05134a815 | |
| parent | 3187de20fd9949ab90df4651f5d1ae0d218a9afd (diff) | |
| download | CMake-f19d6a2c953aef79a9b807a51c6b7a7379d888cb.zip CMake-f19d6a2c953aef79a9b807a51c6b7a7379d888cb.tar.gz CMake-f19d6a2c953aef79a9b807a51c6b7a7379d888cb.tar.bz2 | |
Help: Document add_test expectations of test command (#15798)
| -rw-r--r-- | Help/command/add_test.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst index 7e7e6bd..d8a96e9 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. |