summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2015-04-04 17:10:38 (GMT)
committerStephen Kelly <steveire@gmail.com>2015-04-04 17:14:56 (GMT)
commit6f82b5e81ca9677dc2fde855ba7be8e235baa667 (patch)
tree4fb52cfa4f54616a4c695a515cb7b3ba55ff6783
parent66f5af29f3855c743580821eb73a94f72b709064 (diff)
downloadCMake-6f82b5e81ca9677dc2fde855ba7be8e235baa667.zip
CMake-6f82b5e81ca9677dc2fde855ba7be8e235baa667.tar.gz
CMake-6f82b5e81ca9677dc2fde855ba7be8e235baa667.tar.bz2
Help: Link to properties in set_tests_properties.
Remove help for specific properties to their own help pages.
-rw-r--r--Help/command/set_tests_properties.rst30
-rw-r--r--Help/prop_test/FAIL_REGULAR_EXPRESSION.rst11
-rw-r--r--Help/prop_test/PASS_REGULAR_EXPRESSION.rst10
3 files changed, 22 insertions, 29 deletions
diff --git a/Help/command/set_tests_properties.rst b/Help/command/set_tests_properties.rst
index afac847..3efb165 100644
--- a/Help/command/set_tests_properties.rst
+++ b/Help/command/set_tests_properties.rst
@@ -8,29 +8,7 @@ Set a property of the tests.
set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2 value2)
Set a property for the tests. If the test is not found, CMake
-will report an error. Generator expressions will be expanded the same
-as supported by the test's add_test call. The properties include:
-
-WILL_FAIL: If set to true, this will invert the pass/fail flag of the
-test.
-
-PASS_REGULAR_EXPRESSION: If set, the test output will be checked
-against the specified regular expressions and at least one of the
-regular expressions has to match, otherwise the test will fail.
-
-::
-
- Example: PASS_REGULAR_EXPRESSION "TestPassed;All ok"
-
-FAIL_REGULAR_EXPRESSION: If set, if the output will match to one of
-specified regular expressions, the test will fail.
-
-::
-
- Example: FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
-
-Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a list
-of regular expressions.
-
-TIMEOUT: Setting this will limit the test runtime to the number of
-seconds specified.
+will report an error.
+:manual:`Generator expressions <cmake-generator-expressions(7)>` will be
+expanded the same as supported by the test's :command:`add_test` call. See
+:ref:`Test Properties` for the list of properties known to CMake.
diff --git a/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst
index b02d17d..facf902 100644
--- a/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst
+++ b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst
@@ -4,5 +4,12 @@ FAIL_REGULAR_EXPRESSION
If the output matches this regular expression the test will fail.
If set, if the output matches one of specified regular expressions,
-the test will fail.For example: FAIL_REGULAR_EXPRESSION
-"[^a-z]Error;ERROR;Failed"
+the test will fail. Example:
+
+.. code-block:: cmake
+
+ set_tests_properties(mytest PROPERTIES
+ FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
+ )
+
+``FAIL_REGULAR_EXPRESSION`` expects a list of regular expressions.
diff --git a/Help/prop_test/PASS_REGULAR_EXPRESSION.rst b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst
index bb35f77..0cd6215 100644
--- a/Help/prop_test/PASS_REGULAR_EXPRESSION.rst
+++ b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst
@@ -5,4 +5,12 @@ The output must match this regular expression for the test to pass.
If set, the test output will be checked against the specified regular
expressions and at least one of the regular expressions has to match,
-otherwise the test will fail.
+otherwise the test will fail. Example:
+
+.. code-block:: cmake
+
+ set_tests_properties(mytest PROPERTIES
+ PASS_REGULAR_EXPRESSION "TestPassed;All ok"
+ )
+
+``PASS_REGULAR_EXPRESSION`` expects a list of regular expressions.