os-testr/README.rst
Matthew Treinish 2f29ca51be
Improved docs for os-testr commands
This commit adds real docs for using the 3 currently packaged commands
in the os-testr project. As part of this change it also updates the
sphinx config to generate proper man pages for all the tooling. At a
future stage we need to ensure that these get installed properly.

Change-Id: I0055c7961203a094590f6cfeb136a2236a2f65cc
2015-07-17 11:09:23 -04:00

35 lines
1.0 KiB
ReStructuredText

===============================
os-testr
===============================
A testr wrapper to provide functionality for OpenStack projects
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/os-testr
* Source: http://git.openstack.org/cgit/openstack/os-testr
* Bugs: http://bugs.launchpad.net/os-testr
Features
--------
* ostestr: a testr wrapper that uses subunit-trace for output and builds some
helpful extra functionality around testr
* subunit-trace: an output filter for a subunit stream which provides useful
information about the run
* subunit2html: generates a test results html page from a subunit stream
Release Notes
=============
0.2.0
-----
* Adds support for comments in a blacklist file and printing comments for each
exclude
* Several bugfixes for subunit-trace
* Switched subunit-trace behavior to disable printing percent change
in run time by default and make it optional
0.1.0
-----
* First release which includes: ostestr, subunit-trace, and subunit2html