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 | |
| parent | 1223a53aa871b1279cb4a78ec714f5fc1273de9b (diff) | |
| download | erlang-95e286750901d56e6e25fb13da8fe34f32702594.tar.gz | |
otp: Change all MFA links to use "/" syntax for arity
88 files changed, 1102 insertions, 1102 deletions
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index 5666ea269e..ce90c73a09 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -10649,7 +10649,7 @@ timestamp() -> <seealso marker="time_correction#Erlang_Monotonic_Time">Erlang monotonic time</seealso> time stamp in all trace messages. The time stamp (Ts) has the same format and value as produced by - <seealso marker="#monotonic_time-1"> + <seealso marker="#monotonic_time/1"> <c>erlang:monotonic_time(nanosecond)</c></seealso>. This flag overrides flag <c>cpu_timestamp</c>.</p> </item> @@ -10660,9 +10660,9 @@ timestamp() -> monotonic time</seealso> and a monotonically increasing integer in all trace messages. The time stamp (Ts) has the same format and value as produced by <c>{</c> - <seealso marker="#monotonic_time-1"> + <seealso marker="#monotonic_time/1"> <c>erlang:monotonic_time(nanosecond)</c></seealso><c>,</c> - <seealso marker="#unique_integer-1"> + <seealso marker="#unique_integer/1"> <c>erlang:unique_integer([monotonic])</c></seealso><c>}</c>. This flag overrides flag <c>cpu_timestamp</c>.</p> </item> 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> diff --git a/lib/crypto/doc/src/algorithm_details.xml b/lib/crypto/doc/src/algorithm_details.xml index d40664bb9f..45a93bfe22 100644 --- a/lib/crypto/doc/src/algorithm_details.xml +++ b/lib/crypto/doc/src/algorithm_details.xml @@ -51,7 +51,7 @@ <seealso marker="crypto:new_api#retired-cipher-names">Retired cipher names</seealso>. </p> <p>To dynamically check availability, check that the name in the <i>Cipher and Mode</i> column is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(ciphers)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(ciphers)</seealso>. </p> <section> @@ -162,7 +162,7 @@ <section> <title>Message Authentication Codes (MACs)</title> - <p>To be used in <seealso marker="crypto#mac-4">mac/4</seealso> and + <p>To be used in <seealso marker="crypto#mac/4">mac/4</seealso> and <seealso marker="crypto:new_api#macs--message-authentication-codes-">related functions</seealso>. </p> @@ -172,9 +172,9 @@ </p> <p>To dynamically check availability, check that the name <c>cmac</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(macs)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(macs)</seealso>. Also check that the name in the <i>Cipher and Mode</i> column is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(ciphers)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(ciphers)</seealso>. </p> <table> <row> @@ -203,9 +203,9 @@ <p>Available in all OpenSSL compatible with Erlang CRYPTO if not disabled by configuration. </p> <p>To dynamically check availability, check that the name <c>hmac</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(macs)</seealso> and + list returned by <seealso marker="crypto#supports/1">crypto:supports(macs)</seealso> and that the hash name is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(hashs)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(hashs)</seealso>. </p> <table> @@ -238,7 +238,7 @@ <p>POLY1305 is available with OpenSSL 1.1.1 or later if not disabled by configuration. </p> <p>To dynamically check availability, check that the name <c>poly1305</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(macs)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(macs)</seealso>. </p> <p>The poly1305 mac wants an 32 bytes key and produces a 16 byte MAC by default. </p> @@ -250,7 +250,7 @@ <title>Hash</title> <p>To dynamically check availability, check that the wanted name in the <i>Names</i> column is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(hashs)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(hashs)</seealso>. </p> <table> @@ -275,7 +275,7 @@ <title>RSA</title> <p>RSA is available with all OpenSSL versions compatible with Erlang CRYPTO if not disabled by configuration. To dynamically check availability, check that the atom <c>rsa</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(public_keys)</seealso>. </p> <warning> <!-- In RefMan rsa_opt(), rsa_sign_verify_opt() and User's man RSA --> @@ -347,7 +347,7 @@ <title>DSS</title> <p>DSS is available with OpenSSL versions compatible with Erlang CRYPTO if not disabled by configuration. To dynamically check availability, check that the atom <c>dss</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(public_keys)</seealso>. </p> </section> @@ -355,11 +355,11 @@ <title>ECDSA</title> <p>ECDSA is available with OpenSSL 0.9.8o or later if not disabled by configuration. To dynamically check availability, check that the atom <c>ecdsa</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(public_keys)</seealso>. If the atom <c>ec_gf2m</c> also is present, the characteristic two field curves are available. </p> <p>The actual supported named curves could be checked by examining the - list returned by <seealso marker="crypto#supports-1">crypto:supports(curves)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(curves)</seealso>. </p> </section> @@ -367,11 +367,11 @@ <title>EdDSA</title> <p>EdDSA is available with OpenSSL 1.1.1 or later if not disabled by configuration. To dynamically check availability, check that the atom <c>eddsa</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(public_keys)</seealso>. </p> <p>Support for the curves ed25519 and ed448 is implemented. The actual supported named curves could be checked by examining the list with the - list returned by <seealso marker="crypto#supports-1">crypto:supports(curves)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(curves)</seealso>. </p> </section> @@ -380,7 +380,7 @@ <p>Diffie-Hellman computations are available with OpenSSL versions compatible with Erlang CRYPTO if not disabled by configuration. To dynamically check availability, check that the atom <c>dh</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(public_keys)</seealso>. </p> </section> @@ -388,7 +388,7 @@ <title>Elliptic Curve Diffie-Hellman</title> <p>Elliptic Curve Diffie-Hellman is available with OpenSSL 0.9.8o or later if not disabled by configuration. To dynamically check availability, check that the atom <c>ecdh</c> is present in the - list returned by <seealso marker="crypto#supports-1">crypto:supports(public_keys)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(public_keys)</seealso>. </p> <p>The Edward curves <c>x25519</c> and <c>x448</c> are supported with OpenSSL 1.1.1 or later @@ -396,7 +396,7 @@ </p> <p>The actual supported named curves could be checked by examining the - list returned by <seealso marker="crypto#supports-1">crypto:supports(curves)</seealso>. + list returned by <seealso marker="crypto#supports/1">crypto:supports(curves)</seealso>. </p> </section> diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index f7c0cbc679..66c4eca093 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -585,7 +585,7 @@ <name name="engine_key_ref"/> <name name="engine_ref"/> <desc> - <p>The result of a call to <seealso marker="#engine_load-3">engine_load/3</seealso>. + <p>The result of a call to <seealso marker="#engine_load/3">engine_load/3</seealso>. </p> </desc> </datatype> @@ -614,7 +614,7 @@ <datatype> <name name="engine_cmnd"/> <desc> - <p>Pre and Post commands for <seealso marker="#engine_load-3">engine_load/3 and /4</seealso>. + <p>Pre and Post commands for <seealso marker="#engine_load/3">engine_load/3 and /4</seealso>. </p> </desc> </datatype> @@ -644,7 +644,7 @@ <p>The exception <c>error:notsup</c> signifies that the algorithm is known but is not supported by current underlying libcrypto or explicitly disabled when building that. </p> - <p>For a list of supported algorithms, see <seealso marker="#supports-0">supports/0</seealso>. + <p>For a list of supported algorithms, see <seealso marker="#supports/0">supports/0</seealso>. </p> </desc> </datatype> @@ -917,7 +917,7 @@ <desc> <p> Can be used to determine which crypto algorithms that are supported by the underlying libcrypto library</p> - <p>See <seealso marker="#hash_info-1">hash_info/1</seealso> and <seealso marker="#cipher_info-1">cipher_info/1</seealso> + <p>See <seealso marker="#hash_info/1">hash_info/1</seealso> and <seealso marker="#cipher_info/1">cipher_info/1</seealso> for information about the hash and cipher algorithms. </p> </desc> @@ -927,7 +927,7 @@ <name name="mac" arity="3" since="OTP 22.1"/> <fsummary></fsummary> <desc> - <p>Short for <seealso marker="#mac-4">mac(Type, undefined, Key, Data)</seealso>. + <p>Short for <seealso marker="#mac/4">mac(Type, undefined, Key, Data)</seealso>. </p> </desc> </func> @@ -949,7 +949,7 @@ <seealso marker="algorithm_details#cmac">Algorithm Details</seealso> in the User's Guide. </item> <item>For <c>poly1305</c> it should be set to <c>undefined</c> or the - <seealso marker="#mac_init-2">mac/2</seealso> function could be used instead, see + <seealso marker="#mac_init/2">mac/2</seealso> function could be used instead, see <seealso marker="algorithm_details#poly1305">Algorithm Details</seealso> in the User's Guide. </item> </list> @@ -957,15 +957,15 @@ <p><c>Key</c> is the authentication key with a length according to the <c>Type</c> and <c>SubType</c>. The key length could be found with the - <seealso marker="#hash_info-1">hash_info/1</seealso> (<c>hmac</c>) for and - <seealso marker="#cipher_info-1">cipher_info/1</seealso> (<c>cmac</c>) + <seealso marker="#hash_info/1">hash_info/1</seealso> (<c>hmac</c>) for and + <seealso marker="#cipher_info/1">cipher_info/1</seealso> (<c>cmac</c>) functions. For <c>poly1305</c> the key length is 32 bytes. Note that the cryptographic quality of the key is not checked. </p> <p>The <c>Mac</c> result will have a default length depending on the <c>Type</c> and <c>SubType</c>. - To set a shorter length, use <seealso marker="#macN-4">macN/4</seealso> or - <seealso marker="#macN-5">macN/5</seealso> instead. + To set a shorter length, use <seealso marker="#macN/4">macN/4</seealso> or + <seealso marker="#macN/5">macN/5</seealso> instead. The default length is documented in <seealso marker="algorithm_details#message-authentication-codes--macs-">Algorithm Details</seealso> in the User's Guide. @@ -977,7 +977,7 @@ <name name="macN" arity="4" since="OTP 22.1"/> <fsummary></fsummary> <desc> - <p>Short for <seealso marker="#macN-5">macN(Type, undefined, Key, Data, MacLength)</seealso>. + <p>Short for <seealso marker="#macN/5">macN(Type, undefined, Key, Data, MacLength)</seealso>. </p> </desc> </func> @@ -987,7 +987,7 @@ <fsummary></fsummary> <desc> <p>Computes a MAC (Message Authentication Code) - as <seealso marker="#mac-3">mac/3</seealso> and <seealso marker="#mac-4">mac/4</seealso> but + as <seealso marker="#mac/3">mac/3</seealso> and <seealso marker="#mac/4">mac/4</seealso> but <c>MacLength</c> will limit the size of the resultant <c>Mac</c> to at most <c>MacLength</c> bytes. Note that if <c>MacLength</c> is greater than the actual number of @@ -1005,7 +1005,7 @@ <name name="mac_init" arity="2" since="OTP 22.1"/> <fsummary></fsummary> <desc> - <p>Short for <seealso marker="#mac_init-3">mac_init(Type, undefined, Key)</seealso>. + <p>Short for <seealso marker="#mac_init/3">mac_init(Type, undefined, Key)</seealso>. </p> </desc> </func> @@ -1029,7 +1029,7 @@ <seealso marker="algorithm_details#cmac">Algorithm Details</seealso> in the User's Guide. </item> <item>For <c>poly1305</c> it should be set to <c>undefined</c> or the - <seealso marker="#mac_init-2">mac/2</seealso> function could be used instead, see + <seealso marker="#mac_init/2">mac/2</seealso> function could be used instead, see <seealso marker="algorithm_details#poly1305">Algorithm Details</seealso> in the User's Guide. </item> </list> @@ -1037,17 +1037,17 @@ <p><c>Key</c> is the authentication key with a length according to the <c>Type</c> and <c>SubType</c>. The key length could be found with the - <seealso marker="#hash_info-1">hash_info/1</seealso> (<c>hmac</c>) for and - <seealso marker="#cipher_info-1">cipher_info/1</seealso> (<c>cmac</c>) + <seealso marker="#hash_info/1">hash_info/1</seealso> (<c>hmac</c>) for and + <seealso marker="#cipher_info/1">cipher_info/1</seealso> (<c>cmac</c>) functions. For <c>poly1305</c> the key length is 32 bytes. Note that the cryptographic quality of the key is not checked. </p> <p>The returned <c>State</c> should be used in one or more subsequent calls to - <seealso marker="#mac_update-2">mac_update/2</seealso>. + <seealso marker="#mac_update/2">mac_update/2</seealso>. The MAC value is finally returned by calling - <seealso marker="#mac_final-1">mac_final/1</seealso> or - <seealso marker="#mac_finalN-2">mac_finalN/2</seealso>. + <seealso marker="#mac_final/1">mac_final/1</seealso> or + <seealso marker="#mac_finalN/2">mac_finalN/2</seealso>. </p> <p>See <seealso marker="crypto:new_api#example-of-mac_init-mac_update-and-mac_final"> @@ -1064,8 +1064,8 @@ could be of any length. </p> <p>The <c>State0</c> is the State value originally from a MAC init function, that is - <seealso marker="#mac_init-2">mac_init/2</seealso>, - <seealso marker="#mac_init-3">mac_init/3</seealso> or + <seealso marker="#mac_init/2">mac_init/2</seealso>, + <seealso marker="#mac_init/3">mac_init/3</seealso> or a previous call of <c>mac_update/2</c>. The value <c>State0</c> is returned unchanged by the function as <c>State</c>. </p> @@ -1078,8 +1078,8 @@ <desc> <p>Finalizes the MAC operation referenced by <c>State</c>. The <c>Mac</c> result will have a default length depending on the <c>Type</c> and <c>SubType</c> in the - <seealso marker="#mac_init-3">mac_init/2,3</seealso> call. - To set a shorter length, use <seealso marker="#mac_finalN-2">mac_finalN/2</seealso> instead. + <seealso marker="#mac_init/3">mac_init/2,3</seealso> call. + To set a shorter length, use <seealso marker="#mac_finalN/2">mac_finalN/2</seealso> instead. The default length is documented in <seealso marker="algorithm_details#message-authentication-codes--macs-">Algorithm Details</seealso> in the User's Guide. @@ -1125,7 +1125,7 @@ <fsummary>Computes the shared secret</fsummary> <desc> <p>Computes the shared secret from the private key and the other party's public key. - See also <seealso marker="public_key:public_key#compute_key-2">public_key:compute_key/2</seealso> + See also <seealso marker="public_key:public_key#compute_key/2">public_key:compute_key/2</seealso> </p> </desc> </func> @@ -1145,7 +1145,7 @@ <fsummary>Generates a public key of type <c>Type</c></fsummary> <desc> <p>Generates a public key of type <c>Type</c>. - See also <seealso marker="public_key:public_key#generate_key-1">public_key:generate_key/1</seealso>. + See also <seealso marker="public_key:public_key#generate_key/1">public_key:generate_key/1</seealso>. May raise exception: </p> <list type="bulleted"> @@ -1177,7 +1177,7 @@ <desc> <p>Initializes the context for streaming hash operations. <c>Type</c> determines which digest to use. The returned context should be used as argument - to <seealso marker="#hash_update-2">hash_update</seealso>.</p> + to <seealso marker="#hash_update/2">hash_update</seealso>.</p> <p>May raise exception <c>error:notsup</c> in case the chosen <c>Type</c> is not supported by the underlying libcrypto implementation.</p> </desc> @@ -1188,10 +1188,10 @@ <fsummary></fsummary> <desc> <p>Updates the digest represented by <c>Context</c> using the given <c>Data</c>. <c>Context</c> - must have been generated using <seealso marker="#hash_init-1">hash_init</seealso> + must have been generated using <seealso marker="#hash_init/1">hash_init</seealso> or a previous call to this function. <c>Data</c> can be any length. <c>NewContext</c> must be passed into the next call to <c>hash_update</c> - or <seealso marker="#hash_final-1">hash_final</seealso>.</p> + or <seealso marker="#hash_final/1">hash_final</seealso>.</p> </desc> </func> @@ -1200,7 +1200,7 @@ <fsummary></fsummary> <desc> <p>Finalizes the hash operation referenced by <c>Context</c> returned - from a previous call to <seealso marker="#hash_update-2">hash_update</seealso>. + from a previous call to <seealso marker="#hash_update/2">hash_update</seealso>. The size of <c>Digest</c> is determined by the type of hash function used to generate it.</p> </desc> @@ -1216,13 +1216,13 @@ running in FIPS mode) or <c>not_enabled</c>. For other builds this value is always <c>not_supported</c>. </p> - <p>See <seealso marker="#enable_fips_mode-1">enable_fips_mode/1</seealso> about how to enable + <p>See <seealso marker="#enable_fips_mode/1">enable_fips_mode/1</seealso> about how to enable FIPS mode. </p> <warning> <p>In FIPS mode all non-FIPS compliant algorithms are disabled and raise exception <c>error:notsup</c>. Check - <seealso marker="#supports-0">supports</seealso> that in + <seealso marker="#supports/0">supports</seealso> that in FIPS mode returns the restricted list of available algorithms.</p> </warning> @@ -1239,7 +1239,7 @@ <p>Note that to enable FIPS mode succesfully, OTP must be built with the configure option <c>--enable-fips</c>, and the underlying libcrypto must also support FIPS. </p> - <p>See also <seealso marker="#info_fips-0">info_fips/0</seealso>. + <p>See also <seealso marker="#info_fips/0">info_fips/0</seealso>. </p> </desc> </func> @@ -1272,7 +1272,7 @@ <p>Provides a map with information about block_size, size and possibly other properties of the hash algorithm in question. </p> - <p>For a list of supported hash algorithms, see <seealso marker="#supports-0">supports/0</seealso>. + <p>For a list of supported hash algorithms, see <seealso marker="#supports/0">supports/0</seealso>. </p> </desc> </func> @@ -1293,7 +1293,7 @@ <p>Always use a <c>Type</c> with an explicit key length, </p> </note> - <p>For a list of supported cipher algorithms, see <seealso marker="#supports-0">supports/0</seealso>. + <p>For a list of supported cipher algorithms, see <seealso marker="#supports/0">supports/0</seealso>. </p> </desc> </func> @@ -1324,11 +1324,11 @@ <fsummary>Decrypts CipherText using the private Key.</fsummary> <desc> <p>Decrypts the <c>CipherText</c>, encrypted with - <seealso marker="#public_encrypt-4">public_encrypt/4</seealso> (or equivalent function) + <seealso marker="#public_encrypt/4">public_encrypt/4</seealso> (or equivalent function) using the <c>PrivateKey</c>, and returns the plaintext (message digest). This is a low level signature verification operation used for instance by older versions of the SSL protocol. - See also <seealso marker="public_key:public_key#decrypt_private-2">public_key:decrypt_private/[2,3]</seealso> + See also <seealso marker="public_key:public_key#decrypt_private/2">public_key:decrypt_private/[2,3]</seealso> </p> </desc> </func> @@ -1341,7 +1341,7 @@ and returns the ciphertext. This is a low level signature operation used for instance by older versions of the SSL protocol. See also <seealso - marker="public_key:public_key#encrypt_private-2">public_key:encrypt_private/[2,3]</seealso> + marker="public_key:public_key#encrypt_private/2">public_key:encrypt_private/[2,3]</seealso> </p> </desc> </func> @@ -1351,11 +1351,11 @@ <fsummary>Decrypts CipherText using the public Key.</fsummary> <desc> <p>Decrypts the <c>CipherText</c>, encrypted with - <seealso marker="#private_encrypt-4">private_encrypt/4</seealso>(or equivalent function) + <seealso marker="#private_encrypt/4">private_encrypt/4</seealso>(or equivalent function) using the <c>PrivateKey</c>, and returns the plaintext (message digest). This is a low level signature verification operation used for instance by older versions of the SSL protocol. - See also <seealso marker="public_key:public_key#decrypt_public-2">public_key:decrypt_public/[2,3]</seealso> + See also <seealso marker="public_key:public_key#decrypt_public/2">public_key:decrypt_public/[2,3]</seealso> </p> </desc> </func> @@ -1367,7 +1367,7 @@ <p>Encrypts the <c>PlainText</c> (message digest) using the <c>PublicKey</c> and returns the <c>CipherText</c>. This is a low level signature operation used for instance by older versions of the SSL protocol. See also <seealso - marker="public_key:public_key#encrypt_public-2">public_key:encrypt_public/[2,3]</seealso> + marker="public_key:public_key#encrypt_public/2">public_key:encrypt_public/[2,3]</seealso> </p> </desc> </func> @@ -1438,8 +1438,8 @@ (based on OpenSSL's <c>BN_rand_range</c>), and saves it in the process dictionary before returning it as well. See also - <seealso marker="stdlib:rand#seed-1">rand:seed/1</seealso> and - <seealso marker="#rand_seed_s-0">rand_seed_s/0</seealso>. + <seealso marker="stdlib:rand#seed/1">rand:seed/1</seealso> and + <seealso marker="#rand_seed_s/0">rand_seed_s/0</seealso>. </p> <p> When using the state object from this function the @@ -1465,7 +1465,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[</pre> in order to generate cryptographically strongly random numbers (based on OpenSSL's <c>BN_rand_range</c>). See also - <seealso marker="stdlib:rand#seed_s-1">rand:seed_s/1</seealso>. + <seealso marker="stdlib:rand#seed_s/1">rand:seed_s/1</seealso>. </p> <p> When using the state object from this function the @@ -1504,8 +1504,8 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[</pre> in order to generate cryptographically strong random numbers, and saves it in the process dictionary before returning it as well. See also - <seealso marker="stdlib:rand#seed-1">rand:seed/1</seealso> and - <seealso marker="#rand_seed_alg_s-1">rand_seed_alg_s/1</seealso>. + <seealso marker="stdlib:rand#seed/1">rand:seed/1</seealso> and + <seealso marker="#rand_seed_alg_s/1">rand_seed_alg_s/1</seealso>. </p> <p> When using the state object from this function the @@ -1535,7 +1535,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[</pre> in order to generate cryptographically unpredictable random numbers, and saves it in the process dictionary before returning it as well. See also - <seealso marker="#rand_seed_alg_s-2">rand_seed_alg_s/2</seealso>. + <seealso marker="#rand_seed_alg_s/2">rand_seed_alg_s/2</seealso>. </p> <p><em>Example</em></p> <pre> @@ -1562,11 +1562,11 @@ FloatValue = rand:uniform(). % again <seealso marker="stdlib:rand">random number generation</seealso>, in order to generate cryptographically strongly random numbers. See also - <seealso marker="stdlib:rand#seed_s-1">rand:seed_s/1</seealso>. + <seealso marker="stdlib:rand#seed_s/1">rand:seed_s/1</seealso>. </p> <p> If <c>Alg</c> is <c>crypto</c> this function behaves exactly like - <seealso marker="#rand_seed_s-0">rand_seed_s/0</seealso>. + <seealso marker="#rand_seed_s/0">rand_seed_s/0</seealso>. </p> <p> If <c>Alg</c> is <c>crypto_cache</c> this function @@ -1626,7 +1626,7 @@ FloatValue = rand:uniform(). % again <seealso marker="stdlib:rand">random number generation</seealso>, in order to generate cryptographically unpredictable random numbers. See also - <seealso marker="#rand_seed_alg-1">rand_seed_alg/1</seealso>. + <seealso marker="#rand_seed_alg/1">rand_seed_alg/1</seealso>. </p> <p> To get a long period the Xoroshiro928 generator from the @@ -1646,7 +1646,7 @@ FloatValue = rand:uniform(). % again <item> <p> If you need cryptographically strong random numbers use - <seealso marker="#rand_seed_alg_s-1">rand_seed_alg_s/1</seealso> + <seealso marker="#rand_seed_alg_s/1">rand_seed_alg_s/1</seealso> with <c>Alg =:= crypto</c> or <c>Alg =:= crypto_cache</c>. </p> </item> @@ -1666,7 +1666,7 @@ FloatValue = rand:uniform(). % again </list> <p> Thanks to the used generator the state object supports the - <seealso marker="stdlib:rand#jump-0"><c>rand:jump/0,1</c></seealso> + <seealso marker="stdlib:rand#jump/0"><c>rand:jump/0,1</c></seealso> function with distance 2^512. </p> <p> @@ -1706,7 +1706,7 @@ FloatValue = rand:uniform(). % again digest (plaintext).</p> <p>Algorithm <c>dss</c> can only be used together with digest type <c>sha</c>.</p> - <p>See also <seealso marker="public_key:public_key#sign-3">public_key:sign/3</seealso>.</p> + <p>See also <seealso marker="public_key:public_key#sign/3">public_key:sign/3</seealso>.</p> </desc> </func> @@ -1722,7 +1722,7 @@ FloatValue = rand:uniform(). % again <p>Algorithm <c>dss</c> can only be used together with digest type <c>sha</c>.</p> - <p>See also <seealso marker="public_key:public_key#verify-4">public_key:verify/4</seealso>.</p> + <p>See also <seealso marker="public_key:public_key#verify/4">public_key:verify/4</seealso>.</p> </desc> </func> @@ -2141,8 +2141,8 @@ FloatValue = rand:uniform(). % again <desc> <dont><p>Don't use this function for new programs! Use <seealso marker="crypto:new_api">the new api</seealso>.</p></dont> <p>Initializes the state for use in RC4 stream encryption - <seealso marker="#stream_encrypt-2">stream_encrypt</seealso> and - <seealso marker="#stream_decrypt-2">stream_decrypt</seealso></p> + <seealso marker="#stream_encrypt/2">stream_encrypt</seealso> and + <seealso marker="#stream_decrypt/2">stream_decrypt</seealso></p> <p>For keylengths see the <seealso marker="crypto:algorithm_details#ciphers">User's Guide</seealso>. </p> @@ -2157,8 +2157,8 @@ FloatValue = rand:uniform(). % again <p>Initializes the state for use in streaming AES encryption using Counter mode (CTR). <c>Key</c> is the AES key and must be either 128, 192, or 256 bits long. <c>IVec</c> is an arbitrary initializing vector of 128 bits (16 bytes). This state is for use with - <seealso marker="#stream_encrypt-2">stream_encrypt</seealso> and - <seealso marker="#stream_decrypt-2">stream_decrypt</seealso>.</p> + <seealso marker="#stream_encrypt/2">stream_encrypt</seealso> and + <seealso marker="#stream_decrypt/2">stream_decrypt</seealso>.</p> <p>For keylengths and iv-sizes see the <seealso marker="crypto:algorithm_details#ciphers">User's Guide</seealso>. </p> @@ -2172,7 +2172,7 @@ FloatValue = rand:uniform(). % again <dont><p>Don't use this function for new programs! Use <seealso marker="crypto:new_api">the new api</seealso>.</p></dont> <p>Encrypts <c>PlainText</c> according to the stream cipher <c>Type</c> specified in stream_init/3. <c>Text</c> can be any number of bytes. The initial <c>State</c> is created using - <seealso marker="#stream_init-2">stream_init</seealso>. + <seealso marker="#stream_init/2">stream_init</seealso>. <c>NewState</c> must be passed into the next call to <c>stream_encrypt</c>.</p> </desc> </func> @@ -2184,7 +2184,7 @@ FloatValue = rand:uniform(). % again <dont><p>Don't use this function for new programs! Use <seealso marker="crypto:new_api">the new api</seealso>.</p></dont> <p>Decrypts <c>CipherText</c> according to the stream cipher <c>Type</c> specified in stream_init/3. <c>PlainText</c> can be any number of bytes. The initial <c>State</c> is created using - <seealso marker="#stream_init-2">stream_init</seealso>. + <seealso marker="#stream_init/2">stream_init</seealso>. <c>NewState</c> must be passed into the next call to <c>stream_decrypt</c>.</p> </desc> </func> @@ -2194,11 +2194,11 @@ FloatValue = rand:uniform(). % again <fsummary>Provide a list of available crypto algorithms.</fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#supports-1">supports/1</seealso> in + <seealso marker="crypto#supports/1">supports/1</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p></dont> <p> Can be used to determine which crypto algorithms that are supported by the underlying libcrypto library</p> - <p>See <seealso marker="#hash_info-1">hash_info/1</seealso> and <seealso marker="#cipher_info-1">cipher_info/1</seealso> + <p>See <seealso marker="#hash_info/1">hash_info/1</seealso> and <seealso marker="#cipher_info/1">cipher_info/1</seealso> for information about the hash and cipher algorithms. </p> </desc> @@ -2210,8 +2210,8 @@ FloatValue = rand:uniform(). % again <fsummary></fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#mac-4">mac/4</seealso> or - <seealso marker="crypto#macN-5">macN/5</seealso> in + <seealso marker="crypto#mac/4">mac/4</seealso> or + <seealso marker="crypto#macN/5">macN/5</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p> </dont> <p>Computes a HMAC of type <c>Type</c> from <c>Data</c> using @@ -2225,7 +2225,7 @@ FloatValue = rand:uniform(). % again <fsummary></fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#mac_init-3">mac_init/3</seealso> in + <seealso marker="crypto#mac_init/3">mac_init/3</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p> </dont> <p>Initializes the context for streaming HMAC operations. <c>Type</c> determines @@ -2239,15 +2239,15 @@ FloatValue = rand:uniform(). % again <fsummary></fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#mac_update-2">mac_update/2</seealso> in + <seealso marker="crypto#mac_update/2">mac_update/2</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p> </dont> <p>Updates the HMAC represented by <c>Context</c> using the given <c>Data</c>. <c>Context</c> must have been generated using an HMAC init function (such as - <seealso marker="#hmac_init-2">hmac_init</seealso>). <c>Data</c> can be any length. <c>NewContext</c> + <seealso marker="#hmac_init/2">hmac_init</seealso>). <c>Data</c> can be any length. <c>NewContext</c> must be passed into the next call to <c>hmac_update</c> - or to one of the functions <seealso marker="#hmac_final-1">hmac_final</seealso> and - <seealso marker="#hmac_final_n-2">hmac_final_n</seealso> + or to one of the functions <seealso marker="#hmac_final/1">hmac_final</seealso> and + <seealso marker="#hmac_final_n/2">hmac_final_n</seealso> </p> <warning><p>Do not use a <c>Context</c> as argument in more than one call to hmac_update or hmac_final. The semantics of reusing old contexts @@ -2262,7 +2262,7 @@ FloatValue = rand:uniform(). % again <fsummary></fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#mac_final-1">mac_final/1</seealso> in + <seealso marker="crypto#mac_final/1">mac_final/1</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p> </dont> <p>Finalizes the HMAC operation referenced by <c>Context</c>. The size of the resultant MAC is @@ -2275,7 +2275,7 @@ FloatValue = rand:uniform(). % again <fsummary></fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#mac_finalN-2">mac_finalN/2</seealso> in + <seealso marker="crypto#mac_finalN/2">mac_finalN/2</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p> </dont> <p>Finalizes the HMAC operation referenced by <c>Context</c>. <c>HashLen</c> must be greater than @@ -2289,8 +2289,8 @@ FloatValue = rand:uniform(). % again <fsummary>Calculates the Cipher-based Message Authentication Code.</fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#mac-4">mac/4</seealso> or - <seealso marker="crypto#macN-5">macN/5</seealso> in + <seealso marker="crypto#mac/4">mac/4</seealso> or + <seealso marker="crypto#macN/5">macN/5</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p> </dont> <p>Computes a CMAC of type <c>Type</c> from <c>Data</c> using @@ -2304,8 +2304,8 @@ FloatValue = rand:uniform(). % again <fsummary></fsummary> <desc> <dont><p>Don't use this function for new programs! Use - <seealso marker="crypto#mac-3">mac/3</seealso> or - <seealso marker="crypto#macN-4">macN/4</seealso> in + <seealso marker="crypto#mac/3">mac/3</seealso> or + <seealso marker="crypto#macN/4">macN/4</seealso> in <seealso marker="crypto:new_api">the new api</seealso>.</p> </dont> <p>Computes a POLY1305 message authentication code (<c>Mac</c>) from <c>Data</c> using diff --git a/lib/crypto/doc/src/crypto_app.xml b/lib/crypto/doc/src/crypto_app.xml index 8296b1bc77..51105f3992 100644 --- a/lib/crypto/doc/src/crypto_app.xml +++ b/lib/crypto/doc/src/crypto_app.xml @@ -72,10 +72,10 @@ <item> <p> Sets the cache size in bytes to use by - <seealso marker="crypto#rand_seed_alg-1"> + <seealso marker="crypto#rand_seed_alg/1"> <c>crypto:rand_seed_alg(crypto_cache)</c> </seealso> and - <seealso marker="crypto#rand_seed_alg_s-1"> + <seealso marker="crypto#rand_seed_alg_s/1"> <c>crypto:rand_seed_alg_s(crypto_cache)</c> </seealso>. This parameter is read when a seed function is called, diff --git a/lib/crypto/doc/src/engine_keys.xml b/lib/crypto/doc/src/engine_keys.xml index 153ea8dd24..ce5287c608 100644 --- a/lib/crypto/doc/src/engine_keys.xml +++ b/lib/crypto/doc/src/engine_keys.xml @@ -56,7 +56,7 @@ </p> <list> <item>an Engine is loaded, see the chapter on <seealso marker="crypto:engine_load#engine_load">Engine Load</seealso> - or the <seealso marker="crypto:crypto#engine_load-3">Reference Manual</seealso> + or the <seealso marker="crypto:crypto#engine_load/3">Reference Manual</seealso> </item> <item>a reference to a key in the Engine is available. This should be an Erlang string or binary and depends on the Engine loaded diff --git a/lib/crypto/doc/src/new_api.xml b/lib/crypto/doc/src/new_api.xml index 009f29584f..326e3212ef 100644 --- a/lib/crypto/doc/src/new_api.xml +++ b/lib/crypto/doc/src/new_api.xml @@ -51,32 +51,32 @@ <title>The old API</title> <p>The old functions - not recommended for new programs - are for chipers:</p> <list> - <item><seealso marker="crypto#block_encrypt-3">block_encrypt/3</seealso></item> - <item><seealso marker="crypto#block_encrypt-4">block_encrypt/4</seealso></item> - <item><seealso marker="crypto#block_decrypt-3">block_decrypt/3</seealso></item> - <item><seealso marker="crypto#block_decrypt-4">block_decrypt/4</seealso></item> - <item><seealso marker="crypto#stream_init-2">stream_init/2</seealso></item> - <item><seealso marker="crypto#stream_init-2">stream_init/3</seealso></item> - <item><seealso marker="crypto#stream_encrypt-2">stream_encrypt/2</seealso></item> - <item><seealso marker="crypto#stream_decrypt-2">stream_decrypt/2</seealso></item> - <item><seealso marker="crypto#next_iv-2">next_iv/2</seealso></item> - <item><seealso marker="crypto#next_iv-3">next_iv/3</seealso></item> + <item><seealso marker="crypto#block_encrypt/3">block_encrypt/3</seealso></item> + <item><seealso marker="crypto#block_encrypt/4">block_encrypt/4</seealso></item> + <item><seealso marker="crypto#block_decrypt/3">block_decrypt/3</seealso></item> + <item><seealso marker="crypto#block_decrypt/4">block_decrypt/4</seealso></item> + <item><seealso marker="crypto#stream_init/2">stream_init/2</seealso></item> + <item><seealso marker="crypto#stream_init/2">stream_init/3</seealso></item> + <item><seealso marker="crypto#stream_encrypt/2">stream_encrypt/2</seealso></item> + <item><seealso marker="crypto#stream_decrypt/2">stream_decrypt/2</seealso></item> + <item><seealso marker="crypto#next_iv/2">next_iv/2</seealso></item> + <item><seealso marker="crypto#next_iv/3">next_iv/3</seealso></item> </list> <p>for lists of supported algorithms:</p> <list> - <item><seealso marker="crypto#supports-0">supports/0</seealso></item> + <item><seealso marker="crypto#supports/0">supports/0</seealso></item> </list> <p>and for MACs (Message Authentication Codes):</p> <list> - <item><seealso marker="crypto#cmac-3">cmac/3</seealso></item> - <item><seealso marker="crypto#cmac-4">cmac/4</seealso></item> - <item><seealso marker="crypto#hmac-3">hmac/3</seealso></item> - <item><seealso marker="crypto#hmac-4">hmac/4</seealso></item> - <item><seealso marker="crypto#hmac_init-2">hmac_init/2</seealso></item> - <item><seealso marker="crypto#hmac_update-2">hmac_update/2</seealso></item> - <item><seealso marker="crypto#hmac_final-1">hmac_final/1</seealso></item> - <item><seealso marker="crypto#hmac_final_n-2">hmac_final_n/2</seealso></item> - <item><seealso marker="crypto#poly1305-2">poly1305/2</seealso></item> + <item><seealso marker="crypto#cmac/3">cmac/3</seealso></item> + <item><seealso marker="crypto#cmac/4">cmac/4</seealso></item> + <item><seealso marker="crypto#hmac/3">hmac/3</seealso></item> + <item><seealso marker="crypto#hmac/4">hmac/4</seealso></item> + <item><seealso marker="crypto#hmac_init/2">hmac_init/2</seealso></item> + <item><seealso marker="crypto#hmac_update/2">hmac_update/2</seealso></item> + <item><seealso marker="crypto#hmac_final/1">hmac_final/1</seealso></item> + <item><seealso marker="crypto#hmac_final_n/2">hmac_final_n/2</seealso></item> + <item><seealso marker="crypto#poly1305/2">poly1305/2</seealso></item> </list> <p>They are deprecated from 23.0 and for removal in 24.0. </p> @@ -132,13 +132,13 @@ <p>For information about available algorithms, use: </p> <list> - <item><seealso marker="crypto#supports-1">supports/1</seealso></item> - <item><seealso marker="crypto#hash_info-1">hash_info/1</seealso></item> - <item><seealso marker="crypto#cipher_info-1">cipher_info/1</seealso></item> + <item><seealso marker="crypto#supports/1">supports/1</seealso></item> + <item><seealso marker="crypto#hash_info/1">hash_info/1</seealso></item> + <item><seealso marker="crypto#cipher_info/1">cipher_info/1</seealso></item> </list> - <p>The <seealso marker="crypto#next_iv-2">next_iv/2</seealso> and - <seealso marker="crypto#next_iv-3">next_iv/3</seealso> is not needed since the + <p>The <seealso marker="crypto#next_iv/2">next_iv/2</seealso> and + <seealso marker="crypto#next_iv/3">next_iv/3</seealso> is not needed since the <c>crypto_init</c> and <c>crypto_update</c> includes this functionality. </p> @@ -148,18 +148,18 @@ <title>MACs (Message Authentication Codes)</title> <p>The new functions for calculating a MAC of a single piece of text are:</p> <list> - <item><seealso marker="crypto#mac-3">mac/3</seealso></item> - <item><seealso marker="crypto#mac-4">mac/4</seealso></item> - <item><seealso marker="crypto#macN-4">macN/4</seealso></item> - <item><seealso marker="crypto#macN-5">macN/5</seealso></item> + <item><seealso marker="crypto#mac/3">mac/3</seealso></item> + <item><seealso marker="crypto#mac/4">mac/4</seealso></item> + <item><seealso marker="crypto#macN/4">macN/4</seealso></item> + <item><seealso marker="crypto#macN/5">macN/5</seealso></item> </list> <p>For calculating a MAC of a text divided in parts use:</p> <list> - <item><seealso marker="crypto#mac_init-2">mac_init/2</seealso></item> - <item><seealso marker="crypto#mac_init-3">mac_init/3</seealso></item> - <item><seealso marker="crypto#mac_update-2">mac_update/2</seealso></item> - <item><seealso marker="crypto#mac_final-1">mac_final/1</seealso></item> - <item><seealso marker="crypto#mac_finalN-2">mac_finalN/2</seealso></item> + <item><seealso marker="crypto#mac_init/2">mac_init/2</seealso></item> + <item><seealso marker="crypto#mac_init/3">mac_init/3</seealso></item> + <item><seealso marker="crypto#mac_update/2">mac_update/2</seealso></item> + <item><seealso marker="crypto#mac_final/1">mac_final/1</seealso></item> + <item><seealso marker="crypto#mac_finalN/2">mac_finalN/2</seealso></item> </list> </section> </section> @@ -226,7 +226,7 @@ <section> <title>Example of crypto_one_time/5</title> <p>The same example as in the - <seealso marker="#examples-of-crypto_init-4-and-crypto_update-2">previous section</seealso>, + <seealso marker="#examples-of-crypto_init-4-and-crypto_update/2">previous section</seealso>, but now with one call to <seealso marker="crypto#crypto_one_time/5">crypto_one_time/5</seealso>: </p> <code> @@ -249,7 +249,7 @@ <section> <title>Example of crypto_one_time_aead/6</title> <p>The same example as in the - <seealso marker="#example-of-crypto_one_time-5">previous section</seealso>, + <seealso marker="#example-of-crypto_one_time/5">previous section</seealso>, but now with one call to <seealso marker="crypto#crypto_one_time_aead/6">crypto_one_time_aead/6</seealso>: </p> <code> diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index aa4eb6ad45..1f58ac4386 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd" [ <!ENTITY spawn_opt2 - '<seealso marker="erts:erlang#spawn_opt-2">erlang:spawn_opt/2</seealso>'> + '<seealso marker="erts:erlang#spawn_opt/2">erlang:spawn_opt/2</seealso>'> <!ENTITY spawn_opt5 - '<seealso marker="erts:erlang#spawn_opt-5">erlang:spawn_opt/5</seealso>'> + '<seealso marker="erts:erlang#spawn_opt/5">erlang:spawn_opt/5</seealso>'> <!ENTITY nodes - '<seealso marker="erts:erlang#nodes-0">erlang:nodes/0</seealso>'> + '<seealso marker="erts:erlang#nodes/0">erlang:nodes/0</seealso>'> <!ENTITY make_ref - '<seealso marker="erts:erlang#make_ref-0">erlang:make_ref/0</seealso>'> + '<seealso marker="erts:erlang#make_ref/0">erlang:make_ref/0</seealso>'> <!ENTITY transport_module '<seealso marker="diameter_transport">transport module</seealso>'> <!ENTITY dictionary diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index 4a205b9a89..24f5588005 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd" [ <!ENTITY compile_forms2 - '<seealso marker="compiler:compile#forms-2">compile:forms/2</seealso>'> + '<seealso marker="compiler:compile#forms/2">compile:forms/2</seealso>'> <!ENTITY filename '<seealso marker="kernel:file#type-name">file:name()</seealso>'> <!ENTITY dictionary diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index 097bfce7d9..445541f3bf 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -4,7 +4,7 @@ '<seealso marker="diameter_tcp#sender">diameter_tcp(3)</seealso>'> <!ENTITY gen_sctp '<seealso marker="kernel:gen_sctp">gen_sctp(3)</seealso>'> <!ENTITY gen_sctp_open1 - '<seealso marker="kernel:gen_sctp#open-1">gen_sctp:open/1</seealso>'> + '<seealso marker="kernel:gen_sctp#open/1">gen_sctp:open/1</seealso>'> <!ENTITY ip_address '<seealso marker="kernel:inet#type-ip_address">inet:ip_address()</seealso>'> <!ENTITY inet '<seealso marker="kernel:inet">inet(3)</seealso>'> diff --git a/lib/diameter/doc/src/diameter_soc.xml b/lib/diameter/doc/src/diameter_soc.xml index 2d2d66a243..1319935203 100644 --- a/lib/diameter/doc/src/diameter_soc.xml +++ b/lib/diameter/doc/src/diameter_soc.xml @@ -2,7 +2,7 @@ <!DOCTYPE chapter SYSTEM "chapter.dtd" [ <!ENTITY gen_sctp '<seealso marker="kernel:gen_sctp">gen_sctp(3)</seealso>'> <!ENTITY gen_tcp '<seealso marker="kernel:gen_tcp">gen_tcp(3)</seealso>'> - <!ENTITY service '<seealso marker="diameter#start_service-2">service</seealso>'> + <!ENTITY service '<seealso marker="diameter#start_service/2">service</seealso>'> <!ENTITY capabilities '<seealso marker="diameter#capability">capabilities</seealso>'> <!ENTITY events '<seealso marker="diameter#service_event">events</seealso>'> <!ENTITY NA '—'> diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml index 932bcab1ea..84b01abae0 100644 --- a/lib/diameter/doc/src/diameter_tcp.xml +++ b/lib/diameter/doc/src/diameter_tcp.xml @@ -1,20 +1,20 @@ <?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd" [ - <!ENTITY start '<seealso marker="#start-3">start/3</seealso>'> + <!ENTITY start '<seealso marker="#start/3">start/3</seealso>'> <!ENTITY gen_tcp_connect3 - '<seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect/3</seealso>'> + '<seealso marker="kernel:gen_tcp#connect/3">gen_tcp:connect/3</seealso>'> <!ENTITY gen_tcp_listen2 - '<seealso marker="kernel:gen_tcp#listen-2">gen_tcp:listen/2</seealso>'> + '<seealso marker="kernel:gen_tcp#listen/2">gen_tcp:listen/2</seealso>'> <!ENTITY ip_address '<seealso marker="kernel:inet#type-ip_address">inet:ip_address()</seealso>'> <!ENTITY ssl_connect2 - '<seealso marker="ssl:ssl#connect-2">ssl:connect/2</seealso>'> + '<seealso marker="ssl:ssl#connect/2">ssl:connect/2</seealso>'> <!ENTITY ssl_connect3 - '<seealso marker="ssl:ssl#connect-3">ssl:connect/3</seealso>'> + '<seealso marker="ssl:ssl#connect/3">ssl:connect/3</seealso>'> <!ENTITY ssl_accept2 - '<seealso marker="ssl:ssl#ssl_accept-2">ssl:ssl_accept/2</seealso>'> + '<seealso marker="ssl:ssl#ssl_accept/2">ssl:ssl_accept/2</seealso>'> <!ENTITY ssl_listen2 - '<seealso marker="ssl:ssl#listen-2">ssl:listen/2</seealso>'> + '<seealso marker="ssl:ssl#listen/2">ssl:listen/2</seealso>'> <!ENTITY gen_tcp '<seealso marker="kernel:gen_tcp">gen_tcp(3)</seealso>'> <!ENTITY inet '<seealso marker="kernel:inet">inet(3)</seealso>'> <!ENTITY ssl '<seealso marker="ssl:ssl">ssl(3)</seealso>'> diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml index 0a8ef321c6..af4ac9ef25 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -2,7 +2,7 @@ <!DOCTYPE erlref SYSTEM "erlref.dtd" [ <!ENTITY message '<seealso marker="#message">message()</seealso>'> <!ENTITY MESSAGES '<seealso marker="#MESSAGES">MESSAGES</seealso>'> - <!ENTITY start '<seealso marker="#Mod:start-3">start/3</seealso>'> + <!ENTITY start '<seealso marker="#Mod:start/3">start/3</seealso>'> <!ENTITY ip_address '<seealso marker="kernel:inet#type-ip_address">inet:ip_address()</seealso>'> <!ENTITY % also SYSTEM "seealso.ent" > diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent index 72d74c103c..47423a57ab 100644 --- a/lib/diameter/doc/src/seealso.ent +++ b/lib/diameter/doc/src/seealso.ent @@ -37,16 +37,16 @@ significant. <!-- diameter --> -<!ENTITY mod_add_transport '<seealso marker="diameter#add_transport-2">diameter:add_transport/2</seealso>'> -<!ENTITY mod_call '<seealso marker="diameter#call-4">diameter:call/4</seealso>'> -<!ENTITY mod_origin_state_id '<seealso marker="diameter#origin_state_id-0">diameter:origin_state_id/0</seealso>'> -<!ENTITY mod_remove_transport '<seealso marker="diameter#remove_transport-2">diameter:remove_transport/2</seealso>'> -<!ENTITY mod_service_info '<seealso marker="diameter#service_info-2">diameter:service_info/2</seealso>'> -<!ENTITY mod_services '<seealso marker="diameter#services-0">diameter:services/0</seealso>'> -<!ENTITY mod_session_id '<seealso marker="diameter#session_id-1">diameter:session_id/1</seealso>'> -<!ENTITY mod_start_service '<seealso marker="diameter#start_service-2">diameter:start_service/2</seealso>'> -<!ENTITY mod_stop_service '<seealso marker="diameter#stop_service-1">diameter:stop_service/1</seealso>'> -<!ENTITY mod_subscribe '<seealso marker="diameter#subscribe-1">diameter:subscribe/1</seealso>'> +<!ENTITY mod_add_transport '<seealso marker="diameter#add_transport/2">diameter:add_transport/2</seealso>'> +<!ENTITY mod_call '<seealso marker="diameter#call/4">diameter:call/4</seealso>'> +<!ENTITY mod_origin_state_id '<seealso marker="diameter#origin_state_id/0">diameter:origin_state_id/0</seealso>'> +<!ENTITY mod_remove_transport '<seealso marker="diameter#remove_transport/2">diameter:remove_transport/2</seealso>'> +<!ENTITY mod_service_info '<seealso marker="diameter#service_info/2">diameter:service_info/2</seealso>'> +<!ENTITY mod_services '<seealso marker="diameter#services/0">diameter:services/0</seealso>'> +<!ENTITY mod_session_id '<seealso marker="diameter#session_id/1">diameter:session_id/1</seealso>'> +<!ENTITY mod_start_service '<seealso marker="diameter#start_service/2">diameter:start_service/2</seealso>'> +<!ENTITY mod_stop_service '<seealso marker="diameter#stop_service/1">diameter:stop_service/1</seealso>'> +<!ENTITY mod_subscribe '<seealso marker="diameter#subscribe/1">diameter:subscribe/1</seealso>'> <!ENTITY mod_application_alias '<seealso marker="diameter#application_alias">diameter:application_alias()</seealso>'> <!ENTITY mod_application_module '<seealso marker="diameter#application_module">diameter:application_module()</seealso>'> @@ -76,14 +76,14 @@ significant. <!-- diameter_app --> -<!ENTITY app_handle_answer '<seealso marker="diameter_app#Mod:handle_answer-4">handle_answer/4</seealso>'> -<!ENTITY app_handle_request '<seealso marker="diameter_app#Mod:handle_request-3">handle_request/3</seealso>'> -<!ENTITY app_handle_error '<seealso marker="diameter_app#Mod:handle_error-4">handle_error/4</seealso>'> -<!ENTITY app_peer_down '<seealso marker="diameter_app#Mod:peer_down-3">peer_down/3</seealso>'> -<!ENTITY app_peer_up '<seealso marker="diameter_app#Mod:peer_up-3">peer_up/3</seealso>'> -<!ENTITY app_pick_peer '<seealso marker="diameter_app#Mod:pick_peer-4">pick_peer/4</seealso>'> -<!ENTITY app_prepare_retransmit '<seealso marker="diameter_app#Mod:prepare_retransmit-3">prepare_retransmit/3</seealso>'> -<!ENTITY app_prepare_request '<seealso marker="diameter_app#Mod:prepare_request-3">prepare_request/3</seealso>'> +<!ENTITY app_handle_answer '<seealso marker="diameter_app#Mod:handle_answer/4">handle_answer/4</seealso>'> +<!ENTITY app_handle_request '<seealso marker="diameter_app#Mod:handle_request/3">handle_request/3</seealso>'> +<!ENTITY app_handle_error '<seealso marker="diameter_app#Mod:handle_error/4">handle_error/4</seealso>'> +<!ENTITY app_peer_down '<seealso marker="diameter_app#Mod:peer_down/3">peer_down/3</seealso>'> +<!ENTITY app_peer_up '<seealso marker="diameter_app#Mod:peer_up/3">peer_up/3</seealso>'> +<!ENTITY app_pick_peer '<seealso marker="diameter_app#Mod:pick_peer/4">pick_peer/4</seealso>'> +<!ENTITY app_prepare_retransmit '<seealso marker="diameter_app#Mod:prepare_retransmit/3">prepare_retransmit/3</seealso>'> +<!ENTITY app_prepare_request '<seealso marker="diameter_app#Mod:prepare_request/3">prepare_request/3</seealso>'> <!ENTITY app_capabilities '<seealso marker="diameter_app#capabilities">diameter_app:capabilities()</seealso>'> <!ENTITY app_peer '<seealso marker="diameter_app#peer">diameter_app:peer()</seealso>'> @@ -92,8 +92,8 @@ significant. <!-- diameter_codec --> -<!ENTITY codec_encode '<seealso marker="diameter_codec#encode-2">diameter_codec:encode/2</seealso>'> -<!ENTITY codec_decode '<seealso marker="diameter_codec#decode-2">diameter_codec:decode/2</seealso>'> +<!ENTITY codec_encode '<seealso marker="diameter_codec#encode/2">diameter_codec:encode/2</seealso>'> +<!ENTITY codec_decode '<seealso marker="diameter_codec#decode/2">diameter_codec:decode/2</seealso>'> <!ENTITY codec_avp '<seealso marker="diameter_codec#avp">diameter_codec:avp()</seealso>'> <!ENTITY codec_header '<seealso marker="diameter_codec#header">diameter_codec:header()</seealso>'> @@ -122,15 +122,15 @@ significant. <!-- diameter_make --> -<!ENTITY make_codec '<seealso marker="diameter_make#codec-2">diameter_make:codec/2</seealso>'> -<!ENTITY make_format '<seealso marker="diameter_make#format-1">diameter_make:format/1</seealso>'> -<!ENTITY make_flatten '<seealso marker="diameter_make#flatten-1">diameter_make:flatten/1</seealso>'> -<!ENTITY make_format_error '<seealso marker="diameter_make#format_error-1">diameter_make:format_error/1</seealso>'> +<!ENTITY make_codec '<seealso marker="diameter_make#codec/2">diameter_make:codec/2</seealso>'> +<!ENTITY make_format '<seealso marker="diameter_make#format/1">diameter_make:format/1</seealso>'> +<!ENTITY make_flatten '<seealso marker="diameter_make#flatten/1">diameter_make:flatten/1</seealso>'> +<!ENTITY make_format_error '<seealso marker="diameter_make#format_error/1">diameter_make:format_error/1</seealso>'> <!-- diameter_transport --> <!ENTITY transport_start - '<seealso marker="diameter_transport#Mod:start-3">start/3</seealso>'> + '<seealso marker="diameter_transport#Mod:start/3">start/3</seealso>'> <!-- reference pages --> diff --git a/lib/erl_docgen/doc/src/doc_storage.xml b/lib/erl_docgen/doc/src/doc_storage.xml index 9eee863e3d..1af81ca3ad 100644 --- a/lib/erl_docgen/doc/src/doc_storage.xml +++ b/lib/erl_docgen/doc/src/doc_storage.xml @@ -54,7 +54,7 @@ <title>See Also</title> <p> <seealso marker="stdlib:shell_docs"><c>shell_docs(3)</c></seealso>, - <seealso marker="kernel:code#get_doc-1"><c>code:get_doc(3)</c></seealso> + <seealso marker="kernel:code#get_doc/1"><c>code:get_doc(3)</c></seealso> </p> </section> diff --git a/lib/hipe/doc/src/hipe_app.xml b/lib/hipe/doc/src/hipe_app.xml index 50812bc991..2011edd03a 100644 --- a/lib/hipe/doc/src/hipe_app.xml +++ b/lib/hipe/doc/src/hipe_app.xml @@ -87,7 +87,7 @@ </item> <tag>NIFs</tag> - <item><p>Modules compiled with HiPE cannot call <seealso marker="erts:erlang#load_nif-2"> + <item><p>Modules compiled with HiPE cannot call <seealso marker="erts:erlang#load_nif/2"> <c>erlang:load_nif/2</c></seealso> to load NIFs.</p> </item> diff --git a/lib/inets/doc/src/http_server.xml b/lib/inets/doc/src/http_server.xml index 865abc6f5f..8fe8bb00fb 100644 --- a/lib/inets/doc/src/http_server.xml +++ b/lib/inets/doc/src/http_server.xml @@ -436,7 +436,7 @@ start() -> more information. As the implementation of the <c>mod_auth_mnesia</c> saves one row for each user, the type must be <c>bag</c>. When the schema and the tables are created, function - <seealso marker="mnesia:mnesia#start-0">mnesia:start/0</seealso> + <seealso marker="mnesia:mnesia#start/0">mnesia:start/0</seealso> is used to start Mnesia and waits for the tables to be loaded. Mnesia uses the directory specified as <c>mnesia_dir</c> at startup if specified, diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml index 72ac79a0b0..82d9d544fb 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -188,7 +188,7 @@ <p>Option <c>ipv6_host_with_bracket</c> deals with how to parse IPv6 addresses. For details, see argument <c>Options</c> of - <seealso marker="#request-4">request/[4,5]</seealso>.</p> + <seealso marker="#request/4">request/[4,5]</seealso>.</p> </desc> </func> @@ -443,7 +443,7 @@ <item> <p>Socket options to be used for this request.</p> <p>Overrides any value set by function - <seealso marker="#set_options-1">set_options</seealso>.</p> + <seealso marker="#set_options/1">set_options</seealso>.</p> <p>The validity of the options is <em>not</em> checked by the HTTP client they are assumed to be correct and passed on to ssl application and inet driver, which may reject @@ -459,7 +459,7 @@ </note> <p>By default the socket options set by function - <seealso marker="#set_options-1">set_options/[1,2]</seealso> + <seealso marker="#set_options/1">set_options/[1,2]</seealso> are used when establishing a connection.</p> </item> diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml index 19dd0c0abf..8d3768420c 100644 --- a/lib/inets/doc/src/httpd.xml +++ b/lib/inets/doc/src/httpd.xml @@ -144,10 +144,10 @@ <tag><marker id="prop_socket_type"></marker>{socket_type, ip_comm | {ip_comm, Config::proplist()} | {essl, Config::proplist()}}</tag> <item> <p>For <c>ip_comm</c> configuration options, see - <seealso marker="kernel:gen_tcp#listen-2">gen_tcp:listen/2</seealso>, some options + <seealso marker="kernel:gen_tcp#listen/2">gen_tcp:listen/2</seealso>, some options that are used internally by httpd cannot be set.</p> <p>For <c>SSL</c> configuration options, see - <seealso marker="ssl:ssl#listen-2">ssl:listen/2</seealso>.</p> + <seealso marker="ssl:ssl#listen/2">ssl:listen/2</seealso>.</p> <p>Default is <c>ip_comm</c>.</p> </item> diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml index ff57d49d08..54ac70acfc 100644 --- a/lib/inets/doc/src/mod_alias.xml +++ b/lib/inets/doc/src/mod_alias.xml @@ -106,7 +106,7 @@ <c>FakeName</c> is replaced with <c>RealName</c> in the match. The resulting path is split into two parts, <c>ShortPath</c> and <c>AfterPath</c>, as defined in - <seealso marker="httpd_util#split_path-1">httpd_util:split_path/1</seealso>. + <seealso marker="httpd_util#split_path/1">httpd_util:split_path/1</seealso>. <c>Path</c> is generated from <c>ShortPath</c>, that is, the result from <seealso marker="#default_index">default_index/2</seealso> with @@ -140,7 +140,7 @@ <c>not_a_script</c> is returned. If it is a script, the resulting script path is in two parts, <c>ShortPath</c> and <c>AfterPath</c>, as defined in - <seealso marker="httpd_util#split_script_path-1">httpd_util:split_script_path/1</seealso>. + <seealso marker="httpd_util#split_script_path/1">httpd_util:split_script_path/1</seealso>. <c>config_db()</c> is the server config file in ETS table format as described in <seealso marker="http_server">Inets User's Guide</seealso>.</p> diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml index d755fbd8d1..677fb33b87 100644 --- a/lib/inets/doc/src/notes.xml +++ b/lib/inets/doc/src/notes.xml @@ -2029,9 +2029,9 @@ <p>Better handling of errorI(s) during update of the session database. </p> <p>Also added and updated some debugging functions - <seealso marker="httpc#which_sessions-0">which_sessions/[0,1]</seealso> + <seealso marker="httpc#which_sessions/0">which_sessions/[0,1]</seealso> and - <seealso marker="httpc#info-0">info/0</seealso>. </p> + <seealso marker="httpc#info/0">info/0</seealso>. </p> <p>Own Id: OTP-10093</p> <p>Aux Id: Seq 12062</p> </item> @@ -2125,7 +2125,7 @@ <item> <p>[httpc] Add function for retrieving current options, - <seealso marker="httpc#get_options-1">get_options/[1,2]</seealso>. </p> + <seealso marker="httpc#get_options/1">get_options/[1,2]</seealso>. </p> <p>Own Id: OTP-9979</p> </item> @@ -2500,7 +2500,7 @@ <p>[httpc] Add support for upload body streaming (PUT and POST).</p> <p>For more info, see the definition of the <c>Body</c> argument of the - <seealso marker="httpc#request-4">request/[4,5]</seealso> + <seealso marker="httpc#request/4">request/[4,5]</seealso> function. </p> <p>Filipe David Manana</p> <p>Own Id: OTP-9094</p> @@ -2513,7 +2513,7 @@ <item> <p>[httpd] - <seealso marker="mod_esi#deliver-2">mod_esi:deliver/2</seealso> + <seealso marker="mod_esi#deliver/2">mod_esi:deliver/2</seealso> made to accept binary data. </p> <p>Bernard Duggan</p> <p>Own Id: OTP-9123</p> @@ -2541,7 +2541,7 @@ for using file descriptors has been improved. It is now possible to add the file descriptor to the config (option fd) when calling the - <seealso marker="inets#start-2">inets:start(httpd, ...)</seealso> + <seealso marker="inets#start/2">inets:start(httpd, ...)</seealso> function. </p> <p>Attila Rajmund Nohl</p> <p>Own Id: OTP-9202</p> @@ -2555,7 +2555,7 @@ <p>See the httpd <seealso marker="httpd#props_comm">socket_type</seealso> communication property or the httpc - <seealso marker="httpc#request-4">request/[4,5]</seealso> function + <seealso marker="httpc#request/4">request/[4,5]</seealso> function for more info. </p> <p>Own Id: OTP-9230</p> <p>*** POTENTIAL INCOMPATIBILITY ***</p> @@ -2755,7 +2755,7 @@ <p>[httpc|httpd] - Now allow the use of the "new" ssl, by using the <c>essl</c> tag instead. </p> <p>See the <c>http_option</c> option in the - <seealso marker="httpc#request-4">request/[4,5]</seealso> or + <seealso marker="httpc#request/4">request/[4,5]</seealso> or the <seealso marker="httpd#props_comm">socket-type</seealso> section of the Communication properties chapter for more info, </p> <p>Own Id: OTP-7907</p> @@ -2985,8 +2985,8 @@ <p>[httpc] - Allow users to pass socket options to the transport module when making requests. </p> <p>See the <c>socket_opts</c> option in the - <seealso marker="httpc#request-4">request/4</seealso> or - <seealso marker="httpc#set_options-1">set_options/[1,2]</seealso> + <seealso marker="httpc#request/4">request/4</seealso> or + <seealso marker="httpc#set_options/1">set_options/[1,2]</seealso> for more info, </p> <p>Own Id: OTP-8352</p> </item> @@ -3027,7 +3027,7 @@ deliver an async reply to more receivers then the calling process. </p> <p>See the - <seealso marker="httpc#request-2">receiver</seealso> + <seealso marker="httpc#request/2">receiver</seealso> option for more info, </p> <p>Own Id: OTP-8106</p> </item> @@ -3294,7 +3294,7 @@ request, when the client connects to the server. Default value is that of the <c>timeout</c> option. </p> <p>See the - <seealso marker="httpc#request-4">request/[4,5]</seealso> + <seealso marker="httpc#request/4">request/[4,5]</seealso> function for more info. </p> <p>Own Id: OTP-7298</p> <!-- <p>Aux Id: seq11086</p> --> @@ -3401,7 +3401,7 @@ the client connects to the server. </p> <p>As a side-effect of this, the option <c>ipv6</c> has been removed and replaced by the <c>ipfamily</c> option. </p> - <p>See <seealso marker="httpc#set_options-1">http:set_options/[1,2]</seealso> + <p>See <seealso marker="httpc#set_options/1">http:set_options/[1,2]</seealso> for more info. </p> <p>*** POTENTIAL INCOMPATIBILITY ***</p> <p>Own Id: OTP-8004</p> diff --git a/lib/kernel/doc/src/error_logger.xml b/lib/kernel/doc/src/error_logger.xml index c170b4fa34..03d53ad4b5 100644 --- a/lib/kernel/doc/src/error_logger.xml +++ b/lib/kernel/doc/src/error_logger.xml @@ -125,7 +125,7 @@ <p>These functions are kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_ERROR</c></seealso> macro or - <seealso marker="logger#error-1"><c>logger:error/1,2,3</c></seealso> + <seealso marker="logger#error/1"><c>logger:error/1,2,3</c></seealso> instead.</p> <p><em>Example:</em></p> <pre> @@ -152,7 +152,7 @@ ok</pre> <p>This functions is kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_ERROR</c></seealso> macro or - <seealso marker="logger#error-1"><c>logger:error/1,2,3</c></seealso> + <seealso marker="logger#error/1"><c>logger:error/1,2,3</c></seealso> instead.</p> <p><em>Example:</em></p> <pre> @@ -186,7 +186,7 @@ ok</pre> <p>This functions is kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_ERROR</c></seealso> macro or - <seealso marker="logger#error-1"><c>logger:error/1,2,3</c></seealso> + <seealso marker="logger#error/1"><c>logger:error/1,2,3</c></seealso> instead.</p> </desc> </func> @@ -227,7 +227,7 @@ ok</pre> <p>These functions are kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_INFO</c></seealso> macro or - <seealso marker="logger#info-1"><c>logger:info/1,2,3</c></seealso> + <seealso marker="logger#info/1"><c>logger:info/1,2,3</c></seealso> instead.</p> <p><em>Example:</em></p> <pre> @@ -254,7 +254,7 @@ ok</pre> <p>This functions is kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_INFO</c></seealso> macro or - <seealso marker="logger#info-1"><c>logger:info/1,2,3</c></seealso> + <seealso marker="logger#info/1"><c>logger:info/1,2,3</c></seealso> instead.</p> <p><em>Example:</em></p> <pre> @@ -289,7 +289,7 @@ ok</pre> <p>This functions is kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_INFO</c></seealso> macro or - <seealso marker="logger#info-1"><c>logger:info/1,2,3</c></seealso> + <seealso marker="logger#info/1"><c>logger:info/1,2,3</c></seealso> instead.</p> </desc> </func> @@ -418,7 +418,7 @@ ok</pre> <p>These functions are kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_WARNING</c></seealso> macro or - <seealso marker="logger#warning-1"><c>logger:warning/1,2,3</c></seealso> + <seealso marker="logger#warning/1"><c>logger:warning/1,2,3</c></seealso> instead.</p> <warning> <p>If the Unicode translation modifier (<c>t</c>) is used in @@ -441,7 +441,7 @@ ok</pre> <p>This functions is kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_WARNING</c></seealso> macro or - <seealso marker="logger#warning-1"><c>logger:warning/1,2,3</c></seealso> + <seealso marker="logger#warning/1"><c>logger:warning/1,2,3</c></seealso> instead.</p> </desc> </func> @@ -465,7 +465,7 @@ ok</pre> <p>This functions is kept for backwards compatibility and must not be used by new code. Use the <seealso marker="logger#macros"> <c>?LOG_WARNING</c></seealso> macro or - <seealso marker="logger#warning-1"><c>logger:warning/1,2,3</c></seealso> + <seealso marker="logger#warning/1"><c>logger:warning/1,2,3</c></seealso> instead.</p> </desc> </func> diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml index c4073f13a2..4c3353cf20 100644 --- a/lib/kernel/doc/src/file.xml +++ b/lib/kernel/doc/src/file.xml @@ -1834,7 +1834,7 @@ f.txt: {person, "kalle", 25}. <c>0</c> all data after the specified <c>Offset</c> is sent.</p> <p>The file used must be opened using the <c>raw</c> flag, and the process calling <c>sendfile</c> must be the controlling process of the socket. - See <seealso marker="gen_tcp#controlling_process-2"><c>gen_tcp:controlling_process/2</c></seealso>.</p> + See <seealso marker="gen_tcp#controlling_process/2"><c>gen_tcp:controlling_process/2</c></seealso>.</p> <p>If the OS used does not support non-blocking <c>sendfile</c>, an Erlang fallback using <seealso marker="#read/2"><c>read/2</c></seealso> and <seealso marker="gen_tcp#send/2"><c>gen_tcp:send/2</c></seealso> is diff --git a/lib/kernel/doc/src/gen_sctp.xml b/lib/kernel/doc/src/gen_sctp.xml index 4aaa37f4b0..bc636e836d 100644 --- a/lib/kernel/doc/src/gen_sctp.xml +++ b/lib/kernel/doc/src/gen_sctp.xml @@ -381,8 +381,8 @@ connect(Socket, Ip, Port>, can be either a <seealso marker="#record-sctp_assoc_change"><c>#sctp_assoc_change{}</c></seealso> record as returned from, for example, - <seealso marker="#recv-2"><c>recv/*</c></seealso>, - <seealso marker="#connect-5"><c>connect/*</c></seealso>, or + <seealso marker="#recv/2"><c>recv/*</c></seealso>, + <seealso marker="#connect/5"><c>connect/*</c></seealso>, or from a listening socket in active mode. It can also be just the field <c>assoc_id</c> integer from such a record.</p> </desc> diff --git a/lib/kernel/doc/src/logger.xml b/lib/kernel/doc/src/logger.xml index a906f0deff..bdd9debabe 100644 --- a/lib/kernel/doc/src/logger.xml +++ b/lib/kernel/doc/src/logger.xml @@ -145,7 +145,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <p>In addition to these, the following fields are automatically inserted by Logger, values taken from the two first parameters - to <seealso marker="#add_handler-3"><c>add_handler/3</c></seealso>:</p> + to <seealso marker="#add_handler/3"><c>add_handler/3</c></seealso>:</p> <list> <item><c>id => HandlerId</c></item> <item><c>module => Module</c></item> @@ -202,9 +202,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <p>You can add custom metadata, either by specifying a map as the last parameter to any of the log macros or the API functions, or by setting process metadata - with <seealso marker="#set_process_metadata-1"> + with <seealso marker="#set_process_metadata/1"> <c>set_process_metadata/1</c></seealso> - or <seealso marker="#update_process_metadata-1"> + or <seealso marker="#update_process_metadata/1"> <c>update_process_metadata/1</c></seealso>.</p> <p>Logger merges all the metadata maps before forwarding the log event to the handlers. If the same keys occur, values @@ -217,7 +217,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <p>The value associated with this key is used by filters for grouping log events originating from, for example, specific functional - areas. See <seealso marker="logger_filters#domain-2"> + areas. See <seealso marker="logger_filters#domain/2"> <c>logger_filters:domain/2</c></seealso> for a description of how this field can be used.</p> </item> @@ -288,7 +288,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <name name="timestamp"/> <desc> <p>A timestamp produced - with <seealso marker="#timestamp-0"> + with <seealso marker="#timestamp/0"> <c>logger:timestamp()</c></seealso>.</p> </desc> </datatype> @@ -346,7 +346,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>emergency</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(emergency,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(emergency,...)</c></seealso>.</p> </desc> </func> @@ -357,7 +357,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>alert</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(alert,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(alert,...)</c></seealso>.</p> </desc> </func> @@ -368,7 +368,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>critical</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(critical,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(critical,...)</c></seealso>.</p> </desc> </func> @@ -379,7 +379,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>error</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(error,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(error,...)</c></seealso>.</p> </desc> </func> @@ -390,7 +390,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>warning</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(warning,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(warning,...)</c></seealso>.</p> </desc> </func> @@ -401,7 +401,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>notice</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(notice,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(notice,...)</c></seealso>.</p> </desc> </func> @@ -412,7 +412,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>info</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(info,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(info,...)</c></seealso>.</p> </desc> </func> @@ -423,7 +423,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro <fsummary>Logs the given message as level <c>debug</c>.</fsummary> <desc> <p>Equivalent to - <seealso marker="#log-2"><c>log(debug,...)</c></seealso>.</p> + <seealso marker="#log/2"><c>log(debug,...)</c></seealso>.</p> </desc> </func> @@ -659,7 +659,7 @@ start(_, []) -> <p>Look up all current module levels. Returns a list containing one <c>{Module,Level}</c> element for each module for which the module level was previously set - with <seealso marker="#set_module_level-2"> + with <seealso marker="#set_module_level/2"> <c>set_module_level/2</c></seealso>.</p> </desc> </func> @@ -671,7 +671,7 @@ start(_, []) -> <p>Look up the current level for the given modules. Returns a list containing one <c>{Module,Level}</c> element for each of the given modules for which the module level was - previously set with <seealso marker="#set_module_level-2"> + previously set with <seealso marker="#set_module_level/2"> <c>set_module_level/2</c></seealso>.</p> </desc> </func> @@ -681,9 +681,9 @@ start(_, []) -> <fsummary>Retrieve data set with set_process_metadata/1.</fsummary> <desc> <p>Retrieve data set - with <seealso marker="#set_process_metadata-1"> + with <seealso marker="#set_process_metadata/1"> <c>set_process_metadata/1</c></seealso> or - <seealso marker="#update_process_metadata-1"> + <seealso marker="#update_process_metadata/1"> <c>update_process_metadata/1</c></seealso>.</p> </desc> </func> @@ -742,10 +742,10 @@ start(_, []) -> <p>Set configuration data for the specified handler. This overwrites the current handler configuration.</p> <p>To modify the existing configuration, - use <seealso marker="#update_handler_config-2"> + use <seealso marker="#update_handler_config/2"> <c>update_handler_config/2</c></seealso>, or, if a more complex merge is needed, read the current configuration - with <seealso marker="#get_handler_config-1"><c>get_handler_config/1</c> + with <seealso marker="#get_handler_config/1"><c>get_handler_config/1</c> </seealso>, then do the merge before writing the new configuration back with this function.</p> <p>If a key is removed compared to the current configuration, @@ -783,7 +783,7 @@ start(_, []) -> handlers in the Kernel application, unspecified data for the <c>config</c> key is set to default values. To update only specified data, and keep the existing configuration for - the rest, use <seealso marker="#update_handler_config-3"> + the rest, use <seealso marker="#update_handler_config/3"> <c>update_handler_config/3</c></seealso>.</p> <p>See the definition of the <seealso marker="#type-handler_config"> @@ -799,10 +799,10 @@ start(_, []) -> <p>Set primary configuration data for Logger. This overwrites the current configuration.</p> <p>To modify the existing configuration, - use <seealso marker="#update_primary_config-1"> + use <seealso marker="#update_primary_config/1"> <c>update_primary_config/1</c></seealso>, or, if a more complex merge is needed, read the current configuration - with <seealso marker="#get_primary_config-0"><c>get_primary_config/0</c> + with <seealso marker="#get_primary_config/0"><c>get_primary_config/0</c> </seealso>, then do the merge before writing the new configuration back with this function.</p> <p>If a key is removed compared to the current configuration, @@ -835,10 +835,10 @@ start(_, []) -> specified in the <c><anno>Config</anno></c> map gets default values.</p> <p>To modify the existing configuration, - use <seealso marker="#update_proxy_config-1"> + use <seealso marker="#update_proxy_config/1"> <c>update_proxy_config/1</c></seealso>, or, if a more complex merge is needed, read the current configuration - with <seealso marker="#get_proxy_config-0"><c>get_proxy_config/0</c> + with <seealso marker="#get_proxy_config/0"><c>get_proxy_config/0</c> </seealso>, then do the merge before writing the new configuration back with this function.</p> <p>For more information about the proxy, see @@ -901,7 +901,7 @@ start(_, []) -> overwrite values from the location data.</p> <p>Subsequent calls to this function overwrites previous data set. To update existing data instead of overwriting it, - see <seealso marker="#update_process_metadata-1"> + see <seealso marker="#update_process_metadata/1"> <c>update_process_metadata/1</c></seealso>.</p> </desc> </func> @@ -941,9 +941,9 @@ start(_, []) -> <fsummary>Delete data set with set_process_metadata/1.</fsummary> <desc> <p>Delete data set - with <seealso marker="#set_process_metadata-1"> + with <seealso marker="#set_process_metadata/1"> <c>set_process_metadata/1</c></seealso> or - <seealso marker="#update_process_metadata-1"> + <seealso marker="#update_process_metadata/1"> <c>update_process_metadata/1</c></seealso>.</p> </desc> </func> @@ -958,7 +958,7 @@ start(_, []) -> <p>To overwrite the existing configuration without any merge, use</p> <pre> -<seealso marker="#set_handler_config-3">set_handler_config(HandlerId, formatter, +<seealso marker="#set_handler_config/3">set_handler_config(HandlerId, formatter, {FormatterModule, FormatterConfig})</seealso>.</pre> </desc> </func> @@ -970,7 +970,7 @@ start(_, []) -> <p>Update the formatter configuration for the specified handler.</p> <p>This is equivalent to</p> <pre> -<seealso marker="#update_formatter_config-2">update_formatter_config(<anno>HandlerId</anno>, #{<anno>Key</anno> => <anno>Value</anno>})</seealso></pre> +<seealso marker="#update_formatter_config/2">update_formatter_config(<anno>HandlerId</anno>, #{<anno>Key</anno> => <anno>Value</anno>})</seealso></pre> </desc> </func> @@ -985,7 +985,7 @@ start(_, []) -> logger:set_handler_config(HandlerId, maps:merge(Old, Config)). </code> <p>To overwrite the existing configuration without any merge, - use <seealso marker="#set_handler_config-2"><c>set_handler_config/2</c> + use <seealso marker="#set_handler_config/2"><c>set_handler_config/2</c> </seealso>.</p> </desc> </func> @@ -1017,7 +1017,7 @@ logger:set_handler_config(HandlerId, maps:merge(Old, Config)). handlers in the Kernel application, unspecified data for the <c>config</c> key is not changed. To reset unspecified data to default values, - use <seealso marker="#set_handler_config-3"> + use <seealso marker="#set_handler_config/3"> <c>set_handler_config/3</c></seealso>.</p> <p>See the definition of the <seealso marker="#type-handler_config"> @@ -1037,7 +1037,7 @@ Old = logger:get_primary_config(), logger:set_primary_config(maps:merge(Old, Config)). </code> <p>To overwrite the existing configuration without any merge, - use <seealso marker="#set_primary_config-1"><c>set_primary_config/1</c> + use <seealso marker="#set_primary_config/1"><c>set_primary_config/1</c> </seealso>.</p> </desc> </func> @@ -1055,7 +1055,7 @@ logger:set_primary_config(maps:merge(Old, Config)). logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). </code> <p>If no process metadata exists, the function behaves as - <seealso marker="#set_process_metadata-1"> + <seealso marker="#set_process_metadata/1"> <c>set_process_metadata/1</c> </seealso>.</p> </desc> @@ -1072,7 +1072,7 @@ Old = logger:get_proxy_config(), logger:set_proxy_config(maps:merge(Old, Config)). </code> <p>To overwrite the existing configuration without any merge, - use <seealso marker="#set_proxy_config-1"><c>set_proxy_config/1</c> + use <seealso marker="#set_proxy_config/1"><c>set_proxy_config/1</c> </seealso>.</p> <p>For more information about the proxy, see section <seealso marker="logger_chapter#proxy">Logger @@ -1125,7 +1125,7 @@ logger:set_proxy_config(maps:merge(Old, Config)). <desc> <p>Return a timestamp that can be inserted as the <c>time</c> field in the meta data for a log event. It is produced with - <seealso marker="kernel:os#system_time-1"> + <seealso marker="kernel:os#system_time/1"> <c>os:system_time(microsecond)</c></seealso>.</p> <p>Notice that Logger automatically inserts a timestamp in the meta data unless it already exists. This function is @@ -1191,9 +1191,9 @@ logger:set_proxy_config(maps:merge(Old, Config)). in <c>OldConfig</c>.</p> <p><c>SetOrUpdate</c> has the value <c>set</c> if the configuration change originates from a call to - <seealso marker="#set_handler_config-2"> + <seealso marker="#set_handler_config/2"> <c>set_handler_config/2,3</c></seealso>, and <c>update</c> - if it originates from <seealso marker="#update_handler_config-2"> + if it originates from <seealso marker="#update_handler_config/2"> <c>update_handler_config/2,3</c></seealso>. The handler can use this parameteter to decide how to update the value of the <c>config</c> field, that is, the handler specific @@ -1221,7 +1221,7 @@ logger:set_proxy_config(maps:merge(Old, Config)). <p>The function is called when one of the Logger API functions for fetching the handler configuration is called, for example - <seealso marker="#get_handler_config-1"> + <seealso marker="#get_handler_config/1"> <c>logger:get_handler_config/1</c></seealso>.</p> <p>It allows the handler to remove internal data fields from its configuration data before it is returned to the @@ -1296,13 +1296,13 @@ logger:set_proxy_config(maps:merge(Old, Config)). is correct, and <c>{error,Reason}</c> if it is faulty.</p> <p>The following Logger API functions can trigger this callback:</p> <list> - <item><seealso marker="logger#add_handler-3"> + <item><seealso marker="logger#add_handler/3"> <c>logger:add_handler/3</c></seealso></item> - <item><seealso marker="logger#set_handler_config-2"> + <item><seealso marker="logger#set_handler_config/2"> <c>logger:set_handler_config/2,3</c></seealso></item> - <item><seealso marker="logger#update_handler_config-2"> + <item><seealso marker="logger#update_handler_config/2"> <c>logger:update_handler_config/2,3</c></seealso></item> - <item><seealso marker="logger#update_formatter_config-2"> + <item><seealso marker="logger#update_formatter_config/2"> <c>logger:update_formatter_config/2</c></seealso></item> </list> <p>See <seealso marker="logger_formatter"> @@ -1327,7 +1327,7 @@ logger:set_proxy_config(maps:merge(Old, Config)). <p>The function can be called by a log handler to convert a log event term to a printable string. The returned value can, for example, be printed as a log entry to the console - or a file using <seealso marker="stdlib:io#put_chars-1"> + or a file using <seealso marker="stdlib:io#put_chars/1"> <c>io:put_chars/1,2</c></seealso>.</p> <p>See <seealso marker="logger_formatter"> <c>logger_formatter(3)</c></seealso> diff --git a/lib/kernel/doc/src/logger_chapter.xml b/lib/kernel/doc/src/logger_chapter.xml index 7782227157..5fea48e7c8 100644 --- a/lib/kernel/doc/src/logger_chapter.xml +++ b/lib/kernel/doc/src/logger_chapter.xml @@ -112,7 +112,7 @@ of <seealso marker="logger#macros">macros</seealso>, and a set of functions on the form <c>logger:Level/1,2,3</c>, which are all shortcuts - for <seealso marker="logger#log-2"> + for <seealso marker="logger#log/2"> <c>logger:log(Level,Arg1[,Arg2[,Arg3]])</c></seealso>.</p> <p>The macros are defined in <c>logger.hrl</c>, which is included in a module with the directive</p> @@ -183,7 +183,7 @@ <p>Notice that the integer value is only used internally in Logger. In the API, you must always use the atom. To compare the severity of two log levels, - use <seealso marker="logger#compare_levels-2"> + use <seealso marker="logger#compare_levels/2"> <c>logger:compare_levels/2</c></seealso>.</p> </section> <section> @@ -242,9 +242,9 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <tag>Set process metadata</tag> <item> <p>Process metadata is set and updated - with <seealso marker="logger#set_process_metadata-1"> + with <seealso marker="logger#set_process_metadata/1"> <c>logger:set_process_metadata/1</c></seealso> - and <seealso marker="logger#update_process_metadata-1"> + and <seealso marker="logger#update_process_metadata/1"> <c>logger:update_process_metadata/1</c></seealso>, respectively. This metadata applies to the process on which these calls are made, and Logger adds the metadata @@ -306,18 +306,18 @@ logger:debug(#{got => connection_request, id => Id, state => State}, callback. If <c>filter_default</c> is set to <c>stop</c>, Logger discards such events.</p> <p>Primary filters are added - with <seealso marker="logger#add_primary_filter-2"> + with <seealso marker="logger#add_primary_filter/2"> <c>logger:add_primary_filter/2</c></seealso> and removed - with <seealso marker="logger#remove_primary_filter-1"> + with <seealso marker="logger#remove_primary_filter/1"> <c>logger:remove_primary_filter/1</c></seealso>. They can also be added at system start via the Kernel configuration parameter <seealso marker="#logger_parameter"><c>logger</c></seealso>.</p> <p>Handler filters are added - with <seealso marker="logger#add_handler_filter-3"> + with <seealso marker="logger#add_handler_filter/3"> <c>logger:add_handler_filter/3</c></seealso> and removed - with <seealso marker="logger#remove_handler_filter-2"> + with <seealso marker="logger#remove_handler_filter/2"> <c>logger:remove_handler_filter/2</c></seealso>. They can also be specified directly in the configuration when adding a handler with <seealso marker="logger#add_handler/3"> @@ -326,11 +326,11 @@ logger:debug(#{got => connection_request, id => Id, state => State}, parameter <seealso marker="#logger_parameter"><c>logger</c></seealso>.</p> <p>To see which filters are currently installed in the system, - use <seealso marker="logger#get_config-0"> + use <seealso marker="logger#get_config/0"> <c>logger:get_config/0</c></seealso>, - or <seealso marker="logger#get_primary_config-0"> + or <seealso marker="logger#get_primary_config/0"> <c>logger:get_primary_config/0</c></seealso> - and <seealso marker="logger#get_handler_config-1"> + and <seealso marker="logger#get_handler_config/1"> <c>logger:get_handler_config/1</c></seealso>. Filters are listed in the order they are applied, that is, the first filter in the list is applied first, and so on.</p> @@ -338,25 +338,25 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <p>For convenience, the following built-in filters exist:</p> <taglist> - <tag><seealso marker="logger_filters#domain-2"> + <tag><seealso marker="logger_filters#domain/2"> <c>logger_filters:domain/2</c></seealso></tag> <item> <p>Provides a way of filtering log events based on a <c>domain</c> field in <c>Metadata</c>.</p> </item> - <tag><seealso marker="logger_filters#level-2"> + <tag><seealso marker="logger_filters#level/2"> <c>logger_filters:level/2</c></seealso></tag> <item> <p>Provides a way of filtering log events based on the log level.</p> </item> - <tag><seealso marker="logger_filters#progress-2"> + <tag><seealso marker="logger_filters#progress/2"> <c>logger_filters:progress/2</c></seealso></tag> <item> <p>Stops or allows progress reports from <c>supervisor</c> and <c>application_controller</c>.</p> </item> - <tag><seealso marker="logger_filters#remote_gl-2"> + <tag><seealso marker="logger_filters#remote_gl/2"> <c>logger_filters:remote_gl/2</c></seealso></tag> <item> <p>Stops or allows log events originating from a process @@ -371,7 +371,7 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <p>A handler is defined as a module exporting at least the following callback function:</p> - <pre><seealso marker="logger#HModule:log-2">log(LogEvent, Config) -> void()</seealso></pre> + <pre><seealso marker="logger#HModule:log/2">log(LogEvent, Config) -> void()</seealso></pre> <p>This function is called when a log event has passed through all primary filters, and all handler filters attached to the handler @@ -416,7 +416,7 @@ logger:debug(#{got => connection_request, id => Id, state => State}, only. It is not started by default, but will be automatically started the first time an <c>error_logger</c> event handler is added - with <seealso marker="error_logger#add_report_handler-1"> + with <seealso marker="error_logger#add_report_handler/1"> <c>error_logger:add_report_handler/1,2</c></seealso>.</p> <p>The old <c>error_logger</c> event handlers in STDLIB and @@ -434,25 +434,25 @@ logger:debug(#{got => connection_request, id => Id, state => State}, handler's destination. The handler callback receives the formatter information as part of the handler configuration, which is passed as the second argument - to <seealso marker="logger#HModule:log-2"> + to <seealso marker="logger#HModule:log/2"> <c>HModule:log/2</c></seealso>.</p> <p>The formatter information consist of a formatter module, <c>FModule</c> and its configuration, <c>FConfig</c>. <c>FModule</c> must export the following function, which can be called by the handler:</p> - <pre><seealso marker="logger#FModule:format-2">format(LogEvent,FConfig) + <pre><seealso marker="logger#FModule:format/2">format(LogEvent,FConfig) -> FormattedLogEntry</seealso></pre> <p>The formatter information for a handler is set as a part of its configuration when the handler is added. It can also be changed during runtime - with <seealso marker="logger#set_handler_config-3"> + with <seealso marker="logger#set_handler_config/3"> <c>logger:set_handler_config(HandlerId,formatter,{FModule,FConfig})</c> </seealso>, which overwrites the current formatter information, - or with <seealso marker="logger#update_formatter_config-2"> + or with <seealso marker="logger#update_formatter_config/2"> <c>logger:update_formatter_config/2,3</c></seealso>, which only modifies the formatter configuration.</p> <p>If the formatter module exports the optional callback - function <seealso marker="logger#FModule:check_config-1"> + function <seealso marker="logger#FModule:check_config/1"> <c>check_config(FConfig)</c></seealso>, Logger calls this function when the formatter information is set or modified, to verify the validity of the formatter configuration.</p> @@ -482,15 +482,15 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <p>Logger API functions that apply to the primary Logger configuration are:</p> <list> - <item><seealso marker="logger#get_primary_config-0"> + <item><seealso marker="logger#get_primary_config/0"> <c>get_primary_config/0</c></seealso></item> - <item><seealso marker="logger#set_primary_config-1"> + <item><seealso marker="logger#set_primary_config/1"> <c>set_primary_config/1,2</c></seealso></item> - <item><seealso marker="logger#update_primary_config-1"> + <item><seealso marker="logger#update_primary_config/1"> <c>update_primary_config/1</c></seealso></item> - <item><seealso marker="logger#add_primary_filter-2"> + <item><seealso marker="logger#add_primary_filter/2"> <c>add_primary_filter/2</c></seealso></item> - <item><seealso marker="logger#remove_primary_filter-1"> + <item><seealso marker="logger#remove_primary_filter/1"> <c>remove_primary_filter/1</c></seealso></item> </list> <p>The primary Logger configuration is a map with the following @@ -510,7 +510,7 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <p>The initial value of this option is set by the Kernel configuration parameter <seealso marker="#logger_level"> <c>logger_level</c></seealso>. It is changed during - runtime with <seealso marker="logger#set_primary_config-2"> + runtime with <seealso marker="logger#set_primary_config/2"> <c>logger:set_primary_config(level,Level)</c></seealso>.</p> <p>Defaults to <c>notice</c>.</p> </item> @@ -527,9 +527,9 @@ logger:debug(#{got => connection_request, id => Id, state => State}, configuration parameter <seealso marker="#logger_parameter"><c>logger</c></seealso>. During runtime, primary filters are added and removed with - <seealso marker="logger#add_primary_filter-2"> + <seealso marker="logger#add_primary_filter/2"> <c>logger:add_primary_filter/2</c></seealso> and - <seealso marker="logger#remove_primary_filter-1"> + <seealso marker="logger#remove_primary_filter/1"> <c>logger:remove_primary_filter/1</c></seealso>, respectively.</p> <p>See section <seealso marker="#filters">Filters</seealso> @@ -553,17 +553,17 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <p>Logger API functions that apply to handler configuration are:</p> <list> - <item><seealso marker="logger#get_handler_config-0"> + <item><seealso marker="logger#get_handler_config/0"> <c>get_handler_config/0,1</c></seealso></item> - <item><seealso marker="logger#set_handler_config-2"> + <item><seealso marker="logger#set_handler_config/2"> <c>set_handler_config/2,3</c></seealso></item> - <item><seealso marker="logger#update_handler_config-2"> + <item><seealso marker="logger#update_handler_config/2"> <c>update_handler_config/2,3</c></seealso></item> - <item><seealso marker="logger#add_handler_filter-3"> + <item><seealso marker="logger#add_handler_filter/3"> <c>add_handler_filter/3</c></seealso></item> - <item><seealso marker="logger#remove_handler_filter-2"> + <item><seealso marker="logger#remove_handler_filter/2"> <c>remove_handler_filter/2</c></seealso></item> - <item><seealso marker="logger#update_formatter_config-2"> + <item><seealso marker="logger#update_formatter_config/2"> <c>update_formatter_config/2,3</c></seealso></item> </list> <p>The configuration for a handler is a map with the following keys:</p> @@ -609,9 +609,9 @@ logger:debug(#{got => connection_request, id => Id, state => State}, </list> <p>Handler filters are specified when adding the handler, or added or removed during runtime with - <seealso marker="logger#add_handler_filter-3"> + <seealso marker="logger#add_handler_filter/3"> <c>logger:add_handler_filter/3</c></seealso> and - <seealso marker="logger#remove_handler_filter-2"> + <seealso marker="logger#remove_handler_filter/2"> <c>logger:remove_handler_filter/2</c></seealso>, respectively.</p> <p>See <seealso marker="#filters">Filters</seealso> for more @@ -639,11 +639,11 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <p>The formatter information is specified when adding the handler. The formatter configuration can be changed during runtime - with <seealso marker="logger#update_formatter_config-2"> + with <seealso marker="logger#update_formatter_config/2"> <c>logger:update_formatter_config/2,3</c></seealso>, or the complete formatter information can be overwritten with, for - instance, <seealso marker="logger#set_handler_config-3"> + instance, <seealso marker="logger#set_handler_config/3"> <c>logger:set_handler_config/3</c></seealso>.</p> <p>See section <seealso marker="#formatters">Formatters</seealso> @@ -709,11 +709,11 @@ logger:debug(#{got => connection_request, id => Id, state => State}, <item> <p>If <c>HandlerId</c> is <c>default</c>, then this entry modifies the default handler, equivalent to calling</p> - <pre><seealso marker="logger#remove_handler-1"> + <pre><seealso marker="logger#remove_handler/1"> logger:remove_handler(default) </seealso></pre> <p>followed by</p> - <pre><seealso marker="logger#add_handler-3"> + <pre><seealso marker="logger#add_handler/3"> logger:add_handler(default, Module, HandlerConfig) </seealso></pre> <p>For all other values of <c>HandlerId</c>, this entry @@ -854,13 +854,13 @@ logger:debug(#{got => connection_request, id => Id, state => State}, be used by legacy code. It will be removed in a later release.</p> <p>Calls - to <seealso marker="error_logger#error_report-1"> + to <seealso marker="error_logger#error_report/1"> <c>error_logger:error_report/1,2</c></seealso>, - <seealso marker="error_logger#error_msg-1"> + <seealso marker="error_logger#error_msg/1"> <c>error_logger:error_msg/1,2</c></seealso>, and corresponding functions for warning and info messages, are all forwarded to Logger as calls - to <seealso marker="logger#log-3"> + to <seealso marker="logger#log/3"> <c>logger:log(Level,Report,Metadata)</c></seealso>.</p> <p><c>Level = error | warning | info</c> and is taken from the function name. <c>Report</c> contains the actual @@ -1014,7 +1014,7 @@ ok</pre> handler now receives all log events. If you want info events only in the file, you must add a filter to stop all non-info events. The built-in - filter <seealso marker="logger_filters#level-2"> + filter <seealso marker="logger_filters#level/2"> <c>logger_filters:level/2</c></seealso> can do this:</p> <pre> @@ -1045,7 +1045,7 @@ ok</pre> <item><c>filter_config(Config)</c></item> </list> <p>When a handler is added, by for example a call - to <seealso marker="logger#add_handler-3"> + to <seealso marker="logger#add_handler/3"> <c>logger:add_handler(Id, HModule, Config)</c></seealso>, Logger first calls <c>HModule:adding_handler(Config)</c>. If this function returns <c>{ok,Config1}</c>, Logger @@ -1054,11 +1054,11 @@ ok</pre> handler is installed and must be ready to receive log events as calls to <c>HModule:log/2</c>.</p> <p>A handler can be removed by calling - <seealso marker="logger#remove_handler-1"> + <seealso marker="logger#remove_handler/1"> <c>logger:remove_handler(Id)</c></seealso>. Logger calls <c>HModule:removing_handler(Config)</c>, and removes the handler's configuration from the configuration database.</p> - <p>When <seealso marker="logger#set_handler_config-2"> + <p>When <seealso marker="logger#set_handler_config/2"> <c>logger:set_handler_config/2,3</c></seealso> or <seealso marker="logger#update_handler_config/2"> <c>logger:update_handler_config/2,3</c></seealso> is called, @@ -1066,9 +1066,9 @@ ok</pre> calls <c>HModule:changing_config(SetOrUpdate, OldConfig, NewConfig)</c>. If this function returns <c>{ok,NewConfig1}</c>, Logger writes <c>NewConfig1</c> to the configuration database.</p> - <p>When <seealso marker="logger#get_config-0"> + <p>When <seealso marker="logger#get_config/0"> <c>logger:get_config/0</c></seealso> or - <seealso marker="logger#get_handler_config-0"> + <seealso marker="logger#get_handler_config/0"> <c>logger:get_handler_config/0,1</c></seealso> is called, Logger calls <c>HModule:filter_config(Config)</c>. This function must return the handler configuration where internal data is diff --git a/lib/kernel/doc/src/logger_cookbook.xml b/lib/kernel/doc/src/logger_cookbook.xml index f682fa3c10..0a6b199b26 100644 --- a/lib/kernel/doc/src/logger_cookbook.xml +++ b/lib/kernel/doc/src/logger_cookbook.xml @@ -53,12 +53,12 @@ Primary configuration: Filters: (none)</code> <p>It is also possible to fetch the configuration using - <seealso marker="logger#get_primary_config-0"><c>logger:get_primary_config()</c></seealso>. + <seealso marker="logger#get_primary_config/0"><c>logger:get_primary_config()</c></seealso>. </p> <section> <title>See also</title> <list> - <item><seealso marker="logger#i-0">logger:i()</seealso></item> + <item><seealso marker="logger#i/0">logger:i()</seealso></item> <item><seealso marker="logger_chapter#configuration">Configuration</seealso> in the Logging User's Guide</item> </list> </section> @@ -101,15 +101,15 @@ Handler configuration: type: standard_io </code> <p>You can also print the configuration of a specific handler using - <seealso marker="logger#i-1"><c>logger:i(HandlerName)</c></seealso>, + <seealso marker="logger#i/1"><c>logger:i(HandlerName)</c></seealso>, or fetch the configuration using - <seealso marker="logger#get_handler_config-0"><c>logger:get_handler_config()</c></seealso>, - or <seealso marker="logger#get_handler_config-1"><c>logger:get_handler_config(HandlerName)</c></seealso> + <seealso marker="logger#get_handler_config/0"><c>logger:get_handler_config()</c></seealso>, + or <seealso marker="logger#get_handler_config/1"><c>logger:get_handler_config(HandlerName)</c></seealso> for a specific handler.</p> <section> <title>See also</title> <list> - <item><seealso marker="logger#i-0"><c>logger:i()</c></seealso></item> + <item><seealso marker="logger#i/0"><c>logger:i()</c></seealso></item> <item><seealso marker="logger_chapter#configuration">Configuration</seealso> in the Logging User's Guide</item> </list> </section> @@ -169,7 +169,7 @@ ok <list> <item><seealso marker="logger_formatter#type-config">logger_formatter's Configuration</seealso></item> <item><seealso marker="logger_chapter#formatters">Formatters</seealso> in the Logging User's Guide</item> - <item><seealso marker="logger#set_handler_config-3"><c>logger:set_handler_config/3</c></seealso></item> + <item><seealso marker="logger#set_handler_config/3"><c>logger:set_handler_config/3</c></seealso></item> </list> </section> </section> @@ -187,7 +187,7 @@ Eshell V10.5.1 (abort with ^G) 1> logger:error("Oh noes, more errors",#{ file => "shell.erl", line => 1 }). 1962-10-05T07:37:44.104241+02:00 shell.erl:1 error: Oh noes, more errors</code> <p>Note that file and line have to be added in the metadata by the caller of - <seealso marker="logger#log-3"><c>logger:log/3</c></seealso> as otherwise + <seealso marker="logger#log/3"><c>logger:log/3</c></seealso> as otherwise Logger will not know from where it was called. The file and line number are automatically added if you use the <c>?LOG_ERROR</c> macros in <c>kernel/include/logger.hrl</c>.</p> @@ -392,8 +392,8 @@ logger:debug("Debug should be logged"). <title>See also</title> <list> <item><seealso marker="logger_chapter#filters">Filters</seealso> in the Logging User's Guide</item> - <item><seealso marker="logger_filters#level-2"><c>logger_filters:level/2</c></seealso></item> - <item><seealso marker="logger#set_primary_config-2"><c>logger:set_primary_config/2</c></seealso></item> + <item><seealso marker="logger_filters#level/2"><c>logger_filters:level/2</c></seealso></item> + <item><seealso marker="logger#set_primary_config/2"><c>logger:set_primary_config/2</c></seealso></item> </list> </section> </section> @@ -414,8 +414,8 @@ logger:debug("Debug should be logged"). <title>See also</title> <list> <item><seealso marker="logger_chapter#filters">Filters</seealso> in the Logging User's Guide</item> - <item><seealso marker="logger_filters#domain-2"><c>logger_filters:domain/2</c></seealso></item> - <item><seealso marker="logger#set_primary_config-2"><c>logger:set_primary_config/2</c></seealso></item> + <item><seealso marker="logger_filters#domain/2"><c>logger_filters:domain/2</c></seealso></item> + <item><seealso marker="logger#set_primary_config/2"><c>logger:set_primary_config/2</c></seealso></item> </list> </section> </section> diff --git a/lib/kernel/doc/src/logger_disk_log_h.xml b/lib/kernel/doc/src/logger_disk_log_h.xml index de344ab30b..9146d316ea 100644 --- a/lib/kernel/doc/src/logger_disk_log_h.xml +++ b/lib/kernel/doc/src/logger_disk_log_h.xml @@ -52,7 +52,7 @@ <seealso marker="logger_chapter#overload_protection"><c>User's Guide</c> </seealso>.</p> <p>To add a new instance of the disk_log handler, use - <seealso marker="logger#add_handler-3"><c>logger:add_handler/3</c> + <seealso marker="logger#add_handler/3"><c>logger:add_handler/3</c> </seealso>. The handler configuration argument is a map which can contain general configuration parameters, as documented in the <seealso marker="logger_chapter#handler_configuration"><c>User's Guide</c> @@ -64,7 +64,7 @@ <item> <p>This is the full name of the disk log file. The option corresponds to the <c>name</c> property in the - <seealso marker="disk_log#open-1"><c>dlog_option()</c></seealso> + <seealso marker="disk_log#open/1"><c>dlog_option()</c></seealso> datatype.</p> <p>The value is set when the handler is added, and it cannot be changed in runtime.</p> @@ -75,7 +75,7 @@ <item> <p>This is the disk log type, <c>wrap</c> or <c>halt</c>. The option corresponds to the <c>type</c> property in the - <seealso marker="disk_log#open-1"><c>dlog_option()</c></seealso> + <seealso marker="disk_log#open/1"><c>dlog_option()</c></seealso> datatype.</p> <p>The value is set when the handler is added, and it cannot be changed in runtime.</p> @@ -86,7 +86,7 @@ <p>This is the maximum number of files that disk_log uses for its circular logging. The option corresponds to the <c>MaxNoFiles</c> element in the <c>size</c> property in the - <seealso marker="disk_log#open-1"><c>dlog_option()</c></seealso> + <seealso marker="disk_log#open/1"><c>dlog_option()</c></seealso> datatype.</p> <p>The value is set when the handler is added, and it cannot be changed in runtime.</p> @@ -99,7 +99,7 @@ a log file before disk_log proceeds with the next file in order, or generates an error in case of a full halt log. The option corresponds to the <c>MaxNoBytes</c> element in the <c>size</c> property in the - <seealso marker="disk_log#open-1"><c>dlog_option()</c></seealso> + <seealso marker="disk_log#open/1"><c>dlog_option()</c></seealso> datatype.</p> <p>The value is set when the handler is added, and it cannot be changed in runtime.</p> @@ -115,7 +115,7 @@ <p>Defaults to <c>5000</c> milliseconds.</p> <p>If <c>no_repeat</c> is set as value, the repeated sync operation is disabled. The user can also call the - <seealso marker="logger_disk_log_h#filesync-1"><c>filesync/1</c> + <seealso marker="logger_disk_log_h#filesync/1"><c>filesync/1</c> </seealso> function to perform a disk_log sync.</p> </item> </taglist> diff --git a/lib/kernel/doc/src/logger_filters.xml b/lib/kernel/doc/src/logger_filters.xml index 0a02342864..2d5750cd29 100644 --- a/lib/kernel/doc/src/logger_filters.xml +++ b/lib/kernel/doc/src/logger_filters.xml @@ -38,14 +38,14 @@ <description> <p>All functions exported from this module can be used as primary or handler - filters. See <seealso marker="logger#add_primary_filter-2"> + filters. See <seealso marker="logger#add_primary_filter/2"> <c>logger:add_primary_filter/2</c></seealso> - and <seealso marker="logger#add_handler_filter-3"> + and <seealso marker="logger#add_handler_filter/3"> <c>logger:add_handler_filter/3</c></seealso> for more information about how filters are added.</p> - <p>Filters are removed with <seealso marker="logger#remove_primary_filter-1"> + <p>Filters are removed with <seealso marker="logger#remove_primary_filter/1"> <c>logger:remove_primary_filter/1</c></seealso> - and <seealso marker="logger#remove_handler_filter-2"> + and <seealso marker="logger#remove_handler_filter/2"> <c>logger:remove_handler_filter/2</c></seealso>.</p> </description> @@ -86,9 +86,9 @@ D2 = [otp, sasl]</pre> <p>The <c><anno>Extra</anno></c> parameter to the <c>domain/2</c> function is specified when adding the - filter via <seealso marker="logger#add_primary_filter-2"> + filter via <seealso marker="logger#add_primary_filter/2"> <c>logger:add_primary_filter/2</c></seealso> - or <seealso marker="logger#add_handler_filter-3"> + or <seealso marker="logger#add_handler_filter/3"> <c>logger:add_handler_filter/3</c></seealso>.</p> <p>The filter compares the value of the <c>domain</c> field in @@ -161,14 +161,14 @@ ok</code> <p>The <c><anno>Extra</anno></c> parameter is specified when adding the filter - via <seealso marker="logger#add_primary_filter-2"> + via <seealso marker="logger#add_primary_filter/2"> <c>logger:add_primary_filter/2</c></seealso> - or <seealso marker="logger#add_handler_filter-3"> + or <seealso marker="logger#add_handler_filter/3"> <c>logger:add_handler_filter/3</c></seealso>.</p> <p>The filter compares the value of the event's log level (<c>Level</c>) to <c><anno>MatchLevel</anno></c> by - calling <seealso marker="logger#compare_levels-2"> + calling <seealso marker="logger#compare_levels/2"> <c>logger:compare_levels(Level, MatchLevel)</c></seealso>. The filter matches if the value of <c><anno>Operator</anno></c> is:</p> diff --git a/lib/kernel/doc/src/logger_formatter.xml b/lib/kernel/doc/src/logger_formatter.xml index 6dc83d24e1..8d8e49b5d3 100644 --- a/lib/kernel/doc/src/logger_formatter.xml +++ b/lib/kernel/doc/src/logger_formatter.xml @@ -63,7 +63,7 @@ <item> <p>A positive integer representing the value of the option with the same name to be used when calling - <seealso marker="stdlib:io_lib#format-3"> + <seealso marker="stdlib:io_lib#format/3"> <c>io_lib:format/3</c></seealso>. This value limits the total number of characters printed for each log event. Notice that this is a soft limit. For a @@ -78,7 +78,7 @@ format controls ~p and ~w are replaced with ~P and ~W, respectively, and the value is used as the depth parameter. For details, see - <seealso marker="stdlib:io#format-2"><c>io:format/2,3</c></seealso> + <seealso marker="stdlib:io#format/2"><c>io:format/2,3</c></seealso> in STDLIB.</p> <p>Defaults to <c>unlimited</c>.</p> </item> @@ -113,7 +113,7 @@ arguments. The report callback can be specified in the metadata for the log event. If no report callback exists in metadata, <c>logger_formatter</c> will - use <seealso marker="logger#format_report-1"> + use <seealso marker="logger#format_report/1"> <c>logger:format_report/1</c></seealso> as default callback.</p> <p>If this configuration parameter is set, it replaces @@ -127,7 +127,7 @@ single line. To achieve this, <c>logger_formatter</c> sets the field width to <c>0</c> for all <c>~p</c> and <c>~P</c> control sequences in the format a string - (see <seealso marker="stdlib:io#format-2"> + (see <seealso marker="stdlib:io#format/2"> <c>io:format/2</c></seealso>), and replaces all newlines in the message with <c>", "</c>. White spaces following directly after newlines are removed. Notice @@ -153,7 +153,7 @@ <p>Defaults to <c>$T</c>.</p> <p>The value of this parameter is used as the <c>time_designator</c> option - to <seealso marker="stdlib:calendar#system_time_to_rfc3339-2"> + to <seealso marker="stdlib:calendar#system_time_to_rfc3339/2"> <c>calendar:system_time_to_rcf3339/2</c></seealso>.</p> </item> <tag><c>time_offset = integer() | [byte()]</c></tag> @@ -178,7 +178,7 @@ in UTC.</p> <p>The value of this parameter is used as the <c>offset</c> option - to <seealso marker="stdlib:calendar#system_time_to_rfc3339-2"> + to <seealso marker="stdlib:calendar#system_time_to_rfc3339/2"> <c>calendar:system_time_to_rcf3339/2</c></seealso>.</p> </item> </taglist> @@ -298,13 +298,13 @@ exit_reason: "It crashed"</code> and <c>{error,term()}</c> if it is faulty.</p> <p>The following Logger API functions can trigger this callback:</p> <list> - <item><seealso marker="logger#add_handler-3"> + <item><seealso marker="logger#add_handler/3"> <c>logger:add_handler/3</c></seealso></item> - <item><seealso marker="logger#set_handler_config-2"> + <item><seealso marker="logger#set_handler_config/2"> <c>logger:set_handler_config/2,3</c></seealso></item> - <item><seealso marker="logger#update_handler_config-2"> + <item><seealso marker="logger#update_handler_config/2"> <c>logger:update_handler_config/2</c></seealso></item> - <item><seealso marker="logger#update_formatter_config-2"> + <item><seealso marker="logger#update_formatter_config/2"> <c>logger:update_formatter_config/2</c></seealso></item> </list> </desc> diff --git a/lib/kernel/doc/src/logger_std_h.xml b/lib/kernel/doc/src/logger_std_h.xml index b7d7105fd9..71ebefc16c 100644 --- a/lib/kernel/doc/src/logger_std_h.xml +++ b/lib/kernel/doc/src/logger_std_h.xml @@ -47,7 +47,7 @@ <seealso marker="logger_chapter#overload_protection"><c>User's Guide</c> </seealso>.</p> <p>To add a new instance of the standard handler, use - <seealso marker="logger#add_handler-3"><c>logger:add_handler/3</c> + <seealso marker="logger#add_handler/3"><c>logger:add_handler/3</c> </seealso>. The handler configuration argument is a map which can contain general configuration parameters, as documented in the <seealso marker="logger_chapter#handler_configuration"><c>User's Guide</c> @@ -77,7 +77,7 @@ <item> <p>This specifies the file modes to use when opening the log file, - see <seealso marker="file#open-2"><c>file:open/2</c></seealso>. + see <seealso marker="file#open/2"><c>file:open/2</c></seealso>. If <c>modes</c> are not specified, the default list used is <c>[raw,append,delayed_write]</c>. If <c>modes</c> are specified, the list replaces the default modes list with the @@ -162,7 +162,7 @@ <p>If <c>no_repeat</c> is set as value, the repeated file sync operation is disabled, and it is the operating system settings that determine how quickly or slowly data is written to disk. The user can also call - the <seealso marker="logger_std_h#filesync-1"><c>filesync/1</c></seealso> + the <seealso marker="logger_std_h#filesync/1"><c>filesync/1</c></seealso> function to perform a file sync.</p> <p>Defaults to <c>5000</c> milliseconds.</p> </item> diff --git a/lib/observer/doc/src/observer_ug.xml b/lib/observer/doc/src/observer_ug.xml index c9204f2bbe..ec7f7ff269 100644 --- a/lib/observer/doc/src/observer_ug.xml +++ b/lib/observer/doc/src/observer_ug.xml @@ -226,7 +226,7 @@ <tag>Name</tag> <item><p>The registered name of the port, if any.</p></item> <tag>Controls</tag> - <item><p>The name of the command set by <seealso marker="erts:erlang#open_port-2"><c>erlang:open_port/2</c></seealso>.</p></item> + <item><p>The name of the command set by <seealso marker="erts:erlang#open_port/2"><c>erlang:open_port/2</c></seealso>.</p></item> <tag>Slot</tag> <item><p>The internal index of the port.</p></item> </taglist> @@ -245,7 +245,7 @@ that name are then traced on all traced nodes.</p> <p>Option <em>Close</em> - executes <seealso marker="erts:erlang#port_close-1"><c>erlang:port_close/1</c></seealso> + executes <seealso marker="erts:erlang#port_close/1"><c>erlang:port_close/1</c></seealso> on the port under the mouse pointer.</p> </section> diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 64f01e670b..2b09152cee 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -93,7 +93,7 @@ <desc> <code>Cipher = "RC2-CBC" | "DES-CBC" | "DES-EDE3-CBC"</code> <p><c>Salt</c> could be generated with - <seealso marker="crypto:crypto#strong_rand_bytes-1"><c>crypto:strong_rand_bytes(8)</c></seealso>.</p> + <seealso marker="crypto:crypto#strong_rand_bytes/1"><c>crypto:strong_rand_bytes(8)</c></seealso>.</p> </desc> </datatype> @@ -418,7 +418,7 @@ Performs a basic path validation according to <url href="http://www.ietf.org/rfc/rfc5280.txt">RFC 5280.</url> However, CRL validation is done separately by <seealso - marker="#pkix_crls_validate-3">pkix_crls_validate/3 </seealso> and is to be called + marker="#pkix_crls_validate/3">pkix_crls_validate/3 </seealso> and is to be called from the supplied <c>verify_fun</c>. </p> @@ -505,7 +505,7 @@ fun(OtpCert :: #'OTPCertificate'{}, <fsummary>Performs CRL validation.</fsummary> <desc> <p>Performs CRL validation. It is intended to be called from - the verify fun of <seealso marker="#pkix_path_validation-3"> pkix_path_validation/3 + the verify fun of <seealso marker="#pkix_path_validation/3"> pkix_path_validation/3 </seealso>.</p> <p>Available options:</p> @@ -566,7 +566,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, <desc> <p>Creates a distribution point for CRLs issued by the same issuer as <c>Cert</c>. Can be used as input to <seealso - marker="#pkix_crls_validate-3">pkix_crls_validate/3 </seealso> + marker="#pkix_crls_validate/3">pkix_crls_validate/3 </seealso> </p> </desc> </func> @@ -626,14 +626,14 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, <d> A valid chain must have at least a ROOT and a peer cert. The root cert can be given either as a cert pre-generated by - <seealso marker="#pkix_test_root_cert-2"> + <seealso marker="#pkix_test_root_cert/2"> pkix_test_root_cert/2 </seealso>, or as root cert generation options. </d> <v>root_cert() = #{cert := der_encoded(), key := Key}</v> <d> A root certificate generated by - <seealso marker="#pkix_test_root_cert-2"> + <seealso marker="#pkix_test_root_cert/2"> pkix_test_root_cert/2 </seealso>. </d> @@ -648,7 +648,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, This is a subset of the type <seealso marker="ssl:ssl#type-tls_option"> ssl:tls_option()</seealso>. <c>PrivateKey</c> is what - <seealso marker="#generate_key-1">generate_key/1</seealso> + <seealso marker="#generate_key/1">generate_key/1</seealso> returns. </d> </type> @@ -675,7 +675,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, as root of the client certificate chain. Vice versa applies to the <c>cacerts</c> returned for the client. The root cert(s) can either be pre-generated with - <seealso marker="#pkix_test_root_cert-2"> + <seealso marker="#pkix_test_root_cert/2"> pkix_test_root_cert/2 </seealso>, or if options are specified; it is (they are) generated. @@ -754,19 +754,19 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, For available options see <seealso marker="#cert_opt">cert_opt()</seealso> under - <seealso marker="#pkix_test_data-1">pkix_test_data/1</seealso>. + <seealso marker="#pkix_test_data/1">pkix_test_data/1</seealso>. </d> <v>RootCert = #{cert := der_encoded(), key := Key}</v> <d> A root certificate and key. The <c>Key</c> is generated by - <seealso marker="#generate_key-1">generate_key/1</seealso>. + <seealso marker="#generate_key/1">generate_key/1</seealso>. </d> </type> <desc> <p> Generates a root certificate that can be used in multiple calls to - <seealso marker="#pkix_test_data-1">pkix_test_data/1</seealso> + <seealso marker="#pkix_test_data/1">pkix_test_data/1</seealso> when you want the same root certificate for several generated certificates. </p> @@ -803,7 +803,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, <p>This function checks that the <i>Presented Identifier</i> (e.g hostname) in a peer certificate is in agreement with at least one of the <i>Reference Identifier</i> that the client expects to be connected to. The function is intended to be added as an extra client check of the peer certificate when performing - <seealso marker="public_key:public_key#pkix_path_validation-3">public_key:pkix_path_validation/3</seealso> + <seealso marker="public_key:public_key#pkix_path_validation/3">public_key:pkix_path_validation/3</seealso> </p> <p>See <url href="https://tools.ietf.org/html/rfc6125">RFC 6125</url> for detailed information about hostname verification. @@ -832,7 +832,7 @@ fun(....) -> true; % My special case (_, _) -> default % all others falls back to the inherit tests end </code> - <br/>See <seealso marker="#pkix_verify_hostname_match_fun-1">pkix_verify_hostname_match_fun/1</seealso> for a + <br/>See <seealso marker="#pkix_verify_hostname_match_fun/1">pkix_verify_hostname_match_fun/1</seealso> for a function that takes a protocol name as argument and returns a <c>fun/2</c> suitable for this option and <seealso marker="using_public_key#redefining_match_op">Re-defining the match operation</seealso> in the User's Guide for an example. @@ -874,15 +874,15 @@ end <v>Protocol = https</v> <d>The algorithm for wich the fun should implement the special matching rules</d> <v>RefId</v> - <d>See <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>.</d> + <d>See <seealso marker="#pkix_verify_hostname/3">pkix_verify_hostname/3</seealso>.</d> <v>FQDN</v> - <d>See <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>.</d> + <d>See <seealso marker="#pkix_verify_hostname/3">pkix_verify_hostname/3</seealso>.</d> <v>PresentedID</v> - <d>See <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>.</d> + <d>See <seealso marker="#pkix_verify_hostname/3">pkix_verify_hostname/3</seealso>.</d> </type> <desc> <p>The return value of calling this function is intended to be used in the <c>match_fun</c> option in - <seealso marker="#pkix_verify_hostname-3">pkix_verify_hostname/3</seealso>. + <seealso marker="#pkix_verify_hostname/3">pkix_verify_hostname/3</seealso>. </p> <p>The returned fun augments the verify hostname matching according to the specific rules for the protocol in the argument. @@ -941,7 +941,7 @@ end <desc> <p>Encodes a list of SSH file entries (public keys and attributes) to a binary. Possible attributes depend on the file type, see - <seealso marker="#ssh_decode-2"> ssh_decode/2 </seealso>. + <seealso marker="#ssh_decode/2"> ssh_decode/2 </seealso>. </p> <p>If the <c>Type</c> is <c>ssh2_pubkey</c>, the <c>InData</c> shall be <c>InData_ssh2_pubkey</c>. Otherwise it shall be <c>OtherInData</c>. diff --git a/lib/public_key/doc/src/using_public_key.xml b/lib/public_key/doc/src/using_public_key.xml index de0a6596c3..d1290cf83a 100644 --- a/lib/public_key/doc/src/using_public_key.xml +++ b/lib/public_key/doc/src/using_public_key.xml @@ -439,11 +439,11 @@ true = public_key:verify(Digest, none, Signature, PublicKey),</code> could trust the host names signed in it. </p> <p>There is a default hostname matching procedure defined in - <url href="https://tools.ietf.org/html/rfc6125#section-6">RFC 6125, section 6</url> + <url href="https://tools.ietf.org/html/rfc6125#section/6">RFC 6125, section 6</url> as well as protocol dependent variations defined in <url href="https://tools.ietf.org/html/rfc6125#appendix-B">RFC 6125 appendix B</url>. The default procedure is implemented in - <seealso marker="public_key:public_key#pkix_verify_hostname-2">public_key:pkix_verify_hostname/2,3</seealso>. + <seealso marker="public_key:public_key#pkix_verify_hostname/2">public_key:pkix_verify_hostname/2,3</seealso>. It is possible for a client to hook in modified rules using the options list. </p> <p>Some terminology is needed: the certificate presents hostname(s) on which it is valid. diff --git a/lib/reltool/doc/src/reltool_examples.xml b/lib/reltool/doc/src/reltool_examples.xml index 3888b643a2..11cd7d9657 100644 --- a/lib/reltool/doc/src/reltool_examples.xml +++ b/lib/reltool/doc/src/reltool_examples.xml @@ -42,11 +42,11 @@ is or be used via the GUI frontend process. When the GUI is started, a server process will automatically be started. The GUI process is started with - <seealso marker="reltool#start-0"><c>reltool:start/0</c></seealso>, - <seealso marker="reltool#start-1"><c>reltool:start/1</c></seealso> or - <seealso marker="reltool#start_link-1"><c>reltool:start_link/1</c></seealso>. + <seealso marker="reltool#start/0"><c>reltool:start/0</c></seealso>, + <seealso marker="reltool#start/1"><c>reltool:start/1</c></seealso> or + <seealso marker="reltool#start_link/1"><c>reltool:start_link/1</c></seealso>. The pid of its server can be obtained with - <seealso marker="reltool#start_link-1"><c>reltool:get_server/1</c></seealso> + <seealso marker="reltool#start_link/1"><c>reltool:get_server/1</c></seealso> </p> <pre> diff --git a/lib/runtime_tools/doc/src/LTTng.xml b/lib/runtime_tools/doc/src/LTTng.xml index e6fa8d484c..6c0de3805a 100644 --- a/lib/runtime_tools/doc/src/LTTng.xml +++ b/lib/runtime_tools/doc/src/LTTng.xml @@ -77,7 +77,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>procs</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>procs</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">process_spawn: { cpu_id = 3 }, { pid = "<0.131.0>", parent = "<0.130.0>", entry = "erlang:apply/2" }</code> @@ -90,7 +90,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>procs</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>procs</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">process_link: { cpu_id = 3 }, { from = "<0.130.0>", to = "<0.131.0>", type = "link" }</code> @@ -103,7 +103,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>procs</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>procs</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">process_exit: { cpu_id = 3 }, { pid = "<0.130.0>", reason = "normal" }</code> @@ -125,7 +125,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>running</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>running</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">process_scheduled: { cpu_id = 0 }, { pid = "<0.136.0>", entry = "erlang:apply/2", type = "in" }</code> @@ -139,7 +139,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>ports</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>ports</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">port_open: { cpu_id = 5 }, { pid = "<0.131.0>", driver = "'/bin/sh -s unix:cmd'", port = "#Port<0.1887>" }</code> @@ -151,7 +151,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>ports</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>ports</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">port_exit: { cpu_id = 5 }, { port = "#Port<0.1887>", reason = "normal" }</code> @@ -164,7 +164,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>ports</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>ports</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">port_link: { cpu_id = 5 }, { from = "#Port<0.1887>", to = "<0.131.0>", type = "unlink" }</code> @@ -172,7 +172,7 @@ $ make </code> <p><em>port_scheduled</em></p> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>running</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>running</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <list type="bulleted"> <item><c>port : string</c> :: Port ID. Ex. <c>"#Port<0.1031>"</c></item> @@ -184,7 +184,7 @@ $ make </code> <code type="none">port_scheduled: { cpu_id = 5 }, { pid = "#Port<0.1905>", entry = "close", type = "out" }</code> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>running</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>running</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p><em>function_call</em></p> <list type="bulleted"> @@ -194,7 +194,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>call</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>call</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">function_call: { cpu_id = 5 }, { pid = "<0.145.0>", entry = "dyntrace_lttng_SUITE:'-t_call/1-fun-1-'/0", depth = 0 }</code> @@ -207,7 +207,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>call</c> or <c>return_to</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>call</c> or <c>return_to</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">function_return: { cpu_id = 5 }, { pid = "<0.145.0>", entry = "dyntrace_lttng_SUITE:waiter/0", depth = 0 }</code> @@ -220,7 +220,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>call</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>call</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">function_exception: { cpu_id = 5 }, { pid = "<0.144.0>", entry = "t:call_exc/1", class = "error" }</code> @@ -233,7 +233,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>send</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>send</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">message_send: { cpu_id = 3 }, { from = "#Port<0.1938>", to = "<0.160.0>", message = "{#Port<0.1938>,eof}" }</code> @@ -245,7 +245,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>'receive'</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>'receive'</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">message_receive: { cpu_id = 7 }, { to = "<0.167.0>", message = "{<0.165.0>,ok}" }</code> @@ -259,7 +259,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">gc_minor_start: { cpu_id = 0 }, { pid = "<0.172.0>", need = 0, heap = 610, old_heap = 0 }</code> @@ -273,7 +273,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">gc_minor_end: { cpu_id = 0 }, { pid = "<0.172.0>", reclaimed = 120, heap = 1598, old_heap = 1598 }</code> @@ -287,7 +287,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">gc_major_start: { cpu_id = 0 }, { pid = "<0.172.0>", need = 8, heap = 2586, old_heap = 1598 }</code> @@ -301,7 +301,7 @@ $ make </code> </list> <p> Available through - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso> with trace flag <c>garbage_collection</c> and <c>{tracer,dyntrace,[]}</c> as tracer module. </p> <p>Example:</p> <code type="none">gc_major_end: { cpu_id = 0 }, { pid = "<0.172.0>", reclaimed = 240, heap = 4185, old_heap = 0 }</code> diff --git a/lib/runtime_tools/doc/src/dbg.xml b/lib/runtime_tools/doc/src/dbg.xml index 6589e514ed..1af74de485 100644 --- a/lib/runtime_tools/doc/src/dbg.xml +++ b/lib/runtime_tools/doc/src/dbg.xml @@ -36,8 +36,8 @@ <modulesummary>The Text Based Trace Facility</modulesummary> <description> <p>This module implements a text based interface to the - <seealso marker="erts:erlang#trace-3"><c>trace/3</c></seealso> and the - <seealso marker="erts:erlang#trace_pattern-2"><c>trace_pattern/2</c></seealso> BIFs. It makes it + <seealso marker="erts:erlang#trace/3"><c>trace/3</c></seealso> and the + <seealso marker="erts:erlang#trace_pattern/2"><c>trace_pattern/2</c></seealso> BIFs. It makes it possible to trace functions, processes, ports and messages. </p> <p> @@ -184,8 +184,8 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <tag><c>pid()</c> or <c>port()</c></tag> <item>The corresponding process or port is traced. The process or port may be a remote process or port (on another Erlang node). The node must - be in the list of traced nodes (see <seealso marker="#n-1"><c>n/1</c></seealso> - and <seealso marker="#tracer-3"><c>tracer/3</c></seealso>).</item> + be in the list of traced nodes (see <seealso marker="#n/1"><c>n/1</c></seealso> + and <seealso marker="#tracer/3"><c>tracer/3</c></seealso>).</item> <tag><c>all</c></tag> <item>All processes and ports in the system as well as all processes and ports created hereafter are to be traced.</item> @@ -208,23 +208,23 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <tag><c>atom()</c></tag> <item>The process or port with the corresponding registered name is traced. The process or port may be a remote process (on another Erlang node). The node must be - added with the <seealso marker="#n-1"><c>n/1</c></seealso> or - <seealso marker="#tracer-3"><c>tracer/3</c></seealso> function.</item> + added with the <seealso marker="#n/1"><c>n/1</c></seealso> or + <seealso marker="#tracer/3"><c>tracer/3</c></seealso> function.</item> <tag><c>integer()</c></tag> <item>The process <c><![CDATA[<0.Item.0>]]></c> is traced.</item> <tag><c>{X, Y, Z}</c></tag> <item>The process <c><![CDATA[<X.Y.Z>]]></c> is traced. </item> <tag><c>string()</c></tag> <item>If the <c>Item</c> is a string <![CDATA["<X.Y.Z>"]]> - as returned from <seealso marker="erts:erlang#pid_to_list-1"><c>pid_to_list/1</c></seealso>, + as returned from <seealso marker="erts:erlang#pid_to_list/1"><c>pid_to_list/1</c></seealso>, the process <c><![CDATA[<X.Y.Z>]]></c> is traced. </item> </taglist> <p>When enabling an <c>Item</c> that represents a group of processes, the <c>Item</c> is enabled on all nodes added with the - <seealso marker="#n-1"><c>n/1</c></seealso> or - <seealso marker="#tracer-3"><c>tracer/3</c></seealso> function.</p> + <seealso marker="#n/1"><c>n/1</c></seealso> or + <seealso marker="#tracer/3"><c>tracer/3</c></seealso> function.</p> <p><c>Flags</c> can be a single atom, or a list of flags. The available flags are: @@ -276,7 +276,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <item> <p>This is the same as <c>sol</c>, but only for the first call to - <seealso marker="erts:erlang#link-1"><c>link/1</c></seealso> by the traced process.</p> + <seealso marker="erts:erlang#link/1"><c>link/1</c></seealso> by the traced process.</p> </item> <tag><c>all</c></tag> <item> @@ -289,7 +289,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ </item> </taglist> <p>The list can also include any of the flags allowed in - <seealso marker="erts:erlang#trace-3"><c>erlang:trace/3</c></seealso></p> + <seealso marker="erts:erlang#trace/3"><c>erlang:trace/3</c></seealso></p> <p>The function returns either an error tuple or a tuple <c>{ok, List}</c>. The <c>List</c> consists of specifications of how many processes and ports that matched (in the @@ -373,7 +373,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ explains the general match specification "language". The most common generic match specifications used can be found as <c>Built-inAlias</c>', see - <seealso marker="#ltp-0"><c>ltp/0</c></seealso> below for details. + <seealso marker="#ltp/0"><c>ltp/0</c></seealso> below for details. </p> <p>The Module, Function and/or Arity parts of the tuple may be specified as the atom <c>'_'</c> which is a "wild-card" @@ -381,21 +381,21 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ Module is specified as <c>'_'</c>, the Function and Arity parts have to be specified as '_' too. The same holds for the Functions relation to the Arity.</p> - <p>All nodes added with <seealso marker="#n-1"><c>n/1</c></seealso> or - <seealso marker="#tracer-3"><c>tracer/3</c></seealso> will + <p>All nodes added with <seealso marker="#n/1"><c>n/1</c></seealso> or + <seealso marker="#tracer/3"><c>tracer/3</c></seealso> will be affected by this call, and if Module is not <c>'_'</c> the module will be loaded on all nodes.</p> <p>The function returns either an error tuple or a tuple <c>{ok, List}</c>. The <c>List</c> consists of specifications of how many functions that matched, in the same way as the processes and ports - are presented in the return value of <seealso marker="#p-2"><c>p/2</c></seealso>. </p> + are presented in the return value of <seealso marker="#p/2"><c>p/2</c></seealso>. </p> <p>There may be a tuple <c>{saved, N}</c> in the return value, if the MatchSpec is other than []. The integer <c>N</c> may then be used in subsequent calls to this function and will stand as an "alias" for the given expression. There are also a couple of built-in aliases for common expressions, see - <seealso marker="#ltp-0"><c>ltp/0</c></seealso> below for details.</p> + <seealso marker="#ltp/0"><c>ltp/0</c></seealso> below for details.</p> <p>If an error is returned, it can be due to errors in compilation of the match specification. Such errors are presented as a list of tuples <c>{error, string()}</c> where @@ -434,7 +434,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <name since="">tpl({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()}</name> <fsummary>Set pattern for traced local (as well as global) function calls</fsummary> <desc> - <p>This function works as <seealso marker="#tp-2"><c>tp/2</c></seealso>, but enables + <p>This function works as <seealso marker="#tp/2"><c>tp/2</c></seealso>, but enables tracing for local calls (and local functions) as well as for global calls (and functions).</p> </desc> @@ -474,11 +474,11 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ be the case for remote senders). <c>Msg</c> is the message term. The pid of the receiving process can be accessed with the guard function <c>self/0</c>.</p> - <p>All nodes added with <seealso marker="#n-1"><c>n/1</c></seealso> or - <seealso marker="#tracer-3"><c>tracer/3</c></seealso> will + <p>All nodes added with <seealso marker="#n/1"><c>n/1</c></seealso> or + <seealso marker="#tracer/3"><c>tracer/3</c></seealso> will be affected by this call.</p> <p>The return value is the same as for - <seealso marker="#tp-2"><c>tp/2</c></seealso>. The number of matched + <seealso marker="#tp/2"><c>tp/2</c></seealso>. The number of matched events are never larger than 1 as <c>tpe/2</c> does not accept any form of wildcards for argument <c>Event</c>.</p> </desc> @@ -525,10 +525,10 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <p>This function disables call tracing on the specified functions. The semantics of the parameter is the same as for the corresponding function specification in - <seealso marker="#tp-2"><c>tp/2</c></seealso> or <seealso marker="#tpl-2"><c>tpl/2</c></seealso>. Both local and global call trace + <seealso marker="#tp/2"><c>tp/2</c></seealso> or <seealso marker="#tpl/2"><c>tpl/2</c></seealso>. Both local and global call trace is disabled. </p> <p>The return value reflects how many functions that matched, - and is constructed as described in <seealso marker="#tp-2"><c>tp/2</c></seealso>. No tuple + and is constructed as described in <seealso marker="#tp/2"><c>tp/2</c></seealso>. No tuple <c>{saved, N}</c> is however ever returned (for obvious reasons).</p> </desc> </func> @@ -564,9 +564,9 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <name since="">ctpl({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()}</name> <fsummary>Clear call trace pattern for the specified functions</fsummary> <desc> - <p>This function works as <seealso marker="#ctp-1"><c>ctp/1</c></seealso>, but only disables - tracing set up with <seealso marker="#tpl-2"><c>tpl/2</c></seealso> - (not with <seealso marker="#tp-2"><c>tp/2</c></seealso>).</p> + <p>This function works as <seealso marker="#ctp/1"><c>ctp/1</c></seealso>, but only disables + tracing set up with <seealso marker="#tpl/2"><c>tpl/2</c></seealso> + (not with <seealso marker="#tp/2"><c>tp/2</c></seealso>).</p> </desc> </func> <func> @@ -601,9 +601,9 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <name since="">ctpg({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()}</name> <fsummary>Clear call trace pattern for the specified functions</fsummary> <desc> - <p>This function works as <seealso marker="#ctp-1"><c>ctp/1</c></seealso>, but only disables - tracing set up with <seealso marker="#tp-2"><c>tp/2</c></seealso> - (not with <seealso marker="#tpl-2"><c>tpl/2</c></seealso>).</p> + <p>This function works as <seealso marker="#ctp/1"><c>ctp/1</c></seealso>, but only disables + tracing set up with <seealso marker="#tp/2"><c>tp/2</c></seealso> + (not with <seealso marker="#tpl/2"><c>tpl/2</c></seealso>).</p> </desc> </func> <func> @@ -619,7 +619,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ trace event (<c>send</c> or <c>'receive'</c>). It will revert back to the default behavior of tracing all triggered events.</p> <p>The return value follow the same style as for - <seealso marker="#ctp-1"><c>ctp/1</c></seealso>.</p> + <seealso marker="#ctp/1"><c>ctp/1</c></seealso>.</p> </desc> </func> <func> @@ -628,14 +628,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <desc> <p>Use this function to recall all match specifications previously used in the session (i. e. previously saved during calls - to <seealso marker="#tp-2"><c>tp/2</c></seealso>, and built-in match specifications. + to <seealso marker="#tp/2"><c>tp/2</c></seealso>, and built-in match specifications. This is very useful, as a complicated match_spec can be quite awkward to write. Note that the - match specifications are lost if <seealso marker="#stop-0"><c>stop/0</c></seealso> is called.</p> + match specifications are lost if <seealso marker="#stop/0"><c>stop/0</c></seealso> is called.</p> <p>Match specifications used can be saved in a file (if a read-write file system is present) for use in later - debugging sessions, see <seealso marker="#wtp-1"><c>wtp/1</c></seealso> - and <seealso marker="#rtp-1"><c>rtp/1</c></seealso></p> + debugging sessions, see <seealso marker="#wtp/1"><c>wtp/1</c></seealso> + and <seealso marker="#rtp/1"><c>rtp/1</c></seealso></p> <p>There are three built-in trace patterns: <c>exception_trace</c>, <c>caller_trace</c> and <c>caller_exception_trace</c> (or <c>x</c>, <c>c</c> and @@ -658,10 +658,10 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <fsummary>Delete all saved match specifications.</fsummary> <desc> <p>Use this function to "forget" all match specifications - saved during calls to <seealso marker="#tp-2"><c>tp/2</c></seealso>. + saved during calls to <seealso marker="#tp/2"><c>tp/2</c></seealso>. This is useful when one wants to restore other match - specifications from a file with <seealso marker="#rtp-1"><c>rtp/1</c></seealso>. Use - <seealso marker="#dtp-1"><c>dtp/1</c></seealso> to delete specific saved match specifications.</p> + specifications from a file with <seealso marker="#rtp/1"><c>rtp/1</c></seealso>. Use + <seealso marker="#dtp/1"><c>dtp/1</c></seealso> to delete specific saved match specifications.</p> </desc> </func> <func> @@ -672,7 +672,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ </type> <desc> <p>Use this function to "forget" a specific match specification - saved during calls to <seealso marker="#tp-2"><c>tp/2</c></seealso>.</p> + saved during calls to <seealso marker="#tp/2"><c>tp/2</c></seealso>.</p> </desc> </func> <func> @@ -684,12 +684,12 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ </type> <desc> <p>This function will save all match specifications saved - during the session (during calls to <seealso marker="#tp-2"><c>tp/2</c></seealso>) + during the session (during calls to <seealso marker="#tp/2"><c>tp/2</c></seealso>) and built-in match specifications in a text file with the name designated by <c>Name</c>. The format of the file is textual, why it can be edited with an ordinary text editor, and then restored with - <seealso marker="#rtp-1"><c>rtp/1</c></seealso>. </p> + <seealso marker="#rtp/1"><c>rtp/1</c></seealso>. </p> <p>Each match spec in the file ends with a full stop (<c>.</c>) and new (syntactically correct) match specifications can be added to the file manually.</p> @@ -707,7 +707,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ </type> <desc> <p>This function reads match specifications from a file - (possibly) generated by the <seealso marker="#wtp-1"><c>wtp/1</c></seealso> + (possibly) generated by the <seealso marker="#wtp/1"><c>wtp/1</c></seealso> function. It checks the syntax of all match specifications and verifies that they are correct. The error handling principle is "all or @@ -716,7 +716,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ saved match specifications for the running system. </p> <p>The match specifications in the file are <em>merged</em> with the current match specifications, so that no duplicates - are generated. Use <seealso marker="#ltp-0"><c>ltp/0</c></seealso> + are generated. Use <seealso marker="#ltp/0"><c>ltp/0</c></seealso> to see what numbers were assigned to the specifications from the file.</p> <p>The function will return an error, either due to I/O @@ -736,9 +736,9 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ </type> <desc> <p>The <c>dbg</c> server keeps a list of nodes where tracing - should be performed. Whenever a <seealso marker="#tp-2"><c>tp/2</c></seealso> call or a - <seealso marker="#p-2"><c>p/2</c></seealso> call is made, it is executed for all nodes in this - list including the local node (except for <seealso marker="#p-2"><c>p/2</c></seealso> with a + should be performed. Whenever a <seealso marker="#tp/2"><c>tp/2</c></seealso> call or a + <seealso marker="#p/2"><c>p/2</c></seealso> call is made, it is executed for all nodes in this + list including the local node (except for <seealso marker="#p/2"><c>p/2</c></seealso> with a specific <c>pid()</c> or <c>port()</c> as first argument, in which case the command is executed only on the node where the designated process or port resides). @@ -750,17 +750,17 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ distribution). If no tracer process is running on the local node, the error reason <c>no_local_tracer</c> is returned. The tracer process on the local node must be started with the - <seealso marker="#tracer-2"><c>tracer/0/2</c></seealso> function. + <seealso marker="#tracer/2"><c>tracer/0/2</c></seealso> function. </p> <p>If <c>Nodename</c> is the local node, the error reason <c>cant_add_local_node</c> is returned. </p> - <p>If a trace port (see <seealso marker="#trace_port-2"><c>trace_port/2</c></seealso>) is + <p>If a trace port (see <seealso marker="#trace_port/2"><c>trace_port/2</c></seealso>) is running on the local node, remote nodes cannot be traced with a tracer process. The error reason <c>cant_trace_remote_pid_to_local_port</c> is returned. A trace port can however be started on the remote node with the - <seealso marker="#tracer-3"><c>tracer/3</c></seealso> function. + <seealso marker="#tracer/3"><c>tracer/3</c></seealso> function. </p> <p>The function will also return an error if the node <c>Nodename</c> is not reachable.</p> @@ -774,8 +774,8 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ </type> <desc> <p>Clears a node from the list of traced nodes. Subsequent - calls to <seealso marker="#tp-2"><c>tp/2</c></seealso> and - <seealso marker="#p-2"><c>p/2</c></seealso> will not consider that + calls to <seealso marker="#tp/2"><c>tp/2</c></seealso> and + <seealso marker="#p/2"><c>p/2</c></seealso> will not consider that node, but tracing already activated on the node will continue to be in effect.</p> <p>Returns <c>ok</c>, cannot fail.</p> @@ -794,14 +794,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <desc> <p>This function starts a server on the local node that will be the recipient of all trace messages. All subsequent calls - to <seealso marker="#p-2"><c>p/2</c></seealso> will result in messages sent to the newly + to <seealso marker="#p/2"><c>p/2</c></seealso> will result in messages sent to the newly started trace server.</p> <p>A trace server started in this way will simply display the trace messages in a formatted way in the Erlang shell - (i. e. use io:format). See <seealso marker="#tracer-2"><c>tracer/2</c></seealso> + (i. e. use io:format). See <seealso marker="#tracer/2"><c>tracer/2</c></seealso> for a description of how the trace message handler can be customized. </p> - <p>To start a similar tracer on a remote node, use <seealso marker="#n-1"><c>n/1</c></seealso>.</p> + <p>To start a similar tracer on a remote node, use <seealso marker="#n/1"><c>n/1</c></seealso>.</p> </desc> </func> <func> @@ -825,7 +825,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ by a receiving process (<c>process</c>), by a tracer port (<c>port</c>) or by a tracer module (<c>module</c>). For a description about tracer ports see - <seealso marker="#trace_port-2"><c>trace_port/2</c></seealso> + <seealso marker="#trace_port/2"><c>trace_port/2</c></seealso> and for a tracer modules see <seealso marker="erts:erl_tracer"><c>erl_tracer</c></seealso>. </p> @@ -843,7 +843,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <p>If <c>Type</c> is <c>port</c>, then the second parameter should be a <em>fun</em> which takes no arguments and returns a newly opened trace port when called. Such a <em>fun</em> is - preferably generated by calling <seealso marker="#trace_port-2"><c>trace_port/2</c></seealso>. + preferably generated by calling <seealso marker="#trace_port/2"><c>trace_port/2</c></seealso>. </p> <p>if <c>Type</c> is <c>module</c>, then the second parameter should be either a tuple describing the <seealso marker="erts:erl_tracer"><c>erl_tracer</c></seealso> @@ -854,7 +854,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ due to the <c>HandlerFun</c> throwing an exception. </p> <p>To start a similar tracer on a remote node, use - <seealso marker="#tracer-3"><c>tracer/3</c></seealso>. + <seealso marker="#tracer/3"><c>tracer/3</c></seealso>. </p> </desc> </func> @@ -865,19 +865,19 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <v>Nodename = atom()</v> </type> <desc> - <p>This function is equivalent to <seealso marker="#tracer-2"><c>tracer/2</c></seealso>, but acts on + <p>This function is equivalent to <seealso marker="#tracer/2"><c>tracer/2</c></seealso>, but acts on the given node. A tracer is started on the node (<c>Nodename</c>) and the node is added to the list of traced nodes. </p> <note> - <p>This function is not equivalent to <seealso marker="#n-1"><c>n/1</c></seealso>. While - <seealso marker="#n-1"><c>n/1</c></seealso> starts a process tracer which redirects all trace + <p>This function is not equivalent to <seealso marker="#n/1"><c>n/1</c></seealso>. While + <seealso marker="#n/1"><c>n/1</c></seealso> starts a process tracer which redirects all trace information to a process tracer on the local node (i.e. the - trace control node), <seealso marker="#tracer-3"><c>tracer/3</c></seealso> starts a tracer of any + trace control node), <seealso marker="#tracer/3"><c>tracer/3</c></seealso> starts a tracer of any type which is independent of the tracer on the trace control node.</p> </note> - <p>For details, see <seealso marker="#tracer-2"><c>tracer/2</c></seealso>.</p> + <p>For details, see <seealso marker="#tracer/2"><c>tracer/2</c></seealso>.</p> </desc> </func> <func> @@ -909,9 +909,9 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <c>file</c> and the <c>ip</c> trace drivers. The file driver sends all trace messages into one or several binary files, from where they later can be fetched and processed with the - <seealso marker="#trace_client-2"><c>trace_client/2</c></seealso> function. The ip driver opens a TCP/IP + <seealso marker="#trace_client/2"><c>trace_client/2</c></seealso> function. The ip driver opens a TCP/IP port where it listens for connections. When a client - (preferably started by calling <seealso marker="#trace_client-2"><c>trace_client/2</c></seealso> on + (preferably started by calling <seealso marker="#trace_client/2"><c>trace_client/2</c></seealso> on another Erlang node) connects, all trace messages are sent over the IP network for further processing by the remote client. </p> @@ -950,7 +950,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ as fast as they are produced by the runtime system, a special message is sent, which indicates how many messages that are dropped. That message will arrive at the handler function - specified in <seealso marker="#trace_client-3"><c>trace_client/3</c></seealso> + specified in <seealso marker="#trace_client/3"><c>trace_client/3</c></seealso> as the tuple <c>{drop, N}</c> where <c>N</c> is the number of consecutive messages dropped. In case of heavy tracing, drop's are likely to occur, and they surely occur if no client is reading the trace @@ -1029,7 +1029,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <p>This function starts a trace client that reads the output created by a trace port driver and handles it in mostly the same way as a tracer process created by the - <seealso marker="#tracer-0"><c>tracer/0</c></seealso> function.</p> + <seealso marker="#tracer/0"><c>tracer/0</c></seealso> function.</p> <p>If <c>Type</c> is <c>file</c>, the client reads all trace messages stored in the file named <c>Filename</c> or specified by <c>WrapFilesSpec</c> (must be the same as used @@ -1040,7 +1040,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ <p>If <c>Type</c> is <c>follow_file</c>, the client behaves as in the <c>file</c> case, but keeps trying to read (and process) more data - from the file until stopped by <seealso marker="#stop_trace_client-1"><c>stop_trace_client/1</c></seealso>. + from the file until stopped by <seealso marker="#stop_trace_client/1"><c>stop_trace_client/1</c></seealso>. <c>WrapFilesSpec</c> is not allowed as second argument for this <c>Type</c>.</p> <p>If <c>Type</c> is <c>ip</c>, the client connects to the @@ -1096,10 +1096,10 @@ hello</pre> <v>InitialData = term()</v> </type> <desc> - <p>This function works exactly as <seealso marker="#trace_client-2"><c>trace_client/2</c></seealso>, + <p>This function works exactly as <seealso marker="#trace_client/2"><c>trace_client/2</c></seealso>, but allows you to write your own handler function. The handler function works mostly as the one described in - <seealso marker="#tracer-2"><c>tracer/2</c></seealso>, but will also have to be prepared to handle + <seealso marker="#tracer/2"><c>tracer/2</c></seealso>, but will also have to be prepared to handle trace messages of the form <c>{drop, N}</c>, where <c>N</c> is the number of dropped messages. This pseudo trace message will only occur if the ip trace driver is used.</p> @@ -1118,8 +1118,8 @@ hello</pre> <desc> <p>This function shuts down a previously started trace client. The <c>Pid</c> argument is the process id returned - from the <seealso marker="#trace_client-2"><c>trace_client/2</c></seealso> - or <seealso marker="#trace_client-3"><c>trace_client/3</c></seealso> call.</p> + from the <seealso marker="#trace_client/2"><c>trace_client/2</c></seealso> + or <seealso marker="#trace_client/3"><c>trace_client/3</c></seealso> call.</p> </desc> </func> <func> @@ -1272,7 +1272,7 @@ SeqTrace [0]: (<0.30.0>) <0.25.0> ! {dbg,{ok,<0.31.0>}} [Serial: {4,5}] of causing a deadlock. This will happen if a group leader process generates a trace message and the tracer process, by calling the trace handler function, sends an IO request to the same group leader. The problem can only occur if the trace handler - prints to tty using an <c>io</c> function such as <seealso marker="stdlib:io#format-2"><c>format/2</c></seealso>. + prints to tty using an <c>io</c> function such as <seealso marker="stdlib:io#format/2"><c>format/2</c></seealso>. Note that when <c>dbg:p(all,call)</c> is called, IO processes are also traced. Here's an example:</p> diff --git a/lib/runtime_tools/doc/src/msacc.xml b/lib/runtime_tools/doc/src/msacc.xml index ae089de8d0..584411e918 100644 --- a/lib/runtime_tools/doc/src/msacc.xml +++ b/lib/runtime_tools/doc/src/msacc.xml @@ -64,10 +64,10 @@ Stats per type: ok </pre> <p>This first command enables microstate accounting for 1000 milliseconds. - See <seealso marker="#start-0"><c>start/0</c></seealso>, - <seealso marker="#stop-0"><c>stop/0</c></seealso>, - <seealso marker="#reset-0"><c>reset/0</c></seealso> and - <seealso marker="#start-1"><c>start/1</c></seealso> for more details. + See <seealso marker="#start/0"><c>start/0</c></seealso>, + <seealso marker="#stop/0"><c>stop/0</c></seealso>, + <seealso marker="#reset/0"><c>reset/0</c></seealso> and + <seealso marker="#start/1"><c>start/1</c></seealso> for more details. The second command prints the statistics gathered during that time. First three general statistics are printed.</p> <taglist> @@ -113,7 +113,7 @@ ok <desc><p>A map containing information about a specific thread. The percentages in the map can be either run-time or real-time depending on if <c>runtime</c> or <c>realtime</c> was requested from - <seealso marker="#stats-2">stats/2</seealso>. <c>system</c> is the + <seealso marker="#stats/2">stats/2</seealso>. <c>system</c> is the percentage of total system time for this specific thread.</p></desc> </datatype> <datatype> @@ -140,7 +140,7 @@ ok <datatype> <name name="msacc_print_options"/> <desc><p>The different options that can be given to - <seealso marker="#print-2"><c>print/2</c></seealso>. + <seealso marker="#print/2"><c>print/2</c></seealso>. </p></desc> </datatype> </datatypes> @@ -192,7 +192,7 @@ ok <p> Prints the current microstate accounting to standard out. Same as - <seealso marker="#print-1"> + <seealso marker="#print/1"> <c>msacc:print(msacc:stats(),#{}).</c> </seealso> </p> @@ -204,7 +204,7 @@ ok <desc> <p>Print the given microstate statistics values to stdout. Same as - <seealso marker="#print-1"> + <seealso marker="#print/1"> <c>msacc:print(DataOrStats,#{}).</c> </seealso> </p> @@ -219,7 +219,7 @@ ok reference manual for a brief description of what the fields mean.</p> <p>It is possible to print more specific types of statistics by first manipulating the <c>DataOrStats</c> using - <seealso marker="#stats-2"><c>stats/2</c></seealso>. + <seealso marker="#stats/2"><c>stats/2</c></seealso>. For instance if you want to print the percentage of run-time for each thread you can do:</p> <pre><input>msacc:print(msacc:stats(runtime,msacc:stats())).</input></pre> @@ -239,7 +239,7 @@ ok <desc> <p>Print the given microstate statistics values to the given file or device. The other arguments behave the same way as for - <seealso marker="#print-2"><c>print/2</c></seealso>.</p> + <seealso marker="#print/2"><c>print/2</c></seealso>.</p> </desc> </func> <func> diff --git a/lib/runtime_tools/doc/src/scheduler.xml b/lib/runtime_tools/doc/src/scheduler.xml index b033430183..66e5250a3d 100644 --- a/lib/runtime_tools/doc/src/scheduler.xml +++ b/lib/runtime_tools/doc/src/scheduler.xml @@ -39,7 +39,7 @@ calculation of scheduler utilization, otherwise obtained from calling the more primitive <seealso marker="erts:erlang#statistics_scheduler_wall_time"> <c>statistics(scheduler_wall_time)</c></seealso>.</p> - <p>The simplest usage is to call <seealso marker="#utilization-1"> + <p>The simplest usage is to call <seealso marker="#utilization/1"> <c>scheduler:utilization(Seconds)</c></seealso>.</p> </description> @@ -70,7 +70,7 @@ <tag><c>{io, SchedulerId, Util, Percent}</c></tag> <item>Scheduler utilization of a dirty-io scheduler with number <c>SchedulerId</c>. This tuple will only exist if both samples were - taken with <seealso marker="#sample_all-0"><c>sample_all/0</c></seealso>.</item> + taken with <seealso marker="#sample_all/0"><c>sample_all/0</c></seealso>.</item> <tag><c>{total, Util, Percent}</c></tag> <item>Total utilization of all normal and dirty-cpu schedulers.</item> <tag><c>{weighted, Util, Percent}</c></tag> @@ -126,8 +126,8 @@ <desc> <p>Calculates scheduler utilizations for the time interval between the two samples obtained from calling - <seealso marker="#sample-0"><c>sample/0</c></seealso> or - <seealso marker="#sample_all-0"><c>sample_all/0</c></seealso>.</p> + <seealso marker="#sample/0"><c>sample/0</c></seealso> or + <seealso marker="#sample_all/0"><c>sample_all/0</c></seealso>.</p> </desc> </func> diff --git a/lib/snmp/doc/src/snmp_agent_funct_descr.xml b/lib/snmp/doc/src/snmp_agent_funct_descr.xml index fdcab79646..c86788ca45 100644 --- a/lib/snmp/doc/src/snmp_agent_funct_descr.xml +++ b/lib/snmp/doc/src/snmp_agent_funct_descr.xml @@ -205,12 +205,12 @@ <icaption>MIB Compiler Principles</icaption> </image> <p>The compiler parses the SMI file and associates each table or - variable with an instrumentation function (see the figure <seealso marker="#image-1">MIB Compiler Principles</seealso>). The actual + variable with an instrumentation function (see the figure <seealso marker="#image/1">MIB Compiler Principles</seealso>). The actual instrumentation functions are not needed at MIB compile time, only their names. </p> <p>The binary output file produced by the compiler is read by the - agent at MIB load time (see the figure <seealso marker="#image-2">Starting the Agent</seealso>). The instrumentation is ordinary Erlang code which + agent at MIB load time (see the figure <seealso marker="#image/2">Starting the Agent</seealso>). The instrumentation is ordinary Erlang code which is loaded explicitly or automatically the first time it is called.</p> <marker id="image-2"></marker> <image file="snmp-um-1-image-2.gif"> diff --git a/lib/ssh/doc/src/configure_algos.xml b/lib/ssh/doc/src/configure_algos.xml index fa45b1cb4c..46721a40be 100644 --- a/lib/ssh/doc/src/configure_algos.xml +++ b/lib/ssh/doc/src/configure_algos.xml @@ -116,7 +116,7 @@ </list> <p>Due to this, it impossible to list in documentation what algorithms that are available in a certain installation.</p> <p>There is an important command to list the actual algorithms and their ordering: - <seealso marker="ssh#default_algorithms-0">ssh:default_algorithms/0</seealso>.</p> + <seealso marker="ssh#default_algorithms/0">ssh:default_algorithms/0</seealso>.</p> <marker id="example_default_algorithms"/> <code type="erl"> 0> ssh:default_algorithms(). @@ -145,9 +145,9 @@ </code> <p>To change the algorithm list, there are two options which can be used in - <seealso marker="ssh#connect-3">ssh:connect/2,3,4</seealso> + <seealso marker="ssh#connect/3">ssh:connect/2,3,4</seealso> and - <seealso marker="ssh#daemon-2">ssh:daemon/2,3</seealso>. The options could of course + <seealso marker="ssh#daemon/2">ssh:daemon/2,3</seealso>. The options could of course be used in all other functions that initiates connections.</p> <p>The options are <c>preferred_algorithms</c> and <c>modify_algorithms</c>. The first one diff --git a/lib/ssh/doc/src/introduction.xml b/lib/ssh/doc/src/introduction.xml index 8444daf0cc..b69d497315 100644 --- a/lib/ssh/doc/src/introduction.xml +++ b/lib/ssh/doc/src/introduction.xml @@ -106,8 +106,8 @@ </list> <p>Several configuration options for authentication handling are available in - <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso> - and <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>.</p> + <seealso marker="ssh#connect/3">ssh:connect/[3,4]</seealso> + and <seealso marker="ssh#daemon/2">ssh:daemon/[2,3]</seealso>.</p> <p> The public key handling can be customized by implementing the following behaviours from <c>ssh</c>:</p> @@ -168,7 +168,7 @@ but that is much more work. </item> <item><em>Exec</em> - One-time remote execution of commands. See function - <seealso marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso> + <seealso marker="ssh_connection#exec/4">ssh_connection:exec/4</seealso> for more information.</item> </list> </section> diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 9ed67a3c8b..b5275e0564 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -214,7 +214,7 @@ <list type="bulleted"> <item><c>PeerName</c> - a string with the name or address of the remote host.</item> <item><c>FingerPrint</c> - the fingerprint of the Host Key as - <seealso marker="public_key:public_key#ssh_hostkey_fingerprint-1">public_key:ssh_hostkey_fingerprint/1</seealso> + <seealso marker="public_key:public_key#ssh_hostkey_fingerprint/1">public_key:ssh_hostkey_fingerprint/1</seealso> calculates it. </item> </list> @@ -224,7 +224,7 @@ shall be used to calculate the fingerprint used in the call of the <c>accept_callback()</c>. The <c>HashALgoSpec</c> is either an atom or a list of atoms as the first argument in - <seealso marker="public_key:public_key#ssh_hostkey_fingerprint-2">public_key:ssh_hostkey_fingerprint/2</seealso>. + <seealso marker="public_key:public_key#ssh_hostkey_fingerprint/2">public_key:ssh_hostkey_fingerprint/2</seealso>. If it is a list of hash algorithm names, the <c>FingerPrint</c> argument in the <c>accept_callback()</c> will be a list of fingerprints in the same order as the corresponding name in the <c>HashAlgoSpec</c> list. @@ -750,7 +750,7 @@ <name name="tcpip_tunnel_in_daemon_option"/> <desc> <p>Enables (<c>true</c>) or disables (<c>false</c>) the possibility to tunnel a TCP/IP connection in to a - <seealso marker="ssh:ssh#daemon-2">server</seealso>. + <seealso marker="ssh:ssh#daemon/2">server</seealso>. Disabled per default. </p> </desc> @@ -760,7 +760,7 @@ <name name="tcpip_tunnel_out_daemon_option"/> <desc> <p>Enables (<c>true</c>) or disables (<c>false</c>) the possibility to tunnel a TCP/IP connection out of a - <seealso marker="ssh:ssh#daemon-2">server</seealso>. + <seealso marker="ssh:ssh#daemon/2">server</seealso>. Disabled per default. </p> </desc> @@ -847,9 +847,9 @@ <seealso marker="ssh_client_key_api">ssh_client_key_api</seealso> and/or <seealso marker="ssh_server_key_api">ssh_server_key_api</seealso>. The <c>UserOptions</c> are the options given to - <seealso marker="ssh:ssh#connect-3">ssh:connect</seealso>, - <seealso marker="ssh:ssh#shell-1">ssh:shell</seealso> or - <seealso marker="ssh:ssh#daemon-2">ssh:daemon</seealso>. + <seealso marker="ssh:ssh#connect/3">ssh:connect</seealso>, + <seealso marker="ssh:ssh#shell/1">ssh:shell</seealso> or + <seealso marker="ssh:ssh#daemon/2">ssh:daemon</seealso>. </p> </desc> @@ -974,7 +974,7 @@ <item> <p>Input is the <c>modify_algs_list()</c> and a set of algorithms <c>A</c> obtained from the <c>preferred_algorithms</c> option if existing, or else from the - <seealso marker="ssh#default_algorithms-0">ssh:default_algorithms/0</seealso>. + <seealso marker="ssh#default_algorithms/0">ssh:default_algorithms/0</seealso>. </p> </item> <item> @@ -1077,8 +1077,8 @@ <datatype> <name name="open_socket"/> <desc> - <p>The socket is supposed to be result of a <seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect</seealso> - or a <seealso marker="kernel:gen_tcp#accept-1">gen_tcp:accept</seealso>. The socket must be in passive + <p>The socket is supposed to be result of a <seealso marker="kernel:gen_tcp#connect/3">gen_tcp:connect</seealso> + or a <seealso marker="kernel:gen_tcp#accept/1">gen_tcp:accept</seealso>. The socket must be in passive mode (that is, opened with the option <c>{active,false})</c>. </p> </desc> @@ -1088,7 +1088,7 @@ <name name="daemon_ref"/> <desc> <p>Opaque data type representing a daemon.</p> - <p>Returned by the functions <seealso marker="ssh#daemon-1"><c>daemon/1,2,3</c></seealso>.</p> + <p>Returned by the functions <seealso marker="ssh#daemon/1"><c>daemon/1,2,3</c></seealso>.</p> </desc> </datatype> @@ -1097,8 +1097,8 @@ <desc> <p>Opaque data type representing a connection between a client and a server (daemon).</p> <p>Returned by the functions - <seealso marker="ssh#connect-3"><c>connect/2,3,4</c></seealso> and - <seealso marker="ssh_sftp#start_channel-2"><c>ssh_sftp:start_channel/2,3</c></seealso>. + <seealso marker="ssh#connect/3"><c>connect/2,3,4</c></seealso> and + <seealso marker="ssh_sftp#start_channel/2"><c>ssh_sftp:start_channel/2,3</c></seealso>. </p> </desc> </datatype> diff --git a/lib/ssh/doc/src/ssh_agent.xml b/lib/ssh/doc/src/ssh_agent.xml index 034b6b3b66..290d3febf4 100644 --- a/lib/ssh/doc/src/ssh_agent.xml +++ b/lib/ssh/doc/src/ssh_agent.xml @@ -43,8 +43,8 @@ allow it to be used by setting the option <seealso marker="ssh:ssh#type-key_cb_common_option"><c>key_cb</c></seealso> when starting a client (with for example - <seealso marker="ssh:ssh#connect-3">ssh:connect</seealso>, - <seealso marker="ssh:ssh#shell-1">ssh:shell</seealso> + <seealso marker="ssh:ssh#connect/3">ssh:connect</seealso>, + <seealso marker="ssh:ssh#shell/1">ssh:shell</seealso> ). </p> <code type="erl"> @@ -106,7 +106,7 @@ <fsummary></fsummary> <desc> <p> - This callback is delegated to the <seealso marker="ssh:ssh_file#add_host_key-4">ssh_file</seealso> module. + This callback is delegated to the <seealso marker="ssh:ssh_file#add_host_key/4">ssh_file</seealso> module. </p> </desc> </func> @@ -117,7 +117,7 @@ <fsummary></fsummary> <desc> <p> - This callback is delegated to the <seealso marker="ssh:ssh_file#is_host_key-5">ssh_file</seealso> module. + This callback is delegated to the <seealso marker="ssh:ssh_file#is_host_key/5">ssh_file</seealso> module. </p> </desc> </func> @@ -128,7 +128,7 @@ <desc> <p><strong>Types and description</strong></p> <p>See the api description in - <seealso marker="ssh:ssh_client_key_api#Module:user_key-2">ssh_client_key_api, Module:user_key/2</seealso>. + <seealso marker="ssh:ssh_client_key_api#Module:user_key/2">ssh_client_key_api, Module:user_key/2</seealso>. </p> </desc> </func> diff --git a/lib/ssh/doc/src/ssh_client_channel.xml b/lib/ssh/doc/src/ssh_client_channel.xml index e5f64ea603..4eba4939f6 100644 --- a/lib/ssh/doc/src/ssh_client_channel.xml +++ b/lib/ssh/doc/src/ssh_client_channel.xml @@ -73,7 +73,7 @@ <fsummary>Makes a synchronous call to a channel.</fsummary> <type> <v>ChannelRef = pid() </v> - <d>As returned by <seealso marker = "#start_link-4">start_link/4</seealso></d> + <d>As returned by <seealso marker = "#start_link/4">start_link/4</seealso></d> <v>Msg = term()</v> <v>Timeout = timeout()</v> <v>Reply = term()</v> @@ -84,7 +84,7 @@ <p>Makes a synchronous call to the channel process by sending a message and waiting until a reply arrives, or a time-out occurs. The channel calls <seealso marker = - "#Module:handle_call-3">Module:handle_call/3</seealso> + "#Module:handle_call/3">Module:handle_call/3</seealso> to handle the message. If the channel process does not exist, <c>{error, closed}</c> is returned. </p> @@ -97,14 +97,14 @@ ChannelRef and returns ok.</fsummary> <type> <v>ChannelRef = pid()</v> - <d>As returned by <seealso marker = "#start_link-4">start_link/4</seealso></d> + <d>As returned by <seealso marker = "#start_link/4">start_link/4</seealso></d> <v>Msg = term()</v> </type> <desc> <p>Sends an asynchronous message to the channel process and returns ok immediately, ignoring if the destination node or channel process does not exist. The channel calls - <seealso marker = "#Module:handle_cast-2">Module:handle_cast/2</seealso> + <seealso marker = "#Module:handle_cast/2">Module:handle_cast/2</seealso> to handle the message. </p> </desc> @@ -115,7 +115,7 @@ <fsummary>Makes an existing process an ssh_client_channel (replaces ssh_channel) process.</fsummary> <type> <v>State = term()</v> - <d>as returned by <seealso marker = "#init-1">init/1</seealso></d> + <d>as returned by <seealso marker = "#init/1">init/1</seealso></d> </type> <desc> <p>Makes an existing process an <c>ssh_client_channel</c> (replaces ssh_channel) @@ -125,7 +125,7 @@ one of the start functions in <c>proc_lib</c>, see the <seealso marker="stdlib:proc_lib">proc_lib(3)</seealso> manual page in STDLIB. The user is responsible for any initialization of the process - and must call <seealso marker = "#init-1">init/1</seealso>. + and must call <seealso marker = "#init/1">init/1</seealso>. </p> </desc> </func> @@ -152,7 +152,7 @@ <tag><c>{cm, </c><seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso><c>}</c></tag> <item><p>Reference to the <c>ssh</c> connection as returned by - <seealso marker="ssh#connect-3">ssh:connect/3</seealso>. + <seealso marker="ssh#connect/3">ssh:connect/3</seealso>. </p></item> <tag><c>{channel_id, </c><seealso marker="ssh:ssh#type-channel_id">ssh:channel_id()</seealso><c>}</c></tag> @@ -183,12 +183,12 @@ <p>This function can be used by a channel to send a reply to a client that called <c>call/[2,3]</c> when the reply cannot be defined in the return value of - <seealso marker ="#Module:handle_call-3">Module:handle_call/3</seealso>.</p> + <seealso marker ="#Module:handle_call/3">Module:handle_call/3</seealso>.</p> <p><c>Client</c> must be the <c>From</c> argument provided to the callback function <c>handle_call/3</c>. <c>Reply</c> is an arbitrary term, which is given back to the client as the return value of - <seealso marker="#call-2">call/[2,3].</seealso></p> + <seealso marker="#call/2">call/[2,3].</seealso></p> </desc> </func> @@ -199,7 +199,7 @@ <fsummary>Starts a process that handles an SSH channel.</fsummary> <type> <v>SshConnection = <seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso></v> - <d>As returned by <seealso marker="ssh#connect-3">ssh:connect/3</seealso></d> + <d>As returned by <seealso marker="ssh#connect/3">ssh:connect/3</seealso></d> <v>ChannelId = <seealso marker="ssh#type-channel_id">ssh:channel_id()</seealso></v> <d>As returned by @@ -237,7 +237,7 @@ <title>Callback timeouts</title> <p>The timeout values that can be returned by the callback functions have the same semantics as in a <seealso marker="stdlib:gen_server">gen_server</seealso>. - If the time-out occurs, <seealso marker="#Module:handle_msg-2">handle_msg/2</seealso> + If the time-out occurs, <seealso marker="#Module:handle_msg/2">handle_msg/2</seealso> is called as <c>handle_msg(timeout, State)</c>.</p> </section> </section> @@ -314,19 +314,19 @@ <v>Msg = term()</v> <v>From = opaque()</v> <d>Is to be used as argument to - <seealso marker="#reply-2">reply/2</seealso></d> + <seealso marker="#reply/2">reply/2</seealso></d> <v>State = term()</v> <v>Result = {reply, Reply, NewState} | {reply, Reply, NewState, timeout()} | {noreply, NewState} | {noreply , NewState, timeout()} | {stop, Reason, Reply, NewState} | {stop, Reason, NewState} </v> <v>Reply = term()</v> - <d>Will be the return value of <seealso marker="#call-2">call/[2,3]</seealso></d> + <d>Will be the return value of <seealso marker="#call/2">call/[2,3]</seealso></d> <v>NewState = term()</v> <v>Reason = term()</v> </type> <desc> <p>Handles messages sent by calling - <seealso marker="#call-2">call/[2,3]</seealso> + <seealso marker="#call/2">call/[2,3]</seealso> </p> <p>For more detailed information on time-outs,, see Section <seealso marker="#cb_timeouts">Callback timeouts</seealso>.</p> @@ -377,7 +377,7 @@ <tag><c>{ssh_channel_up, </c><seealso marker="ssh:ssh#type-channel_id">ssh:channel_id()</seealso><c>, </c><seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso><c>}</c></tag> <item><p>This is the first message that the channel receives. It is sent just before the <seealso - marker="#init-1">init/1</seealso> function + marker="#init/1">init/1</seealso> function returns successfully. This is especially useful if the server wants to send a message to the client without first receiving a message from it. If the message is not @@ -426,7 +426,7 @@ <desc> <p>This function is called by a channel process when it is about to terminate. Before this function is called, <seealso - marker="ssh_connection#close-2"> ssh_connection:close/2 + marker="ssh_connection#close/2"> ssh_connection:close/2 </seealso> is called, if it has not been called earlier. This function does any necessary cleaning up. When it returns, the channel process terminates with diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml index a61d43a818..3f22286126 100644 --- a/lib/ssh/doc/src/ssh_client_key_api.xml +++ b/lib/ssh/doc/src/ssh_client_key_api.xml @@ -45,7 +45,7 @@ <datatype> <name name="client_key_cb_options"/> <desc> - <p>Options provided to <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso>. + <p>Options provided to <seealso marker="ssh#connect/3">ssh:connect/[3,4]</seealso>. </p> <p>The option list given in the <seealso marker="ssh#type-key_cb_common_option"><c>key_cb</c></seealso> diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 762cca1ded..032005e226 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -49,7 +49,7 @@ <p> If the <seealso marker="ssh_client_channel">ssh_client_channel</seealso> behavior is used to implement the channel process, these messages are handled by - <seealso marker="ssh_client_channel#Module:handle_ssh_msg-2">handle_ssh_msg/2</seealso>.</p> + <seealso marker="ssh_client_channel#Module:handle_ssh_msg/2">handle_ssh_msg/2</seealso>.</p> </description> <datatypes> @@ -57,7 +57,7 @@ <name name="ssh_data_type_code"/> <desc> <p>The valid values are <c>0</c> ("normal") and <c>1</c> ("stderr"), see - <url href="https://tools.ietf.org/html/rfc4254#page-8">RFC 4254, Section 5.2</url>.</p> + <url href="https://tools.ietf.org/html/rfc4254#page/8">RFC 4254, Section 5.2</url>.</p> </desc> </datatype> @@ -109,7 +109,7 @@ <name name="want_reply"/> <desc> <p>Messages that include a <c>WantReply</c> expect the channel handling - process to call <seealso marker="ssh_connection#reply_request-4"> + process to call <seealso marker="ssh_connection#reply_request/4"> ssh_connection:reply_request/4</seealso> with the boolean value of <c>WantReply</c> as the second argument.</p> </desc> @@ -121,7 +121,7 @@ <name name="data_ch_msg"/> <desc> <p>Data has arrived on the channel. This event is sent as a result of calling - <seealso marker="ssh_connection#send-3"> ssh_connection:send/[3,4,5]</seealso>. + <seealso marker="ssh_connection#send/3"> ssh_connection:send/[3,4,5]</seealso>. </p> </desc> </datatype> @@ -132,7 +132,7 @@ <name name="eof_ch_msg"/> <desc> <p>Indicates that the other side sends no more data. This event is sent as a result of calling - <seealso marker="ssh_connection#send_eof-2"> ssh_connection:send_eof/2</seealso>. + <seealso marker="ssh_connection#send_eof/2"> ssh_connection:send_eof/2</seealso>. </p> </desc> </datatype> @@ -140,7 +140,7 @@ <name name="closed_ch_msg"/> <desc> <p>This event is sent as a result of calling - <seealso marker="ssh_connection#close-2">ssh_connection:close/2</seealso>. + <seealso marker="ssh_connection#close/2">ssh_connection:close/2</seealso>. Both the handling of this event and sending it are taken care of by the <seealso marker="ssh_client_channel">ssh_client_channel</seealso> behavior.</p> </desc> @@ -160,7 +160,7 @@ drawable area of the window. <c>Opcode</c> in the <c>TerminalModes</c> list is the mnemonic name, represented as a lowercase Erlang atom, defined in - <url href="https://tools.ietf.org/html/rfc4254#section-8">RFC 4254</url>, Section 8. + <url href="https://tools.ietf.org/html/rfc4254#section/8">RFC 4254</url>, Section 8. It can also be an <c>Opcode</c> if the mnemonic name is not listed in the RFC. Example: <c>OP code: 53, mnemonic name ECHO erlang atom: echo</c>. This event is sent as a result of calling <seealso @@ -175,7 +175,7 @@ <desc> <p>Environment variables can be passed to the shell/command to be started later. This event is sent as a result of calling <seealso - marker="ssh_connection#setenv-5"> ssh_connection:setenv/5</seealso>. + marker="ssh_connection#setenv/5"> ssh_connection:setenv/5</seealso>. </p> </desc> </datatype> @@ -187,7 +187,7 @@ <desc> <p>This message requests that the user default shell is started at the other end. This event is sent as a result of calling - <seealso marker="ssh_connection#shell-2"> ssh_connection:shell/2</seealso>. + <seealso marker="ssh_connection#shell/2"> ssh_connection:shell/2</seealso>. </p> </desc> </datatype> @@ -196,7 +196,7 @@ <desc> <p>This message requests that the server starts execution of the given command. This event is sent as a result of calling <seealso - marker="ssh_connection#exec-4">ssh_connection:exec/4 </seealso>. + marker="ssh_connection#exec/4">ssh_connection:exec/4 </seealso>. </p> </desc> </datatype> @@ -234,7 +234,7 @@ following message can be sent to return the exit status of the command. A zero <c>exit_status</c> usually means that the command terminated successfully. This event is sent as a result of calling - <seealso marker="ssh_connection#exit_status-3"> + <seealso marker="ssh_connection#exit_status/3"> ssh_connection:exit_status/3</seealso>.</p> </desc> </datatype> @@ -263,7 +263,7 @@ <note><p>Channels implemented with the <seealso marker="ssh_client_channel"> ssh_client_channel</seealso> behavior do not normally need to call this function as flow control is handled by the behavior. The behavior adjusts the window every time - the callback <seealso marker="ssh_client_channel#Module:handle_ssh_msg-2"> + the callback <seealso marker="ssh_client_channel#Module:handle_ssh_msg/2"> handle_ssh_msg/2</seealso> returns after processing channel data.</p></note> </desc> </func> diff --git a/lib/ssh/doc/src/ssh_file.xml b/lib/ssh/doc/src/ssh_file.xml index 6315bcbdbd..8ac0ba7ceb 100644 --- a/lib/ssh/doc/src/ssh_file.xml +++ b/lib/ssh/doc/src/ssh_file.xml @@ -48,9 +48,9 @@ <p>Such another callback module could be used by setting the option <seealso marker="ssh:ssh#type-key_cb_common_option"><c>key_cb</c></seealso> when starting a client or a server (with for example - <seealso marker="ssh:ssh#connect-3">ssh:connect</seealso>, - <seealso marker="ssh:ssh#daemon-2">ssh:daemon</seealso> of - <seealso marker="ssh:ssh#shell-1">ssh:shell</seealso> + <seealso marker="ssh:ssh#connect/3">ssh:connect</seealso>, + <seealso marker="ssh:ssh#daemon/2">ssh:daemon</seealso> of + <seealso marker="ssh:ssh#shell/1">ssh:shell</seealso> ). </p> @@ -189,7 +189,7 @@ <desc> <p><strong>Types and description</strong></p> <p>See the api description in - <seealso marker="ssh:ssh_server_key_api#Module:host_key-2">ssh_server_key_api, Module:host_key/2</seealso>. + <seealso marker="ssh:ssh_server_key_api#Module:host_key/2">ssh_server_key_api, Module:host_key/2</seealso>. </p> <p><strong>Options</strong></p> <list> @@ -215,7 +215,7 @@ <desc> <p><strong>Types and description</strong></p> <p>See the api description in - <seealso marker="ssh:ssh_server_key_api#Module:is_auth_key-3">ssh_server_key_api: Module:is_auth_key/3</seealso>. + <seealso marker="ssh:ssh_server_key_api#Module:is_auth_key/3">ssh_server_key_api: Module:is_auth_key/3</seealso>. </p> <p><strong>Options</strong></p> <list> @@ -238,11 +238,11 @@ <desc> <p><strong>Types and description</strong></p> <p>See the api description in - <seealso marker="ssh:ssh_client_key_api#Module:add_host_key-4">ssh_client_key_api, Module:add_host_key/4</seealso>. + <seealso marker="ssh:ssh_client_key_api#Module:add_host_key/4">ssh_client_key_api, Module:add_host_key/4</seealso>. </p> <marker id="add_host_key-3"/> <p>Note that the alternative, the old - <seealso marker="ssh:ssh_client_key_api#Module:add_host_key-3">Module:add_host_key/3</seealso> + <seealso marker="ssh:ssh_client_key_api#Module:add_host_key/3">Module:add_host_key/3</seealso> is no longer supported by <c>ssh_file</c>. </p> <p><strong>Option</strong></p> @@ -262,11 +262,11 @@ <desc> <p><strong>Types and description</strong></p> <p>See the api description in - <seealso marker="ssh:ssh_client_key_api#Module:is_host_key-5">ssh_client_key_api, Module:is_host_key/5</seealso>. + <seealso marker="ssh:ssh_client_key_api#Module:is_host_key/5">ssh_client_key_api, Module:is_host_key/5</seealso>. </p> <marker id="is_host_key-4"/> <p>Note that the alternative, the old - <seealso marker="ssh:ssh_client_key_api#Module:is_host_key-4">Module:is_host_key/4</seealso> + <seealso marker="ssh:ssh_client_key_api#Module:is_host_key/4">Module:is_host_key/4</seealso> is no longer supported by <c>ssh_file</c>. </p> <p><strong>Option</strong></p> @@ -301,7 +301,7 @@ key :: % encoded key from eg ssh_host_*.pub <desc> <p><strong>Types and description</strong></p> <p>See the api description in - <seealso marker="ssh:ssh_client_key_api#Module:user_key-2">ssh_client_key_api, Module:user_key/2</seealso>. + <seealso marker="ssh:ssh_client_key_api#Module:user_key/2">ssh_client_key_api, Module:user_key/2</seealso>. </p> <p><strong>Options</strong></p> <list> diff --git a/lib/ssh/doc/src/ssh_protocol.xml b/lib/ssh/doc/src/ssh_protocol.xml index 0d99a96997..05fb365770 100644 --- a/lib/ssh/doc/src/ssh_protocol.xml +++ b/lib/ssh/doc/src/ssh_protocol.xml @@ -57,8 +57,8 @@ this case the the plain text password will be encrypted before sent over the network. There are several configuration options for authentication handling available in - <seealso marker="ssh#connect-3">ssh:connect/[3,4]</seealso> - and <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso> + <seealso marker="ssh#connect/3">ssh:connect/[3,4]</seealso> + and <seealso marker="ssh#daemon/2">ssh:daemon/[2,3]</seealso> It is also possible to customize the public key handling by implementing the behaviours <seealso marker="ssh_client_key_api">ssh_client_key_api</seealso> and @@ -113,7 +113,7 @@ to provide your own CLI (Command Line Interface) implementation. </item> <item><em>Exec</em> - one-time remote execution of commands. See <seealso - marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso></item> + marker="ssh_connection#exec/4">ssh_connection:exec/4</seealso></item> </list> </section> diff --git a/lib/ssh/doc/src/ssh_server_channel.xml b/lib/ssh/doc/src/ssh_server_channel.xml index 037c4acda3..da2949a57d 100644 --- a/lib/ssh/doc/src/ssh_server_channel.xml +++ b/lib/ssh/doc/src/ssh_server_channel.xml @@ -86,7 +86,7 @@ </p> <p>The time-out values that can be returned have the same semantics as in a <seealso marker="stdlib:gen_server">gen_server</seealso>. - If the time-out occurs, <seealso marker="#Module:handle_msg-2">handle_msg/2</seealso> + If the time-out occurs, <seealso marker="#Module:handle_msg/2">handle_msg/2</seealso> is called as <c>handle_msg(timeout, State)</c>. </p> </desc> @@ -162,7 +162,7 @@ <desc> <p>This function is called by a channel process when it is about to terminate. Before this function is called, <seealso - marker="ssh_connection#close-2"> ssh_connection:close/2 + marker="ssh_connection#close/2"> ssh_connection:close/2 </seealso> is called, if it has not been called earlier. This function does any necessary cleaning up. When it returns, the channel process terminates with diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml index 013a788a4a..c77b9809de 100644 --- a/lib/ssh/doc/src/ssh_server_key_api.xml +++ b/lib/ssh/doc/src/ssh_server_key_api.xml @@ -75,7 +75,7 @@ <datatype> <name name="daemon_key_cb_options"/> <desc> - <p>Options provided to <seealso marker="ssh#daemon-2">ssh:daemon/2,3</seealso>. + <p>Options provided to <seealso marker="ssh#daemon/2">ssh:daemon/2,3</seealso>. </p> <p>The option list given in the <seealso marker="ssh#type-key_cb_common_option"><c>key_cb</c></seealso> diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 5c8eba6203..0a344a5977 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -144,8 +144,8 @@ <name name="apread" arity="4" since=""/> <fsummary>Reads asynchronously from an open file.</fsummary> <desc><p>The <c><![CDATA[apread/4]]></c> function reads from a specified position, - combining the <seealso marker="#position-3"><c>position/3</c></seealso> and - <seealso marker="#aread-3"><c>aread/3</c></seealso> functions.</p> + combining the <seealso marker="#position/3"><c>position/3</c></seealso> and + <seealso marker="#aread/3"><c>aread/3</c></seealso> functions.</p> </desc> </func> @@ -153,8 +153,8 @@ <name name="apwrite" arity="4" since=""/> <fsummary>Writes asynchronously to an open file.</fsummary> <desc><p>The <c><![CDATA[apwrite/4]]></c> function writes to a specified position, - combining the <seealso marker="#position-3"><c>position/3</c></seealso> and - <seealso marker="#awrite-3"><c>awrite/3</c></seealso> functions.</p> + combining the <seealso marker="#position/3"><c>position/3</c></seealso> and + <seealso marker="#awrite/3"><c>awrite/3</c></seealso> functions.</p> </desc> </func> @@ -276,10 +276,10 @@ <p>Opens a handle to a tar file on the server, associated with <c>ChannelPid</c>. The handle can be used for remote tar creation and extraction. The actual writing and reading is performed by calls to - <seealso marker="stdlib:erl_tar#add-3">erl_tar:add/3,4</seealso> and - <seealso marker="stdlib:erl_tar#extract-2">erl_tar:extract/2</seealso>. + <seealso marker="stdlib:erl_tar#add/3">erl_tar:add/3,4</seealso> and + <seealso marker="stdlib:erl_tar#extract/2">erl_tar:extract/2</seealso>. Note: The - <seealso marker="stdlib:erl_tar#init-3">erl_tar:init/3</seealso> function should not + <seealso marker="stdlib:erl_tar#init/3">erl_tar:init/3</seealso> function should not be called, that one is called by this open_tar function. </p> <p>For code examples see Section @@ -335,8 +335,8 @@ <name name="pread" arity="5" since=""/> <fsummary>Reads from an open file.</fsummary> <desc><p>The <c><![CDATA[pread/3,4]]></c> function reads from a specified position, - combining the <seealso marker="#position-3"><c>position/3</c></seealso> and - <seealso marker="#read-3"><c>read/3,4</c></seealso> functions.</p> + combining the <seealso marker="#position/3"><c>position/3</c></seealso> and + <seealso marker="#read/3"><c>read/3,4</c></seealso> functions.</p> </desc> </func> @@ -345,8 +345,8 @@ <name name="pwrite" arity="5" since=""/> <fsummary>Writes to an open file.</fsummary> <desc><p>The <c><![CDATA[pwrite/3,4]]></c> function writes to a specified position, - combining the <seealso marker="#position-3"><c>position/3</c></seealso> and - <seealso marker="#write-3"><c>write/3,4</c></seealso> functions.</p> + combining the <seealso marker="#position/3"><c>position/3</c></seealso> and + <seealso marker="#write/3"><c>write/3,4</c></seealso> functions.</p> </desc> </func> @@ -381,12 +381,12 @@ <desc> <p>Returns a <c><![CDATA[file_info]]></c> record from the file system object specified by <c><![CDATA[Name]]></c> or <c><![CDATA[Handle]]></c>. See - <seealso marker="kernel:file#read_file_info-2">file:read_file_info/2</seealso> + <seealso marker="kernel:file#read_file_info/2">file:read_file_info/2</seealso> for information about the record. </p> <p> Depending on the underlying OS:es links might be followed and info on the final file, directory - etc is returned. See <seealso marker="#read_link_info-2">read_link_info/2</seealso> + etc is returned. See <seealso marker="#read_link_info/2">read_link_info/2</seealso> on how to get information on links instead. </p> </desc> @@ -410,7 +410,7 @@ <p>Returns a <c><![CDATA[file_info]]></c> record from the symbolic link specified by <c><![CDATA[Name]]></c> or <c><![CDATA[Handle]]></c>. See - <seealso marker="kernel:file#read_link_info-2">file:read_link_info/2</seealso> + <seealso marker="kernel:file#read_link_info/2">file:read_link_info/2</seealso> for information about the record. </p> </desc> @@ -494,7 +494,7 @@ <fsummary>Stops the SFTP client channel.</fsummary> <desc> <p>Stops an SFTP channel. Does not close the SSH connection. - Use <seealso marker="ssh#close-1">ssh:close/1</seealso> to close it.</p> + Use <seealso marker="ssh#close/1">ssh:close/1</seealso> to close it.</p> </desc> </func> @@ -527,7 +527,7 @@ <desc> <p>Writes file information from a <c><![CDATA[file_info]]></c> record to the file specified by <c><![CDATA[Name]]></c>. See - <seealso marker="kernel:file#write_file_info-2">file:write_file_info/[2,3]</seealso> + <seealso marker="kernel:file#write_file_info/2">file:write_file_info/[2,3]</seealso> for information about the record. </p> </desc> diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml index 17468917fb..938d549ef8 100644 --- a/lib/ssh/doc/src/using_ssh.xml +++ b/lib/ssh/doc/src/using_ssh.xml @@ -35,7 +35,7 @@ <section> <title>General Information</title> <p>The following examples use the utility function - <seealso marker="ssh#start-0"> ssh:start/0</seealso> to start + <seealso marker="ssh#start/0"> ssh:start/0</seealso> to start all needed applications (<c>crypto</c>, <c>public_key</c>, and <c>ssh</c>). All examples are run in an Erlang shell, or in a bash shell, using <em>openssh</em> to illustrate how the <c>ssh</c> application can be used. The @@ -173,7 +173,7 @@ ok 7></pre> <p>See <seealso marker="ssh_connection#description">ssh_connection</seealso> and - <seealso marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso> + <seealso marker="ssh_connection#exec/4">ssh_connection:exec/4</seealso> for finding documentation of the channel messages.</p> <p>To collect the channel messages in a program, use <c>receive...end</c> instead of <c>flush/1</c>:</p> @@ -198,7 +198,7 @@ ok {ok,1} 8></pre> - <p>To close the connection, call the function <seealso marker="ssh#close-1"><c>ssh:close(ConnectionRef)</c></seealso>. + <p>To close the connection, call the function <seealso marker="ssh#close/1"><c>ssh:close(ConnectionRef)</c></seealso>. As an alternative, set the option <seealso marker="ssh#type-max_idle_time_common_option"><c>{idle_time, 1}</c></seealso> when opening the connection. This will cause the connection to be closed automaticaly when there are @@ -260,7 +260,7 @@ ok $bash></pre> <p>And similar for reading from stdin. As an example we use - <seealso marker="stdlib:io#read-1">io:read/1</seealso> which + <seealso marker="stdlib:io#read/1">io:read/1</seealso> which displays the argument as a prompt on stdout, reads a term from stdin and returns it in an ok-tuple:</p> <pre> @@ -314,7 +314,7 @@ ok <p>There is often a need to configure some other exec evaluator to tailor the input language or restrict the possible functions to call. There are two ways of doing this which will be shown with examples - below. See <seealso marker="ssh#daemon-2">ssh:daemon/2,3</seealso> and + below. See <seealso marker="ssh#daemon/2">ssh:daemon/2,3</seealso> and <seealso marker="ssh#type-exec_daemon_option">exec_daemon_option()</seealso>) for details.</p> <p>Examples of the two ways to configure the exec evaluator:</p> <list type="ordered"> diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index af02c21a5a..36488d4c16 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -296,8 +296,8 @@ <p>Defaults to <c>full</c>. If hello is specified the handshake will pause after the hello message and give the user a possibility make decisions based on hello extensions before continuing or aborting the handshake by calling - <seealso marker="#handshake_continue-3"> handshake_continue/3</seealso> or - <seealso marker="#handshake_cancel-1"> handshake_cancel/1</seealso></p> + <seealso marker="#handshake_continue/3"> handshake_continue/3</seealso> or + <seealso marker="#handshake_cancel/1"> handshake_cancel/1</seealso></p> </desc> </datatype> @@ -321,7 +321,7 @@ <desc> <p>The DER-encoded user's private key or a map refering to a crypto engine and its key reference that optionally can be password protected, - seealso <seealso marker="crypto:crypto#engine_load-4"> crypto:engine_load/4 + seealso <seealso marker="crypto:crypto#engine_load/4"> crypto:engine_load/4 </seealso> and <seealso marker="crypto:engine_load"> Crypto's Users Guide</seealso>. If this option is supplied, it overrides option <c>keyfile</c>.</p> </desc> @@ -351,18 +351,18 @@ <p>A list of cipher suites that should be supported</p> <p>The function <seealso - marker="#cipher_suites-2"> ssl:cipher_suites/2 </seealso> + marker="#cipher_suites/2"> ssl:cipher_suites/2 </seealso> can be used to find all cipher suites that are supported by default and all cipher suites that may be configured.</p> <p>If you compose your own <c>cipher_suites()</c> make sure they are filtered for cryptolib support <seealso - marker="#filter_cipher_suites-2"> ssl:filter_cipher_suites/2 </seealso> + marker="#filter_cipher_suites/2"> ssl:filter_cipher_suites/2 </seealso> Additionaly the functions <seealso - marker="#append_cipher_suites-2"> ssl:append_cipher_suites/2 </seealso> + marker="#append_cipher_suites/2"> ssl:append_cipher_suites/2 </seealso> , <seealso - marker="#prepend_cipher_suites-2"> ssl:prepend_cipher_suites/2</seealso>, + marker="#prepend_cipher_suites/2"> ssl:prepend_cipher_suites/2</seealso>, <seealso marker="#suite_to_str/1">ssl:suite_to_str/1</seealso>, <seealso marker="#str_to_suite/1">ssl:str_to_suite/1</seealso>, and <seealso marker="#suite_to_openssl_str/1">ssl:suite_to_openssl_str/1</seealso> @@ -533,7 +533,7 @@ fun(OtpCert :: #'OTPCertificate'{}, Event :: {bad_cert, Reason :: atom() | <tag><c>PKIX X-509-path validation error</c></tag> <item><p>For possible reasons, see <seealso -marker="public_key:public_key#pkix_path_validation-3">public_key:pkix_path_validation/3</seealso> +marker="public_key:public_key#pkix_path_validation/3">public_key:pkix_path_validation/3</seealso> </p></item> </taglist> </desc> @@ -543,10 +543,10 @@ marker="public_key:public_key#pkix_path_validation-3">public_key:pkix_path_valid <name name="crl_check"/> <desc> <p>Perform CRL (Certificate Revocation List) verification - <seealso marker="public_key:public_key#pkix_crls_validate-3"> + <seealso marker="public_key:public_key#pkix_crls_validate/3"> (public_key:pkix_crls_validate/3)</seealso> on all the certificates during the path validation <seealso - marker="public_key:public_key#pkix_path_validation-3">(public_key:pkix_path_validation/3) + marker="public_key:public_key#pkix_path_validation/3">(public_key:pkix_path_validation/3) </seealso> of the certificate chain. Defaults to <c>false</c>.</p> @@ -582,7 +582,7 @@ marker="public_key:public_key#pkix_path_validation-3">public_key:pkix_path_valid <item> <p>This module maintains a cache of CRLs. CRLs can be added to the cache using the function <seealso - marker="ssl:ssl_crl_cache#insert-1">ssl_crl_cache:insert/1</seealso>, + marker="ssl:ssl_crl_cache#insert/1">ssl_crl_cache:insert/1</seealso>, and optionally automatically fetched through HTTP if the following argument is specified:</p> @@ -636,7 +636,7 @@ fun(Chain::[public_key:der_encoded()]) -> </code> <p>Claim an intermediate CA in the chain as trusted. TLS then performs <seealso - marker="public_key:public_key#pkix_path_validation-3">public_key:pkix_path_validation/3</seealso> + marker="public_key:public_key#pkix_path_validation/3">public_key:pkix_path_validation/3</seealso> with the selected CA as trusted anchor and the rest of the chain.</p> </desc> </datatype> @@ -674,7 +674,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <p>For Secure Remote Password (SRP), the fun is only used by the server to obtain parameters that it uses to generate its session keys. <c>DerivedKey</c> is to be derived according to - <url href="http://tools.ietf.org/html/rfc2945#section-3"> RFC 2945</url> and + <url href="http://tools.ietf.org/html/rfc2945#section/3"> RFC 2945</url> and <url href="http://tools.ietf.org/html/rfc5054#section-2.4"> RFC 5054</url>: <c>crypto:sha([Salt, crypto:sha([Username, <<$:>>, Password])])</c> </p> @@ -804,7 +804,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <desc> <p>When <c>save</c> is specified a new connection will be negotiated and saved for later reuse. The session ID can be fetched with - <seealso marker="#connection_information-2">connection_information/2</seealso> + <seealso marker="#connection_information/2">connection_information/2</seealso> and used with the client option <seealso marker="#type-client_reuse_session">reuse_session</seealso> The boolean value true specifies that if possible, automatized session reuse will be performed. If a new session is created, and is unique in regard @@ -887,15 +887,15 @@ fun(srp, Username :: string(), UserState :: term()) -> <name name="sni"/> <desc> <p>Specify the hostname to be used in TLS Server Name Indication extension. - If not specified it will default to the <c>Host</c> argument of <seealso marker="#connect-3">connect/[3,4]</seealso> + If not specified it will default to the <c>Host</c> argument of <seealso marker="#connect/3">connect/[3,4]</seealso> unless it is of type inet:ipaddress().</p> <p> The <c>HostName</c> will also be used in the hostname verification of the peer certificate using - <seealso marker="public_key:public_key#pkix_verify_hostname-2">public_key:pkix_verify_hostname/2</seealso>. + <seealso marker="public_key:public_key#pkix_verify_hostname/2">public_key:pkix_verify_hostname/2</seealso>. </p> <p> The special value <c>disable</c> prevents the Server Name Indication extension from being sent and disables the hostname verification check - <seealso marker="public_key:public_key#pkix_verify_hostname-2">public_key:pkix_verify_hostname/2</seealso> </p> + <seealso marker="public_key:public_key#pkix_verify_hostname/2">public_key:pkix_verify_hostname/2</seealso> </p> </desc> </datatype> @@ -904,7 +904,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <desc> <p> Customizes the hostname verification of the peer certificate, as different protocols that use TLS such as HTTP or LDAP may want to do it differently, for possible options see - <seealso marker="public_key:public_key#pkix_verify_hostname-3">public_key:pkix_verify_hostname/3</seealso> </p> + <seealso marker="public_key:public_key#pkix_verify_hostname/3">public_key:pkix_verify_hostname/3</seealso> </p> </desc> </datatype> @@ -1276,7 +1276,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <name name="cipher_suites" arity="1" since="OTP R14B"/> <fsummary>Returns a list of supported cipher suites.</fsummary> <desc> - <p>Deprecated in OTP 21, use <seealso marker="#cipher_suites-2">cipher_suites/2</seealso> instead.</p> + <p>Deprecated in OTP 21, use <seealso marker="#cipher_suites/2">cipher_suites/2</seealso> instead.</p> </desc> </func> @@ -1292,7 +1292,7 @@ fun(srp, Username :: string(), UserState :: term()) -> cipher suites that the OTP ssl application can support provided that they are supported by the cryptolib linked with the OTP crypto application. Use <seealso - marker="#filter_cipher_suites-2"> ssl:filter_cipher_suites(Suites, + marker="#filter_cipher_suites/2"> ssl:filter_cipher_suites(Suites, []).</seealso> to filter the list for the current cryptolib. Note that cipher suites may be filtered out because they are too old or too new depending on the @@ -1304,7 +1304,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <func> <name name="cipher_suites" arity="3" since="OTP 22.0"/> <fsummary>Returns a list of RFC or OpenSSL names</fsummary> - <desc><p>Same as <seealso marker="#cipher_suites-2">cipher_suites/2</seealso> + <desc><p>Same as <seealso marker="#cipher_suites/2">cipher_suites/2</seealso> but lists RFC or OpenSSL string names instead of <seealso marker="#type-erl_cipher_suite">erl_cipher_suite()</seealso> </p> </desc> @@ -1344,7 +1344,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <c>verify_peer</c> the option <c>server_name_indication</c> shall also be specified, if it is not no Server Name Indication extension will be sent, and <seealso - marker="public_key:public_key#pkix_verify_hostname-2">public_key:pkix_verify_hostname/2</seealso> + marker="public_key:public_key#pkix_verify_hostname/2">public_key:pkix_verify_hostname/2</seealso> will be called with the IP-address of the connection as <c>ReferenceID</c>, which is proably not what you want.</p> </note> @@ -1354,9 +1354,9 @@ fun(srp, Username :: string(), UserState :: term()) -> and the success response is <c>{ok, SslSocket, Ext}</c> instead of <c>{ok, SslSocket}</c>. Thereafter the handshake is continued or canceled by calling <seealso - marker="#handshake_continue-3"> + marker="#handshake_continue/3"> <c>handshake_continue/3</c></seealso> or <seealso - marker="#handshake_cancel-1"><c>handshake_cancel/1</c></seealso>. + marker="#handshake_cancel/1"><c>handshake_cancel/1</c></seealso>. </p> <p> If the option <c>active</c> is set to <c>once</c>, <c>true</c> or an integer value, @@ -1373,16 +1373,16 @@ fun(srp, Username :: string(), UserState :: term()) -> <desc><p>Opens a TLS/DTLS connection to <c>Host</c>, <c>Port</c>.</p> <p> When the option <c>verify</c> is set to <c>verify_peer</c> the check - <seealso marker="public_key:public_key#pkix_verify_hostname-2">public_key:pkix_verify_hostname/2</seealso> + <seealso marker="public_key:public_key#pkix_verify_hostname/2">public_key:pkix_verify_hostname/2</seealso> will be performed in addition to the usual x509-path validation checks. If the check fails the error {bad_cert, hostname_check_failed} will be propagated to the path validation fun <seealso marker="#type-custom_verify">verify_fun</seealso>, where it is possible to do customized - checks by using the full possibilities of the <seealso marker="public_key:public_key#pkix_verify_hostname-3">public_key:pkix_verify_hostname/3</seealso> API. + checks by using the full possibilities of the <seealso marker="public_key:public_key#pkix_verify_hostname/3">public_key:pkix_verify_hostname/3</seealso> API. When the option <c>server_name_indication</c> is provided, its value (the DNS name) will be used as <c>ReferenceID</c> - to <seealso marker="public_key:public_key#pkix_verify_hostname-2">public_key:pkix_verify_hostname/2</seealso>. + to <seealso marker="public_key:public_key#pkix_verify_hostname/2">public_key:pkix_verify_hostname/2</seealso>. When no <c>server_name_indication</c> option is given, the <c>Host</c> argument will be used as Server Name Indication extension. The <c>Host</c> argument will also be used for the - <seealso marker="public_key:public_key#pkix_verify_hostname-2">public_key:pkix_verify_hostname/2</seealso> check and if the <c>Host</c> + <seealso marker="public_key:public_key#pkix_verify_hostname/2">public_key:pkix_verify_hostname/2</seealso> check and if the <c>Host</c> argument is an <c>inet:ip_address()</c> the <c>ReferenceID</c> used for the check will be <c>{ip, Host}</c> otherwise <c>dns_id</c> will be assumed with a fallback to <c>ip</c> if that fails. </p> <note><p>According to good practices certificates should not use IP-addresses as "server names". It would @@ -1393,9 +1393,9 @@ fun(srp, Username :: string(), UserState :: term()) -> handshake is paused after receiving the server hello message and the success response is <c>{ok, SslSocket, Ext}</c> instead of <c>{ok, SslSocket}</c>. Thereafter the handshake is continued or - canceled by calling <seealso marker="#handshake_continue-3"> + canceled by calling <seealso marker="#handshake_continue/3"> <c>handshake_continue/3</c></seealso> or <seealso - marker="#handshake_cancel-1"><c>handshake_cancel/1</c></seealso>. + marker="#handshake_cancel/1"><c>handshake_cancel/1</c></seealso>. </p> <p> If the option <c>active</c> is set to <c>once</c>, <c>true</c> or an integer value, @@ -1537,7 +1537,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <p>If <c>Socket</c> is an <seealso marker="#type-sslsocket"> sslsocket() </seealso>: provides extra TLS/DTLS options to those specified in - <seealso marker="#listen-2">listen/2 </seealso> and then performs + <seealso marker="#listen/2">listen/2</seealso> and then performs the TLS/DTLS handshake. Returns a new TLS/DTLS socket if the handshake is successful.</p> <p> @@ -1545,9 +1545,9 @@ fun(srp, Username :: string(), UserState :: term()) -> paused after receiving the client hello message and the success response is <c>{ok, SslSocket, Ext}</c> instead of <c>{ok, SslSocket}</c>. Thereafter the handshake is continued or - canceled by calling <seealso marker="#handshake_continue-3"> + canceled by calling <seealso marker="#handshake_continue/3"> <c>handshake_continue/3</c></seealso> or <seealso - marker="#handshake_cancel-1"><c>handshake_cancel/1</c></seealso>. + marker="#handshake_cancel/1"><c>handshake_cancel/1</c></seealso>. </p> <p> If the option <c>active</c> is set to <c>once</c>, <c>true</c> or an integer value, @@ -1599,7 +1599,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <desc> <p>The peer certificate is returned as a DER-encoded binary. The certificate can be decoded with - <seealso marker="public_key:public_key#pkix_decode_cert-2">public_key:pkix_decode_cert/2</seealso> + <seealso marker="public_key:public_key#pkix_decode_cert/2">public_key:pkix_decode_cert/2</seealso> </p> </desc> </func> @@ -1721,7 +1721,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <name since="" name="ssl_accept" arity="2" /> <fsummary>Performs server-side TLS handshake.</fsummary> <desc> - <p>Deprecated in OTP 21, use <seealso marker="#handshake-1">handshake/[1,2]</seealso> instead.</p> + <p>Deprecated in OTP 21, use <seealso marker="#handshake/1">handshake/[1,2]</seealso> instead.</p> <note><p>handshake/[1,2] always returns a new socket.</p></note> </desc> </func> @@ -1730,7 +1730,7 @@ fun(srp, Username :: string(), UserState :: term()) -> <name since="OTP R14B" name="ssl_accept" arity="3" /> <fsummary>Performs server-side TLS/DTLS handshake.</fsummary> <desc> - <p>Deprecated in OTP 21, use <seealso marker="#handshake-3">handshake/[2,3]</seealso> instead.</p> + <p>Deprecated in OTP 21, use <seealso marker="#handshake/3">handshake/[2,3]</seealso> instead.</p> <note><p>handshake/[2,3] always returns a new socket.</p></note> </desc> </func> @@ -1802,9 +1802,9 @@ fun(srp, Username :: string(), UserState :: term()) -> <desc> <p>Accepts an incoming connection request on a listen socket. <c>ListenSocket</c> must be a socket returned from - <seealso marker="#listen-2"> listen/2</seealso>. + <seealso marker="#listen/2"> listen/2</seealso>. The socket returned is to be passed to - <seealso marker="#handshake-2"> handshake/[2,3]</seealso> + <seealso marker="#handshake/2"> handshake/[2,3]</seealso> to complete handshaking, that is, establishing the TLS/DTLS connection.</p> <warning> @@ -1814,7 +1814,7 @@ fun(srp, Username :: string(), UserState :: term()) -> </warning> <p>The accepted socket inherits the options set for <c>ListenSocket</c> in - <seealso marker="#listen-2"> listen/2</seealso>.</p> + <seealso marker="#listen/2"> listen/2</seealso>.</p> <p>The default value for <c>Timeout</c> is <c>infinity</c>. If <c>Timeout</c> is specified and no connection is accepted @@ -1838,9 +1838,9 @@ fun(srp, Username :: string(), UserState :: term()) -> <item>TLS versions supported by default if crypto lib support is sufficent· Overridden by a version option on - <seealso marker="#connect-2"> connect/[2,3,4]</seealso>, - <seealso marker="#listen-2"> listen/2</seealso>, and <seealso - marker="#ssl_accept-2">ssl_accept/[1,2,3]</seealso>. + <seealso marker="#connect/2"> connect/[2,3,4]</seealso>, + <seealso marker="#listen/2"> listen/2</seealso>, and <seealso + marker="#ssl_accept/2">ssl_accept/[1,2,3]</seealso>. For the negotiated TLS version, see <seealso marker="#connection_information-1">connection_information/1 </seealso>.</item> @@ -1849,11 +1849,11 @@ fun(srp, Username :: string(), UserState :: term()) -> <item>DTLS versions supported by default if crypto lib support is sufficent· Overridden by a version option on - <seealso marker="#connect-2"> connect/[2,3,4]</seealso>, - <seealso marker="#listen-2"> listen/2</seealso>, and <seealso - marker="#ssl_accept-2">ssl_accept/[1,2,3]</seealso>. + <seealso marker="#connect/2"> connect/[2,3,4]</seealso>, + <seealso marker="#listen/2"> listen/2</seealso>, and <seealso + marker="#ssl_accept/2">ssl_accept/[1,2,3]</seealso>. For the negotiated DTLS version, see <seealso - marker="#connection_information-1">connection_information/1 + marker="#connection_information/1">connection_information/1 </seealso>.</item> <tag><c>available</c></tag> diff --git a/lib/ssl/doc/src/ssl_app.xml b/lib/ssl/doc/src/ssl_app.xml index 5c259cda01..111293f2f6 100644 --- a/lib/ssl/doc/src/ssl_app.xml +++ b/lib/ssl/doc/src/ssl_app.xml @@ -116,7 +116,7 @@ Number of milliseconds between PEM cache validations. Defaults to 2 minutes. </p> <seealso - marker="ssl#clear_pem_cache-0">ssl:clear_pem_cache/0</seealso> + marker="ssl#clear_pem_cache/0">ssl:clear_pem_cache/0</seealso> </item> diff --git a/lib/ssl/doc/src/ssl_crl_cache_api.xml b/lib/ssl/doc/src/ssl_crl_cache_api.xml index 1954492a53..1f4aeae855 100644 --- a/lib/ssl/doc/src/ssl_crl_cache_api.xml +++ b/lib/ssl/doc/src/ssl_crl_cache_api.xml @@ -91,7 +91,7 @@ </type> <desc> <p> <c>fun fresh_crl/2 </c> will be used as input option <c>update_crl</c> to - <seealso marker="public_key:public_key#pkix_crls_validate-3">public_key:pkix_crls_validate/3 </seealso> </p> + <seealso marker="public_key:public_key#pkix_crls_validate/3">public_key:pkix_crls_validate/3 </seealso> </p> <p>It is possible to return logger info that will be used by the TLS connection to produce log events. diff --git a/lib/ssl/doc/src/standards_compliance.xml b/lib/ssl/doc/src/standards_compliance.xml index d70f12ad51..e2beee1113 100644 --- a/lib/ssl/doc/src/standards_compliance.xml +++ b/lib/ssl/doc/src/standards_compliance.xml @@ -197,7 +197,7 @@ <row> <cell align="left" valign="middle"> - <url href="https://tools.ietf.org/html/rfc8446#section-2"> + <url href="https://tools.ietf.org/html/rfc8446#section/2"> 2. Protocol Overview </url> </cell> @@ -1908,7 +1908,7 @@ <row> <cell align="left" valign="middle"> - <url href="https://tools.ietf.org/html/rfc8446#section-8"> + <url href="https://tools.ietf.org/html/rfc8446#section/8"> 8. 0-RTT and Anti-Replay </url> </cell> diff --git a/lib/ssl/doc/src/using_ssl.xml b/lib/ssl/doc/src/using_ssl.xml index 5684af135a..34b32b1750 100644 --- a/lib/ssl/doc/src/using_ssl.xml +++ b/lib/ssl/doc/src/using_ssl.xml @@ -33,10 +33,10 @@ <file>using_ssl.xml</file> </header> <p>To see relevant version information for ssl, call - <seealso marker="ssl:ssl#versions-0"><c>ssl:versions/0</c></seealso> + <seealso marker="ssl:ssl#versions/0"><c>ssl:versions/0</c></seealso> .</p> - <p>To see all supported cipher suites, call <seealso marker="ssl:ssl#cipher_suites-1"><c>ssl:cipher_suites(all)</c> </seealso>. + <p>To see all supported cipher suites, call <seealso marker="ssl:ssl#cipher_suites/1"><c>ssl:cipher_suites(all)</c> </seealso>. The available cipher suites for a connection depend on your certificate. Specific cipher suites that you want your connection to use can also be specified. Default is to use the strongest available.</p> diff --git a/lib/stdlib/doc/src/array.xml b/lib/stdlib/doc/src/array.xml index 3607c4f162..feaf5de93a 100644 --- a/lib/stdlib/doc/src/array.xml +++ b/lib/stdlib/doc/src/array.xml @@ -47,14 +47,14 @@ value is the atom <c>undefined</c>. There is no difference between an unset entry and an entry that has been explicitly set to the same value as the default one (compare - <seealso marker="#reset-2"><c>reset/2</c></seealso>). If you need to + <seealso marker="#reset/2"><c>reset/2</c></seealso>). If you need to differentiate between unset and set entries, ensure that the default value cannot be confused with the values of set entries.</p> <p>The array never shrinks automatically. If an index <c>I</c> has been used to set an entry successfully, all indices in the range [0,<c>I</c>] stay accessible unless the array size is explicitly changed by calling - <seealso marker="#resize-2"><c>resize/2</c></seealso>.</p> + <seealso marker="#resize/2"><c>resize/2</c></seealso>.</p> <p><em>Examples:</em></p> @@ -139,20 +139,20 @@ A3 = array:fix(A2).</pre> <func> <name name="default" arity="1" since=""/> <fsummary>Get the value used for uninitialized entries.</fsummary> - <desc><marker id="default-1"/> + <desc> <p>Gets the value used for uninitialized entries.</p> - <p>See also <seealso marker="#new-2"><c>new/2</c></seealso>.</p> + <p>See also <seealso marker="#new/2"><c>new/2</c></seealso>.</p> </desc> </func> <func> <name name="fix" arity="1" since=""/> <fsummary>Fix the array size.</fsummary> - <desc><marker id="fix-1"/> + <desc> <p>Fixes the array size. This prevents it from growing automatically upon insertion.</p> - <p>See also <seealso marker="#set-3"><c>set/3</c></seealso> and - <seealso marker="#relax-1"><c>relax/1</c></seealso>.</p> + <p>See also <seealso marker="#set/3"><c>set/3</c></seealso> and + <seealso marker="#relax/1"><c>relax/1</c></seealso>.</p> </desc> </func> @@ -160,14 +160,14 @@ A3 = array:fix(A2).</pre> <name name="foldl" arity="3" since=""/> <fsummary>Fold the array elements using the specified function and initial accumulator value.</fsummary> - <desc><marker id="foldl-3"/> + <desc> <p>Folds the array elements using the specified function and initial accumulator value. The elements are visited in order from the lowest index to the highest. If <c><anno>Function</anno></c> is not a function, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#foldr-3"><c>foldr/3</c></seealso>, - <seealso marker="#map-2"><c>map/2</c></seealso>, - <seealso marker="#sparse_foldl-3"><c>sparse_foldl/3</c></seealso>.</p> + <p>See also <seealso marker="#foldr/3"><c>foldr/3</c></seealso>, + <seealso marker="#map/2"><c>map/2</c></seealso>, + <seealso marker="#sparse_foldl/3"><c>sparse_foldl/3</c></seealso>.</p> </desc> </func> @@ -175,35 +175,35 @@ A3 = array:fix(A2).</pre> <name name="foldr" arity="3" since=""/> <fsummary>Fold the array elements right-to-left using the specified function and initial accumulator value.</fsummary> - <desc><marker id="foldr-3"/> + <desc> <p>Folds the array elements right-to-left using the specified function and initial accumulator value. The elements are visited in order from the highest index to the lowest. If <c><anno>Function</anno></c> is not a function, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#foldl-3"><c>foldl/3</c></seealso>, - <seealso marker="#map-2"><c>map/2</c></seealso>.</p> + <p>See also <seealso marker="#foldl/3"><c>foldl/3</c></seealso>, + <seealso marker="#map/2"><c>map/2</c></seealso>.</p> </desc> </func> <func> <name name="from_list" arity="1" since=""/> <fsummary>Equivalent to <c>from_list(List, undefined)</c>.</fsummary> - <desc><marker id="from_list-1"/> + <desc> <p>Equivalent to - <seealso marker="#from_list-2"><c>from_list(<anno>List</anno>, undefined)</c></seealso>.</p> + <seealso marker="#from_list/2"><c>from_list(<anno>List</anno>, undefined)</c></seealso>.</p> </desc> </func> <func> <name name="from_list" arity="2" since=""/> <fsummary>Convert a list to an extendible array.</fsummary> - <desc><marker id="from_list-2"/> + <desc> <p>Converts a list to an extendible array. <c><anno>Default</anno></c> is used as the value for uninitialized entries of the array. If <c><anno>List</anno></c> is not a proper list, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#new-2"><c>new/2</c></seealso>, - <seealso marker="#to_list-1"><c>to_list/1</c></seealso>.</p> + <p>See also <seealso marker="#new/2"><c>new/2</c></seealso>, + <seealso marker="#to_list/1"><c>to_list/1</c></seealso>.</p> </desc> </func> @@ -211,9 +211,9 @@ A3 = array:fix(A2).</pre> <name name="from_orddict" arity="1" since=""/> <fsummary>Equivalent to <c>from_orddict(Orddict, undefined)</c>. </fsummary> - <desc><marker id="from_orddict-1"/> + <desc> <p>Equivalent to - <seealso marker="#from_orddict-2"><c>from_orddict(<anno>Orddict</anno>, undefined)</c></seealso>.</p> + <seealso marker="#from_orddict/2"><c>from_orddict(<anno>Orddict</anno>, undefined)</c></seealso>.</p> </desc> </func> @@ -221,22 +221,22 @@ A3 = array:fix(A2).</pre> <name name="from_orddict" arity="2" since=""/> <fsummary>Convert an ordered list of pairs <c>{Index, Value}</c> to a corresponding extendible array.</fsummary> - <desc><marker id="from_orddict-2"/> + <desc> <p>Converts an ordered list of pairs <c>{Index, <anno>Value</anno>}</c> to a corresponding extendible array. <c><anno>Default</anno></c> is used as the value for uninitialized entries of the array. If <c><anno>Orddict</anno></c> is not a proper, ordered list of pairs whose first elements are non-negative integers, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#new-2"><c>new/2</c></seealso>, - <seealso marker="#to_orddict-1"><c>to_orddict/1</c></seealso>.</p> + <p>See also <seealso marker="#new/2"><c>new/2</c></seealso>, + <seealso marker="#to_orddict/1"><c>to_orddict/1</c></seealso>.</p> </desc> </func> <func> <name name="get" arity="2" since=""/> <fsummary>Get the value of entry <c>I</c>.</fsummary> - <desc><marker id="get-2"/> + <desc> <p>Gets the value of entry <c><anno>I</anno></c>. If <c><anno>I</anno></c> is not a non-negative integer, or if the array has fixed size and <c><anno>I</anno></c> is larger than the maximum @@ -244,7 +244,7 @@ A3 = array:fix(A2).</pre> <p>If the array does not have fixed size, the default value for any index <c><anno>I</anno></c> greater than <c>size(<anno>Array</anno>)-1</c> is returned.</p> - <p>See also <seealso marker="#set-3"><c>set/3</c></seealso>.</p> + <p>See also <seealso marker="#set/3"><c>set/3</c></seealso>.</p> </desc> </func> @@ -252,7 +252,7 @@ A3 = array:fix(A2).</pre> <name name="is_array" arity="1" since=""/> <fsummary>Returns <c>true</c> if <c>X</c> is an array, otherwise <c>false</c>.</fsummary> - <desc><marker id="is_array-1"/> + <desc> <p>Returns <c>true</c> if <c><anno>X</anno></c> is an array, otherwise <c>false</c>. Notice that the check is only shallow, as there is no guarantee that <c><anno>X</anno></c> is a well-formed array @@ -263,24 +263,24 @@ A3 = array:fix(A2).</pre> <func> <name name="is_fix" arity="1" since=""/> <fsummary>Check if the array has fixed size.</fsummary> - <desc><marker id="is_fix-1"/> + <desc> <p>Checks if the array has fixed size. Returns <c>true</c> if the array is fixed, otherwise <c>false</c>.</p> - <p>See also <seealso marker="#fix-1"><c>fix/1</c></seealso>.</p> + <p>See also <seealso marker="#fix/1"><c>fix/1</c></seealso>.</p> </desc> </func> <func> <name name="map" arity="2" since=""/> <fsummary>Map the specified function onto each array element.</fsummary> - <desc><marker id="map-2"/> + <desc> <p>Maps the specified function onto each array element. The elements are visited in order from the lowest index to the highest. If <c><anno>Function</anno></c> is not a function, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#foldl-3"><c>foldl/3</c></seealso>, - <seealso marker="#foldr-3"><c>foldr/3</c></seealso>, - <seealso marker="#sparse_map-2"><c>sparse_map/2</c></seealso>.</p> + <p>See also <seealso marker="#foldl/3"><c>foldl/3</c></seealso>, + <seealso marker="#foldr/3"><c>foldr/3</c></seealso>, + <seealso marker="#sparse_map/2"><c>sparse_map/2</c></seealso>.</p> </desc> </func> @@ -288,10 +288,10 @@ A3 = array:fix(A2).</pre> <name name="new" arity="0" since=""/> <fsummary>Create a new, extendible array with initial size zero. </fsummary> - <desc><marker id="new-0"/> + <desc> <p>Creates a new, extendible array with initial size zero.</p> - <p>See also <seealso marker="#new-1"><c>new/1</c></seealso>, - <seealso marker="#new-2"><c>new/2</c></seealso>.</p> + <p>See also <seealso marker="#new/1"><c>new/1</c></seealso>, + <seealso marker="#new/2"><c>new/2</c></seealso>.</p> </desc> </func> @@ -299,7 +299,7 @@ A3 = array:fix(A2).</pre> <name name="new" arity="1" since=""/> <fsummary>Create a new array according to the specified options. </fsummary> - <desc><marker id="new-1"/> + <desc> <p>Creates a new array according to the specified otions. By default, the array is extendible and has initial size zero. Array indices start at <c>0</c>.</p> @@ -313,7 +313,7 @@ A3 = array:fix(A2).</pre> call fails with reason <c>badarg</c>.</p></item> <tag><c>fixed</c> or <c>{fixed, true}</c></tag> <item><p>Creates a fixed-size array. See also - <seealso marker="#fix-1"><c>fix/1</c></seealso>.</p></item> + <seealso marker="#fix/1"><c>fix/1</c></seealso>.</p></item> <tag><c>{fixed, false}</c></tag> <item><p>Creates an extendible (non-fixed-size) array.</p></item> <tag><c>{default, Value}</c></tag> @@ -336,12 +336,12 @@ array:new({default,0})</pre> array:new([{size,10},{fixed,false},{default,-1}])</pre> <p>creates an extendible array with initial size 10 whose default value is <c>-1</c>.</p> - <p>See also <seealso marker="#fix-1"><c>fix/1</c></seealso>, - <seealso marker="#from_list-2"><c>from_list/2</c></seealso>, - <seealso marker="#get-2"><c>get/2</c></seealso>, - <seealso marker="#new-0"><c>new/0</c></seealso>, - <seealso marker="#new-2"><c>new/2</c></seealso>, - <seealso marker="#set-3"><c>set/3</c></seealso>.</p> + <p>See also <seealso marker="#fix/1"><c>fix/1</c></seealso>, + <seealso marker="#from_list/2"><c>from_list/2</c></seealso>, + <seealso marker="#get/2"><c>get/2</c></seealso>, + <seealso marker="#new/0"><c>new/0</c></seealso>, + <seealso marker="#new/2"><c>new/2</c></seealso>, + <seealso marker="#set/3"><c>set/3</c></seealso>.</p> </desc> </func> @@ -349,7 +349,7 @@ array:new([{size,10},{fixed,false},{default,-1}])</pre> <name name="new" arity="2" since=""/> <fsummary>Create a new array according to the specified size and options. </fsummary> - <desc><marker id="new-2"/> + <desc> <p>Creates a new array according to the specified size and options. If <c><anno>Size</anno></c> is not a non-negative integer, the call fails with reason <c>badarg</c>. By default, the array has fixed size. @@ -365,17 +365,17 @@ array:new([{size,10},{fixed,false},{default,-1}])</pre> array:new(100, {default,0})</pre> <p>creates a fixed-size array of size 100, whose default value is <c>0</c>.</p> - <p>See also <seealso marker="#new-1"><c>new/1</c></seealso>.</p> + <p>See also <seealso marker="#new/1"><c>new/1</c></seealso>.</p> </desc> </func> <func> <name name="relax" arity="1" since=""/> <fsummary>Make the array resizable.</fsummary> - <desc><marker id="relax-1"/> + <desc> <p>Makes the array resizable. (Reverses the effects of - <seealso marker="#fix-1"><c>fix/1</c></seealso>.)</p> - <p>See also <seealso marker="#fix-1"><c>fix/1</c></seealso>.</p> + <seealso marker="#fix/1"><c>fix/1</c></seealso>.)</p> + <p>See also <seealso marker="#fix/1"><c>fix/1</c></seealso>.</p> </desc> </func> @@ -383,18 +383,18 @@ array:new(100, {default,0})</pre> <name name="reset" arity="2" since=""/> <fsummary>Reset entry <c>I</c> to the default value for the array. </fsummary> - <desc><marker id="reset-2"/> + <desc> <p>Resets entry <c><anno>I</anno></c> to the default value for the array. If the value of entry <c><anno>I</anno></c> is the default value, the array is returned unchanged. Reset never changes the array size. Shrinking can be done explicitly by calling - <seealso marker="#resize-2"><c>resize/2</c></seealso>.</p> + <seealso marker="#resize/2"><c>resize/2</c></seealso>.</p> <p>If <c><anno>I</anno></c> is not a non-negative integer, or if the array has fixed size and <c><anno>I</anno></c> is larger than the maximum index, the call fails with reason <c>badarg</c>; compare - <seealso marker="#set-3"><c>set/3</c></seealso></p> - <p>See also <seealso marker="#new-2"><c>new/2</c></seealso>, - <seealso marker="#set-3"><c>set/3</c></seealso>.</p> + <seealso marker="#set/3"><c>set/3</c></seealso></p> + <p>See also <seealso marker="#new/2"><c>new/2</c></seealso>, + <seealso marker="#set/3"><c>set/3</c></seealso>.</p> </desc> </func> @@ -402,20 +402,20 @@ array:new(100, {default,0})</pre> <name name="resize" arity="1" since=""/> <fsummary>Change the array size to that reported by <c>sparse_size/1</c>. </fsummary> - <desc><marker id="resize-1"/> + <desc> <p>Changes the array size to that reported by - <seealso marker="#sparse_size-1"><c>sparse_size/1</c></seealso>. If + <seealso marker="#sparse_size/1"><c>sparse_size/1</c></seealso>. If the specified array has fixed size, also the resulting array has fixed size.</p> - <p>See also <seealso marker="#resize-2"><c>resize/2</c></seealso>, - <seealso marker="#sparse_size-1"><c>sparse_size/1</c></seealso>.</p> + <p>See also <seealso marker="#resize/2"><c>resize/2</c></seealso>, + <seealso marker="#sparse_size/1"><c>sparse_size/1</c></seealso>.</p> </desc> </func> <func> <name name="resize" arity="2" since=""/> <fsummary>Change the array size.</fsummary> - <desc><marker id="resize-2"/> + <desc> <p>Change the array size. If <c><anno>Size</anno></c> is not a non-negative integer, the call fails with reason <c>badarg</c>. If the specified array has fixed size, also the resulting array has fixed @@ -426,7 +426,7 @@ array:new(100, {default,0})</pre> <func> <name name="set" arity="3" since=""/> <fsummary>Set entry <c>I</c> of the array to <c>Value</c>.</fsummary> - <desc><marker id="set-3"/> + <desc> <p>Sets entry <c><anno>I</anno></c> of the array to <c><anno>Value</anno></c>. If <c><anno>I</anno></c> is not a non-negative integer, or if the array has fixed size and @@ -435,21 +435,21 @@ array:new(100, {default,0})</pre> <p>If the array does not have fixed size, and <c><anno>I</anno></c> is greater than <c>size(<anno>Array</anno>)-1</c>, the array grows to size <c><anno>I</anno>+1</c>.</p> - <p>See also <seealso marker="#get-2"><c>get/2</c></seealso>, - <seealso marker="#reset-2"><c>reset/2</c></seealso>.</p> + <p>See also <seealso marker="#get/2"><c>get/2</c></seealso>, + <seealso marker="#reset/2"><c>reset/2</c></seealso>.</p> </desc> </func> <func> <name name="size" arity="1" since=""/> <fsummary>Get the number of entries in the array.</fsummary> - <desc><marker id="size-1"/> + <desc> <p>Gets the number of entries in the array. Entries are numbered from <c>0</c> to <c>size(<anno>Array</anno>)-1</c>. Hence, this is also the index of the first entry that is guaranteed to not have been previously set.</p> - <p>See also <seealso marker="#set-3"><c>set/3</c></seealso>, - <seealso marker="#sparse_size-1"><c>sparse_size/1</c></seealso>.</p> + <p>See also <seealso marker="#set/3"><c>set/3</c></seealso>, + <seealso marker="#sparse_size/1"><c>sparse_size/1</c></seealso>.</p> </desc> </func> @@ -457,14 +457,14 @@ array:new(100, {default,0})</pre> <name name="sparse_foldl" arity="3" since=""/> <fsummary>Fold the array elements using the specified function and initial accumulator value, skipping default-valued entries.</fsummary> - <desc><marker id="sparse_foldl-3"/> + <desc> <p>Folds the array elements using the specified function and initial accumulator value, skipping default-valued entries. The elements are visited in order from the lowest index to the highest. If <c><anno>Function</anno></c> is not a function, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#foldl-3"><c>foldl/3</c></seealso>, - <seealso marker="#sparse_foldr-3"><c>sparse_foldr/3</c></seealso>.</p> + <p>See also <seealso marker="#foldl/3"><c>foldl/3</c></seealso>, + <seealso marker="#sparse_foldr/3"><c>sparse_foldr/3</c></seealso>.</p> </desc> </func> @@ -473,14 +473,14 @@ array:new(100, {default,0})</pre> <fsummary>Fold the array elements right-to-left using the specified function and initial accumulator value, skipping default-valued entries.</fsummary> - <desc><marker id="sparse_foldr-3"/> + <desc> <p>Folds the array elements right-to-left using the specified function and initial accumulator value, skipping default-valued entries. The elements are visited in order from the highest index to the lowest. If <c><anno>Function</anno></c> is not a function, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#foldr-3"><c>foldr/3</c></seealso>, - <seealso marker="#sparse_foldl-3"><c>sparse_foldl/3</c></seealso>.</p> + <p>See also <seealso marker="#foldr/3"><c>foldr/3</c></seealso>, + <seealso marker="#sparse_foldl/3"><c>sparse_foldl/3</c></seealso>.</p> </desc> </func> @@ -488,12 +488,12 @@ array:new(100, {default,0})</pre> <name name="sparse_map" arity="2" since=""/> <fsummary>Map the specified function onto each array element, skipping default-valued entries.</fsummary> - <desc><marker id="sparse_map-2"/> + <desc> <p>Maps the specified function onto each array element, skipping default-valued entries. The elements are visited in order from the lowest index to the highest. If <c><anno>Function</anno></c> is not a function, the call fails with reason <c>badarg</c>.</p> - <p>See also <seealso marker="#map-2"><c>map/2</c></seealso>.</p> + <p>See also <seealso marker="#map/2"><c>map/2</c></seealso>.</p> </desc> </func> @@ -501,13 +501,13 @@ array:new(100, {default,0})</pre> <name name="sparse_size" arity="1" since=""/> <fsummary>Get the number of entries in the array up until the last non-default-valued entry.</fsummary> - <desc><marker id="sparse_size-1"/> + <desc> <p>Gets the number of entries in the array up until the last non-default-valued entry. That is, returns <c>I+1</c> if <c>I</c> is the last non-default-valued entry in the array, or zero if no such entry exists.</p> - <p>See also <seealso marker="#resize-1"><c>resize/1</c></seealso>, - <seealso marker="#size-1"><c>size/1</c></seealso>.</p> + <p>See also <seealso marker="#resize/1"><c>resize/1</c></seealso>, + <seealso marker="#size/1"><c>size/1</c></seealso>.</p> </desc> </func> @@ -515,9 +515,9 @@ array:new(100, {default,0})</pre> <name name="sparse_to_list" arity="1" since=""/> <fsummary>Convert the array to a list, skipping default-valued entries. </fsummary> - <desc><marker id="sparse_to_list-1"/> + <desc> <p>Converts the array to a list, skipping default-valued entries.</p> - <p>See also <seealso marker="#to_list-1"><c>to_list/1</c></seealso>.</p> + <p>See also <seealso marker="#to_list/1"><c>to_list/1</c></seealso>.</p> </desc> </func> @@ -525,21 +525,21 @@ array:new(100, {default,0})</pre> <name name="sparse_to_orddict" arity="1" since=""/> <fsummary>Convert the array to an ordered list of pairs <c>{Index, Value}</c>, skipping default-valued entries.</fsummary> - <desc><marker id="sparse_to_orddict-1"/> + <desc> <p>Converts the array to an ordered list of pairs <c>{Index, <anno>Value</anno>}</c>, skipping default-valued entries.</p> <p>See also - <seealso marker="#to_orddict-1"><c>to_orddict/1</c></seealso>.</p> + <seealso marker="#to_orddict/1"><c>to_orddict/1</c></seealso>.</p> </desc> </func> <func> <name name="to_list" arity="1" since=""/> <fsummary>Convert the array to a list.</fsummary> - <desc><marker id="to_list-1"/> + <desc> <p>Converts the array to a list.</p> - <p>See also <seealso marker="#from_list-2"><c>from_list/2</c></seealso>, - <seealso marker="#sparse_to_list-1"><c>sparse_to_list/1</c></seealso>. + <p>See also <seealso marker="#from_list/2"><c>from_list/2</c></seealso>, + <seealso marker="#sparse_to_list/1"><c>sparse_to_list/1</c></seealso>. </p> </desc> </func> @@ -548,12 +548,12 @@ array:new(100, {default,0})</pre> <name name="to_orddict" arity="1" since=""/> <fsummary>Convert the array to an ordered list of pairs <c>{Index, Value}</c>.</fsummary> - <desc><marker id="to_orddict-1"/> + <desc> <p>Converts the array to an ordered list of pairs <c>{Index, <anno>Value</anno>}</c>.</p> <p>See also - <seealso marker="#from_orddict-2"><c>from_orddict/2</c></seealso>, - <seealso marker="#sparse_to_orddict-1"><c>sparse_to_orddict/1</c></seealso>. + <seealso marker="#from_orddict/2"><c>from_orddict/2</c></seealso>, + <seealso marker="#sparse_to_orddict/1"><c>sparse_to_orddict/1</c></seealso>. </p> </desc> </func> diff --git a/lib/stdlib/doc/src/binary.xml b/lib/stdlib/doc/src/binary.xml index 2dd6c6a436..aacfe498d1 100644 --- a/lib/stdlib/doc/src/binary.xml +++ b/lib/stdlib/doc/src/binary.xml @@ -131,10 +131,10 @@ <desc> <p>Builds an internal structure representing a compilation of a search pattern, later to be used in functions - <seealso marker="#match-3"><c>match/3</c></seealso>, - <seealso marker="#matches-3"><c>matches/3</c></seealso>, - <seealso marker="#split-3"><c>split/3</c></seealso>, or - <seealso marker="#replace-4"><c>replace/4</c></seealso>. + <seealso marker="#match/3"><c>match/3</c></seealso>, + <seealso marker="#matches/3"><c>matches/3</c></seealso>, + <seealso marker="#split/3"><c>split/3</c></seealso>, or + <seealso marker="#replace/4"><c>replace/4</c></seealso>. The <c>cp()</c> returned is guaranteed to be a <c>tuple()</c> to allow programs to distinguish it from non-precompiled search patterns.</p> @@ -361,7 +361,7 @@ atom <c>nomatch</c> is returned.</p> <p>For a description of <c><anno>Pattern</anno></c>, see function - <seealso marker="#compile_pattern-1"><c>compile_pattern/1</c></seealso>. + <seealso marker="#compile_pattern/1"><c>compile_pattern/1</c></seealso>. </p> <p>If <c>{scope, {Start,Length}}</c> is specified in the options such @@ -385,7 +385,7 @@ <fsummary>Search for all matches of a pattern in a binary.</fsummary> <type name="part"/> <desc> - <p>As <seealso marker="#match-2"><c>match/2</c></seealso>, + <p>As <seealso marker="#match/2"><c>match/2</c></seealso>, but <c><anno>Subject</anno></c> is searched until exhausted and a list of all non-overlapping parts matching <c><anno>Pattern</anno></c> is returned (in order).</p> @@ -411,9 +411,9 @@ returned.</p> <p>For a description of <c><anno>Pattern</anno></c>, see - <seealso marker="#compile_pattern-1"><c>compile_pattern/1</c></seealso>. + <seealso marker="#compile_pattern/1"><c>compile_pattern/1</c></seealso>. For a description of available options, see - <seealso marker="#match-3"><c>match/3</c></seealso>.</p> + <seealso marker="#match/3"><c>match/3</c></seealso>.</p> <p>If <c>{scope, {<anno>Start</anno>,<anno>Length</anno>}}</c> is specified in the options such that <c><anno>Start</anno></c> > size @@ -440,8 +440,8 @@ <<6,7,8,9,10>></code> <note> - <p><seealso marker="#part-2">part/2</seealso> and - <seealso marker="#part-3">part/3</seealso> are also available in the + <p><seealso marker="#part/2">part/2</seealso> and + <seealso marker="#part/3">part/3</seealso> are also available in the <seealso marker="erts:erlang"><c>erlang</c></seealso> module under the names <c>binary_part/2</c> and <c>binary_part/3</c>. Those BIFs are allowed in guard tests.</p> @@ -566,11 +566,11 @@ store(Binary, GBSet) -> of the replacement binary, a <c>badarg</c> exception is raised.</p> <p>Options <c>global</c> and <c>{scope, part()}</c> work as for - <seealso marker="#split-3"><c>split/3</c></seealso>. + <seealso marker="#split/3"><c>split/3</c></seealso>. The return type is always a <c>binary()</c>.</p> <p>For a description of <c><anno>Pattern</anno></c>, see - <seealso marker="#compile_pattern-1"><c>compile_pattern/1</c></seealso>. + <seealso marker="#compile_pattern/1"><c>compile_pattern/1</c></seealso>. </p> </desc> </func> @@ -608,8 +608,8 @@ store(Binary, GBSet) -> <taglist> <tag>{scope, part()}</tag> - <item><p>Works as in <seealso marker="#match-3"><c>match/3</c></seealso> - and <seealso marker="#matches-3"><c>matches/3</c></seealso>. Notice that + <item><p>Works as in <seealso marker="#match/3"><c>match/3</c></seealso> + and <seealso marker="#matches/3"><c>matches/3</c></seealso>. Notice that this only defines the scope of the search for matching strings, it does not cut the binary before splitting. The bytes before and after the scope are kept in the result. See the example below.</p></item> @@ -622,9 +622,9 @@ store(Binary, GBSet) -> <item><p>Repeats the split until <c><anno>Subject</anno></c> is exhausted. Conceptually option <c>global</c> makes split work on the positions returned by - <seealso marker="#matches-3"><c>matches/3</c></seealso>, while it + <seealso marker="#matches/3"><c>matches/3</c></seealso>, while it normally works on the position returned by - <seealso marker="#match-3"><c>match/3</c></seealso>.</p></item> + <seealso marker="#match/3"><c>match/3</c></seealso>.</p></item> </taglist> <p>Example of the difference between a scope and taking the @@ -643,7 +643,7 @@ store(Binary, GBSet) -> of the split are no longer referenced.</p> <p>For a description of <c><anno>Pattern</anno></c>, see - <seealso marker="#compile_pattern-1"><c>compile_pattern/1</c></seealso>. + <seealso marker="#compile_pattern/1"><c>compile_pattern/1</c></seealso>. </p> </desc> </func> diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 53e1939abc..614b708a48 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -411,7 +411,7 @@ <tag><c>(position,{UserData,Position})</c></tag> <item> <p>Sets the position of <c>UserData</c> as defined for files in - <seealso marker="kernel:file#position-2"> + <seealso marker="kernel:file#position/2"> <c>file:position/2</c></seealso></p> </item> </taglist> diff --git a/lib/stdlib/doc/src/maps.xml b/lib/stdlib/doc/src/maps.xml index 8e88882b56..b8a48c5ec2 100644 --- a/lib/stdlib/doc/src/maps.xml +++ b/lib/stdlib/doc/src/maps.xml @@ -39,11 +39,11 @@ <desc> <p>An iterator representing the associations in a map with keys of type <c><anno>Key</anno></c> and values of type <c><anno>Value</anno></c>.</p> - <p>Created using <seealso marker="#iterator-1"><c>maps:iterator/1</c></seealso>.</p> - <p>Consumed by <seealso marker="#next-1"><c>maps:next/1</c></seealso>, - <seealso marker="#filter-2"><c>maps:filter/2</c></seealso>, - <seealso marker="#fold-3"><c>maps:fold/3</c></seealso> and - <seealso marker="#map-2"><c>maps:map/2</c></seealso>.</p> + <p>Created using <seealso marker="#iterator/1"><c>maps:iterator/1</c></seealso>.</p> + <p>Consumed by <seealso marker="#next/1"><c>maps:next/1</c></seealso>, + <seealso marker="#filter/2"><c>maps:filter/2</c></seealso>, + <seealso marker="#fold/3"><c>maps:fold/3</c></seealso> and + <seealso marker="#map/2"><c>maps:map/2</c></seealso>.</p> </desc> </datatype> @@ -197,7 +197,7 @@ false</code> <fsummary>Create a map iterator.</fsummary> <desc> <p>Returns a map iterator <c><anno>Iterator</anno></c> that can - be used by <seealso marker="#next-1"><c>maps:next/1</c></seealso> + be used by <seealso marker="#next/1"><c>maps:next/1</c></seealso> to traverse the key-value associations in a map. When iterating over a map, the memory usage is guaranteed to be bounded no matter the size of the map.</p> diff --git a/lib/stdlib/doc/src/rand.xml b/lib/stdlib/doc/src/rand.xml index 5ed67dcaca..350c2f2f49 100644 --- a/lib/stdlib/doc/src/rand.xml +++ b/lib/stdlib/doc/src/rand.xml @@ -131,7 +131,7 @@ <p> The default algorithm is <c>exsss</c> (Xorshift116**). If a specific algorithm is - required, ensure to always use <seealso marker="#seed-1"> + required, ensure to always use <seealso marker="#seed/1"> <c>seed/1</c></seealso> to initialize the state. </p> @@ -179,10 +179,10 @@ variable <c>rand_seed</c> to remember the current state.</p> <p>If a process calls - <seealso marker="#uniform-0"><c>uniform/0</c></seealso>, - <seealso marker="#uniform-1"><c>uniform/1</c></seealso> or - <seealso marker="#uniform_real-0"><c>uniform_real/0</c></seealso> without - setting a seed first, <seealso marker="#seed-1"><c>seed/1</c></seealso> + <seealso marker="#uniform/0"><c>uniform/0</c></seealso>, + <seealso marker="#uniform/1"><c>uniform/1</c></seealso> or + <seealso marker="#uniform_real/0"><c>uniform_real/0</c></seealso> without + setting a seed first, <seealso marker="#seed/1"><c>seed/1</c></seealso> is called automatically with the default algorithm and creates a non-constant seed.</p> @@ -236,7 +236,7 @@ SND0 = math:sqrt(-2 * math:log(R5)) * math:cos(math:pi() * R6)</pre> <p>The builtin random number generator algorithms are not cryptographically strong. If a cryptographically strong random number generator is needed, use something like - <seealso marker="crypto:crypto#rand_seed-0"><c>crypto:rand_seed/0</c></seealso>. + <seealso marker="crypto:crypto#rand_seed/0"><c>crypto:rand_seed/0</c></seealso>. </p> </note> @@ -353,7 +353,7 @@ tests. We suggest to use a sign test to extract a random Boolean value.</pre> <fsummary>Export the random number generation state.</fsummary> <desc><marker id="export_seed-0"/> <p>Returns the random number state in an external format. - To be used with <seealso marker="#seed-1"><c>seed/1</c></seealso>.</p> + To be used with <seealso marker="#seed/1"><c>seed/1</c></seealso>.</p> </desc> </func> @@ -362,7 +362,7 @@ tests. We suggest to use a sign test to extract a random Boolean value.</pre> <fsummary>Export the random number generation state.</fsummary> <desc><marker id="export_seed_s-1"/> <p>Returns the random number generator state in an external format. - To be used with <seealso marker="#seed-1"><c>seed/1</c></seealso>.</p> + To be used with <seealso marker="#seed/1"><c>seed/1</c></seealso>.</p> </desc> </func> @@ -443,7 +443,7 @@ tests. We suggest to use a sign test to extract a random Boolean value.</pre> </p> <p>Otherwise recreates the exported seed in the process dictionary, and returns the state. See also - <seealso marker="#export_seed-0"><c>export_seed/0</c></seealso>.</p> + <seealso marker="#export_seed/0"><c>export_seed/0</c></seealso>.</p> </desc> </func> @@ -466,7 +466,7 @@ tests. We suggest to use a sign test to extract a random Boolean value.</pre> is an algorithm. </p> <p>Otherwise recreates the exported seed and returns the state. - See also <seealso marker="#export_seed-0"> + See also <seealso marker="#export_seed/0"> <c>export_seed/0</c></seealso>.</p> </desc> </func> @@ -499,7 +499,7 @@ tests. We suggest to use a sign test to extract a random Boolean value.</pre> fatal for certain applications. If that is undesired you can use <c>(1.0 - rand:uniform())</c> to get the interval <c>0.0 < <anno>X</anno> =< 1.0</c>, or instead use - <seealso marker="#uniform_real-0"><c>uniform_real/0</c></seealso>. + <seealso marker="#uniform_real/0"><c>uniform_real/0</c></seealso>. </p> <p> If neither endpoint is desired you can test and re-try @@ -537,7 +537,7 @@ end.</pre> <p> The generated numbers from this function has got better granularity for small numbers than the regular - <seealso marker="#uniform-0"><c>uniform/0</c></seealso> + <seealso marker="#uniform/0"><c>uniform/0</c></seealso> because all bits in the mantissa are random. This property, in combination with the fact that exactly zero is never returned is useful for algoritms doing for example @@ -546,7 +546,7 @@ end.</pre> </note> <p> See - <seealso marker="#uniform_real_s-1"><c>uniform_real_s/1</c></seealso> + <seealso marker="#uniform_real_s/1"><c>uniform_real_s/1</c></seealso> for more explanation. </p> </desc> @@ -582,7 +582,7 @@ end.</pre> fatal for certain applications. If that is undesired you can use <c>(1.0 - rand:uniform(State))</c> to get the interval <c>0.0 < <anno>X</anno> =< 1.0</c>, or instead use - <seealso marker="#uniform_real_s-1"><c>uniform_real_s/1</c></seealso>. + <seealso marker="#uniform_real_s/1"><c>uniform_real_s/1</c></seealso>. </p> <p> If neither endpoint is desired you can test and re-try @@ -620,7 +620,7 @@ end.</pre> <p> The generated numbers from this function has got better granularity for small numbers than the regular - <seealso marker="#uniform_s-1"><c>uniform_s/1</c></seealso> + <seealso marker="#uniform_s/1"><c>uniform_s/1</c></seealso> because all bits in the mantissa are random. This property, in combination with the fact that exactly zero is never returned is useful for algoritms doing for example @@ -650,13 +650,13 @@ end.</pre> <c>0 =< integer(N) < 2.0^53</c> the probability is the same. Compare that with the form of the numbers generated by - <seealso marker="#uniform_s-1"><c>uniform_s/1</c></seealso>. + <seealso marker="#uniform_s/1"><c>uniform_s/1</c></seealso>. </p> <p> Having to generate extra random bits for small numbers costs a little performance. This function is about 20% slower than the regular - <seealso marker="#uniform_s-1"><c>uniform_s/1</c></seealso> + <seealso marker="#uniform_s/1"><c>uniform_s/1</c></seealso> </p> </desc> </func> diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml index ebea054fff..d79f4dfe99 100644 --- a/lib/stdlib/doc/src/sys.xml +++ b/lib/stdlib/doc/src/sys.xml @@ -332,8 +332,8 @@ provided for convenience, allowing developers to avoid having to create their own state extraction functions and also avoid having to interactively extract the state from the return values of - <seealso marker="#get_status-1"><c>get_status/1</c></seealso> or - <seealso marker="#get_status-2"><c>get_status/2</c></seealso> + <seealso marker="#get_status/1"><c>get_status/1</c></seealso> or + <seealso marker="#get_status/2"><c>get_status/2</c></seealso> while debugging.</p> </note> <p>The value of <c><anno>State</anno></c> varies for different types of @@ -378,7 +378,7 @@ <p>If the callback module exports a function <c>system_get_state/1</c>, it is called in the target process to get its state. Its argument is the same as the <c>Misc</c> value returned by - <seealso marker="#get_status-1"><c>get_status/1,2</c></seealso>, and + <seealso marker="#get_status/1"><c>get_status/1,2</c></seealso>, and function <seealso marker="#Module:system_get_state/1"> <c>Module:system_get_state/1</c></seealso> is expected to extract the state of the callback module from it. Function @@ -400,8 +400,8 @@ behavior modules export this function, so callback modules for those behaviors need not to supply their own.</p> <p>For more information about a process, including its state, see - <seealso marker="#get_status-1"><c>get_status/1</c></seealso> and - <seealso marker="#get_status-2"><c>get_status/2</c></seealso>.</p> + <seealso marker="#get_status/1"><c>get_status/1</c></seealso> and + <seealso marker="#get_status/2"><c>get_status/2</c></seealso>.</p> </desc> </func> @@ -596,7 +596,7 @@ target process to replace its state using <c>StateFun</c>. Its two arguments are <c>StateFun</c> and <c>Misc</c>, where <c>Misc</c> is the same as the <c>Misc</c> value returned by - <seealso marker="#get_status-1"><c>get_status/1,2</c></seealso>. + <seealso marker="#get_status/1"><c>get_status/1,2</c></seealso>. A <c>system_replace_state/2</c> function is expected to return <c>{ok, NewState, NewMisc}</c>, where <c>NewState</c> is the new state of the callback module, obtained by calling <c>StateFun</c>, and diff --git a/lib/tools/doc/src/cover.xml b/lib/tools/doc/src/cover.xml index 1605b12e25..5c4a5c2597 100644 --- a/lib/tools/doc/src/cover.xml +++ b/lib/tools/doc/src/cover.xml @@ -387,11 +387,11 @@ </type> <desc> <p>This function works exactly the same way as - <seealso marker="#analyse_to_file-1">analyse_to_file</seealso> except + <seealso marker="#analyse_to_file/1">analyse_to_file</seealso> except that it is asynchronous instead of synchronous. The spawned process will link with the caller when created. If an <c>Error</c> occurs while doing the cover analysis the process will crash with the same - error reason as <seealso marker="#analyse_to_file-1">analyse_to_file</seealso> + error reason as <seealso marker="#analyse_to_file/1">analyse_to_file</seealso> would return.</p> </desc> </func> diff --git a/lib/tools/doc/src/cover_chapter.xml b/lib/tools/doc/src/cover_chapter.xml index 3847adbe59..288350d899 100644 --- a/lib/tools/doc/src/cover_chapter.xml +++ b/lib/tools/doc/src/cover_chapter.xml @@ -405,10 +405,10 @@ ok Cover compiled module, performance decreases proportionally to the size and number of the Cover compiled modules.</p> <p>To improve performance when analysing cover results it is possible - to do multiple calls to <seealso marker="cover#analyse-1">analyse</seealso> - and <seealso marker="cover#analyse_to_file-1">analyse_to_file</seealso> + to do multiple calls to <seealso marker="cover#analyse/1">analyse</seealso> + and <seealso marker="cover#analyse_to_file/1">analyse_to_file</seealso> at once. You can also use the - <seealso marker="cover#async_analyse_to_file-1">async_analyse_to_file</seealso> + <seealso marker="cover#async_analyse_to_file/1">async_analyse_to_file</seealso> convenience function. </p> </section> |