aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2010-12-02 15:27:10 +0100
committerLukas Larsson <[email protected]>2010-12-08 18:08:27 +0100
commit6288b704f2ee0699407f645536ad69e0dd07756d (patch)
tree4752e17e90405885ce9ffee97f4ead81df92abbe /lib/common_test/doc/src
parent963d9f96452243a31cdcaa793a4bbe221a30a6f5 (diff)
downloadotp-6288b704f2ee0699407f645536ad69e0dd07756d.tar.gz
otp-6288b704f2ee0699407f645536ad69e0dd07756d.tar.bz2
otp-6288b704f2ee0699407f645536ad69e0dd07756d.zip
Started work on documenting suite callbacks, this is a partial commit
Diffstat (limited to 'lib/common_test/doc/src')
-rw-r--r--lib/common_test/doc/src/Makefile2
-rw-r--r--lib/common_test/doc/src/ct_suite_callbacks.xml94
-rw-r--r--lib/common_test/doc/src/ref_man.xml1
3 files changed, 96 insertions, 1 deletions
diff --git a/lib/common_test/doc/src/Makefile b/lib/common_test/doc/src/Makefile
index 1a767a8197..be066143e0 100644
--- a/lib/common_test/doc/src/Makefile
+++ b/lib/common_test/doc/src/Makefile
@@ -52,7 +52,7 @@ CT_XML_FILES = $(CT_MODULES:=.xml)
XML_APPLICATION_FILES = ref_man.xml
XML_REF1_FILES = ct_run.xml
-XML_REF3_FILES = $(CT_XML_FILES)
+XML_REF3_FILES = $(CT_XML_FILES) ct_suite_callbacks.xml
XML_REF6_FILES = common_test_app.xml
XML_PART_FILES = part.xml
diff --git a/lib/common_test/doc/src/ct_suite_callbacks.xml b/lib/common_test/doc/src/ct_suite_callbacks.xml
new file mode 100644
index 0000000000..28a496a47b
--- /dev/null
+++ b/lib/common_test/doc/src/ct_suite_callbacks.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="latin1" ?>
+
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>2010</year><year>2010</year>
+ <holder>Ericsson AB. All Rights Reserved.</holder>
+ </copyright>
+ <legalnotice>
+ The contents of this file are subject to the Erlang Public License,
+ Version 1.1, (the "License"); you may not use this file except in
+ compliance with the License. You should have received a copy of the
+ Erlang Public License along with this software. If not, it can be
+ retrieved online at http://www.erlang.org/.
+
+ Software distributed under the License is distributed on an "AS IS"
+ basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+ the License for the specific language governing rights and limitations
+ under the License.
+
+ </legalnotice>
+
+ <title>Suite Callbacks</title>
+ <prepared>Lukas Larsson</prepared>
+ <responsible>Lukas Larsson</responsible>
+ <docno></docno>
+ <approved></approved>
+ <checked></checked>
+ <date>2010-12-02</date>
+ <rev>PA1</rev>
+ <file>suite_callback.sgml</file>
+ </header>
+ <module>ct_suite_callback</module>
+ <modulesummary>A callback interface on top of common test</modulesummary>
+
+ <description>
+
+ <p>The <em>Suite Callback</em> framework allows extensions of the default
+ behaviour of Common Test by means of callbacks before and after all
+ test suite calls. </p>
+
+ <p>In brief, Suite Callbacks allows you to:</p>
+
+ <list>
+ <item>Manipulating the runtime config before each suite configuration calls</item>
+ <item>Manipulating the return of all suite configuration calls</item>
+ </list>
+
+ <p>The following sections describe the mandatory and optional suite callback
+ functions Common Test will call during test execution. For more details
+ see <seealso marker="suite_callbacks">Suite Callbacks</seealso> in the User's Guide.</p>
+
+ </description>
+
+ <section>
+ <title>CALLBACK FUNCTIONS</title>
+ <p>The following functions define the callback interface
+ for a suite callback.</p>
+ </section>
+
+ <funcs>
+ <func>
+ <name>Module:init(Opts) -> {Id,State} </name>
+ <fsummary>asdas</fsummary>
+ <type>
+ <v>Opts = term()</v>
+ <v>Id = term()</v>
+ <v>GroupName = term()</v>
+ </type>
+
+ <desc>
+ <p> MANDATORY </p>
+
+ <p></p>
+
+ <p> If <c>{skip,Reason}</c> is returned, all test cases
+ in the module will be skipped, and the <c>Reason</c> will
+ be printed on the HTML result page.</p>
+
+ <p>For details on groups, see
+ <seealso marker="write_test_chapter#test_case_groups">Test case
+ groups</seealso> in the User's Guide.</p>
+
+ </desc>
+ </func>
+
+
+ </funcs>
+
+</erlref>
+
+
diff --git a/lib/common_test/doc/src/ref_man.xml b/lib/common_test/doc/src/ref_man.xml
index d5985bb021..100c0fe5d7 100644
--- a/lib/common_test/doc/src/ref_man.xml
+++ b/lib/common_test/doc/src/ref_man.xml
@@ -76,6 +76,7 @@
<xi:include href="ct_telnet.xml"/>
<xi:include href="unix_telnet.xml"/>
<xi:include href="ct_slave.xml"/>
+ <xi:include href="ct_suite_callbacks.xml"/>
</application>