diff options
author | Peter Andersson <peppe@erlang.org> | 2016-04-18 12:31:07 +0200 |
---|---|---|
committer | Peter Andersson <peppe@erlang.org> | 2016-05-02 14:07:22 +0200 |
commit | 03d7a4ac57ac52358fbf5388f1462a5347882d50 (patch) | |
tree | bde3b10cd075de936aba9964f5f131a755a540c4 /lib/common_test/doc | |
parent | 10c1adf6028bf770003eb19b0c775ddc0260c950 (diff) | |
download | otp-03d7a4ac57ac52358fbf5388f1462a5347882d50.tar.gz otp-03d7a4ac57ac52358fbf5388f1462a5347882d50.tar.bz2 otp-03d7a4ac57ac52358fbf5388f1462a5347882d50.zip |
Skip pre/post test IO suite if cover or debug is running
OTP-13535
The return value of ct:get_timetrap_info/0 has been modified.
Diffstat (limited to 'lib/common_test/doc')
-rw-r--r-- | lib/common_test/doc/src/ct.xml | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml index a87be21d73..438099c074 100644 --- a/lib/common_test/doc/src/ct.xml +++ b/lib/common_test/doc/src/ct.xml @@ -601,18 +601,21 @@ </func> <func> - <name>get_timetrap_info() -> {Time, Scale}</name> + <name>get_timetrap_info() -> {Time, {Scaling,ScaleVal}}</name> <fsummary>Reads information about the timetrap set for the current test case.</fsummary> <type> <v>Time = integer() | infinity</v> - <v>Scale = true | false</v> + <v>Scaling = true | false</v> + <v>ScaleVal = integer()</v> </type> <desc><marker id="get_timetrap_info-0"/> <p>Reads information about the timetrap set for the current test - case. <c>Scale</c> indicates if <c>Common Test</c> will attempt + case. <c>Scaling</c> indicates if <c>Common Test</c> will attempt to compensate timetraps automatically for runtime delays - introduced by, for example, tools like cover.</p> + introduced by, for example, tools like cover. <c>ScaleVal</c> is + the value of the current scaling multipler (always 1 if scaling is + disabled). Note the <c>Time</c> is not the scaled result.</p> </desc> </func> |