diff options
| author | Brad King <brad.king@kitware.com> | 2021-05-28 16:21:06 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2021-05-28 16:21:26 (GMT) |
| commit | c19fdf69fa466538a49fcefd2dedd3ebdb6055f0 (patch) | |
| tree | 630a78a1f91c224d94d7124473598d1d5d1554ce /Help | |
| parent | be0e013fd9141caa5851c6c01fccbe96903a3250 (diff) | |
| parent | 91b8676f8c6dd2611a234bb0ef1697627e901772 (diff) | |
| download | CMake-c19fdf69fa466538a49fcefd2dedd3ebdb6055f0.zip CMake-c19fdf69fa466538a49fcefd2dedd3ebdb6055f0.tar.gz CMake-c19fdf69fa466538a49fcefd2dedd3ebdb6055f0.tar.bz2 | |
Merge topic 'doc-test-regex-v-exit-code'
91b8676f8c Help: Clarify {PASS,FAIL}_REGULAR_EXPRESSION semantics w.r.t. exit code
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6165
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/prop_test/FAIL_REGULAR_EXPRESSION.rst | 6 | ||||
| -rw-r--r-- | Help/prop_test/PASS_REGULAR_EXPRESSION.rst | 4 | ||||
| -rw-r--r-- | Help/prop_test/SKIP_REGULAR_EXPRESSION.rst | 4 |
3 files changed, 12 insertions, 2 deletions
diff --git a/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst index facf902..1ec4517 100644 --- a/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst +++ b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst @@ -1,7 +1,8 @@ FAIL_REGULAR_EXPRESSION ----------------------- -If the output matches this regular expression the test will fail. +If the output matches this regular expression the test will fail, +regardless of the process exit code. If set, if the output matches one of specified regular expressions, the test will fail. Example: @@ -13,3 +14,6 @@ the test will fail. Example: ) ``FAIL_REGULAR_EXPRESSION`` expects a list of regular expressions. + +See also the :prop_test:`PASS_REGULAR_EXPRESSION` and +:prop_test:`SKIP_REGULAR_EXPRESSION` test properties. diff --git a/Help/prop_test/PASS_REGULAR_EXPRESSION.rst b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst index 0cd6215..96468c0 100644 --- a/Help/prop_test/PASS_REGULAR_EXPRESSION.rst +++ b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst @@ -2,6 +2,7 @@ PASS_REGULAR_EXPRESSION ----------------------- The output must match this regular expression for the test to pass. +The process exit code is ignored. If set, the test output will be checked against the specified regular expressions and at least one of the regular expressions has to match, @@ -14,3 +15,6 @@ otherwise the test will fail. Example: ) ``PASS_REGULAR_EXPRESSION`` expects a list of regular expressions. + +See also the :prop_test:`FAIL_REGULAR_EXPRESSION` and +:prop_test:`SKIP_REGULAR_EXPRESSION` test properties. diff --git a/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst b/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst index 46c4363..60038e4 100644 --- a/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst +++ b/Help/prop_test/SKIP_REGULAR_EXPRESSION.rst @@ -16,4 +16,6 @@ the test will be marked as skipped. Example: ``SKIP_REGULAR_EXPRESSION`` expects a list of regular expressions. -See also the :prop_test:`SKIP_RETURN_CODE` property. +See also the :prop_test:`SKIP_RETURN_CODE`, +:prop_test:`PASS_REGULAR_EXPRESSION`, and :prop_test:`FAIL_REGULAR_EXPRESSION` +test properties. |