From 5f93ed61f48b5d90d1217215d16a8ca61120dd66 Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Sun, 11 Dec 2011 01:07:11 +0100
Subject: Document the group info function

---
 lib/common_test/doc/src/write_test_chapter.xml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'lib/common_test/doc')

diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index b8487ea2d4..9f2cf73ef2 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -694,6 +694,28 @@
     sub-group also has a <c>shuffle</c> property).</p>
   </section>
 
+  <section>
+    <marker id="group_info"></marker>
+    <title>Group info function</title>
+
+      <p>The test case group info function, <c>group(GroupName)</c>,
+	serves the same purpose as the suite- and test case info
+	functions previously described in this chapter. The scope for
+	the group info, however, is all test cases and sub-groups in the
+	group in question (<c>GroupName</c>).</p>
+      <p>Example:</p>
+      <pre>
+	group(connection_tests) ->
+	   [{require,login_data},
+	    {timetrap,1000}].</pre>
+	
+      <p>The group info properties override those set with the
+	suite info function, and may in turn be overridden by test
+	case info properties. Please see the suite- and test case info
+	functions above for a list of valid info properties and more
+	general information.</p>
+  </section>
+
   <section>
     <marker id="data_priv_dir"></marker>
     <title>Data and Private Directories</title>
-- 
cgit v1.2.3