telepathy-mission-control: Document the new test logging arrangement

[Simon McVittie]

Module: telepathy-mission-control
Branch: master
Commit: 439309bfede3afe68469f39bbde332ff5f668ba6
URL:    http://cgit.freedesktop.org/telepathy/telepathy-mission-control/commit/?id=439309bfede3afe68469f39bbde332ff5f668ba6

Author: Simon McVittie <simon.mcvittie at collabora.co.uk>
Date:   Fri Sep 20 12:49:27 2013 +0100

Document the new test logging arrangement

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=69585

---

 tests/twisted/README |   14 +++++++++-----
 1 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/tests/twisted/README b/tests/twisted/README
index b1b0716..f4edd32 100644
--- a/tests/twisted/README
+++ b/tests/twisted/README
@@ -7,11 +7,15 @@ To run an individual Twisted test:
   make -C tests/twisted check-twisted \
         TWISTED_TESTS=dispatcher/create-at-startup.py
 
-To run with debug information:
-
-  make -C tests/twisted check-twisted \
-        TWISTED_TESTS=dispatcher/create-at-startup.py \
-        CHECK_TWISTED_VERBOSE=1
+Debug information (the test's own log, and Mission Control's log)
+is recorded in a subdirectory of tests-twisted whose name is based
+on the test's name, like tests/twisted/tmp-dispatcher_create-at-startup_py.
+The same tmp-* directory also contains the account data used in the test.
+If the test fails, its output will be sent to stdout.
+
+These directories are normally deleted after a test passes or is skipped,
+and kept for analysis if it fails. Set the environment variable
+MC_TEST_KEEP_TEMP to avoid deleting them.
 
 To debug an individual test you can set one of the following env variable: