]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Document the new '$' suite file 21012/head
authorWarren Usui <wusui@redhat.com>
Fri, 23 Mar 2018 00:02:11 +0000 (00:02 +0000)
committerWarren Usui <wusui@redhat.com>
Fri, 23 Mar 2018 00:02:11 +0000 (00:02 +0000)
Including the $ in a directory of yaml files causes teuthology to randomly
select one of the yaml files in that directory.

Signed-off-by: Warren Usui <wusui@redhat.com>
qa/README

index 0e32ce9f638831fd326119ff02425feecbd27bbc..6b3ec220276a93c9638b0933a2359dea62f6fe29 100644 (file)
--- a/qa/README
+++ b/qa/README
@@ -47,6 +47,18 @@ item), so this is really 2x2 = 4 tests, which are
   a + b2 + c + d1
   a + b2 + c + d2
 
+A directory with a magic '$' file represents a test where one of the other
+items is chosen randomly. For example,
+
+suites/foo/$
+suites/foo/a.yaml
+suites/foo/b.yaml
+suites/foo/c.yaml
+
+is a single test.  It will be either a.yaml, b.yaml or c.yaml.  This can be
+used in conjunction with the '%' file in other directories to run a series of
+tests without causing an unwanted increase in the total number of jobs run.
+
 Symlinks are okay.
 
 The teuthology code can be found in https://github.com/ceph/teuthology.git