From a95a238719369feb1002daeacf4e1485439a38d2 Mon Sep 17 00:00:00 2001
From: Lukas Larsson
Date: Tue, 21 Aug 2012 17:44:49 +0200
Subject: Add more cross reference links to ct docs
---
lib/common_test/doc/src/common_test_app.xml | 53 +++++++++++++++--------------
1 file changed, 27 insertions(+), 26 deletions(-)
(limited to 'lib/common_test/doc/src/common_test_app.xml')
diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index addeed002a..a0fa45c71f 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -99,11 +99,11 @@
be executed by Common Test. A test case is represented by an atom,
the name of the test case function. A test case group is
represented by a group tuple, where GroupName,
- an atom, is the name of the group (defined in groups/0).
+ an atom, is the name of the group (defined in groups/0).
Execution properties for groups may also be specified, both
for a top level group and for any of its sub-groups.
Group execution properties specified here, will override
- properties in the group definition (see groups/0).
+ properties in the group definition (see groups/0).
(With value default, the group definition properties
will be used).
@@ -184,8 +184,8 @@
test cases in the suite).
The timetrap tag sets the maximum time each
- test case is allowed to execute (including init_per_testcase/2
- and end_per_testcase/2). If the timetrap time is
+ test case is allowed to execute (including init_per_testcase/2
+ and end_per_testcase/2). If the timetrap time is
exceeded, the test case fails with reason
timetrap_timeout. A TimeFunc function can be used to
set a new timetrap by returning a TimeVal. It may also be
@@ -201,11 +201,11 @@
in any of the configuration files, all test cases are skipped. For more
information about the 'require' functionality, see the
reference manual for the function
- ct:require/[1,2].
+ ct:require/1/2.
With userdata, it is possible for the user to
specify arbitrary test suite related information which can be
- read by calling ct:userdata/2.
+ read by calling ct:userdata/2.
The ct_hooks tag specifies which
Common Test Hooks
@@ -264,7 +264,7 @@
This function is called as the last test case in the
suite. It is meant to be used for cleaning up after
- init_per_suite/1.
+ init_per_suite/1.
For information on save_config, please see
Dependencies
between Test Cases and Suites in the User's Guide.
@@ -309,13 +309,14 @@
This is the test case group info function. It is supposed to
return a list of tagged tuples that specify various properties
related to the execution of a test case group (i.e. its test cases
- and sub-groups). Properties set by groups/1 override
+ and sub-groups). Properties set by
+ group/1 override
properties with the same key that have been previously set by
- suite/0.
+ suite/0.
The timetrap tag sets the maximum time each
- test case is allowed to execute (including init_per_testcase/2
- and end_per_testcase/2). If the timetrap time is
+ test case is allowed to execute (including init_per_testcase/2
+ and end_per_testcase/2). If the timetrap time is
exceeded, the test case fails with reason
timetrap_timeout. A TimeFunc function can be used to
set a new timetrap by returning a TimeVal. It may also be
@@ -330,11 +331,11 @@
in any of the configuration files, all test cases in this group are skipped.
For more information about the 'require' functionality, see the
reference manual for the function
- ct:require/[1,2].
+ ct:require/1/2.
With userdata, it is possible for the user to
specify arbitrary test case group related information which can be
- read by calling ct:userdata/2.
+ read by calling ct:userdata/2.
The ct_hooks tag specifies which
Common Test Hooks
@@ -367,7 +368,7 @@
test case group. It typically contains initializations which are
common for all test cases and sub-groups in the group, and which
shall only be performed once. GroupName is the name of the
- group, as specified in the group definition (see groups/0). The
+ group, as specified in the group definition (see groups/0). The
Config parameter is the configuration data which can be modified
here. The return value of this function is given as Config
to all test cases and sub-groups in the group. If {skip,Reason}
@@ -396,10 +397,10 @@
OPTIONAL
This function is called after the execution of a test case group is finished.
- It is meant to be used for cleaning up after init_per_group/2.
+ It is meant to be used for cleaning up after init_per_group/2.
By means of {return_group_result,Status}, it is possible to return a
status value for a nested sub-group. The status can be retrieved in
- end_per_group/2 for the group on the level above. The status will also
+ end_per_group/2 for the group on the level above. The status will also
be used by Common Test for deciding if execution of a group should proceed in
case the property sequence or repeat_until_* is set.
@@ -450,7 +451,7 @@
OPTIONAL
This function is called after each test case, and can be used
- to clean up after init_per_testcase/2 and the test case.
+ to clean up after init_per_testcase/2 and the test case.
Any return value (besides {fail,Reason} and {save_config,SaveConfig})
is ignored. By returning {fail,Reason}, TestCase will be marked as
failed (even though it was actually successful in the sense that it returned
@@ -492,15 +493,15 @@
This is the test case info function. It is supposed to
return a list of tagged tuples that specify various properties
related to the execution of this particular test case.
- Properties set by Testcase/0 override
+ Properties set by Testcase/0 override
properties that have been previously set for the test case
- by group/1 or suite/0.
+ by group/1 or suite/0.
The timetrap tag sets the maximum time the
test case is allowed to execute. If the timetrap time is
exceeded, the test case fails with reason
- timetrap_timeout. init_per_testcase/2
- and end_per_testcase/2 are included in the
+ timetrap_timeout. init_per_testcase/2
+ and end_per_testcase/2 are included in the
timetrap time. A TimeFunc function can be used to
set a new timetrap by returning a TimeVal. It may also be
used to trigger a timetrap timeout by, at some point, returning a
@@ -514,15 +515,15 @@
configuration files, the test case is skipped. For more
information about the 'require' functionality, see the
reference manual for the function
- ct:require/[1,2].
+ ct:require/1/2.
If timetrap and/or require is not set, the
- default values specified by suite/0 (or
- group/1) will be used.
+ default values specified by suite/0 (or
+ group/1) will be used.
With userdata, it is possible for the user to
specify arbitrary test case related information which can be
- read by calling ct:userdata/3.
+ read by calling ct:userdata/3.
Other tuples than the ones defined will simply be ignored.
@@ -550,7 +551,7 @@
This is the implementation of a test case. Here you must
call the functions you want to test, and do whatever you
need to check the result. If something fails, make sure the
- function causes a runtime error, or call ct:fail/1/2
+ function causes a runtime error, or call ct:fail/1/2
(which also causes the test case process to terminate).
Elements from the Config list can e.g. be read
--
cgit v1.2.3