openstack/os-testr
Code Issues Proposed changes
48c4dd5b2a
os-testr/doc/source/subunit2html.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

913 B
Raw Blame History

subunit2html

subunit2html is a tool that takes in a subunit stream file and will output an html page

Summary

subunit2html subunit_stream [output]

Usage

subunit2html takes in 1 mandatory argument. This is used to specify the location of the subunit stream file. For example:

$ subunit2html subunit_stream

By default subunit2html will store the generated html results file at results.html file in the current working directory.

An optional second argument can be provided to set the output path of the html results file that is generated. If it is provided this will be the output path for saving the generated file, otherwise results.html in the current working directory will be used. For example:

$ subunit2html subunit_stream test_results.html

will write the generated html results file to test_results.html in the current working directory