From b72ac8bb33177f6ca117fc0f7727d24de67cbc62 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang-solutions.com>
Date: Fri, 29 Jul 2011 14:47:00 +0200
Subject: Update to reflect addition of CTH priority addition

---
 lib/common_test/doc/src/ct_hooks.xml | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'lib/common_test/doc/src/ct_hooks.xml')

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>
-- 
cgit v1.2.3