diff options
author | Siri Hansen <[email protected]> | 2016-03-10 14:55:22 +0100 |
---|---|---|
committer | Siri Hansen <[email protected]> | 2016-03-10 14:55:22 +0100 |
commit | e3e55881b15757e15ea1995b0f8dbfd305f9e89d (patch) | |
tree | a4379d63af0feefb52542f69511272b70389ce4c /lib/common_test/doc/src/write_test_chapter.xml | |
parent | 5fa1dff3c9f92a3b7c6a897af32c0c72a9a9e8a7 (diff) | |
parent | 880280b22f30a5ba67dcbd93bf85e14c04acc25b (diff) | |
download | otp-e3e55881b15757e15ea1995b0f8dbfd305f9e89d.tar.gz otp-e3e55881b15757e15ea1995b0f8dbfd305f9e89d.tar.bz2 otp-e3e55881b15757e15ea1995b0f8dbfd305f9e89d.zip |
Merge branch 'siri/common_test/fix-doc-links' into maint
* siri/common_test/fix-doc-links:
Fix link errors in common_test documentation
Document that any ssh option is allowed in ct_netconfc
Conflicts:
lib/common_test/doc/src/ct_hooks_chapter.xml
lib/common_test/doc/src/ct_netconfc.xml
Diffstat (limited to 'lib/common_test/doc/src/write_test_chapter.xml')
-rw-r--r-- | lib/common_test/doc/src/write_test_chapter.xml | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml index 96137a632d..e3811ec4cf 100644 --- a/lib/common_test/doc/src/write_test_chapter.xml +++ b/lib/common_test/doc/src/write_test_chapter.xml @@ -67,7 +67,7 @@ </p> <p>Each test suite module must export function - <seealso marker="common_test_app#Module:all-0"><c>all/0</c></seealso>, + <seealso marker="common_test#Module:all-0"><c>all/0</c></seealso>, which returns the list of all test case groups and test cases to be executed in that module. </p> @@ -83,8 +83,8 @@ <title>Init and End per Suite</title> <p>Each test suite module can contain the optional configuration functions - <seealso marker="common_test_app#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso> - and <seealso marker="common_test_app#Module:end_per_suite-1"><c>end_per_suite/1</c></seealso>. + <seealso marker="common_test#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso> + and <seealso marker="common_test#Module:end_per_suite-1"><c>end_per_suite/1</c></seealso>. If the init function is defined, so must the end function be. </p> @@ -138,8 +138,8 @@ <title>Init and End per Test Case</title> <p>Each test suite module can contain the optional configuration functions - <seealso marker="common_test_app#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> - and <seealso marker="common_test_app#Module:end_per_testcase-2"><c>end_per_testcase/2</c></seealso>. + <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> + and <seealso marker="common_test#Module:end_per_testcase-2"><c>end_per_testcase/2</c></seealso>. If the init function is defined, so must the end function be.</p> <p>If <c>init_per_testcase</c> exists, it is called before each @@ -378,7 +378,7 @@ <p>If <c>timetrap</c> or <c>require</c>, or both, is not set specifically for a particular test case, default values specified by function - <seealso marker="common_test_app#Module:suite-0"><c>suite/0</c></seealso> + <seealso marker="common_test#Module:suite-0"><c>suite/0</c></seealso> are used. </p> @@ -404,7 +404,7 @@ <marker id="suite"></marker> <title>Test Suite Information Function</title> - <p>Function <seealso marker="common_test_app#Module:suite-0"><c>suite/0</c></seealso> + <p>Function <seealso marker="common_test#Module:suite-0"><c>suite/0</c></seealso> can, for example, be used in a test suite module to set a default <c>timetrap</c> value and to <c>require</c> external configuration data. If a test case, or a group information function also specifies any of the information tags, it @@ -445,7 +445,7 @@ <p>A test case group is a set of test cases sharing configuration functions and execution properties. Test case groups are defined by function - <seealso marker="common_test_app#Module:groups-0"><c>groups/0</c></seealso> + <seealso marker="common_test#Module:groups-0"><c>groups/0</c></seealso> according to the following syntax:</p> <pre> groups() -> GroupDefs @@ -559,12 +559,12 @@ execution is immediately stopped and the remaining cases are skipped.</p> <p>Before execution of a group begins, the configuration function - <seealso marker="common_test_app#Module:init_per_group-2"><c>init_per_group(GroupName, Config)</c></seealso> + <seealso marker="common_test#Module:init_per_group-2"><c>init_per_group(GroupName, Config)</c></seealso> is called. The list of tuples returned from this function is passed to the test cases in the usual manner by argument <c>Config</c>. <c>init_per_group/2</c> is meant to be used for initializations common for the test cases in the group. After execution of the group is finished, function - <seealso marker="common_test_app#Module:end_per_group-2"><c>end_per_group(GroupName, Config)</c></seealso> + <seealso marker="common_test#Module:end_per_group-2"><c>end_per_group(GroupName, Config)</c></seealso> is called. This function is meant to be used for cleaning up after <c>init_per_group/2</c>.</p> @@ -652,7 +652,7 @@ <title>Parallel Test Cases and I/O</title> <p>A parallel test case has a private I/O server as its group leader. (For a description of the group leader concept, see - <seealso marker="erts"><c>ERTS</c></seealso>). + <seealso marker="erts:index"><c>ERTS</c></seealso>). The central I/O server process, which handles the output from regular test cases and configuration functions, does not respond to I/O messages during execution of parallel groups. This is important to understand @@ -1137,7 +1137,7 @@ environment as possible, so that subsequent test cases do not crash because of their execution order. The function - <seealso marker="common_test_app#Module:end_per_testcase-2"><c>end_per_testcase</c></seealso> + <seealso marker="common_test#Module:end_per_testcase-2"><c>end_per_testcase</c></seealso> is suitable for this. </p> </item> |