From fc13629197e7c3698ff0739b51d8219069444dec Mon Sep 17 00:00:00 2001 From: Kenneth Lundin Date: Thu, 29 Aug 2013 11:56:20 +0200 Subject: Corrections so that the documentation confirms to the DTD --- lib/common_test/doc/src/event_handler_chapter.xml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'lib/common_test/doc/src/event_handler_chapter.xml') diff --git a/lib/common_test/doc/src/event_handler_chapter.xml b/lib/common_test/doc/src/event_handler_chapter.xml index 10a9b52d39..3cc21f28de 100644 --- a/lib/common_test/doc/src/event_handler_chapter.xml +++ b/lib/common_test/doc/src/event_handler_chapter.xml @@ -64,7 +64,7 @@ Usage

Event handlers may be installed by means of an event_handler - start flag (ct_run) or option (ct:run_test/1), where the + start flag (ct_run) or option (ct:run_test/1), where the argument specifies the names of one or more event handler modules. Example:

$ ct_run -suite test/my_SUITE -event_handler handlers/my_evh1 @@ -78,7 +78,7 @@ example).

An event_handler tuple in the argument Opts has the following - definition (see also ct:run_test/1 in the reference manual):

+ definition (see also ct:run_test/1 in the reference manual):

     {event_handler,EventHandlers}
@@ -224,8 +224,9 @@
 	end_per_testcase for the case failed.
 	

+ - #event{name = tc_auto_skip, data = {Suite,Func,Reason}} + #event{name = tc_auto_skip, data = {Suite,Func,Reason}}

Suite = atom(), the name of the suite.

Func = atom(), the name of the test case or configuration function.

Reason = {failed,FailReason} | @@ -251,8 +252,9 @@ the tc_done event.

+ - #event{name = tc_user_skip, data = {Suite,TestCase,Comment}} + #event{name = tc_user_skip, data = {Suite,TestCase,Comment}}

Suite = atom(), name of the suite.

TestCase = atom(), name of the test case.

Comment = string(), reason for skipping the test case.

@@ -308,7 +310,7 @@ manager can look like.

To ensure that printouts to standard out (or printouts made with - ct:log/2/3 or ct:pal/2/3) get written to the test case log + ct:log/2/3 or ct:pal/2/3) get written to the test case log file, and not to the Common Test framework log, you can syncronize with the Common Test server by matching on the tc_start and tc_done events. In the period between these events, all IO gets directed to the -- cgit v1.2.3