aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src/ct_hooks.xml
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2011-09-01 19:17:39 +0200
committerLukas Larsson <[email protected]>2011-09-01 19:17:39 +0200
commit8811898efa3862fbb32f5c7cd7eff3535084bea7 (patch)
treef37f63cd31e9601f834bbfcb34b5e961669a38f7 /lib/common_test/doc/src/ct_hooks.xml
parenteb4aa9b65c8b50597ed8fae092555145e466e1dc (diff)
parent1e18245b72b1a22f90d78ee3f21fe2ea52bebdaf (diff)
downloadotp-8811898efa3862fbb32f5c7cd7eff3535084bea7.tar.gz
otp-8811898efa3862fbb32f5c7cd7eff3535084bea7.tar.bz2
otp-8811898efa3862fbb32f5c7cd7eff3535084bea7.zip
Merge branch 'lukas/common_test/cth_prio/OTP-9445' into dev
* lukas/common_test/cth_prio/OTP-9445: Fix a couple of minor bugs with hook priority Update to reflect addition of CTH priority addition Update CTH priority default to be 0 Update to reflect new cth callback api Update the return from init/2 to be {ok, NewState} or {ok,NewState,Priority} instead of NewState. Add priority functionality and tests for ct hooks Update internal hooks state to use a record instead of tuples
Diffstat (limited to 'lib/common_test/doc/src/ct_hooks.xml')
-rw-r--r--lib/common_test/doc/src/ct_hooks.xml8
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml
index 7d5c9f4750..0ece3199bb 100644
--- a/lib/common_test/doc/src/ct_hooks.xml
+++ b/lib/common_test/doc/src/ct_hooks.xml
@@ -81,12 +81,14 @@
<funcs>
<func>
- <name>Module:init(Id, Opts) -&gt; State</name>
+ <name>Module:init(Id, Opts) -&gt; {ok, State} |
+ {ok, State, Priority}</name>
<fsummary>Initiates the Common Test Hook</fsummary>
<type>
<v>Id = reference() | term()</v>
<v>Opts = term()</v>
<v>State = term()</v>
+ <v>Priority = integer()</v>
</type>
<desc>
@@ -103,6 +105,10 @@
if <seealso marker="#Module:id-1">id/1</seealso> is not implemented.
</p>
+ <p><c>Priority</c> is the relative priority of this hook. Hooks with a
+ lower priority will be executed first. If no priority is given,
+ it will be set to 0. </p>
+
<p>For details about when init is called see
<seealso marker="ct_hooks_chapter#scope">scope</seealso>
in the User's Guide.</p>