aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src/event_handler_chapter.xml
diff options
context:
space:
mode:
authorPeter Andersson <[email protected]>2011-12-11 22:27:34 +0100
committerPeter Andersson <[email protected]>2011-12-12 05:08:40 +0100
commit46ef0536a9e3442c3a54237b59b238e6b6f7a90a (patch)
treee17a61c355e37c9baaab5e7a9be27c2ff7811bc0 /lib/common_test/doc/src/event_handler_chapter.xml
parent76a362c649d78b5790a67df62b757d6ce5403ef3 (diff)
downloadotp-46ef0536a9e3442c3a54237b59b238e6b6f7a90a.tar.gz
otp-46ef0536a9e3442c3a54237b59b238e6b6f7a90a.tar.bz2
otp-46ef0536a9e3442c3a54237b59b238e6b6f7a90a.zip
Document the tc_logfile data
Diffstat (limited to 'lib/common_test/doc/src/event_handler_chapter.xml')
-rw-r--r--lib/common_test/doc/src/event_handler_chapter.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/common_test/doc/src/event_handler_chapter.xml b/lib/common_test/doc/src/event_handler_chapter.xml
index b41b233ce6..a5886b9687 100644
--- a/lib/common_test/doc/src/event_handler_chapter.xml
+++ b/lib/common_test/doc/src/event_handler_chapter.xml
@@ -174,6 +174,16 @@
are also given.
</p></item>
+ <item><c>#event{name = tc_logfile, data = {{Suite,Func},LogFileName}}</c>
+ <p><c>Suite = atom()</c>, name of the test suite.</p>
+ <p><c>Func = atom()</c>, name of test case or configuration function.</p>
+ <p><c>LogFileName = string()</c>, full name of test case log file.</p>
+ <p>This event is sent at the start of each test case (and configuration function
+ except <c>init/end_per_testcase</c>) and carries information about the
+ full name (i.e. the file name including the absolute directory path) of
+ the current test case log file.
+ </p></item>
+
<marker id="tc_done"/>
<item><c>#event{name = tc_done, data = {Suite,FuncOrGroup,Result}}</c>
<p><c>Suite = atom()</c>, name of the suite.</p>