From e6ebe1cdf749cb4f7f167e91a818728aab899b65 Mon Sep 17 00:00:00 2001 From: Peter Andersson Date: Tue, 3 Dec 2013 23:43:36 +0100 Subject: Update documentation --- lib/common_test/doc/src/event_handler_chapter.xml | 12 ++++++++---- lib/common_test/doc/src/run_test_chapter.xml | 6 +++--- 2 files changed, 11 insertions(+), 7 deletions(-) (limited to 'lib/common_test/doc/src') diff --git a/lib/common_test/doc/src/event_handler_chapter.xml b/lib/common_test/doc/src/event_handler_chapter.xml index 3cc21f28de..3076d5f8ba 100644 --- a/lib/common_test/doc/src/event_handler_chapter.xml +++ b/lib/common_test/doc/src/event_handler_chapter.xml @@ -228,7 +228,9 @@ #event{name = tc_auto_skip, data = {Suite,Func,Reason}}

Suite = atom(), the name of the suite.

-

Func = atom(), the name of the test case or configuration function.

+

Func = atom() | {end_per_group,GroupName}, the name of the test case + or configuration function.

+

GroupName = atom(), name of the group.

Reason = {failed,FailReason} | {require_failed_in_suite0,RequireInfo}, reason for auto skipping Func.

@@ -254,9 +256,11 @@ - #event{name = tc_user_skip, data = {Suite,TestCase,Comment}} -

Suite = atom(), name of the suite.

-

TestCase = atom(), name of the test case.

+ #event{name = tc_user_skip, data = {Suite,Func,Comment}} +

Suite = atom(), the name of the suite.

+

Func = atom() | {end_per_group,GroupName}, the name of the test case + or configuration function.

+

GroupName = atom(), name of the group.

Comment = string(), reason for skipping the test case.

This event specifies that a test case has been skipped by the user. It is only ever received if the skip was declared in a test specification. diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index 6b37e183dd..fad0510049 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -205,12 +205,12 @@

The ct_run program sets the exit status before shutting down. The following values are defined:

- 0 indicates a successful testrun, i.e. one without failed or auto-skipped test cases. - 1 indicates that one or more test cases have failed, or have been auto-skipped. + 0 indicates a successful testrun, i.e. one without failed or auto skipped test cases. + 1 indicates that one or more test cases have failed, or have been auto skipped. 2 indicates that the test execution has failed because of e.g. compilation errors, an illegal return value from an info function, etc. -

If auto-skipped test cases should not affect the exit status, you may change the default +

If auto skipped test cases should not affect the exit status, you may change the default behaviour using start flag:

-exit_status ignore_config
-- cgit v1.2.3