From d603d51333b2bdc58658ef8bfe7f2a2a8ed074a5 Mon Sep 17 00:00:00 2001
From: Peter Andersson
Date: Thu, 26 Feb 2015 23:11:38 +0100
Subject: Add documentation
---
lib/common_test/doc/src/event_handler_chapter.xml | 9 +++++++++
1 file changed, 9 insertions(+)
(limited to 'lib/common_test/doc/src')
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.
+
+ 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
+ gen_event:add_handler/3 or gen_event:add_sup_handler/3.
+ In the latter scenario, the reference of the Common Test event manager is
+ required. To get it, call ct:get_event_mgr_ref/0 or (on the CT
+ Master node) ct_master:get_event_mgr_ref/0.