Merge "Document how to write multiline regex with comments"

openstack · Dec 27, 2017 · 180e9f5 · 180e9f5
2 parents 29d6028 + 515edd4
commit 180e9f5
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/roles/run-tempest/README.rst b/roles/run-tempest/README.rst
@@ -16,9 +16,19 @@ Run Tempest
    :default: ''
 
    A regular expression used to select the tests.
+
    It works only when used with some specific tox environments
    ('all', 'all-plugin'.)
 
+   Multi-line and commented regexs can be achieved by doing this:
+
+       ::
+           vars:
+             tempest_test_regex: |
+               (?x)    # Ignore comments and whitespaces
+               # Line with only a comment.
+               (tempest\.(api|scenario|thirdparty)).*$    # Run only api scenario and third party
+
 .. zuul:rolevar:: tox_venvlist
    :default: smoke