summaryrefslogtreecommitdiffstats
path: root/Help/prop_test
diff options
context:
space:
mode:
authorGabor Bencze <b.gabor98@gmail.com>2019-07-18 14:59:15 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2019-07-18 19:45:09 (GMT)
commit407dd1a910b1232cf915db9afb9c09022c6e22a9 (patch)
treef643b4677e491b056c25af3e206405b6c8f9a02a /Help/prop_test
parentd7955d4e5d3038930f333bf12e15a09c7ae6088c (diff)
downloadCMake-407dd1a910b1232cf915db9afb9c09022c6e22a9.zip
CMake-407dd1a910b1232cf915db9afb9c09022c6e22a9.tar.gz
CMake-407dd1a910b1232cf915db9afb9c09022c6e22a9.tar.bz2
Help: Add documentation for SKIP_REGULAR_EXPRESSION test property
Diffstat (limited to 'Help/prop_test')
-rw-r--r--Help/prop_test/SKIP_REGULAR_EXPRESSION.rst17
-rw-r--r--Help/prop_test/SKIP_RETURN_CODE.rst2
2 files changed, 19 insertions, 0 deletions
diff --git a/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst b/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst
new file mode 100644
index 0000000..2c6d980
--- /dev/null
+++ b/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst
@@ -0,0 +1,17 @@
+SKIP_REGULAR_EXPRESSION
+-----------------------
+
+If the output matches this regular expression the test will be marked as skipped.
+
+If set, if the output matches one of specified regular expressions,
+the test will be marked as skipped. Example:
+
+.. code-block:: cmake
+
+ set_property(TEST mytest PROPERTY
+ SKIP_REGULAR_EXPRESSION "[^a-z]Skip" "SKIP" "Skipped"
+ )
+
+``SKIP_REGULAR_EXPRESSION`` expects a list of regular expressions.
+
+See also the :prop_test:`SKIP_RETURN_CODE` property.
diff --git a/Help/prop_test/SKIP_RETURN_CODE.rst b/Help/prop_test/SKIP_RETURN_CODE.rst
index 3d48c2f..23c4c62 100644
--- a/Help/prop_test/SKIP_RETURN_CODE.rst
+++ b/Help/prop_test/SKIP_RETURN_CODE.rst
@@ -8,3 +8,5 @@ test are met. If such a situation should not be considered a hard failure
a return code of the process can be specified that will mark the test as
``Not Run`` if it is encountered. Valid values are in the range of
0 to 255, inclusive.
+
+See also the :prop_test:`SKIP_REGULAR_EXPRESSION` property.