From d67b4080fa2dd4622e7b03e60dd5ba49f76f31fb Mon Sep 17 00:00:00 2001
From: Peter Andersson
Date: Fri, 30 Mar 2012 18:25:02 +0200
Subject: Document the new timetrap interface
OTP-10039
---
lib/common_test/doc/src/common_test_app.xml | 28 +++++++++++++++++++---------
1 file changed, 19 insertions(+), 9 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 c7f6c7ce5c..6babdb93af 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -187,9 +187,13 @@
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. If a TimeFunc function is specified,
- it will be called initially and must return a value on
- TimeVal format.
+ timetrap_timeout. 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
+ value other than a TimeVal. (See the
+ User's Guide
+ for details).
+
The require tag specifies configuration variables
that are required by test cases (and/or configuration functions)
@@ -313,9 +317,12 @@
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. If a TimeFunc function is specified,
- it will be called initially and must return a value on
- TimeVal format.
+ timetrap_timeout. 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
+ value other than a TimeVal. (See the
+ User's Guide
+ for details).
The require tag specifies configuration variables
that are required by test cases (and/or configuration functions)
@@ -494,9 +501,12 @@
exceeded, the test case fails with reason
timetrap_timeout. init_per_testcase/2
and end_per_testcase/2 are included in the
- timetrap time. If a TimeFunc function is specified,
- it will be called before the test case (or init_per_testcase/2)
- and must return a value on TimeVal format.
+ 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
+ value other than a TimeVal. (See the
+ User's Guide
+ for details).
The require tag specifies configuration variables
that are required by the test case (and/or init/end_per_testcase/2).
--
cgit v1.2.3