* A new testr.conf option ``group_regex`` can be used for grouping

  tests so that they get run in the same backend runner. (Matthew Treinish)

1 files changed, 19 insertions, 0 deletions

diff --git a/doc/MANUAL.txt b/doc/MANUAL.txt
index cb76c66..788f93c 100644
--- a/doc/MANUAL.txt
+++ b/doc/MANUAL.txt
@@ -205,6 +205,25 @@ And then find tests with that tag::
 
   $ testr last --subunit | subunit-filter -s --xfail --with-tag=worker-3 | subunit-ls > slave-3.list
 
+Grouping Tests
+~~~~~~~~~~~~~~
+
+In certain scenarios you may want to group tests of a certain type together
+so that they will be run by the same backend. The group_regex option in
+.testr.conf permits this. When set, tests are grouped by the group(0) of any
+regex match. Tests with no match are not grouped.
+
+For example, extending the python sample .testr.conf from the configuration
+section with a group regex that will group python tests cases together by
+class (the last . splits the class and test method)::
+
+    [DEFAULT]
+    test_command=python -m subunit.run discover . $LISTOPT $IDOPTION
+    test_id_option=--load-list $IDFILE
+    test_list_option=--list
+    group_regex=([^\.]+\.)+
+
+
 Remote or isolated test environments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~