aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeter Andersson <[email protected]>2011-12-11 01:07:11 +0100
committerPeter Andersson <[email protected]>2011-12-12 05:08:39 +0100
commit5f93ed61f48b5d90d1217215d16a8ca61120dd66 (patch)
treee312cb249d690be765610d1aab0daba81bacae39
parentc96a29d78a8ced79557582c631a9082705d772a3 (diff)
downloadotp-5f93ed61f48b5d90d1217215d16a8ca61120dd66.tar.gz
otp-5f93ed61f48b5d90d1217215d16a8ca61120dd66.tar.bz2
otp-5f93ed61f48b5d90d1217215d16a8ca61120dd66.zip
Document the group info function
-rw-r--r--lib/common_test/doc/src/write_test_chapter.xml22
1 files changed, 22 insertions, 0 deletions
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
@@ -695,6 +695,28 @@
</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>