summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Collins <robertc@robertcollins.net>2012-12-06 14:34:16 +1300
committerRobert Collins <robertc@robertcollins.net>2012-12-06 14:34:16 +1300
commit67787166d0ce28dc92a8d9f8cb5f5d41e9887fd4 (patch)
treea5d5784855b658388ab8a185bdfb5567502ac75b /doc
parent3b3c5074b5c4dae28e20807c23bdffcab33ddc1d (diff)
downloadtestrepository-67787166d0ce28dc92a8d9f8cb5f5d41e9887fd4.tar.gz
* ``testr run --failing`` will no longer run any tests at all if there are
no failing tests. (Robert Collins, #904400)
Diffstat (limited to 'doc')
-rw-r--r--doc/MANUAL.txt30
1 files changed, 17 insertions, 13 deletions
diff --git a/doc/MANUAL.txt b/doc/MANUAL.txt
index fafd16e..c63f971 100644
--- a/doc/MANUAL.txt
+++ b/doc/MANUAL.txt
@@ -8,8 +8,9 @@ Test repository is a small application for tracking test results. Any test run
that can be represented as a subunit stream can be inserted into a repository.
Typical workflow is to have a repository into which test runs are inserted, and
-then to query the repository to find out about issues that need addressing. For
-instance, using the sample subunit stream included with Test repository::
+then to query the repository to find out about issues that need addressing.
+testr can fully automate this, but lets start with the low level facilities,
+using the sample subunit stream included with testr::
# Note that there is a .testr.conf already:
ls .testr.conf
@@ -42,17 +43,20 @@ file in your cwd. A file like::
test_id_option=--bar $IDFILE
will cause 'testr run' to run 'foo' and process it as 'testr load' would.
-Likewise 'testr run --failing' will run 'foo --bar failing.list' and process it
-as 'testr load' would. failing.list will be a newline separated list of the
-test ids that your test runner outputs. Arguments passed to 'testr run' are
-used to filter test ids that will be run - testr will query the runner for test
-ids and then apply each argument as a regex filter. Tests that match any of the
-given filters will be run. Arguments passed to run after a ``--`` are passed
-through to your test runner command line. For instance, using the above config
-example ``testr run quux -- bar --no-plugins`` would query for test ids, filter
-for those that match 'quux' and then run
-``foo bar --load-list tempfile.list --no-plugins``. Shell variables are
-expanded in these commands on platforms that have a shell.
+Likewise 'testr run --failing' will automatically create a list file listing
+just the failing tests, and then run 'foo --bar failing.list' and process it as
+'testr load' would. failing.list will be a newline separated list of the
+test ids that your test runner outputs. If there are no failing tests, no test
+execution will happen at all.
+
+Arguments passed to 'testr run' are used to filter test ids that will be run -
+testr will query the runner for test ids and then apply each argument as a
+regex filter. Tests that match any of the given filters will be run. Arguments
+passed to run after a ``--`` are passed through to your test runner command
+line. For instance, using the above config example ``testr run quux -- bar
+--no-plugins`` would query for test ids, filter for those that match 'quux' and
+then run ``foo bar --load-list tempfile.list --no-plugins``. Shell variables
+are expanded in these commands on platforms that have a shell.
To get a full list of these options run ``testr help run``.