diff options
| author | Lukas Larsson <lukas@erlang.org> | 2020-03-09 17:11:17 +0100 |
|---|---|---|
| committer | Lukas Larsson <lukas@erlang.org> | 2020-03-20 11:46:39 +0100 |
| commit | 95e286750901d56e6e25fb13da8fe34f32702594 (patch) | |
| tree | 88a38f19dc2d4b2a45c2ebd89d45e075a0b67a52 /lib/common_test/doc/src | |
| parent | 1223a53aa871b1279cb4a78ec714f5fc1273de9b (diff) | |
| download | erlang-95e286750901d56e6e25fb13da8fe34f32702594.tar.gz | |
otp: Change all MFA links to use "/" syntax for arity
Diffstat (limited to 'lib/common_test/doc/src')
23 files changed, 350 insertions, 350 deletions
diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml index eb42a4e5f5..143984ad6a 100644 --- a/lib/common_test/doc/src/common_test_app.xml +++ b/lib/common_test/doc/src/common_test_app.xml @@ -96,12 +96,12 @@ indicating that the test case shall be repeated. A test case group is represented by a <c>group</c> tuple, where <c>GroupName</c>, an atom, is the name of the group (defined in - <seealso marker="#Module:groups-0"><c>groups/0</c></seealso>). + <seealso marker="#Module:groups/0"><c>groups/0</c></seealso>). Execution properties for groups can also be specified, both for a top-level group and for any of its subgroups. Group execution properties specified here override properties in the group definition (see - <seealso marker="#Module:groups-0"><c>groups/0</c></seealso>). + <seealso marker="#Module:groups/0"><c>groups/0</c></seealso>). (With value <c>default</c>, the group definition properties are used).</p> @@ -180,9 +180,9 @@ <p>Tag <c>timetrap</c> sets the maximum time that each test case is allowed to execute (including - <seealso marker="#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> + <seealso marker="#Module:init_per_testcase/2"><c>init_per_testcase/2</c></seealso> and - <seealso marker="#Module:end_per_testcase-2"><c>end_per_testcase/2</c></seealso>). + <seealso marker="#Module:end_per_testcase/2"><c>end_per_testcase/2</c></seealso>). If the timetrap time is exceeded, the test case fails with reason <c>timetrap_timeout</c>. A <c>TimeFunc</c> function can be used to set a new timetrap by returning a <c>TimeVal</c>. It can also be @@ -196,12 +196,12 @@ in the suite. If the required configuration variables are not found in any of the configuration files, all test cases are skipped. For details about the <c>require</c> functionality, see funtion - <seealso marker="ct#require-1"><c>ct:require/1,2</c></seealso>.</p> + <seealso marker="ct#require/1"><c>ct:require/1,2</c></seealso>.</p> <p>With <c>userdata</c>, the user can specify any test suite-related information, which can be read by calling - <seealso marker="ct#userdata-2"><c>ct:userdata/2</c></seealso>.</p> + <seealso marker="ct#userdata/2"><c>ct:userdata/2</c></seealso>.</p> <p>Tag <c>ct_hooks</c> specifies the <seealso marker="ct_hooks_chapter">Common Test Hooks</seealso> @@ -228,7 +228,7 @@ <desc> <p>OPTIONAL; if this function is defined, then <seealso - marker="#Module:end_per_suite-1"><c>end_per_suite/1</c></seealso> + marker="#Module:end_per_suite/1"><c>end_per_suite/1</c></seealso> must also be defined.</p> <p>This configuration function is called as the first function in the @@ -262,12 +262,12 @@ <desc> <p>OPTIONAL; if this function is defined, then <seealso - marker="#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso> + marker="#Module:init_per_suite/1"><c>init_per_suite/1</c></seealso> must also be defined.</p> <p>This function is called as the last test case in the suite. It is meant to be used for cleaning up after - <seealso marker="#Module:init_per_suite-1"><c>init_per_suite/1</c></seealso>.</p> + <seealso marker="#Module:init_per_suite/1"><c>init_per_suite/1</c></seealso>.</p> <p>For information on <c>save_config</c>, see section <seealso marker="dependencies_chapter#save_config">Saving Configuration Data</seealso> in the User's Guide.</p> @@ -311,15 +311,15 @@ return a list of tagged tuples that specify various properties related to the execution of a test case group (that is, its test cases and subgroups). Properties set by - <seealso marker="#Module:group-1"><c>group/1</c></seealso> override + <seealso marker="#Module:group/1"><c>group/1</c></seealso> override properties with the same key that have been set previously by - <seealso marker="#Module:suite-0"><c>suite/0</c></seealso>.</p> + <seealso marker="#Module:suite/0"><c>suite/0</c></seealso>.</p> <p>Tag <c>timetrap</c> sets the maximum time that each test case is allowed to execute (including - <seealso marker="#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> + <seealso marker="#Module:init_per_testcase/2"><c>init_per_testcase/2</c></seealso> and - <seealso marker="#Module:end_per_testcase-2"><c>end_per_testcase/2</c></seealso>). + <seealso marker="#Module:end_per_testcase/2"><c>end_per_testcase/2</c></seealso>). If the timetrap time is exceeded, the test case fails with reason <c>timetrap_timeout</c>. A <c>TimeFunc</c> function can be used to @@ -335,12 +335,12 @@ in any of the configuration files, all test cases in this group are skipped. For details about the <c>require</c> functionality, see function - <seealso marker="ct#require-1"><c>ct:require/1,2</c></seealso>.</p> + <seealso marker="ct#require/1"><c>ct:require/1,2</c></seealso>.</p> <p>With <c>userdata</c>, the user can specify any test case group related information that can be read by calling - <seealso marker="ct#userdata-2"><c>ct:userdata/2</c></seealso>.</p> + <seealso marker="ct#userdata/2"><c>ct:userdata/2</c></seealso>.</p> <p>Tag <c>ct_hooks</c> specifies the <seealso marker="ct_hooks_chapter">Common Test Hooks</seealso> @@ -368,7 +368,7 @@ <desc> <p>OPTIONAL; if this function is defined, then <seealso - marker="#Module:end_per_group-2"><c>end_per_group/2</c></seealso> + marker="#Module:end_per_group/2"><c>end_per_group/2</c></seealso> must also be defined.</p> <p>This configuration function is called before execution of a @@ -376,7 +376,7 @@ common for all test cases and subgroups in the group, and that must only be performed once. <c>GroupName</c> is the name of the group, as specified in the group definition (see - <seealso marker="#Module:groups-0"><c>groups/0</c></seealso>). + <seealso marker="#Module:groups/0"><c>groups/0</c></seealso>). Parameter <c>Config</c> is the configuration data that can be modified. The return value of this function is given as <c>Config</c> @@ -406,15 +406,15 @@ <desc> <p>OPTIONAL; if this function is defined, then <seealso - marker="#Module:init_per_group-2"><c>init_per_group/2</c></seealso> + marker="#Module:init_per_group/2"><c>init_per_group/2</c></seealso> must also be defined.</p> <p>This function is called after the execution of a test case group is finished. It is meant to be used for cleaning up after - <seealso marker="#Module:init_per_group-2"><c>init_per_group/2</c></seealso>. + <seealso marker="#Module:init_per_group/2"><c>init_per_group/2</c></seealso>. A status value for a nested subgroup can be returned with <c>{return_group_result,Status}</c>. The status can be retrieved in - <seealso marker="#Module:end_per_group-2"><c>end_per_group/2</c></seealso> + <seealso marker="#Module:end_per_group/2"><c>end_per_group/2</c></seealso> for the group on the level above. The status is also used by <c>Common Test</c> for deciding if execution of a group is to proceed if property <c>sequence</c> or <c>repeat_until_*</c> @@ -439,7 +439,7 @@ <desc> <p>OPTIONAL; if this function is defined, - then <seealso marker="#Module:end_per_testcase-2"> + then <seealso marker="#Module:end_per_testcase/2"> <c>end_per_testcase/2</c></seealso> must also be defined.</p> @@ -469,13 +469,13 @@ <desc> <p>OPTIONAL; if this function is defined, - then <seealso marker="#Module:init_per_testcase-2"> + then <seealso marker="#Module:init_per_testcase/2"> <c>init_per_testcase/2</c></seealso> must also be defined.</p> <p>This function is called after each test case, and can be used to clean up after - <seealso marker="#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> + <seealso marker="#Module:init_per_testcase/2"><c>init_per_testcase/2</c></seealso> and the test case. Any return value (besides <c>{fail,Reason}</c> and <c>{save_config,SaveConfig}</c>) is ignored. By returning <c>{fail,Reason}</c>, <c>TestCase</c> is marked as faulty (even @@ -518,17 +518,17 @@ return a list of tagged tuples that specify various properties related to the execution of this particular test case. Properties set by - <seealso marker="#Module:Testcase-0"><c>Testcase/0</c></seealso> + <seealso marker="#Module:Testcase/0"><c>Testcase/0</c></seealso> override properties set previously for the test case by - <seealso marker="#Module:group-1"><c>group/1</c></seealso> or - <seealso marker="#Module:suite-0"><c>suite/0</c></seealso>.</p> + <seealso marker="#Module:group/1"><c>group/1</c></seealso> or + <seealso marker="#Module:suite/0"><c>suite/0</c></seealso>.</p> <p>Tag <c>timetrap</c> sets the maximum time that the test case is allowed to execute. If the timetrap time is exceeded, the test case fails with reason <c>timetrap_timeout</c>. - <seealso marker="#Module:init_per_testcase-2"><c>init_per_testcase/2</c></seealso> + <seealso marker="#Module:init_per_testcase/2"><c>init_per_testcase/2</c></seealso> and - <seealso marker="#Module:end_per_testcase-2"><c>end_per_testcase/2</c></seealso> + <seealso marker="#Module:end_per_testcase/2"><c>end_per_testcase/2</c></seealso> are included in the timetrap time. A <c>TimeFunc</c> function can be used to set a new timetrap by returning a <c>TimeVal</c>. It can also be @@ -543,16 +543,16 @@ If the required configuration variables are not found in any of the configuration files, the test case is skipped. For details about the <c>require</c> functionality, see function - <seealso marker="ct#require-1"><c>ct:require/1,2</c></seealso>.</p> + <seealso marker="ct#require/1"><c>ct:require/1,2</c></seealso>.</p> <p>If <c>timetrap</c> or <c>require</c> is not set, the default values specified by - <seealso marker="#Module:suite-0"><c>suite/0</c></seealso> (or - <seealso marker="#Module:group-1"><c>group/1</c></seealso>) are used.</p> + <seealso marker="#Module:suite/0"><c>suite/0</c></seealso> (or + <seealso marker="#Module:group/1"><c>group/1</c></seealso>) are used.</p> <p>With <c>userdata</c>, the user can specify any test case-related information that can be read by calling - <seealso marker="ct#userdata-3"><c>ct:userdata/3</c></seealso>.</p> + <seealso marker="ct#userdata/3"><c>ct:userdata/3</c></seealso>.</p> <p>Other tuples than the ones defined are ignored.</p> @@ -579,7 +579,7 @@ <p>The implementation of a test case. Call the functions to test and check the result. If something fails, ensure the function causes a runtime error or call - <seealso marker="ct#fail-1"><c>ct:fail/1,2</c></seealso> + <seealso marker="ct#fail/1"><c>ct:fail/1,2</c></seealso> (which also causes the test case process to terminate).</p> <p>Elements from the <c>Config</c> list can, for example, be read diff --git a/lib/common_test/doc/src/config_file_chapter.xml b/lib/common_test/doc/src/config_file_chapter.xml index db93744214..2f7a630092 100644 --- a/lib/common_test/doc/src/config_file_chapter.xml +++ b/lib/common_test/doc/src/config_file_chapter.xml @@ -81,7 +81,7 @@ test is skipped (unless a default value has been specified, see section <seealso marker="write_test_chapter#info_function">Test Case Information Function</seealso> for details). Also, function - <seealso marker="ct#require-1"><c>ct:require/1/2</c></seealso> can be called + <seealso marker="ct#require/1"><c>ct:require/1/2</c></seealso> can be called from a test case to check if a specific variable is available. The return value from this function must be checked explicitly and appropriate action be taken depending on the result (for example, to skip the test case @@ -91,7 +91,7 @@ information-list is to look like <c>{require,CfgVarName}</c> or <c>{require,AliasName,CfgVarName}</c>. The arguments <c>AliasName</c> and <c>CfgVarName</c> are the same as the - arguments to <seealso marker="ct#require-1"><c>ct:require/1,2</c></seealso>. + arguments to <seealso marker="ct#require/1"><c>ct:require/1,2</c></seealso>. <c>AliasName</c> becomes an alias for the configuration variable, and can be used as reference to the configuration data value. The configuration variable can be associated with any @@ -103,7 +103,7 @@ (or test case) and improve readability.</item> </list> <p>To read the value of a configuration variable, use function - <seealso marker="ct#get_config-1"><c>get_config/1,2,3</c></seealso>. + <seealso marker="ct#get_config/1"><c>get_config/1,2,3</c></seealso>. </p> <p><em>Example:</em></p> <pre> @@ -121,7 +121,7 @@ <title>Using Configuration Variables Defined in Multiple Files</title> <p>If a configuration variable is defined in multiple files and you want to access all possible values, use function - <seealso marker="ct#get_config-3"><c>ct:get_config/3</c></seealso> + <seealso marker="ct#get_config/3"><c>ct:get_config/3</c></seealso> and specify <c>all</c> in the options list. The values are then returned in a list and the order of the elements corresponds to the order that the configuration files were specified at startup.</p> @@ -134,7 +134,7 @@ if they must be stored in open and shared directories.</p> <p>To have <c>Common Test</c> encrypt a specified file using function <c>DES3</c> in application <c>Crypto</c>, - call <seealso marker="ct#encrypt_config_file-2"><c>ct:encrypt_config_file/2,3</c></seealso> + call <seealso marker="ct#encrypt_config_file/2"><c>ct:encrypt_config_file/2,3</c></seealso> The encrypted file can then be used as a regular configuration file in combination with other encrypted files or normal text files. However, the key for decrypting the configuration file must be provided when running the test. @@ -142,7 +142,7 @@ <c>decrypt_file</c>, or a key file in a predefined location.</p> <p><c>Common Test</c> also provides decryption functions, - <seealso marker="ct#decrypt_config_file-2"><c>ct:decrypt_config_file/2,3</c></seealso>, + <seealso marker="ct#decrypt_config_file/2"><c>ct:decrypt_config_file/2,3</c></seealso>, for recreating the original text files.</p> </section> @@ -457,7 +457,7 @@ <p>Here, the handler also provides for dynamically reloading of configuration variables. If - <seealso marker="ct#reload_config-1"><c>ct:reload_config(localtime)</c></seealso> is called from + <seealso marker="ct#reload_config/1"><c>ct:reload_config(localtime)</c></seealso> is called from the test case function, all variables loaded with <c>config_driver:read_config/1</c> are updated with their latest values, and the new value for variable <c>localtime</c> is returned.</p> diff --git a/lib/common_test/doc/src/cover_chapter.xml b/lib/common_test/doc/src/cover_chapter.xml index 6d063e8b2f..06a03c0d84 100644 --- a/lib/common_test/doc/src/cover_chapter.xml +++ b/lib/common_test/doc/src/cover_chapter.xml @@ -91,7 +91,7 @@ $ ct_run -dir $TESTOBJS/db -cover $TESTOBJS/db/config/db.coverspec</pre> <p>You can also pass the cover specification file name in a - call to <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>, + call to <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>, by adding a <c>{cover,CoverSpec}</c> tuple to argument <c>Opts</c>.</p> <p>You can also enable code coverage in your test specifications (see section <seealso marker="run_test_chapter#test_specifications">Test Specifications</seealso> @@ -116,7 +116,7 @@ <p>The option can be set by using flag <c>-cover_stop</c> with <c>ct_run</c>, by adding <c>{cover_stop,true|false}</c> to argument <c>Opts</c> to - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>, + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>, or by adding a <c>cover_stop</c> term in the test specification (see section <seealso marker="run_test_chapter#test_specifications">Test Specifications</seealso> in section Running Tests and Analyzing Results).</p> @@ -257,7 +257,7 @@ <p>Then <c>m1</c> is cover compiled in test run <c>s2</c>, but not shown in the coverage log. Instead, if - <seealso marker="ct_cover#cross_cover_analyse-2"><c>ct_cover:cross_cover_analyse/2</c></seealso> + <seealso marker="ct_cover#cross_cover_analyse/2"><c>ct_cover:cross_cover_analyse/2</c></seealso> is called after both <c>s1</c> and <c>s2</c> test runs are completed, the accumulated result for <c>m1</c> is available in the cross cover log for test run <c>s1</c>.</p> diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml index 83c0ecb309..1ce033c408 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="common_test#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="common_test#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> @@ -92,7 +92,7 @@ <item> <p>A name and association to configuration data introduced through a require statement, or a call to - <seealso marker="#require-2"><c>ct:require/2</c></seealso>, + <seealso marker="#require/2"><c>ct:require/2</c></seealso>, for example, <c>ct:require(mynodename,{node,[telnet]})</c>.</p> </item> @@ -170,7 +170,7 @@ configuration string. The callback module is to be either loaded or present in the code part. Loaded configuration variables can later be removed using function - <seealso marker="#remove_config-2"><c>ct:remove_config/2</c></seealso>. + <seealso marker="#remove_config/2"><c>ct:remove_config/2</c></seealso>. </p> </desc> </func> @@ -190,11 +190,11 @@ The user can then interact with the Erlang node running the tests, for example, for debugging purposes or for manually executing a part of the test case. If a parallel group is executing, - <seealso marker="#break-2"><c>ct:break/2</c></seealso> is to be + <seealso marker="#break/2"><c>ct:break/2</c></seealso> is to be called instead.</p> <p>A cancelled timetrap is not automatically reactivated after the break, but must be started exlicitly with - <seealso marker="#timetrap-1"><c>ct:timetrap/1</c></seealso>.</p> + <seealso marker="#timetrap/1"><c>ct:timetrap/1</c></seealso>.</p> <p>In order for the break/continue functionality to work, <c>Common Test</c> must release the shell process controlling <c>stdin</c>. This is done by setting start option <c>release_shell</c> @@ -216,10 +216,10 @@ </type> <desc><marker id="break-2"/> <p>Works the same way as - <seealso marker="#break-1"><c>ct:break/1</c></seealso>, only + <seealso marker="#break/1"><c>ct:break/1</c></seealso>, only argument <c>TestCase</c> makes it possible to pause a test case executing in a parallel group. Function - <seealso marker="#continue-1"><c>ct:continue/1</c></seealso> is to + <seealso marker="#continue/1"><c>ct:continue/1</c></seealso> is to be used to resume execution of <c>TestCase</c>.</p> <p>For details, see @@ -235,7 +235,7 @@ </type> <desc><marker id="capture_get-0"/> <p>Equivalent to - <seealso marker="#capture_get-1">ct:capture_get([default])</seealso>.</p> + <seealso marker="#capture_get/1">ct:capture_get([default])</seealso>.</p> </desc> </func> @@ -255,9 +255,9 @@ If <c>ExclCategories = []</c>, no filtering takes place.</p> <p>See also - <seealso marker="#capture_start-0"><c>ct:capture_start/0</c></seealso>, - <seealso marker="#capture_stop-0"><c>ct:capture_stop/0</c></seealso>, - <seealso marker="#log-3"><c>ct:log/3</c></seealso>.</p> + <seealso marker="#capture_start/0"><c>ct:capture_start/0</c></seealso>, + <seealso marker="#capture_stop/0"><c>ct:capture_stop/0</c></seealso>, + <seealso marker="#log/3"><c>ct:log/3</c></seealso>.</p> </desc> </func> @@ -270,8 +270,8 @@ during execution of the test case.</p> <p>See also - <seealso marker="#capture_get-1"><c>ct:capture_get/1</c></seealso>, - <seealso marker="#capture_stop-0"><c>ct:capture_stop/0</c></seealso>.</p> + <seealso marker="#capture_get/1"><c>ct:capture_get/1</c></seealso>, + <seealso marker="#capture_stop/0"><c>ct:capture_stop/0</c></seealso>.</p> </desc> </func> @@ -284,8 +284,8 @@ <c>capture_start/0</c>).</p> <p>See also - <seealso marker="#capture_get-1"><c>ct:capture_get/1</c></seealso>, - <seealso marker="#capture_start-0"><c>ct:capture_start/0</c></seealso>.</p> + <seealso marker="#capture_get/1"><c>ct:capture_get/1</c></seealso>, + <seealso marker="#capture_start/0"><c>ct:capture_start/0</c></seealso>.</p> </desc> </func> @@ -321,7 +321,7 @@ <p>Arguments <c>Format</c> and <c>Args</c> are used in a call to <c>io_lib:format/2</c> to create the comment string. The behavior of <c>comment/2</c> is otherwise the same as function - <seealso marker="#comment-1"><c>ct:comment/1</c></seealso>.</p> + <seealso marker="#comment/1"><c>ct:comment/1</c></seealso>.</p> </desc> </func> @@ -332,7 +332,7 @@ <desc><marker id="continue-0"/> <p>This function must be called to continue after a test case (not executing in a parallel group) has called function - <seealso marker="#break-1"><c>ct:break/1</c></seealso>.</p> + <seealso marker="#break/1"><c>ct:break/1</c></seealso>.</p> </desc> </func> @@ -345,7 +345,7 @@ </type> <desc><marker id="continue-1"/> <p>This function must be called to continue after a test case has - called <seealso marker="#break-2"><c>ct:break/2</c></seealso>. + called <seealso marker="#break/2"><c>ct:break/2</c></seealso>. If the paused test case, <c>TestCase</c>, executes in a parallel group, this function, rather than <c>continue/0</c>, must be used to let the test case proceed.</p> @@ -363,7 +363,7 @@ </type> <desc><marker id="decrypt_config_file-2"/> <p>Decrypts <c>EncryptFileName</c>, previously generated with - <seealso marker="#encrypt_config_file-2"><c>ct:encrypt_config_file/2,3</c></seealso>. + <seealso marker="#encrypt_config_file/2"><c>ct:encrypt_config_file/2,3</c></seealso>. The original file contents is saved in the target file. The encryption key, a string, must be available in a text file named <c>.ct_config.crypt</c>, either in the current directory, or the @@ -383,7 +383,7 @@ </type> <desc><marker id="decrypt_config_file-3"/> <p>Decrypts <c>EncryptFileName</c>, previously generated with - <seealso marker="#encrypt_config_file-2"><c>ct:encrypt_config_file/2,3</c></seealso>. + <seealso marker="#encrypt_config_file/2"><c>ct:encrypt_config_file/2,3</c></seealso>. The original file contents is saved in the target file. The key must have the same value as that used for encryption.</p> </desc> @@ -473,7 +473,7 @@ <name since="">get_config(Required) -> Value</name> <fsummary>Equivalent to get_config(Required, undefined, []).</fsummary> <desc><marker id="get_config-1"/> - <p>Equivalent to <seealso marker="#get_config-3"><c>ct:get_config(Required, + <p>Equivalent to <seealso marker="#get_config/3"><c>ct:get_config(Required, undefined, [])</c></seealso>.</p> </desc> </func> @@ -482,7 +482,7 @@ <name since="">get_config(Required, Default) -> Value</name> <fsummary>Equivalent to get_config(Required, Default, []).</fsummary> <desc><marker id="get_config-2"/> - <p>Equivalent to <seealso marker="#get_config-3"><c>ct:get_config(Required, + <p>Equivalent to <seealso marker="#get_config/3"><c>ct:get_config(Required, Default, [])</c></seealso>.</p> </desc> </func> @@ -505,7 +505,7 @@ <p>Returns the matching values or configuration elements, given a configuration variable key or its associated name (if one has been specified with - <seealso marker="#require-2"><c>ct:require/2</c></seealso> + <seealso marker="#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement).</p> <p><em>Example:</em></p> @@ -528,7 +528,7 @@ ct:get_config(unknownkey,Default) -> Default</pre> <p>If a configuration variable key has been associated with a name (by - <seealso marker="#require-2"><c>ct:require/2</c></seealso> + <seealso marker="#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement), the name can be used instead of the key to read the value:</p> @@ -546,10 +546,10 @@ returned elements are then on the form <c>{Required,Value}</c>.</p> <p>See also - <seealso marker="#get_config-1"><c>ct:get_config/1</c></seealso>, - <seealso marker="#get_config-2"><c>ct:get_config/2</c></seealso>, - <seealso marker="#require-1"><c>ct:require/1</c></seealso>, - <seealso marker="#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="#get_config/1"><c>ct:get_config/1</c></seealso>, + <seealso marker="#get_config/2"><c>ct:get_config/2</c></seealso>, + <seealso marker="#require/1"><c>ct:require/1</c></seealso>, + <seealso marker="#require/2"><c>ct:require/2</c></seealso>.</p> </desc> </func> @@ -744,7 +744,7 @@ <fsummary>Equivalent to log(default, 50, Format, [], []).</fsummary> <desc><marker id="log-1"/> <p>Equivalent to - <seealso marker="#log-5"><c>ct:log(default, 50, Format, [], [])</c></seealso>.</p> + <seealso marker="#log/5"><c>ct:log(default, 50, Format, [], [])</c></seealso>.</p> </desc> </func> @@ -757,7 +757,7 @@ <v>X2 = Format | FormatArgs</v> </type> <desc><marker id="log-2"/> - <p>Equivalent to <seealso marker="#log-5"><c>ct:log(Category, + <p>Equivalent to <seealso marker="#log/5"><c>ct:log(Category, Importance, Format, FormatArgs, [])</c></seealso>.</p> </desc> </func> @@ -772,7 +772,7 @@ <v>X3 = Format | FormatArgs | Opts</v> </type> <desc><marker id="log-3"/> - <p>Equivalent to <seealso marker="#log-5"><c>ct:log(Category, + <p>Equivalent to <seealso marker="#log/5"><c>ct:log(Category, Importance, Format, FormatArgs, Opts)</c></seealso>.</p> </desc> </func> @@ -788,7 +788,7 @@ <v>X4 = FormatArgs | Opts</v> </type> <desc><marker id="log-4"/> - <p>Equivalent to <seealso marker="#log-5"><c>ct:log(Category, + <p>Equivalent to <seealso marker="#log/5"><c>ct:log(Category, Importance, Format, FormatArgs, Opts)</c></seealso>.</p> </desc> </func> @@ -863,7 +863,7 @@ <fsummary>Equivalent to pal(default, 50, Format, [], []).</fsummary> <desc><marker id="pal-1"/> <p>Equivalent to - <seealso marker="#pal-5"><c>ct:pal(default, 50, Format, + <seealso marker="#pal/5"><c>ct:pal(default, 50, Format, [], [])</c></seealso>.</p> </desc> </func> @@ -877,7 +877,7 @@ <v>X2 = Format | FormatArgs</v> </type> <desc><marker id="pal-2"/> - <p>Equivalent to <seealso marker="#pal-5"><c>ct:pal(Category, + <p>Equivalent to <seealso marker="#pal/5"><c>ct:pal(Category, Importance, Format, FormatArgs, [])</c></seealso>.</p> </desc> </func> @@ -892,7 +892,7 @@ <v>X3 = Format | FormatArgs | Opts</v> </type> <desc><marker id="pal-3"/> - <p>Equivalent to <seealso marker="#pal-5"><c>ct:pal(Category, + <p>Equivalent to <seealso marker="#pal/5"><c>ct:pal(Category, Importance, Format, FormatArgs, Opts)</c></seealso>.</p> </desc> </func> @@ -908,7 +908,7 @@ <v>X4 = FormatArgs | Opts</v> </type> <desc><marker id="pal-4"/> - <p>Equivalent to <seealso marker="#pal-5"><c>ct:pal(Category, + <p>Equivalent to <seealso marker="#pal/5"><c>ct:pal(Category, Importance, Format, FormatArgs, Opts)</c></seealso>.</p> </desc> </func> @@ -970,7 +970,7 @@ <name since="">print(Format) -> ok</name> <fsummary>Equivalent to print(default, 50, Format, [], []).</fsummary> <desc><marker id="print-1"/> - <p>Equivalent to <seealso marker="#print-5"><c>ct:print(default, + <p>Equivalent to <seealso marker="#print/5"><c>ct:print(default, 50, Format, [], [])</c></seealso>.</p> </desc> </func> @@ -984,7 +984,7 @@ <v>X2 = Format | FormatArgs</v> </type> <desc><marker id="print-2"/> - <p>Equivalent to <seealso marker="#print-5"><c>ct:print(Category, + <p>Equivalent to <seealso marker="#print/5"><c>ct:print(Category, Importance, Format, FormatArgs, [])</c></seealso>.</p> </desc> </func> @@ -999,7 +999,7 @@ <v>X3 = Format | FormatArgs | Opts</v> </type> <desc><marker id="print-3"/> - <p>Equivalent to <seealso marker="#print-5"><c>ct:print(Category, + <p>Equivalent to <seealso marker="#print/5"><c>ct:print(Category, Importance, Format, FormatArgs, Opts)</c></seealso>.</p> </desc> </func> @@ -1015,7 +1015,7 @@ <v>X4 = FormatArgs | Opts</v> </type> <desc><marker id="print-4"/> - <p>Equivalent to <seealso marker="#print-5"><c>ct:print(Category, + <p>Equivalent to <seealso marker="#print/5"><c>ct:print(Category, Importance, Format, FormatArgs, Opts)</c></seealso>.</p> </desc> </func> @@ -1170,10 +1170,10 @@ {myvar,[{sub1,[{sub2,Value}]}]}.</pre> <p>See also - <seealso marker="#get_config-1"><c>ct:get_config/1</c></seealso>, - <seealso marker="#get_config-2"><c>ct:get_config/2</c></seealso>, - <seealso marker="#get_config-3"><c>ct:get_config/3</c></seealso>, - <seealso marker="#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="#get_config/1"><c>ct:get_config/1</c></seealso>, + <seealso marker="#get_config/2"><c>ct:get_config/2</c></seealso>, + <seealso marker="#get_config/3"><c>ct:get_config/3</c></seealso>, + <seealso marker="#require/2"><c>ct:require/2</c></seealso>.</p> </desc> </func> @@ -1190,12 +1190,12 @@ <desc><marker id="require-2"/> <p>Checks if the required configuration is available and gives it a name. The semantics for <c>Required</c> is the same as in - <seealso marker="#require-1"><c>ct:require/1</c></seealso> except + <seealso marker="#require/1"><c>ct:require/1</c></seealso> except that a list of <c>SubKey</c>s cannot be specified.</p> <p>If the requested data is available, the subentry is associated with <c>Name</c> so that the value of the element can be read with - <seealso marker="#get_config-1"><c>ct:get_config/1,2</c></seealso> + <seealso marker="#get_config/1"><c>ct:get_config/1,2</c></seealso> provided <c>Name</c> is used instead of the whole <c>Required</c> term.</p> @@ -1229,10 +1229,10 @@ </note> <p>See also - <seealso marker="#get_config-1"><c>ct:get_config/1</c></seealso>, - <seealso marker="#get_config-2"><c>ct:get_config/2</c></seealso>, - <seealso marker="#get_config-3"><c>ct:get_config/3</c></seealso>, - <seealso marker="#require-1"><c>ct:require/1</c></seealso>.</p> + <seealso marker="#get_config/1"><c>ct:get_config/1</c></seealso>, + <seealso marker="#get_config/2"><c>ct:get_config/2</c></seealso>, + <seealso marker="#get_config/3"><c>ct:get_config/3</c></seealso>, + <seealso marker="#require/1"><c>ct:require/1</c></seealso>.</p> </desc> </func> @@ -1246,7 +1246,7 @@ <desc><marker id="run-1"/> <p>Runs all test cases in all suites in the specified directories.</p> - <p>See also <seealso marker="#run-3"><c>ct:run/3</c></seealso>.</p> + <p>See also <seealso marker="#run/3"><c>ct:run/3</c></seealso>.</p> </desc> </func> @@ -1256,7 +1256,7 @@ <desc><marker id="run-2"/> <p>Runs all test cases in the specified suite.</p> - <p>See also <seealso marker="#run-3"><c>ct:run/3</c></seealso>.</p> + <p>See also <seealso marker="#run/3"><c>ct:run/3</c></seealso>.</p> </desc> </func> @@ -1273,7 +1273,7 @@ <p>Runs the specified test cases.</p> <p>Requires that - <seealso marker="#install-1"><c>ct:install/1</c></seealso> has been + <seealso marker="#install/1"><c>ct:install/1</c></seealso> has been run first.</p> <p>Suites (<c>*_SUITE.erl</c>) files must be stored in <c>TestDir</c> @@ -1348,7 +1348,7 @@ <p><c>TestRunnerPid</c> is returned if <c>release_shell == true</c>. For details, see - <seealso marker="#break-1"><c>ct:break/1</c></seealso>.</p> + <seealso marker="#break/1"><c>ct:break/1</c></seealso>.</p> <p><c>Reason</c> indicates the type of error encountered.</p> </desc> @@ -1425,7 +1425,7 @@ <p>If any functions (for example, Telnet or FTP) using "required configuration data" are to be called from the Erlang shell, configuration data must first be required with - <seealso marker="#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="#require/2"><c>ct:require/2</c></seealso>.</p> <p><em>Example:</em></p> @@ -1448,7 +1448,7 @@ <desc><marker id="step-3"/> <p>Steps through a test case with the debugger.</p> - <p>See also <seealso marker="#run-3"><c>ct:run/3</c></seealso>.</p> + <p>See also <seealso marker="#run/3"><c>ct:run/3</c></seealso>.</p> </desc> </func> @@ -1465,7 +1465,7 @@ <c>config</c> has been specifed, breakpoints are also set on the configuration functions in <c>Suite</c>.</p> - <p>See also <seealso marker="#run-3"><c>ct:run/3</c></seealso>.</p> + <p>See also <seealso marker="#run/3"><c>ct:run/3</c></seealso>.</p> </desc> </func> @@ -1476,7 +1476,7 @@ <p>Exits the interactive mode.</p> <p>See also - <seealso marker="#start_interactive-0"><c>ct:start_interactive/0</c></seealso>. + <seealso marker="#start_interactive/0"><c>ct:start_interactive/0</c></seealso>. </p> </desc> </func> @@ -1551,7 +1551,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="common_test#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_cover.xml b/lib/common_test/doc/src/ct_cover.xml index 70ea9b65ed..03a405abed 100644 --- a/lib/common_test/doc/src/ct_cover.xml +++ b/lib/common_test/doc/src/ct_cover.xml @@ -94,7 +94,7 @@ <p>Call this function to stop cover test on nodes previously added with - <seealso marker="#add_nodes-1"><c>ct_cover:add_nodes/1</c></seealso>. + <seealso marker="#add_nodes/1"><c>ct_cover:add_nodes/1</c></seealso>. Results on the remote node are transferred to the <c>Common Test</c> node.</p> </desc> diff --git a/lib/common_test/doc/src/ct_ftp.xml b/lib/common_test/doc/src/ct_ftp.xml index 7ee6049486..38b8e51407 100644 --- a/lib/common_test/doc/src/ct_ftp.xml +++ b/lib/common_test/doc/src/ct_ftp.xml @@ -111,13 +111,13 @@ <p><c>RemoteFile</c> and <c>LocalFile</c> must be absolute paths.</p> <p>The configuration file must be as for - <seealso marker="#put-3"><c>ct_ftp:put/3</c></seealso>.</p> + <seealso marker="#put/3"><c>ct_ftp:put/3</c></seealso>.</p> <p>For <c>target_name</c>, see module <seealso marker="ct"><c>ct</c></seealso>.</p> <p>See also - <seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="ct#require/2"><c>ct:require/2</c></seealso>.</p> </desc> </func> @@ -156,7 +156,7 @@ with the handle value.</p> <p>For information on how to create a new <c>Name</c>, see - <seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="ct#require/2"><c>ct:require/2</c></seealso>.</p> <p>For <c>target_name</c>, see module <seealso marker="ct"><c>ct</c></seealso>.</p> @@ -198,7 +198,7 @@ {password,Password}]}.</pre> <p>See also - <seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="ct#require/2"><c>ct:require/2</c></seealso>.</p> </desc> </func> @@ -210,7 +210,7 @@ <p>The file gets the same name on the local host.</p> - <p>See also <seealso marker="#recv-3"><c>ct_ftp:recv/3</c></seealso>.</p> + <p>See also <seealso marker="#recv/3"><c>ct_ftp:recv/3</c></seealso>.</p> </desc> </func> @@ -238,7 +238,7 @@ <p>The file gets the same name on the remote host.</p> <p>See also - <seealso marker="#send-3"><c>ct_ftp:send/3</c></seealso>.</p> + <seealso marker="#send/3"><c>ct_ftp:send/3</c></seealso>.</p> </desc> </func> diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml index cd9323a5ff..c98caee06d 100644 --- a/lib/common_test/doc/src/ct_hooks.xml +++ b/lib/common_test/doc/src/ct_hooks.xml @@ -91,11 +91,11 @@ this CTH.</p> <p><c>Id</c> is either the return value of - <seealso marker="#Module:id-1"><c>ct_hooks:id/1</c></seealso>, + <seealso marker="#Module:id/1"><c>ct_hooks:id/1</c></seealso>, or a <c>reference</c> (created using - <seealso marker="erts:erlang#make_ref-0">erlang:make_ref/0</seealso> + <seealso marker="erts:erlang#make_ref/0">erlang:make_ref/0</seealso> in ERTS) if - <seealso marker="#Module:id-1"><c>ct_hooks:id/1</c></seealso> + <seealso marker="#Module:id/1"><c>ct_hooks:id/1</c></seealso> is not implemented.</p> <p><c>Priority</c> is the relative priority of this hook. Hooks with a @@ -129,12 +129,12 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#Module:groups-0"><c>groups/0</c></seealso>. + <seealso marker="common_test#Module:groups/0"><c>groups/0</c></seealso>. It is used to modify the test group definitions, for instance to add or remove groups or change group properties.</p> <p><c>GroupDefs</c> is what - <seealso marker="common_test#Module:groups-0"><c>groups/0</c></seealso> + <seealso marker="common_test#Module:groups/0"><c>groups/0</c></seealso> returned, that is, a list of group definitions.</p> <p><c>NewGroupDefs</c> is the possibly modified version of this list.</p> @@ -145,12 +145,12 @@ in the User's Guide.</p> <p>Notice that for CTHs that are installed by means of the - <seealso marker="common_test#Module:suite-0"><c>suite/0</c></seealso> + <seealso marker="common_test#Module:suite/0"><c>suite/0</c></seealso> function, <c>post_groups/2</c> is called before - the <seealso marker="#Module:init-2"><c>init/2</c></seealso> + the <seealso marker="#Module:init/2"><c>init/2</c></seealso> hook function. However, for CTHs that are installed by means of the CT start flag, - the <seealso marker="#Module:init-2"><c>init/2</c></seealso> + the <seealso marker="#Module:init/2"><c>init/2</c></seealso> function is called first.</p> <note> @@ -190,19 +190,19 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#Module:all-0"><c>all/0</c></seealso>. + <seealso marker="common_test#Module:all/0"><c>all/0</c></seealso>. It is used to modify the set of test cases and test group to be executed, for instance to add or remove test cases and groups, change group properties, or even skip all tests in the suite.</p> <p><c>Return</c> is what - <seealso marker="common_test#Module:all-0"><c>all/0</c></seealso> + <seealso marker="common_test#Module:all/0"><c>all/0</c></seealso> returned, that is, a list of test cases and groups to be executed, or a tuple <c>{skip,Reason}</c>.</p> <p><c>GroupDefs</c> is what - <seealso marker="common_test#Module:groups-0"><c>groups/0</c></seealso> + <seealso marker="common_test#Module:groups/0"><c>groups/0</c></seealso> or the <c>post_groups/2</c> hook returned, that is, a list of group definitions.</p> @@ -214,12 +214,12 @@ in the User's Guide.</p> <p>Notice that for CTHs that are installed by means of the - <seealso marker="common_test#Module:suite-0"><c>suite/0</c></seealso> + <seealso marker="common_test#Module:suite/0"><c>suite/0</c></seealso> function, <c>post_all/2</c> is called before - the <seealso marker="#Module:init-2"><c>init/2</c></seealso> + the <seealso marker="#Module:init/2"><c>init/2</c></seealso> hook function. However, for CTHs that are installed by means of the CT start flag, - the <seealso marker="#Module:init-2"><c>init/2</c></seealso> + the <seealso marker="#Module:init/2"><c>init/2</c></seealso> function is called first.</p> <note> @@ -252,7 +252,7 @@ <p>OPTIONAL</p> <p>This function is called before - <seealso marker="common_test#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> if it exists. It typically contains initialization/logging that must be done before <c>init_per_suite</c> is called. If <c>{skip,Reason}</c> or <c>{fail,Reason}</c> is returned, @@ -269,11 +269,11 @@ <p><c>Return</c> is the result of the <c>init_per_suite</c> function. If it is <c>{skip,Reason}</c> or <c>{fail,Reason}</c>, - <seealso marker="common_test#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> is never called, instead the initiation is considered to be skipped or failed, respectively. If a <c>NewConfig</c> list is returned, - <seealso marker="common_test#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> is called with that <c>NewConfig</c> list. For more details, see section <seealso marker="ct_hooks_chapter#pre">Pre Hooks</seealso> in the User's Guide.</p> @@ -303,21 +303,21 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#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> if it exists. It typically contains extra checks to ensure that all the correct dependencies are started correctly.</p> <p><c>Return</c> is what - <seealso marker="common_test#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> returned, that is, <c>{fail,Reason}</c>, <c>{skip,Reason}</c>, a <c>Config</c> list, or a term describing how - <seealso marker="common_test#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> failed.</p> <p><c>NewReturn</c> is the possibly modified return value of - <seealso marker="common_test#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>. To recover from a failure in - <seealso marker="common_test#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>, return <c>ConfigList</c> with the <c>tc_status</c> element removed. For more details, see <seealso marker="ct_hooks_chapter#post"> Post Hooks</seealso> in @@ -351,11 +351,11 @@ <p>OPTIONAL</p> <p>This function is called before - <seealso marker="common_test#Module:init_per_group-2"><c>init_per_group</c></seealso> + <seealso marker="common_test#Module:init_per_group/2"><c>init_per_group</c></seealso> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:pre_init_per_suite-3"><c>pre_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:pre_init_per_suite/3"><c>pre_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#Module:init_per_group-2"><c>init_per_group</c></seealso> + <seealso marker="common_test#Module:init_per_group/2"><c>init_per_group</c></seealso> instead.</p> <p>If <c>Module:pre_init_per_group/4</c> is not exported, common_test @@ -384,11 +384,11 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#Module:init_per_group-2"><c>init_per_group</c></seealso> + <seealso marker="common_test#Module:init_per_group/2"><c>init_per_group</c></seealso> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:post_init_per_suite-4"><c>post_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:post_init_per_suite/4"><c>post_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#Module:init_per_group-2"><c>init_per_group</c></seealso> + <seealso marker="common_test#Module:init_per_group/2"><c>init_per_group</c></seealso> instead.</p> <p>If <c>Module:post_init_per_group/5</c> is not exported, common_test @@ -417,11 +417,11 @@ <p>OPTIONAL</p> <p>This function is called before - <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase</c></seealso> + <seealso marker="common_test#Module:init_per_testcase/2"><c>init_per_testcase</c></seealso> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:pre_init_per_suite-3"><c>pre_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:pre_init_per_suite/3"><c>pre_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase</c></seealso> + <seealso marker="common_test#Module:init_per_testcase/2"><c>init_per_testcase</c></seealso> instead.</p> <p>If <c>Module:pre_init_per_testcase/4</c> is not exported, common_test @@ -454,11 +454,11 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase</c></seealso> + <seealso marker="common_test#Module:init_per_testcase/2"><c>init_per_testcase</c></seealso> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:post_init_per_suite-4"><c>post_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:post_init_per_suite/4"><c>post_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#Module:init_per_testcase-2"><c>init_per_testcase</c></seealso> + <seealso marker="common_test#Module:init_per_testcase/2"><c>init_per_testcase</c></seealso> instead.</p> <p>If <c>Module:post_init_per_testcase/5</c> is not exported, common_test @@ -486,11 +486,11 @@ <p>OPTIONAL</p> <p>This function is called before - <seealso marker="common_test#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> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:pre_end_per_suite-3"><c>pre_end_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:pre_end_per_suite/3"><c>pre_end_per_suite</c></seealso>, but for function - <seealso marker="common_test#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> instead.</p> <p>This function cannot change the result of the test case by returning skip or fail @@ -523,11 +523,11 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#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> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:post_end_per_suite-4"><c>post_end_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:post_end_per_suite/4"><c>post_end_per_suite</c></seealso>, but for function - <seealso marker="common_test#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> instead.</p> <p>If <c>Module:post_end_per_testcase/5</c> is not exported, common_test @@ -556,11 +556,11 @@ <p>OPTIONAL</p> <p>This function is called before - <seealso marker="common_test#Module:end_per_group-2"><c>end_per_group</c></seealso> + <seealso marker="common_test#Module:end_per_group/2"><c>end_per_group</c></seealso> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:pre_init_per_suite-3"><c>pre_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:pre_init_per_suite/3"><c>pre_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#Module:end_per_group-2"><c>end_per_group</c></seealso> + <seealso marker="common_test#Module:end_per_group/2"><c>end_per_group</c></seealso> instead.</p> <p>If <c>Module:pre_end_per_group/4</c> is not exported, common_test @@ -589,11 +589,11 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#Module:end_per_group-2"><c>end_per_group</c></seealso> + <seealso marker="common_test#Module:end_per_group/2"><c>end_per_group</c></seealso> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:post_init_per_suite-4"><c>post_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:post_init_per_suite/4"><c>post_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#Module:end_per_group-2">end_per_group</seealso> + <seealso marker="common_test#Module:end_per_group/2">end_per_group</seealso> instead.</p> <p>If <c>Module:post_end_per_group/5</c> is not exported, common_test @@ -621,11 +621,11 @@ <p>OPTIONAL</p> <p>This function is called before - <seealso marker="common_test#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> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:pre_init_per_suite-3"><c>pre_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:pre_init_per_suite/3"><c>pre_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#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> instead.</p> </desc> </func> @@ -648,11 +648,11 @@ <p>OPTIONAL</p> <p>This function is called after - <seealso marker="common_test#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> if it exists. It behaves the same way as - <seealso marker="ct_hooks#Module:post_init_per_suite-4"><c>post_init_per_suite</c></seealso>, + <seealso marker="ct_hooks#Module:post_init_per_suite/4"><c>post_init_per_suite</c></seealso>, but for function - <seealso marker="common_test#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> instead.</p> </desc> </func> @@ -677,9 +677,9 @@ <list type="bulleted"> <item><p>If <c>init_per_suite</c> fails, this function is called after - <seealso marker="#Module:post_init_per_suite-4"><c>post_init_per_suite</c></seealso>.</p></item> + <seealso marker="#Module:post_init_per_suite/4"><c>post_init_per_suite</c></seealso>.</p></item> <item><p>If a test case fails, this funcion is called after - <seealso marker="#Module:post_end_per_testcase-5"><c>post_end_per_testcase</c></seealso>.</p></item> + <seealso marker="#Module:post_end_per_testcase/5"><c>post_end_per_testcase</c></seealso>.</p></item> </list> <p>If the failed test case belongs to a test case group, the first @@ -722,9 +722,9 @@ <list type="bulleted"> <item><p>If <c>init_per_group</c> is skipped, this function is called after - <seealso marker="#Module:post_init_per_group-5"><c>post_init_per_group</c></seealso>.</p></item> + <seealso marker="#Module:post_init_per_group/5"><c>post_init_per_group</c></seealso>.</p></item> <item><p>If a test case is skipped, this function is called after - <seealso marker="#Module:post_end_per_testcase-5"><c>post_end_per_testcase</c></seealso>.</p></item> + <seealso marker="#Module:post_end_per_testcase/5"><c>post_end_per_testcase</c></seealso>.</p></item> </list> <p>If the skipped test case belongs to a test case group, the first diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml index 8d1c546fb1..23cd81f4c9 100644 --- a/lib/common_test/doc/src/ct_hooks_chapter.xml +++ b/lib/common_test/doc/src/ct_hooks_chapter.xml @@ -79,15 +79,15 @@ <seealso marker="run_test_chapter#test_specifications"> Test Specification</seealso>.</item> <item>Add tag <c>ct_hooks</c> to your call to - <seealso marker="ct#run_test-1">ct:run_test/1</seealso>.</item> + <seealso marker="ct#run_test/1">ct:run_test/1</seealso>.</item> </list> <p>CTHs can also be added within a test suite. This is done by returning <c>{ct_hooks,[CTH]}</c> in the configuration list from - <seealso marker="common_test#Module:suite-0">suite/0</seealso>, - <seealso marker="common_test#Module:init_per_suite-1"> + <seealso marker="common_test#Module:suite/0">suite/0</seealso>, + <seealso marker="common_test#Module:init_per_suite/1"> init_per_suite/1</seealso>, or - <seealso marker="common_test#Module:init_per_group-2"> + <seealso marker="common_test#Module:init_per_group/2"> init_per_group/2</seealso>.</p> <p>In this case, <c>CTH</c> can either be only the module name of the CTH @@ -105,7 +105,7 @@ to be activated. This can cause problems if you want to override CTHs in test specifications while still having them in the suite information function. The - <seealso marker="ct_hooks#Module:id-1">id/1</seealso> + <seealso marker="ct_hooks#Module:id/1">id/1</seealso> callback exists to address this problem. By returning the same <c>id</c> in both places, <c>Common Test</c> knows that this CTH is already installed and does not try to install it again.</p> @@ -118,7 +118,7 @@ This is not always desired, so <c>Common Test</c> allows the user to specify a priority for each hook. The priority can either be specified in the CTH function - <seealso marker="ct_hooks#Module:init-2">init/2</seealso> or when + <seealso marker="ct_hooks#Module:init/2">init/2</seealso> or when installing the hook. The priority specified at installation overrides the priority returned by the CTH.</p> </section> @@ -130,9 +130,9 @@ <p>Once the CTH is installed into a certain test run it remains there until its scope is expired. The scope of a CTH depends on when it is installed, see the following table. - Function <seealso marker="ct_hooks#Module:init-2">init/2</seealso> is + Function <seealso marker="ct_hooks#Module:init/2">init/2</seealso> is called at the beginning of the scope and function - <seealso marker="ct_hooks#Module:terminate-1">terminate/1</seealso> + <seealso marker="ct_hooks#Module:terminate/1">terminate/1</seealso> is called when the scope ends.</p> <table> <row> @@ -146,7 +146,7 @@ <cell>the last test suite has been run</cell> </row> <row> - <cell><seealso marker="ct#run_test-1">ct:run_test</seealso></cell> + <cell><seealso marker="ct#run_test/1">ct:run_test</seealso></cell> <cell>the first test suite is run</cell> <cell>the last test suite has been run</cell> </row> @@ -157,27 +157,27 @@ <cell>the last test suite has been run</cell> </row> <row> - <cell><seealso marker="common_test#Module:suite-0">suite/0 + <cell><seealso marker="common_test#Module:suite/0">suite/0 </seealso></cell> - <cell><seealso marker="ct_hooks#Module:pre_init_per_suite-3"> + <cell><seealso marker="ct_hooks#Module:pre_init_per_suite/3"> pre_init_per_suite/3</seealso> is called</cell> - <cell><seealso marker="ct_hooks#Module:post_end_per_suite-4"> + <cell><seealso marker="ct_hooks#Module:post_end_per_suite/4"> post_end_per_suite/4</seealso> has been called for that test suite</cell> </row> <row> - <cell><seealso marker="common_test#Module:init_per_suite-1"> + <cell><seealso marker="common_test#Module:init_per_suite/1"> init_per_suite/1</seealso></cell> - <cell><seealso marker="ct_hooks#Module:post_init_per_suite-4"> + <cell><seealso marker="ct_hooks#Module:post_init_per_suite/4"> post_init_per_suite/4</seealso> is called</cell> - <cell><seealso marker="ct_hooks#Module:post_end_per_suite-4"> + <cell><seealso marker="ct_hooks#Module:post_end_per_suite/4"> post_end_per_suite/4</seealso> has been called for that test suite</cell> </row> <row> - <cell><seealso marker="common_test#Module:init_per_group-2"> + <cell><seealso marker="common_test#Module:init_per_group/2"> init_per_group/2</seealso></cell> - <cell><seealso marker="ct_hooks#Module:post_init_per_group-5"> + <cell><seealso marker="ct_hooks#Module:post_init_per_group/5"> post_init_per_group/5</seealso> is called</cell> - <cell><seealso marker="ct_hooks#Module:post_end_per_group-5"> + <cell><seealso marker="ct_hooks#Module:post_end_per_group/5"> post_end_per_group/5</seealso> has been called for that group</cell> </row> <tcaption>Scope of a CTH</tcaption> @@ -197,12 +197,12 @@ <title>External Configuration Data and Logging</title> <p>Configuration data values in the CTH can be read by calling - <seealso marker="ct#get_config-1"><c>ct:get_config/1,2,3</c></seealso> + <seealso marker="ct#get_config/1"><c>ct:get_config/1,2,3</c></seealso> (as explained in section <seealso marker="config_file_chapter#require_config_data">Requiring and Reading Configuration Data</seealso>). The configuration variables in question must, as always, first have been required by a suite-, group-, or test case information function, - or by function <seealso marker="ct#require-1"><c>ct:require/1/2</c></seealso>. + or by function <seealso marker="ct#require/1"><c>ct:require/1/2</c></seealso>. The latter can also be used in CT hook functions.</p> <p>The CT hook functions can call any logging function in the <c>ct</c> interface to print information to the log files, or to @@ -236,12 +236,12 @@ In a CTH, the behavior can be hooked in before 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_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_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> + <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_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_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> @@ -282,12 +282,12 @@ <title>Post Hooks</title> <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_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_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> + <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_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_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> @@ -333,8 +333,8 @@ <title>Skip and Fail Hooks</title> <p> After any post hook has been executed for all installed CTHs, - <seealso marker="ct_hooks#Module:on_tc_fail-4">on_tc_fail</seealso> - or <seealso marker="ct_hooks#Module:on_tc_skip-4">on_tc_skip</seealso> + <seealso marker="ct_hooks#Module:on_tc_fail/4">on_tc_fail</seealso> + or <seealso marker="ct_hooks#Module:on_tc_skip/4">on_tc_skip</seealso> is called if the testcase failed or was skipped, respectively. You cannot affect the outcome of the tests any further at this point. </p> @@ -375,7 +375,7 @@ <marker id="example"/> <title>Example CTH</title> <p>The following CTH logs information about a test run into a format - parseable by <seealso marker="kernel:file#consult-1">file:consult/1</seealso> + parseable by <seealso marker="kernel:file#consult/1">file:consult/1</seealso> (in Kernel): </p> <code> @@ -511,7 +511,7 @@ handler called cth_log_redirect. The formatting and level is copied from the current <c>default</c> handler when the cth is started. If you want to use another level either change the <c>default</c> handler level before - starting common_test, or use the <seealso marker="kernel:logger#set_handler_config-3"> + starting common_test, or use the <seealso marker="kernel:logger#set_handler_config/3"> <c>logger:set_handler_config/3</c></seealso> API.</p> </item> <tag><c>cth_surefire</c></tag> diff --git a/lib/common_test/doc/src/ct_master.xml b/lib/common_test/doc/src/ct_master.xml index e1fa2958a3..cc69939146 100644 --- a/lib/common_test/doc/src/ct_master.xml +++ b/lib/common_test/doc/src/ct_master.xml @@ -118,7 +118,7 @@ <v>TestSpecs = string() | [SeparateOrMerged]</v> </type> <desc><marker id="run-1"/> - <p>Equivalent to <seealso marker="#run-4"><c>ct_master:run(TestSpecs, + <p>Equivalent to <seealso marker="#run/4"><c>ct_master:run(TestSpecs, false, [], [])</c></seealso>.</p> </desc> </func> @@ -134,7 +134,7 @@ <v>ExclNodes = [atom()]</v> </type> <desc><marker id="run-3"/> - <p>Equivalent to <seealso marker="#run-4"><c>ct_master:run(TestSpecs, + <p>Equivalent to <seealso marker="#run/4"><c>ct_master:run(TestSpecs, false, InclNodes, ExclNodes)</c></seealso>.</p> </desc> </func> @@ -171,7 +171,7 @@ </type> <desc><marker id="run_on_node-2"/> <p>Equivalent to - <seealso marker="#run_on_node-3"><c>ct_master:run_on_node(TestSpecs, + <seealso marker="#run_on_node/3"><c>ct_master:run_on_node(TestSpecs, false, Node)</c></seealso>.</p> </desc> </func> @@ -210,7 +210,7 @@ </type> <desc><marker id="run_test-2"/> <p>Tests are spawned on <c>Node</c> using - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso></p> + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso></p> </desc> </func> </funcs> diff --git a/lib/common_test/doc/src/ct_master_chapter.xml b/lib/common_test/doc/src/ct_master_chapter.xml index 7b5aae7ad8..f5f1a4c090 100644 --- a/lib/common_test/doc/src/ct_master_chapter.xml +++ b/lib/common_test/doc/src/ct_master_chapter.xml @@ -62,8 +62,8 @@ able to start test sessions on them.</p> <p>Tests are started by calling - <seealso marker="ct_master#run-1"><c>ct_master:run(TestSpecs)</c></seealso> or - <seealso marker="ct_master#run-3"><c>ct_master:run(TestSpecs, InclNodes, ExclNodes)</c></seealso></p> + <seealso marker="ct_master#run/1"><c>ct_master:run(TestSpecs)</c></seealso> or + <seealso marker="ct_master#run/3"><c>ct_master:run(TestSpecs, InclNodes, ExclNodes)</c></seealso></p> <p><c>TestSpecs</c> is either the name of a test specification file (string) or a list of test specifications. If it is a list, the specifications are handled (and @@ -101,11 +101,11 @@ does not attempt to re-establish contact with the failing node.</p> <p>At any time, to get the current status of the test nodes, call function - <seealso marker="ct_master#progress-0"><c>ct_master:progress()</c></seealso>.</p> + <seealso marker="ct_master#progress/0"><c>ct_master:progress()</c></seealso>.</p> <p>To stop one or more tests, use function - <seealso marker="ct_master#abort-0"><c>ct_master:abort()</c></seealso> (to stop all) or - <seealso marker="ct_master#abort-1"><c>ct_master:abort(Nodes)</c></seealso>.</p> + <seealso marker="ct_master#abort/0"><c>ct_master:abort()</c></seealso> (to stop all) or + <seealso marker="ct_master#abort/1"><c>ct_master:abort(Nodes)</c></seealso>.</p> <p>For details about the <c>Common Test</c> Master API, see module <seealso marker="ct_master"><c>ct_master</c></seealso>.</p> diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml index f4d98b611b..a19f5c4663 100644 --- a/lib/common_test/doc/src/ct_netconfc.xml +++ b/lib/common_test/doc/src/ct_netconfc.xml @@ -45,21 +45,21 @@ <marker id="Connecting"/> <p><em>Connecting to a NETCONF server</em></p> - <p>Call <seealso marker="#connect-1"><c>connect/1,2</c></seealso> + <p>Call <seealso marker="#connect/1"><c>connect/1,2</c></seealso> to establish a connection to a server, then pass the returned - handle to <seealso marker="#session-1"><c>session/1-3</c></seealso> to + handle to <seealso marker="#session/1"><c>session/1-3</c></seealso> to establish a NETCONF session on a new SSH channel. Each call to - <seealso marker="#session-1"><c>session/1-3</c></seealso> establishes a + <seealso marker="#session/1"><c>session/1-3</c></seealso> establishes a new session on the same connection, and results in a hello message to the server.</p> <p>Alternately, - <seealso marker="#open-1"><c>open/1,2</c></seealso> can be used to + <seealso marker="#open/1"><c>open/1,2</c></seealso> can be used to establish a single session on a dedicated connection. (Or, equivalently, - <seealso marker="#only_open-1"><c>only_open/1,2</c></seealso> - followed by <seealso marker="#hello-1"><c>hello/1-3</c></seealso>.)</p> + <seealso marker="#only_open/1"><c>only_open/1,2</c></seealso> + followed by <seealso marker="#hello/1"><c>hello/1-3</c></seealso>.)</p> <p>Connect/session options can be specified in a configuration file with entries like the following.</p> @@ -80,12 +80,12 @@ procedure calls (RPCs) from client to server and a corresponding reply from server to client. RPCs are sent using like-named functions (eg. - <seealso marker="#edit_config-3"><c>edit_config/3-5</c></seealso> + <seealso marker="#edit_config/3"><c>edit_config/3-5</c></seealso> to send an edit-config RPC), with the server reply as return value. There are functions for each RPC defined in RFC 6241 and the create-subscription RPC from RFC 5277, all of which are - wrappers on <seealso marker="#send_rpc-2"><c>send_rpc/2,3</c></seealso>, + wrappers on <seealso marker="#send_rpc/2"><c>send_rpc/2,3</c></seealso>, that can be used to send an arbitrary RPC not defined in RFC 6241 or RFC 5277.</p> @@ -137,7 +137,7 @@ To do this, use hook option <c>hosts</c> and list the names of the servers/connections to be used in the suite. The connections must be named for this to work, that is, they must be opened with - <seealso marker="#open-2"><c>open/2</c></seealso>.</p> + <seealso marker="#open/2"><c>open/2</c></seealso>.</p> <p>Option <c>hosts</c> has no effect if <c>log_type</c> is set to <c>html</c> or <c>silent</c>.</p> @@ -215,11 +215,11 @@ <desc> <p>Handle to a connection to a NETCONF server as returned by - <seealso marker="#connect-1"><c>connect/1,2</c></seealso>, + <seealso marker="#connect/1"><c>connect/1,2</c></seealso>, or to a session as returned by - <seealso marker="#session-1"><c>session/1-3</c></seealso>, - <seealso marker="#open-1"><c>open/1,2</c></seealso>, - or <seealso marker="#only_open-1"><c>only_open/1,2</c></seealso>.</p> + <seealso marker="#session/1"><c>session/1-3</c></seealso>, + <seealso marker="#open/1"><c>open/1,2</c></seealso>, + or <seealso marker="#only_open/1"><c>only_open/1,2</c></seealso>.</p> </desc> </datatype> <datatype> @@ -244,7 +244,7 @@ <name name="notification"/> <desc> <p>Event notification messages sent as a result of calls to - <seealso marker="#create_subscription-2"><c>create_subscription/2,3</c></seealso>.</p> + <seealso marker="#create_subscription/2"><c>create_subscription/2,3</c></seealso>.</p> </desc> </datatype> <datatype> @@ -253,7 +253,7 @@ <p>Options <c>host</c> and <c>port</c> specify the server endpoint to which to connect, and are passed directly to <seealso - marker="ssh:ssh#connect-3"><c>ssh:connect/4</c></seealso>, + marker="ssh:ssh#connect/3"><c>ssh:connect/4</c></seealso>, as are arbitrary ssh options. Common options are <c>user</c>, <c>password</c> and <c>user_dir</c>.</p> @@ -299,7 +299,7 @@ <name name="streams"/> <desc> <p>Stream information as returned by - <seealso marker="#get_event_streams-1"><c>get_event_streams/1-3</c></seealso>. + <seealso marker="#get_event_streams/1"><c>get_event_streams/1-3</c></seealso>. See RFC 5277, "XML Schema for Event Notifications", for detail on the format of the string values.</p> </desc> @@ -377,14 +377,14 @@ <p>Opens an SSH connection to a NETCONF server.</p> <p>If the server options are specified in a configuration file, use - <seealso marker="#connect-2"><c>connect/2</c></seealso> + <seealso marker="#connect/2"><c>connect/2</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> reference returned from this function is required as connection identifier when opening sessions over this connection, see - <seealso marker="#session-1"><c>session/1-3</c></seealso>.</p> + <seealso marker="#session/1"><c>session/1-3</c></seealso>.</p> </desc> </func> @@ -404,17 +404,17 @@ the configuration file takes precedence.</p> <p>If the server is not specified in a configuration file, use - <seealso marker="#connect-1"><c>connect/1</c></seealso> + <seealso marker="#connect/1"><c>connect/1</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> reference returned from this function can be used as connection identifier when opening sessions over this connection, see - <seealso marker="#session-1"><c>session/1-3</c></seealso>. + <seealso marker="#session/1"><c>session/1-3</c></seealso>. However, if <c><anno>KeyOrName</anno></c> is a <c>target_name()</c>, that is, if the server is named through a - call to <seealso marker="ct#require-2"><c>ct:require/2</c></seealso> + call to <seealso marker="ct#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement in the test suite, then this name can be used instead of <seealso marker="#type-handle"><c>handle()</c></seealso>.</p> @@ -513,7 +513,7 @@ <p>If there are open NETCONF sessions on the connection, these will be brutally aborted. To avoid this, close each session - with <seealso marker="#close_session-1"><c>close_session/1,2</c></seealso></p> + with <seealso marker="#close_session/1"><c>close_session/1,2</c></seealso></p> </desc> </func> @@ -618,7 +618,7 @@ </netconf></pre> <p>If more complex filtering is needed, use - <seealso marker="#get-2"><c>ct_netconfc:get/2,3</c></seealso> and + <seealso marker="#get/2"><c>ct_netconfc:get/2,3</c></seealso> and specify the exact filter according to "XML Schema for Event Notifications" in RFC 5277.</p> </desc> @@ -645,7 +645,7 @@ specified timeout.</p> <p>Note that capabilities for an outgoing hello can be passed - directly to <seealso marker="#open-2"><c>open/2</c></seealso>.</p> + directly to <seealso marker="#open/2"><c>open/2</c></seealso>.</p> </desc> </func> @@ -685,7 +685,7 @@ Locks are intended to be short-lived.</p> <p>Operation - <seealso marker="#kill_session-2"><c>kill_session/2,3</c></seealso> + <seealso marker="#kill_session/2"><c>kill_session/2,3</c></seealso> can be used to force the release of a lock owned by another NETCONF session. How this is achieved by the server side is implementation-specific.</p> @@ -698,7 +698,7 @@ <desc> <p>Opens a NETCONF session, but does not send <c>hello</c>.</p> - <p>As <seealso marker="#open-1"><c>open/1</c></seealso>, but + <p>As <seealso marker="#open/1"><c>open/1</c></seealso>, but does not send a <c>hello</c> message.</p> </desc> </func> @@ -709,7 +709,7 @@ <desc> <p>Opens a named NETCONF session, but does not send <c>hello</c>.</p> - <p>As <seealso marker="#open-2"><c>open/2</c></seealso>, but + <p>As <seealso marker="#open/2"><c>open/2</c></seealso>, but does not send a <c>hello</c> message.</p> </desc> </func> @@ -723,7 +723,7 @@ <p>If the server options are specified in a configuration file, or if a named client is needed for logging purposes (see section <seealso marker="#Logging">Logging</seealso> in this module), use - <seealso marker="#open-2"><c>open/2</c></seealso> + <seealso marker="#open/2"><c>open/2</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> @@ -751,7 +751,7 @@ the configuration file take precedence.</p> <p>If the server is not specified in a configuration file, use - <seealso marker="#open-1"><c>open/1</c></seealso> + <seealso marker="#open/1"><c>open/1</c></seealso> instead.</p> <p>The opaque <seealso marker="#type-handle"><c>handle()</c></seealso> @@ -759,13 +759,13 @@ function can be used as client identifier when calling any other function in this module. However, if <c><anno>KeyOrName</anno></c> is a <c>target_name()</c>, that is, if the server is named through a - call to <seealso marker="ct#require-2"><c>ct:require/2</c></seealso> + call to <seealso marker="ct#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement in the test suite, then this name can be used instead of <seealso marker="#type-handle"><c>handle()</c></seealso>.</p> <p>See also - <seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="ct#require/2"><c>ct:require/2</c></seealso>.</p> </desc> </func> @@ -817,7 +817,7 @@ other function in this module. However, if <c><anno>KeyOrName</anno></c> is used and it is a <c>target_name()</c>, that is, if the server is named through a call - to <seealso marker="ct#require-2"><c>ct:require/2</c></seealso> + to <seealso marker="ct#require/2"><c>ct:require/2</c></seealso> or a <c>require</c> statement in the test suite, then this name can be used instead of <seealso marker="#type-handle"><c>handle()</c></seealso>.</p> @@ -833,7 +833,7 @@ <p>Unlocks the configuration target.</p> <p>If the client earlier has acquired a lock through - <seealso marker="#lock-2"><c>lock/2,3</c></seealso>, this + <seealso marker="#lock/2"><c>lock/2,3</c></seealso>, this operation releases the associated lock. To access another target than <c>running</c>, the server must support <c>:candidate</c> and/or <c>:startup</c>.</p> diff --git a/lib/common_test/doc/src/ct_rpc.xml b/lib/common_test/doc/src/ct_rpc.xml index 69b735217c..e3247a7ad9 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_run_cmd.xml b/lib/common_test/doc/src/ct_run_cmd.xml index 3a9b8bbc03..a0097b148f 100644 --- a/lib/common_test/doc/src/ct_run_cmd.xml +++ b/lib/common_test/doc/src/ct_run_cmd.xml @@ -46,7 +46,7 @@ running <c>Common Test</c> in a particular mode.</p> <p>The interface function - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>, + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>, corresponding to the <c>ct_run</c> program, is used for starting <c>Common Test</c> from the Erlang shell (or an Erlang program). For details, see the <seealso marker="ct"><c>ct</c></seealso> diff --git a/lib/common_test/doc/src/ct_slave.xml b/lib/common_test/doc/src/ct_slave.xml index d84d17d0b1..c0af685c71 100644 --- a/lib/common_test/doc/src/ct_slave.xml +++ b/lib/common_test/doc/src/ct_slave.xml @@ -63,7 +63,7 @@ <p>Starts an Erlang node with name <c>Node</c> on the local host.</p> <p>See also - <seealso marker="#start-3"><c>ct_slave:start/3</c></seealso>.</p> + <seealso marker="#start/3"><c>ct_slave:start/3</c></seealso>.</p> </desc> </func> @@ -85,7 +85,7 @@ atom-valued and <c>start(Node, Opts)</c> when it is list-valued.</p> <p>See also - <seealso marker="#start-3"><c>ct_slave:start/3</c></seealso>.</p> + <seealso marker="#start/3"><c>ct_slave:start/3</c></seealso>.</p> </desc> </func> @@ -176,7 +176,7 @@ <item><p><c>{error, started_not_connected, NodeName}</c> if the node is started, but not connected to the master node.</p></item> <item><p><c>{error, not_alive, NodeName}</c> if the node on which - <seealso marker="#start-3"><c>ct_slave:start/3</c></seealso> is + <seealso marker="#start/3"><c>ct_slave:start/3</c></seealso> is called, is not alive. Notice that <c>NodeName</c> is the name of the current node in this case.</p></item> </list> diff --git a/lib/common_test/doc/src/ct_snmp.xml b/lib/common_test/doc/src/ct_snmp.xml index bedf8f3c8a..e057331e9d 100644 --- a/lib/common_test/doc/src/ct_snmp.xml +++ b/lib/common_test/doc/src/ct_snmp.xml @@ -170,7 +170,7 @@ <p>A name for the data must be allocated in the suite using <c>require</c> (see the example above). Pass this name as argument <c>SnmpAppConfName</c> to - <seealso marker="#start-3"><c>ct_snmp:start/3</c></seealso>. + <seealso marker="#start/3"><c>ct_snmp:start/3</c></seealso>. <c>ct_snmp</c> specifies default values for some <c>SNMP</c> application configuration parameters (such as <c>{verbosity,trace}</c> for parameter <c>config</c>). This set of defaults is merged with the parameters @@ -377,7 +377,7 @@ undefined).</fsummary> <desc><marker id="start-2"/> <p>Equivalent to - <seealso marker="#start-3"><c>ct_snmp:start(Config, MgrAgentConfName, + <seealso marker="#start/3"><c>ct_snmp:start(Config, MgrAgentConfName, undefined)</c></seealso>.</p> </desc> </func> @@ -398,13 +398,13 @@ <c>MgrAgentConfName</c>, are performed. When using SNMPv3, called USM users are also registered. Users, <c>usm_users</c>, and managed agents can also be registered later using - <seealso marker="#register_users-2"><c>ct_snmp:register_users/2</c></seealso>, - <seealso marker="#register_agents-2"><c>ct_snmp:register_agents/2</c></seealso>, + <seealso marker="#register_users/2"><c>ct_snmp:register_users/2</c></seealso>, + <seealso marker="#register_agents/2"><c>ct_snmp:register_agents/2</c></seealso>, and - <seealso marker="#register_usm_users-2"><c>ct_snmp:register_usm_users/2</c></seealso>.</p> + <seealso marker="#register_usm_users/2"><c>ct_snmp:register_usm_users/2</c></seealso>.</p> <p>The agent started is called <c>snmp_master_agent</c>. Use - <seealso marker="#load_mibs-1"><c>ct_snmp:load_mibs/1</c></seealso> + <seealso marker="#load_mibs/1"><c>ct_snmp:load_mibs/1</c></seealso> to load MIBs into the agent.</p> <p>With <c>SnmpAppConfName</c> SNMP applications can be configured diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml index c4fb977354..88a48da2f8 100644 --- a/lib/common_test/doc/src/ct_ssh.xml +++ b/lib/common_test/doc/src/ct_ssh.xml @@ -239,7 +239,7 @@ <fsummary>Equivalent to connect(KeyOrName, host, []).</fsummary> <desc><marker id="connect-1"/> <p>Equivalent to - <seealso marker="#connect-3"><c>ct_ssh:connect(KeyOrName, host, + <seealso marker="#connect/3"><c>ct_ssh:connect(KeyOrName, host, [])</c></seealso>.</p> </desc> </func> @@ -249,7 +249,7 @@ <fsummary>Equivalent to connect(KeyOrName, ConnType, []).</fsummary> <desc><marker id="connect-2"/> <p>Equivalent to - <seealso marker="#connect-3"><c>ct_ssh:connect(KeyOrName, ConnType, + <seealso marker="#connect/3"><c>ct_ssh:connect(KeyOrName, ConnType, [])</c></seealso>.</p> </desc> </func> @@ -279,7 +279,7 @@ be opened using the configuration data specified by <c>Key</c>).</p> <p>For information on how to create a new <c>Name</c>, see - <seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="ct#require/2"><c>ct:require/2</c></seealso>.</p> <p>For <c>target_name</c>, see module <seealso marker="ct"><c>ct</c></seealso>.</p> @@ -373,7 +373,7 @@ <fsummary>Equivalent to exec(SSH, Command, DefaultTimeout).</fsummary> <desc><marker id="exec-2"/> <p>Equivalent to - <seealso marker="#exec-3"><c>ct_ssh:exec(SSH, Command, + <seealso marker="#exec/3"><c>ct_ssh:exec(SSH, Command, DefaultTimeout)</c></seealso>.</p> </desc> </func> @@ -811,7 +811,7 @@ close).</fsummary> <desc><marker id="receive_response-2"/> <p>Equivalent to - <seealso marker="#receive_response-3"><c>ct_ssh:receive_response(SSH, + <seealso marker="#receive_response/3"><c>ct_ssh:receive_response(SSH, ChannelId, close)</c></seealso>.</p> </desc> </func> @@ -822,7 +822,7 @@ ChannelId, close)</c></seealso>.</p> DefaultTimeout).</fsummary> <desc><marker id="receive_response-3"/> <p>Equivalent to - <seealso marker="#receive_response-4"><c>ct_ssh:receive_response(SSH, + <seealso marker="#receive_response/4"><c>ct_ssh:receive_response(SSH, ChannelId, End, DefaultTimeout)</c></seealso>.</p> </desc> </func> @@ -895,7 +895,7 @@ ChannelId, End, DefaultTimeout)</c></seealso>.</p> <fsummary>Equivalent to send(SSH, ChannelId, 0, Data, DefaultTimeout).</fsummary> <desc><marker id="send-3"/> - <p>Equivalent to <seealso marker="#send-5"><c>ct_ssh:send(SSH, + <p>Equivalent to <seealso marker="#send/5"><c>ct_ssh:send(SSH, ChannelId, 0, Data, DefaultTimeout)</c></seealso>.</p> </desc> </func> @@ -904,7 +904,7 @@ ChannelId, End, DefaultTimeout)</c></seealso>.</p> <name since="">send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason}</name> <fsummary>Equivalent to send(SSH, ChannelId, 0, Data, Timeout).</fsummary> <desc><marker id="send-4"/> - <p>Equivalent to <seealso marker="#send-5"><c>ct_ssh:send(SSH, + <p>Equivalent to <seealso marker="#send/5"><c>ct_ssh:send(SSH, ChannelId, 0, Data, Timeout)</c></seealso>.</p> </desc> </func> @@ -931,7 +931,7 @@ ChannelId, End, DefaultTimeout)</c></seealso>.</p> close).</fsummary> <desc><marker id="send_and_receive-3"/> <p>Equivalent to - <seealso marker="#send_and_receive-4"><c>ct_ssh:send_and_receive(SSH, + <seealso marker="#send_and_receive/4"><c>ct_ssh:send_and_receive(SSH, ChannelId, Data, close)</c></seealso>.</p> </desc> </func> @@ -942,7 +942,7 @@ ChannelId, End, DefaultTimeout)</c></seealso>.</p> DefaultTimeout).</fsummary> <desc><marker id="send_and_receive-4"/> <p>Equivalent to - <seealso marker="#send_and_receive-6"><c>ct_ssh;send_and_receive(SSH, + <seealso marker="#send_and_receive/6"><c>ct_ssh;send_and_receive(SSH, ChannelId, 0, Data, End, DefaultTimeout)</c></seealso>.</p> </desc> </func> @@ -953,7 +953,7 @@ ChannelId, 0, Data, End, DefaultTimeout)</c></seealso>.</p> Timeout).</fsummary> <desc><marker id="send_and_receive-5"/> <p>Equivalent to - <seealso marker="#send_and_receive-6"><c>ct_ssh:send_and_receive(SSH, + <seealso marker="#send_and_receive/6"><c>ct_ssh:send_and_receive(SSH, ChannelId, 0, Data, End, Timeout)</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> @@ -998,7 +998,7 @@ ChannelId, 0, Data, End, Timeout)</c></seealso>.</p> <fsummary>Equivalent to session_open(SSH, DefaultTimeout).</fsummary> <desc><marker id="session_open-1"/> <p>Equivalent to - <seealso marker="#session_open-2"><c>ct_ssh:session_open(SSH, + <seealso marker="#session_open/2"><c>ct_ssh:session_open(SSH, DefaultTimeout)</c></seealso>.</p> </desc> </func> @@ -1038,7 +1038,7 @@ ChannelId, 0, Data, End, Timeout)</c></seealso>.</p> <fsummary>Equivalent to shell(SSH, ChannelId, DefaultTimeout).</fsummary> <desc><marker id="shell-2"/> <p>Equivalent to - <seealso marker="#shell-3"><c>ct_ssh:shell(SSH, ChannelId, + <seealso marker="#shell/3"><c>ct_ssh:shell(SSH, ChannelId, DefaultTimeout)</c></seealso>.</p> </desc> </func> @@ -1066,7 +1066,7 @@ ChannelId, 0, Data, End, Timeout)</c></seealso>.</p> DefaultTimeout).</fsummary> <desc><marker id="subsystem-3"/> <p>Equivalent to - <seealso marker="#subsystem-4"><c>ct_ssh:subsystem(SSH, ChannelId, + <seealso marker="#subsystem/4"><c>ct_ssh:subsystem(SSH, ChannelId, Subsystem, DefaultTimeout)</c></seealso>.</p> </desc> </func> diff --git a/lib/common_test/doc/src/ct_telnet.xml b/lib/common_test/doc/src/ct_telnet.xml index 2774ab3f3c..b928a1cba0 100644 --- a/lib/common_test/doc/src/ct_telnet.xml +++ b/lib/common_test/doc/src/ct_telnet.xml @@ -127,7 +127,7 @@ option <c>hosts</c> and list the names of the servers/connections to be used in the suite. The connections must be named for this to work (see - <seealso marker="#open-1"><c>ct_telnet:open/1,2,3,4</c></seealso>).</p> + <seealso marker="#open/1"><c>ct_telnet:open/1,2,3,4</c></seealso>).</p> <p>Hook option <c>log_type</c> can be used to change the <c>cth_conn_log</c> behavior. The default value of this option is @@ -218,7 +218,7 @@ <p>A connection can be associated with a target name and/or a handle. If <c>Connection</c> has no associated target name, it can only be closed with the handle value (see - <seealso marker="#open-4"><c>ct_telnet:open/4</c></seealso>).</p> + <seealso marker="#open/4"><c>ct_telnet:open/4</c></seealso>).</p> </desc> </func> @@ -227,7 +227,7 @@ <fsummary>Equivalent to cmd(Connection, Cmd, []).</fsummary> <desc><marker id="cmd-2"/> <p>Equivalent to - <seealso marker="#cmd-3"><c>ct_telnet:cmd(Connection, Cmd, + <seealso marker="#cmd/3"><c>ct_telnet:cmd(Connection, Cmd, [])</c></seealso>.</p> </desc> </func> @@ -269,7 +269,7 @@ <fsummary>Equivalent to cmdf(Connection, CmdFormat, Args, []).</fsummary> <desc><marker id="cmdf-3"/> <p>Equivalent to - <seealso marker="#cmdf-4"><c>ct_telnet:cmdf(Connection, CmdFormat, + <seealso marker="#cmdf/4"><c>ct_telnet:cmdf(Connection, CmdFormat, Args, [])</c></seealso>.</p> </desc> </func> @@ -292,7 +292,7 @@ and a list of arguments to build the command).</p> <p>For details, see - <seealso marker="#cmd-3"><c>ct_telnet:cmd/3</c></seealso>.</p> + <seealso marker="#cmd/3"><c>ct_telnet:cmd/3</c></seealso>.</p> </desc> </func> @@ -301,7 +301,7 @@ <fsummary>Equivalent to expect(Connections, Patterns, []).</fsummary> <desc><marker id="expect-2"/> <p>Equivalent to - <seealso marker="#expect-3"><c>ct_telnet:expect(Connections, + <seealso marker="#expect/3"><c>ct_telnet:expect(Connections, Patterns, [])</c></seealso>.</p> </desc> </func> @@ -453,7 +453,7 @@ <fsummary>Equivalent to open(Name, telnet).</fsummary> <desc><marker id="open-1"/> <p>Equivalent to - <seealso marker="#open-2"><c>ct_telnet:open(Name, + <seealso marker="#open/2"><c>ct_telnet:open(Name, telnet)</c></seealso>.</p> </desc> </func> @@ -478,7 +478,7 @@ <fsummary>Equivalent to open(KeyOrName, ConnType, TargetMod, []).</fsummary> <desc><marker id="open-3"/> <p>Equivalent to - <seealso marker="#open-4"><c>ct_telnet:ct_telnet:open(KeyOrName, + <seealso marker="#open/4"><c>ct_telnet:ct_telnet:open(KeyOrName, ConnType, TargetMod, [])</c></seealso>.</p> </desc> </func> @@ -506,7 +506,7 @@ alternatives:</p> <list type="bulleted"> - <item><p><seealso marker="ct#require-2"><c>ct:require/2</c></seealso> + <item><p><seealso marker="ct#require/2"><c>ct:require/2</c></seealso> in a test case</p></item> <item><p>A <c>require</c> statement in the suite information function (<c>suite/0</c>)</p></item> @@ -529,7 +529,7 @@ <seealso marker="ct"><c>ct</c></seealso>.</p> <p>See also - <seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p> + <seealso marker="ct#require/2"><c>ct:require/2</c></seealso>.</p> </desc> </func> @@ -538,7 +538,7 @@ <fsummary>Equivalent to send(Connection, Cmd, []).</fsummary> <desc><marker id="send-2"/> <p>Equivalent to - <seealso marker="#send-3"><c>ct_telnet:send(Connection, Cmd, + <seealso marker="#send/3"><c>ct_telnet:send(Connection, Cmd, [])</c></seealso>.</p> </desc> </func> @@ -566,8 +566,8 @@ carriage return and newline characters.</p> <p>The resulting output from the command can be read with - <seealso marker="#get_data-1"><c>ct_telnet:get_data/2</c></seealso> or - <seealso marker="#expect-2"><c>ct_telnet:expect/2,3</c></seealso>.</p> + <seealso marker="#get_data/1"><c>ct_telnet:get_data/2</c></seealso> or + <seealso marker="#expect/2"><c>ct_telnet:expect/2,3</c></seealso>.</p> </desc> </func> @@ -576,7 +576,7 @@ <fsummary>Equivalent to sendf(Connection, CmdFormat, Args, []).</fsummary> <desc><marker id="sendf-3"/> <p>Equivalent to - <seealso marker="#sendf-4"><c>ct_telnet:sendf(Connection, CmdFormat, + <seealso marker="#sendf/4"><c>ct_telnet:sendf(Connection, CmdFormat, Args, [])</c></seealso>.</p> </desc> </func> @@ -598,7 +598,7 @@ string and a list of arguments to build the command).</p> <p>For details, see - <seealso marker="#send-3"><c>ct_telnet:send/3</c></seealso>.</p> + <seealso marker="#send/3"><c>ct_telnet:send/3</c></seealso>.</p> </desc> </func> </funcs> diff --git a/lib/common_test/doc/src/dependencies_chapter.xml b/lib/common_test/doc/src/dependencies_chapter.xml index 8ede822ae5..f5805cb6fe 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#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>. + <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#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#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#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/event_handler_chapter.xml b/lib/common_test/doc/src/event_handler_chapter.xml index 89272891ed..26ad155bad 100644 --- a/lib/common_test/doc/src/event_handler_chapter.xml +++ b/lib/common_test/doc/src/event_handler_chapter.xml @@ -69,20 +69,20 @@ manager, either by telling <c>Common Test</c> to install them before the test run (described later), or by adding the handlers dynamically during the test run using - <seealso marker="stdlib:gen_event#add_handler-3"><c>gen_event:add_handler/3</c></seealso> or - <seealso marker="stdlib:gen_event#add_sup_handler-3"><c>gen_event:add_sup_handler/3</c></seealso>. + <seealso marker="stdlib:gen_event#add_handler/3"><c>gen_event:add_handler/3</c></seealso> or + <seealso marker="stdlib:gen_event#add_sup_handler/3"><c>gen_event:add_sup_handler/3</c></seealso>. In the latter scenario, the reference of the <c>Common Test</c> event manager is required. To get it, call - <seealso marker="ct#get_event_mgr_ref-0"><c>ct:get_event_mgr_ref/0</c></seealso> + <seealso marker="ct#get_event_mgr_ref/0"><c>ct:get_event_mgr_ref/0</c></seealso> or (on the <c>Common Test</c> Master node) - <seealso marker="ct_master#get_event_mgr_ref-0"><c>ct_master:get_event_mgr_ref/0</c></seealso>.</p> + <seealso marker="ct_master#get_event_mgr_ref/0"><c>ct_master:get_event_mgr_ref/0</c></seealso>.</p> </section> <section> <marker id="usage"></marker> <title>Use</title> <p>Event handlers can be installed by an <c>event_handler</c> start flag (<seealso marker="ct_run"><c>ct_run</c></seealso>) or option - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>, where the + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>, where the argument specifies the names of one or more event handler modules.</p> <p><em>Example:</em></p> @@ -99,7 +99,7 @@ example).</p></note> <p>An event_handler tuple in argument <c>Opts</c> has the following definition - (see <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>):</p> + (see <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>):</p> <pre> {event_handler,EventHandlers} @@ -377,8 +377,8 @@ manager can look like.</p> <note><p>To ensure that printouts to <c>stdout</c> (or printouts made with - <seealso marker="ct#log-2"><c>ct:log/2,3</c></seealso> or - <seealso marker="ct#pal-2"><c>ct:pal,2,3</c></seealso>) get written to the test case log + <seealso marker="ct#log/2"><c>ct:log/2,3</c></seealso> or + <seealso marker="ct#pal/2"><c>ct:pal,2,3</c></seealso>) get written to the test case log file, and not to the <c>Common Test</c> framework log, you can synchronize with the <c>Common Test</c> server by matching on evvents <c>tc_start</c> and <c>tc_done</c>. In the period between these events, all I/O is directed to the diff --git a/lib/common_test/doc/src/getting_started_chapter.xml b/lib/common_test/doc/src/getting_started_chapter.xml index 9b021058e8..7cd9a71cb7 100644 --- a/lib/common_test/doc/src/getting_started_chapter.xml +++ b/lib/common_test/doc/src/getting_started_chapter.xml @@ -85,7 +85,7 @@ a test case to generate a runtime error to indicate failure (for example, by causing a bad match error or by calling <c>exit/1</c>, preferably through the help function - <seealso marker="ct#fail-1"><c>ct:fail/1,2</c></seealso>). A successful + <seealso marker="ct#fail/1"><c>ct:fail/1,2</c></seealso>). A successful execution is indicated by a normal return from the test case function. </p> </section> diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index 700becf8ab..485568d286 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -64,7 +64,7 @@ control <c>stdin</c>), the test run proceeds automatically without the missing suites. This behavior can however be modified with the <c><![CDATA[ct_run]]></c> flag <c><![CDATA[-abort_if_missing_suites]]></c>, - or the <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso> option + or the <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso> option <c><![CDATA[{abort_if_missing_suites,TrueOrFalse}]]></c>. If <c><![CDATA[abort_if_missing_suites]]></c> is set to <c>true</c>, the test run stops immediately if some suites fail to compile.</p> @@ -314,14 +314,14 @@ <p><c>Common Test</c> provides an Erlang API for running tests. The main (and most flexible) function for specifying and executing tests is - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>. + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>. It takes the same start parameters as <seealso marker="run_test_chapter#ct_run"><c>ct_run</c></seealso>, but the flags are instead specified as options in a list of key-value tuples. For example, a test specified with <c>ct_run</c> as follows:</p> <p><c>$ ct_run -suite ./my_SUITE -logdir ./results</c></p> - <p>is with <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso> specified as:</p> + <p>is with <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso> specified as:</p> <p><c>1> ct:run_test([{suite,"./my_SUITE"},{logdir,"./results"}]).</c></p> <p>The function returns the test result, represented by the tuple @@ -337,7 +337,7 @@ <section> <title>Releasing the Erlang Shell</title> <p>During execution of tests started with - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>, + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>, the Erlang shell process, controlling <c>stdin</c>, remains the top-level process of the <c>Common Test</c> system of processes. Consequently, the Erlang shell is not available for interaction during @@ -352,13 +352,13 @@ <c>ct:run_test/1</c> returns the pid of this process rather than the test result, which instead is printed to tty at the end of the test run.</p> <note><p>To use the functions - <seealso marker="ct#break-1"><c>ct:break/1,2</c></seealso> and - <seealso marker="ct#continue-0"><c>ct:continue/0,1</c></seealso>, + <seealso marker="ct#break/1"><c>ct:break/1,2</c></seealso> and + <seealso marker="ct#continue/0"><c>ct:continue/0,1</c></seealso>, <c>release_shell</c> <em>must</em> be set to <c>true</c>.</p></note> </section> <p>For details, see - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso> manual page.</p> + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso> manual page.</p> </section> <section> @@ -542,9 +542,9 @@ trying out various operations during test suite development.</p> <p>To start the interactive shell mode, start an Erlang shell - manually and call <seealso marker="ct#install-1"><c>ct:install/1</c></seealso> + manually and call <seealso marker="ct#install/1"><c>ct:install/1</c></seealso> to install any configuration data you might need (use <c>[]</c> as argument otherwise). - Then call <seealso marker="ct#start_interactive-0"><c>ct:start_interactive/0</c></seealso> + Then call <seealso marker="ct#start_interactive/0"><c>ct:start_interactive/0</c></seealso> to start <c>Common Test</c>.</p> <p>If you use the <c>ct_run</c> program, you can start @@ -564,7 +564,7 @@ <p>If any functions using "required configuration data" (for example, functions <c>ct_telnet</c> or <c>ct_ftp</c>) are to be called from the Erlang shell, first require - configuration data with <seealso marker="ct#require-1"><c> + configuration data with <seealso marker="ct#require/1"><c> ct:require/1,2</c></seealso>. This is equivalent to a <c>require</c> statement in the <seealso marker="write_test_chapter#suite">Test Suite Information Function</seealso> or in the <seealso marker="write_test_chapter#info_function">Test Case Information Function</seealso>.</p> @@ -587,13 +587,13 @@ is not supported.</p> <p>If you wish to exit the interactive mode (for example, to start an automated - test run with <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>), + test run with <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>), call function - <seealso marker="ct#stop_interactive-0"><c>ct:stop_interactive/0</c></seealso>. + <seealso marker="ct#stop_interactive/0"><c>ct:stop_interactive/0</c></seealso>. This shuts down the running <c>ct</c> application. Associations between configuration names and data created with <c>require</c> are consequently deleted. Function - <seealso marker="ct#start_interactive-0"><c>ct:start_interactive/0</c></seealso> + <seealso marker="ct#start_interactive/0"><c>ct:start_interactive/0</c></seealso> takes you back into interactive mode, but the previous state is not restored.</p> </section> @@ -601,7 +601,7 @@ <title>Step-by-Step Execution of Test Cases with the Erlang Debugger</title> <p>Using <c>ct_run -step [opts]</c>, or by passing option <c>{step,Opts}</c> - to <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>, + to <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>, the following is possible:</p> <list type="bulleted"> <item>Get the Erlang Debugger started automatically.</item> @@ -635,9 +635,9 @@ <p>The most flexible way to specify what to test, is to use a test specification, which is a sequence of Erlang terms. The terms are normally declared in one or more text files - (see <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso>), but + (see <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso>), but can also be passed to <c>Common Test</c> on the form of a list (see - <seealso marker="ct#run_testspec-1"><c>ct:run_testspec/1</c></seealso>). + <seealso marker="ct#run_testspec/1"><c>ct:run_testspec/1</c></seealso>). There are two general types of terms: configuration terms and test specification terms.</p> @@ -1107,7 +1107,7 @@ when starting tests with <c>ct_run</c>. This forces <c>Common Test</c> to ignore unrecognizable terms. In this mode, <c>Common Test</c> is not able to check the specification for errors as efficiently as if the scanner runs in default mode. - If <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso> is used + If <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso> is used for starting the tests, the relaxed scanner mode is enabled by tuple <c>{allow_user_terms,true}</c>.</p> </section> @@ -1116,7 +1116,7 @@ <p>Terms in the current test specification (that is, the specification that has been used to configure and run the current test) can be looked up. - The function <seealso marker="ct#get_testspec_terms-0"><c>get_testspec_terms()</c></seealso> + The function <seealso marker="ct#get_testspec_terms/0"><c>get_testspec_terms()</c></seealso> returns a list of all test specification terms (both configuration terms and test terms), and <c>get_testspec_terms(Tags)</c> returns the term (or a list of terms) matching the tag (or tags) in <c>Tags</c>.</p> @@ -1280,8 +1280,8 @@ <title>The Unexpected I/O Log</title> <p>The test suites overview page includes a link to the Unexpected I/O Log. In this log, <c>Common Test</c> saves printouts made with - <seealso marker="ct#log-2"><c>ct:log/1,2,3,4,5</c></seealso> and - <seealso marker="ct#pal-2"><c>ct:pal/1,2,3,4,5</c></seealso>, as well as captured system + <seealso marker="ct#log/2"><c>ct:log/1,2,3,4,5</c></seealso> and + <seealso marker="ct#pal/2"><c>ct:pal/1,2,3,4,5</c></seealso>, as well as captured system error- and progress reports, which cannot be associated with particular test cases and therefore cannot be written to individual test case log files. This occurs, for example, if a log printout is made from an external process (not a test diff --git a/lib/common_test/doc/src/test_structure_chapter.xml b/lib/common_test/doc/src/test_structure_chapter.xml index 3ffaa623c3..45ec67e3f6 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#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> + <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 8de2377fe6..a27c932050 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#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#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>. + <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#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>. + <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 @@ -187,7 +187,7 @@ <p>Function <c>end_per_testcase/2</c> is even called if a test case terminates because of a call to - <seealso marker="ct#abort_current_testcase-1"><c>ct:abort_current_testcase/1</c></seealso>, + <seealso marker="ct#abort_current_testcase/1"><c>ct:abort_current_testcase/1</c></seealso>, or after a timetrap time-out. However, <c>end_per_testcase</c> then executes on a different process than the test case function. In this situation, <c>end_per_testcase</c> cannot @@ -260,7 +260,7 @@ <note><p>The test case function argument <c>Config</c> is not to be confused with the information that can be retrieved from the - configuration files (using <seealso marker="ct#get_config-1"><c> + configuration files (using <seealso marker="ct#get_config/1"><c> ct:get_config/1/2</c></seealso>). The test case argument <c>Config</c> is to be used for runtime configuration of the test suite and the test cases, while configuration files are to contain data @@ -271,7 +271,7 @@ a data type called a property list, it can be handled by the <seealso marker="stdlib:proplists"><c>proplists</c></seealso> module. A value can, for example, be searched for and returned with function - <seealso marker="stdlib:proplists#get_value-2"><c>proplists:get_value/2</c></seealso>. + <seealso marker="stdlib:proplists#get_value/2"><c>proplists:get_value/2</c></seealso>. Also, or alternatively, the general <seealso marker="stdlib:lists"><c>lists</c></seealso> module contains useful functions. Normally, the only operations performed on <c>Config</c> is insert (adding a tuple to the head of the list) @@ -289,7 +289,7 @@ <p>If the test case returns the tuple <c>{comment,Comment}</c>, the case is considered successful and <c>Comment</c> is printed in the overview log file. This is equal to calling - <seealso marker="ct#comment-1"><c>ct:comment(Comment)</c></seealso>. + <seealso marker="ct#comment/1"><c>ct:comment(Comment)</c></seealso>. </p> </section> @@ -322,7 +322,7 @@ <p> Specifies any data related to the test case. This data can be retrieved at any time using the - <seealso marker="ct#userdata-3"><c>ct:userdata/3</c></seealso> + <seealso marker="ct#userdata/3"><c>ct:userdata/3</c></seealso> utility function. </p> </item> @@ -370,7 +370,7 @@ <seealso marker="config_file_chapter#require_config_data"> Requiring and Reading Configuration Data</seealso> in section External Configuration Data and function - <seealso marker="ct#require-1"><c>ct:require/1/2</c></seealso>.</p> + <seealso marker="ct#require/1"><c>ct:require/1/2</c></seealso>.</p> <note><p>Specifying a default value for a required variable can result in a test case always getting executed. This might not be a desired behavior.</p> @@ -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#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#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#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 @@ -561,12 +561,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#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#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>. If the init function is defined, so must the end function be.</p> @@ -834,7 +834,7 @@ test case and execution instead. This is accomplished with the flag/option <c>create_priv_dir</c> (to be used with the <seealso marker="ct_run"><c>ct_run</c></seealso> program, the - <seealso marker="ct#run_test-1"><c>ct:run_test/1</c></seealso> function, or + <seealso marker="ct#run_test/1"><c>ct:run_test/1</c></seealso> function, or as test specification term). There are three possible values for this option as follows: </p> @@ -853,7 +853,7 @@ Therefore, if the manual version is used instead, the test case must tell <c>Common Test</c> to create <c>priv_dir</c> when it needs it. It does this by calling the function - <seealso marker="ct#make_priv_dir-0"><c>ct:make_priv_dir/0</c></seealso>. + <seealso marker="ct#make_priv_dir/0"><c>ct:make_priv_dir/0</c></seealso>. </p> <note><p>Do not depend on the current working directory for @@ -902,7 +902,7 @@ <p>A timetrap can also be set or reset dynamically during the execution of a test case, or configuration function. This is done by calling - <seealso marker="ct#timetrap-1"><c>ct:timetrap/1</c></seealso>. + <seealso marker="ct#timetrap/1"><c>ct:timetrap/1</c></seealso>. This function cancels the current timetrap and starts a new one (that stays active until time-out, or end of the current function).</p> @@ -916,13 +916,13 @@ <p>If a test case needs to suspend itself for a time that also gets multipled by <c>multiply_timetraps</c> (and possibly also scaled up if <c>scale_timetraps</c> is enabled), the function - <seealso marker="ct#sleep-1"><c>ct:sleep/1</c></seealso> + <seealso marker="ct#sleep/1"><c>ct:sleep/1</c></seealso> can be used (instead of, for example, <c>timer:sleep/1</c>).</p> <p>A function (<c>fun/0</c> or <c>{Mod,Func,Args}</c> (MFA) tuple) can be specified as timetrap value in the suite-, group- and test case information function, and as argument to function - <seealso marker="ct#timetrap-1"><c>ct:timetrap/1</c></seealso>.</p> + <seealso marker="ct#timetrap/1"><c>ct:timetrap/1</c></seealso>.</p> <p><em>Examples:</em></p> <p><c>{timetrap,{my_test_utils,timetrap,[?MODULE,system_start]}}</c></p> @@ -959,11 +959,11 @@ <item><c>ct:print(Category, Importance, Format, FormatArgs)</c></item> <item><c>ct:pal(Category, Importance, Format, FormatArgs)</c></item> </list> - <p>The <seealso marker="ct#log-1"><c>log/1,2,3,4,5</c></seealso> function + <p>The <seealso marker="ct#log/1"><c>log/1,2,3,4,5</c></seealso> function prints a string to the test case log file. - The <seealso marker="ct#print-1"><c>print/1,2,3,4</c></seealso> function + The <seealso marker="ct#print/1"><c>print/1,2,3,4</c></seealso> function prints the string to screen. - The <seealso marker="ct#pal-1"><c>pal/1,2,3,4</c></seealso> function + The <seealso marker="ct#pal/1"><c>pal/1,2,3,4</c></seealso> function prints the same string both to file and screen. The functions are described in module <seealso marker="ct">ct</seealso>. </p> @@ -1047,8 +1047,8 @@ ct:pal(?LOW_IMPORTANCE, "Info report: ~p", [Info])</pre> ct:log(?INFO, "Info report: ~p", [Info]) ct:pal(?ERROR, "Error report: ~p", [Error])</pre> - <p>The functions <seealso marker="ct#set_verbosity-2"><c>ct:set_verbosity/2</c></seealso> - and <seealso marker="ct#get_verbosity-1"><c>ct:get_verbosity/1</c></seealso> may be used + <p>The functions <seealso marker="ct#set_verbosity/2"><c>ct:set_verbosity/2</c></seealso> + and <seealso marker="ct#get_verbosity/1"><c>ct:get_verbosity/1</c></seealso> may be used to modify and read verbosity levels during test execution.</p> <p>The arguments <c>Format</c> and <c>FormatArgs</c> in <c>ct:log/print/pal</c> are @@ -1069,7 +1069,7 @@ ct:pal(?ERROR, "Error report: ~p", [Error])</pre> to the log file made with <c>ct:pal/4</c> and <c>io:format/2</c>. In order to print strings with HTML tags to the log, use the <c>ct:log/3,4,5</c> function. The character escaping feature is per default disabled for <c>ct:log/3,4,5</c> but can be enabled with - the <c>esc_chars</c> option in the <c>Opts</c> list, see <seealso marker="ct#log-5"> + the <c>esc_chars</c> option in the <c>Opts</c> list, see <seealso marker="ct#log/5"> <c>ct:log/3,4,5</c></seealso>.</p> <p>If the character escaping feature needs to be disabled (typically for backwards @@ -1163,7 +1163,7 @@ ct:pal(?ERROR, "Error report: ~p", [Error])</pre> environment as possible, so that subsequent test cases do not crash because of their execution order. The function - <seealso marker="common_test#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> |