summaryrefslogtreecommitdiffstats
path: root/Help/prop_test/WILL_FAIL.rst
diff options
context:
space:
mode:
authorscivision <scivision@users.noreply.github.com>2023-02-15 21:09:09 (GMT)
committerscivision <scivision@users.noreply.github.com>2023-02-15 21:23:35 (GMT)
commit6e71c31afda09d6df03c058911773ac6cd67b3a4 (patch)
tree38c448b89141897982a5c933e62eba409c02ab21 /Help/prop_test/WILL_FAIL.rst
parent37f068083ba53e4140e5660a82bda9708e53c356 (diff)
downloadCMake-6e71c31afda09d6df03c058911773ac6cd67b3a4.zip
CMake-6e71c31afda09d6df03c058911773ac6cd67b3a4.tar.gz
CMake-6e71c31afda09d6df03c058911773ac6cd67b3a4.tar.bz2
Help:add_test: emphasize important points
* enable_testing must be called to enable testing * can only set properties on tests created in same directory * WILL_FAIL still fails on segfault and similar * compact wording
Diffstat (limited to 'Help/prop_test/WILL_FAIL.rst')
-rw-r--r--Help/prop_test/WILL_FAIL.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Help/prop_test/WILL_FAIL.rst b/Help/prop_test/WILL_FAIL.rst
index f1f94a4..4926f40 100644
--- a/Help/prop_test/WILL_FAIL.rst
+++ b/Help/prop_test/WILL_FAIL.rst
@@ -3,5 +3,6 @@ WILL_FAIL
If set to true, this will invert the pass/fail flag of the test.
-This property can be used for tests that are expected to fail and
-return a non zero return code.
+This property can be used for tests that are expected to fail and return a
+non-zero return code. Note that system-level test failures such as segmentation
+faults or heap errors will still fail the test even if ``WILL_FALL`` is true.