[gentoo-commits] proj/pms-test-suite:master commit in: /

["Michał Górny" <mgorny@gentoo.org>]

commit:     b96ba0b0a36e492ee649e0e8d3dbcafaa96deedd
Author:     Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Mon Aug  8 22:13:01 2011 +0000
Commit:     Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Mon Aug  8 22:13:01 2011 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/pms-test-suite.git;a=commit;h=b96ba0b0

Add a note on D-Bus and HTML output.

---
 README |   28 ++++++++++++++++++++++++++++
 1 files changed, 28 insertions(+), 0 deletions(-)

diff --git a/README b/README
index 606cf24..ed474f7 100644
--- a/README
+++ b/README
@@ -17,6 +17,18 @@ to determine whether the PM does comply to the PMS [1].
 [1]:http://www.gentoo.org/proj/en/qa/pms.xml
 
 
+D-Bus setup
+-----------
+
+Right now, the standard test library requires the system-wide D-Bus daemon to
+be set up and running. The `setup.py` install script installs the necessary
+configuration file along with the Python modules but one needs to start or
+restart the daemon as required before running the test suite.
+
+A future version will most probably drop D-Bus dependency and replace it with
+a less painful IPC.
+
+
 How to run it
 -------------
 
@@ -49,4 +61,20 @@ nor `-R` is specified. Thus, the above could be simplified to:
 
 	pms-tester -p yourpm
 
+
+Getting nice HTML results
+-------------------------
+
+By default, pms-tester simply runs all tests and returns information about test
+failures. If you'd like to get a nice HTML output instead (like the one
+published by me [1]), please use:
+
+	pms-tester -p yourpm -o html -O myoutput.html
+
+You can run the test suite using multiple PMs as well:
+
+	pms-tester -p pkgcore -p portage -p paludis -o html -O myoutput.html
+
+[1]:http://dev.gentoo.org/~mgorny/pms-test-suite-output.html
+
 <!-- vim:se syn=markdown :-->