From e6ebe1cdf749cb4f7f167e91a818728aab899b65 Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Tue, 3 Dec 2013 23:43:36 +0100
Subject: Update documentation

---
 lib/common_test/doc/src/event_handler_chapter.xml | 12 ++++++++----
 lib/common_test/doc/src/run_test_chapter.xml      |  6 +++---
 2 files changed, 11 insertions(+), 7 deletions(-)

(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 3cc21f28de..3076d5f8ba 100644
--- a/lib/common_test/doc/src/event_handler_chapter.xml
+++ b/lib/common_test/doc/src/event_handler_chapter.xml
@@ -228,7 +228,9 @@
 	<marker id="tc_auto_skip"></marker>
         <c>#event{name = tc_auto_skip, data = {Suite,Func,Reason}}</c>
         <p><c>Suite = atom()</c>, the name of the suite.</p>
-        <p><c>Func = atom()</c>, the name of the test case or configuration function.</p>
+        <p><c>Func = atom() | {end_per_group,GroupName}</c>, the name of the test case
+	  or configuration function.</p>
+        <p><c>GroupName = atom()</c>, name of the group.</p>
         <p><c>Reason = {failed,FailReason} |
 	               {require_failed_in_suite0,RequireInfo}</c>, 
 	      reason for auto skipping <c>Func</c>.</p>
@@ -254,9 +256,11 @@
 	
       <item>
 	<marker id="tc_user_skip"></marker>
-        <c>#event{name = tc_user_skip, data = {Suite,TestCase,Comment}}</c>
-        <p><c>Suite = atom()</c>, name of the suite.</p>
-        <p><c>TestCase = atom()</c>, name of the test case.</p>
+        <c>#event{name = tc_user_skip, data = {Suite,Func,Comment}}</c>
+        <p><c>Suite = atom()</c>, the name of the suite.</p>
+        <p><c>Func = atom() | {end_per_group,GroupName}</c>, the name of the test case
+	  or configuration function.</p>
+        <p><c>GroupName = atom()</c>, name of the group.</p>
         <p><c>Comment = string()</c>, reason for skipping the test case.</p>
         <p>This event specifies that a test case has been skipped by the user. 
 	It is only ever received if the skip was declared in a test specification. 
diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index 6b37e183dd..fad0510049 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -205,12 +205,12 @@
     <p>The <c>ct_run</c> program sets the exit status before shutting down. The following values
       are defined:</p>
     <list>
-      <item><c>0</c> indicates a successful testrun, i.e. one without failed or auto-skipped test cases.</item>
-      <item><c>1</c> indicates that one or more test cases have failed, or have been auto-skipped.</item>
+      <item><c>0</c> indicates a successful testrun, i.e. one without failed or auto skipped test cases.</item>
+      <item><c>1</c> indicates that one or more test cases have failed, or have been auto skipped.</item>
       <item><c>2</c> indicates that the test execution has failed because of e.g. compilation errors, an
 	illegal return value from an info function, etc.</item>
     </list>
-    <p>If auto-skipped test cases should not affect the exit status, you may change the default
+    <p>If auto skipped test cases should not affect the exit status, you may change the default
       behaviour using start flag:</p>
     <pre>-exit_status ignore_config</pre>
     
-- 
cgit v1.2.3