From 6a5c264882058cf0786aba4418079b8552eea1cb Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Wed, 2 Apr 2014 02:11:43 +0200
Subject: Document changes in the CT hooks API and the event message protocol

OTP-11732
---
 lib/test_server/doc/src/test_server_ctrl.xml | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

(limited to 'lib/test_server/doc/src/test_server_ctrl.xml')

diff --git a/lib/test_server/doc/src/test_server_ctrl.xml b/lib/test_server/doc/src/test_server_ctrl.xml
index f4aae724e0..0cda531716 100644
--- a/lib/test_server/doc/src/test_server_ctrl.xml
+++ b/lib/test_server/doc/src/test_server_ctrl.xml
@@ -773,11 +773,14 @@ test_server_ctrl:cross_cover_analyse(Level,[{s1,S1LogDir},{s2,S2LogDir}])
         <p><c>What = tests_start, Data = {Name,NumCases}</c><br></br>
 	   <c>What = loginfo, Data = [{topdir,TestRootDir},{rundir,CurrLogDir}]</c><br></br>
 	   <c>What = tests_done, Data = {Ok,Failed,{UserSkipped,AutoSkipped}}</c><br></br>
-	   <c>What = tc_start, Data = {{Mod,Func},TCLogFile}</c><br></br>
-	   <c>What = tc_done, Data = {Mod,Func,Result}</c><br></br>
-	   <c>What = tc_user_skip, Data = {Mod,Func,Comment}</c><br></br>
-	   <c>What = tc_auto_skip, Data = {Mod,Func,Comment}</c><br></br>
+	   <c>What = tc_start, Data = {{Mod,{Func,GroupName}},TCLogFile}</c><br></br>
+	   <c>What = tc_done, Data = {Mod,{Func,GroupName},Result}</c><br></br>
+	   <c>What = tc_user_skip, Data = {Mod,{Func,GroupName},Comment}</c><br></br>
+	   <c>What = tc_auto_skip, Data = {Mod,{Func,GroupName},Comment}</c><br></br>
 	   <c>What = framework_error, Data = {{FWMod,FWFunc},Error}</c></p>
+	<p>Note that for a test case function that doesn't belong to a group,
+	  <c>GroupName</c> has value <c>undefined</c>, otherwise the name of the test
+	  case group.</p>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3