aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'lib/common_test/doc/src')
-rw-r--r--lib/common_test/doc/src/ct.xml10
-rw-r--r--lib/common_test/doc/src/ct_hooks_chapter.xml16
-rw-r--r--lib/common_test/doc/src/ct_netconfc.xml2
-rw-r--r--lib/common_test/doc/src/ct_rpc.xml4
-rw-r--r--lib/common_test/doc/src/ct_snmp.xml7
-rw-r--r--lib/common_test/doc/src/ct_ssh.xml4
-rw-r--r--lib/common_test/doc/src/dependencies_chapter.xml10
-rw-r--r--lib/common_test/doc/src/test_structure_chapter.xml4
-rw-r--r--lib/common_test/doc/src/write_test_chapter.xml24
9 files changed, 40 insertions, 41 deletions
diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml
index ed3d76061a..d215d68f30 100644
--- a/lib/common_test/doc/src/ct.xml
+++ b/lib/common_test/doc/src/ct.xml
@@ -57,9 +57,9 @@
<item><p><c>data_dir</c> - Data file directory</p></item>
<item><p><c>priv_dir</c> - Scratch file directory</p></item>
<item><p>Whatever added by
- <seealso marker="#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso>
+ <seealso marker="common_test#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso>
or
- <seealso marker="#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso>
+ <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso>
in the test suite.</p></item>
</list>
@@ -359,7 +359,7 @@
Configuration Files</seealso> in the User's Guide.</p>
<p>For details on DES3 encryption/decryption, see application
- <seealso marker="crypto"><c>Crypto</c></seealso>.</p>
+ <seealso marker="crypto:index"><c>Crypto</c></seealso>.</p>
</desc>
</func>
@@ -385,7 +385,7 @@
Configuration Files</seealso> in the User's Guide.</p>
<p>For details on DES3 encryption/decryption, see application
- <seealso marker="crypto"><c>Crypto</c></seealso>.</p>
+ <seealso marker="crypto:index"><c>Crypto</c></seealso>.</p>
</desc>
</func>
@@ -1357,7 +1357,7 @@
<desc><marker id="userdata-2"/>
<p>Returns any data specified with tag <c>userdata</c> in the list
of tuples returned from
- <seealso marker="#Module:suite-0"><c>suite/0</c></seealso>.</p>
+ <seealso marker="common_test#Module:suite-0"><c>suite/0</c></seealso>.</p>
</desc>
</func>
diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml
index 8f48756ada..95943ced94 100644
--- a/lib/common_test/doc/src/ct_hooks_chapter.xml
+++ b/lib/common_test/doc/src/ct_hooks_chapter.xml
@@ -237,10 +237,10 @@
<list type="bulleted">
<item><seealso marker="common_test#Module:init_per_suite-1"><c>init_per_suite</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>init_per_group</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>init_per_testcase</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>end_per_group</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>end_per_suite</c></seealso></item>
+ <item><seealso marker="common_test#Module:init_per_group-2"><c>init_per_group</c></seealso></item>
+ <item><seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase</c></seealso></item>
+ <item><seealso marker="common_test#Module:end_per_group-2"><c>end_per_group</c></seealso></item>
+ <item><seealso marker="common_test#Module:end_per_suite-1"><c>end_per_suite</c></seealso></item>
</list>
<p>
@@ -280,10 +280,10 @@
<p>In a CTH, behavior can be hooked in after the following functions:</p>
<list type="bulleted">
<item><seealso marker="common_test#Module:init_per_suite-1"><c>init_per_suite</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>init_per_group</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>end_per_testcase</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>end_per_group</c></seealso></item>
- <item><seealso marker="common_test#Module:init_per_suite-1"><c>end_per_suite</c></seealso></item>
+ <item><seealso marker="common_test#Module:init_per_group-2"><c>init_per_group</c></seealso></item>
+ <item><seealso marker="common_test#Module:end_per_testcase-2"><c>end_per_testcase</c></seealso></item>
+ <item><seealso marker="common_test#Module:end_per_group-2"><c>end_per_group</c></seealso></item>
+ <item><seealso marker="common_test#Module:end_per_suite-1"><c>end_per_suite</c></seealso></item>
</list>
<p>
diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml
index d181afbb76..77366da891 100644
--- a/lib/common_test/doc/src/ct_netconfc.xml
+++ b/lib/common_test/doc/src/ct_netconfc.xml
@@ -239,7 +239,7 @@
<tag><c>simple_xml() = {xml_tag(), xml_attributes(), xml_content()} | {xml_tag(), xml_content()} | xml_tag()</c></tag>
<item><marker id="type-simple_xml"/>
<p>This type is further described in application
- <seealso marker="xmerl"><c>xmerl</c></seealso>.</p></item>
+ <seealso marker="xmerl:index"><c>xmerl</c></seealso>.</p></item>
<tag><c>stream_data() = {description, string()} | {replaySupport, string()} | {replayLogCreationTime, string()} | {replayLogAgedTime, string()}</c></tag>
<item><marker id="type-stream_data"/>
diff --git a/lib/common_test/doc/src/ct_rpc.xml b/lib/common_test/doc/src/ct_rpc.xml
index 132d04545d..0169727581 100644
--- a/lib/common_test/doc/src/ct_rpc.xml
+++ b/lib/common_test/doc/src/ct_rpc.xml
@@ -73,7 +73,7 @@
</type>
<desc><marker id="app_node-3"/>
<p>Same as
- <seealso marker="app_node-2"><c>ct_rpc:app_node/2</c></seealso>,
+ <seealso marker="#app_node-2"><c>ct_rpc:app_node/2</c></seealso>,
except that argument <c>FailOnBadRPC</c> determines if the search
for a candidate node is to stop if <c>badrpc</c> is received at
some point.</p>
@@ -94,7 +94,7 @@
</type>
<desc><marker id="app_node-4"/>
<p>Same as
- <seealso marker="app_node-2"><c>ct_rpc:app_node/2</c></seealso>,
+ <seealso marker="#app_node-2"><c>ct_rpc:app_node/2</c></seealso>,
except that argument <c>FailOnBadRPC</c> determines if the search
for a candidate node is to stop if <c>badrpc</c> is received at
some point.</p>
diff --git a/lib/common_test/doc/src/ct_snmp.xml b/lib/common_test/doc/src/ct_snmp.xml
index 60f1d600e0..d001fb24ec 100644
--- a/lib/common_test/doc/src/ct_snmp.xml
+++ b/lib/common_test/doc/src/ct_snmp.xml
@@ -148,7 +148,7 @@
<p>SNMP traps, inform, and report messages are handled by the user
callback module. For details, see the
- <seealso marker="snmp"><c>SNMP</c></seealso> application.</p>
+ <seealso marker="snmp:index"><c>SNMP</c></seealso> application.</p>
<p>It is recommended to use the <c>.hrl</c> files created by the
Erlang/OTP MIB compiler to define the Object Identifiers (OIDs).
@@ -160,8 +160,7 @@
<p>Furthermore, values can be set for <c>SNMP</c> application configuration
parameters, <c>config</c>, <c>server</c>, <c>net_if</c>, and so on (for
- a list of valid parameters and types, see the User's Guide for
- the <seealso marker="snmp"><c>SNMP</c></seealso> application). This is
+ a list of valid parameters and types, see the <seealso marker="snmp:users_guide"><c>User's Guide for the SNMP application</c></seealso>). This is
done by defining a configuration data variable on the following form:</p>
<pre>
@@ -236,7 +235,7 @@
<item><marker id="type-varsandvals"/> </item>
</taglist>
<p>These data types are described in the documentation for
- the <seealso marker="snmp"><c>SNMP</c></seealso> application.</p>
+ the <seealso marker="snmp:index"><c>SNMP</c></seealso> application.</p>
</section>
<funcs>
diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml
index 897fd509d3..92b1f60b8c 100644
--- a/lib/common_test/doc/src/ct_ssh.xml
+++ b/lib/common_test/doc/src/ct_ssh.xml
@@ -296,7 +296,7 @@
the configuration data for <c>KeyOrName</c>. The extra options
override any existing options with the same key in the
configuration data. For details on valid SSH options, see
- application <seealso marker="ssh"><c>SSH</c></seealso>.</p>
+ application <seealso marker="ssh:index"><c>SSH</c></seealso>.</p>
</desc>
</func>
@@ -976,7 +976,7 @@ ChannelId, 0, Data, End, Timeout)</c></seealso>.</p>
receive the server response.</p>
<p>For details on argument <c>End</c>, see
- <seealso marker="receive_response-4"><c>ct_ssh:receive_response/4</c></seealso>.</p>
+ <seealso marker="#receive_response-4"><c>ct_ssh:receive_response/4</c></seealso>.</p>
</desc>
</func>
diff --git a/lib/common_test/doc/src/dependencies_chapter.xml b/lib/common_test/doc/src/dependencies_chapter.xml
index d96a41473f..29c54e819a 100644
--- a/lib/common_test/doc/src/dependencies_chapter.xml
+++ b/lib/common_test/doc/src/dependencies_chapter.xml
@@ -87,8 +87,8 @@
<p>To avoid this, we can consider starting and stopping the server for every test.
We can thus implement the start and stop action as common functions to be
called from
- <seealso marker="common_test_app#Module:init_per_testcase-2"><c>init_per_testcase</c></seealso> and
- <seealso marker="common_test_app#Module:end_per_testcase-2"><c>end_per_testcase</c></seealso>.
+ <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase</c></seealso> and
+ <seealso marker="common_test#Module:end_per_testcase-2"><c>end_per_testcase</c></seealso>.
(Remember to test the start and stop functionality separately.)
The configuration can also be implemented as a common function, maybe grouped
with the start function. Finally, the testing of connecting and disconnecting a
@@ -194,9 +194,9 @@
<p>To pass data from one test suite to another, the same mechanism is used. The data
is to be saved by finction
- <seealso marker="common_test_app#Module:end_per_suite-1"><c>end_per_suite</c></seealso>
+ <seealso marker="common_test#Module:end_per_suite-1"><c>end_per_suite</c></seealso>
and read by function
- <seealso marker="common_test_app#Module:init_per_suite-1"><c>init_per_suite</c></seealso>
+ <seealso marker="common_test#Module:init_per_suite-1"><c>init_per_suite</c></seealso>
in the suite that follows. When passing data between suites, <c>Saver</c> carries the
name of the test suite.</p>
@@ -306,7 +306,7 @@
any property, that is, they are not required to also be sequences. If you want the
status of the subgroup to affect the sequence on the level above, return
<c>{return_group_result,Status}</c> from
- <seealso marker="common_test_app#Module:end_per_group-2"><c>end_per_group/2</c></seealso>,
+ <seealso marker="common_test#Module:end_per_group-2"><c>end_per_group/2</c></seealso>,
as described in section
<seealso marker="write_test_chapter#repeated_groups">Repeated Groups</seealso>
in Writing Test Suites.
diff --git a/lib/common_test/doc/src/test_structure_chapter.xml b/lib/common_test/doc/src/test_structure_chapter.xml
index a9e2c0bf9f..8076244928 100644
--- a/lib/common_test/doc/src/test_structure_chapter.xml
+++ b/lib/common_test/doc/src/test_structure_chapter.xml
@@ -60,8 +60,8 @@
</item>
<item>Returning <c>{skip,Reason}</c> from function
- <seealso marker="common_test_app#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> or
- <seealso marker="common_test_app#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso>.</item>
+ <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> or
+ <seealso marker="common_test#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso>.</item>
<item>Returning <c>{skip,Reason}</c> from the execution clause
of the test case. The execution clause is called, so the author
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 3e30974c9f..8c1d104949 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
@@ -1125,7 +1125,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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-28 04:37:48 +0000