diff options
| author | Peter Andersson <[email protected]> | 2015-02-26 23:11:38 +0100 |
|---|---|---|
| committer | Peter Andersson <[email protected]> | 2015-02-26 23:11:38 +0100 |
| commit | d603d51333b2bdc58658ef8bfe7f2a2a8ed074a5 (patch) | |
| tree | 62591cbf70966f7ec11b1c5e9d2f8ceea121b611 | |
| parent | bb8ddc6d95844f92f4a3bfd7bfd3073f63bcbf45 (diff) | |
| download | otp-d603d51333b2bdc58658ef8bfe7f2a2a8ed074a5.tar.gz otp-d603d51333b2bdc58658ef8bfe7f2a2a8ed074a5.tar.bz2 otp-d603d51333b2bdc58658ef8bfe7f2a2a8ed074a5.zip | |
Add documentation
| -rw-r--r-- | lib/common_test/doc/src/event_handler_chapter.xml | 9 | ||||
| -rw-r--r-- | lib/common_test/src/ct.erl | 2 | ||||
| -rw-r--r-- | lib/common_test/src/ct_master.erl | 2 |
3 files changed, 11 insertions, 2 deletions
diff --git a/lib/common_test/doc/src/event_handler_chapter.xml b/lib/common_test/doc/src/event_handler_chapter.xml index 45f01c12ec..f39f391818 100644 --- a/lib/common_test/doc/src/event_handler_chapter.xml +++ b/lib/common_test/doc/src/event_handler_chapter.xml @@ -59,6 +59,15 @@ Event handlers plugged into this manager will receive the events from all the test nodes as well as information from the CT Master server itself.</p> + + <p>User specific event handlers may be plugged into a Common Test event + manager, either by telling Common Test to install them before the test + run (see below), or by adding the handlers dynamically during the test + run by means of + <c>gen_event:add_handler/3</c> or <c>gen_event:add_sup_handler/3</c>. + In the latter scenario, the reference of the Common Test event manager is + required. To get it, call <c>ct:get_event_mgr_ref/0</c> or (on the CT + Master node) <c>ct_master:get_event_mgr_ref/0</c>.</p> </section> <section> <marker id="usage"></marker> diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl index 0dc80142e0..9d8fce2789 100644 --- a/lib/common_test/src/ct.erl +++ b/lib/common_test/src/ct.erl @@ -1014,7 +1014,7 @@ abort_current_testcase(Reason) -> %%% CT event manager. The reference can be used to e.g. add %%% a user specific event handler while tests are running. %%% Example: -%%% gen_event:add_handler(ct:get_event_mgr_ref(), my_ev_h, [])</p> +%%% <c>gen_event:add_handler(ct:get_event_mgr_ref(), my_ev_h, [])</c></p> get_event_mgr_ref() -> ?CT_EVMGR_REF. diff --git a/lib/common_test/src/ct_master.erl b/lib/common_test/src/ct_master.erl index 0a41a0ed15..2cdb259899 100644 --- a/lib/common_test/src/ct_master.erl +++ b/lib/common_test/src/ct_master.erl @@ -300,7 +300,7 @@ progress() -> %%% CT master event manager. The reference can be used to e.g. %%% add a user specific event handler while tests are running. %%% Example: -%%% gen_event:add_handler(ct_master:get_event_mgr_ref(), my_ev_h, [])</p> +%%% <c>gen_event:add_handler(ct_master:get_event_mgr_ref(), my_ev_h, [])</c></p> get_event_mgr_ref() -> ?CT_MEVMGR_REF. |