From ad6e765bcd4f35a282ef00e38ed9129f3a5c1d83 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 1 Sep 2016 14:32:27 +0200 Subject: doc: Correct errors introduced by Editorial changes Fix some older errors as well. --- lib/common_test/doc/src/common_test_app.xml | 2 +- lib/common_test/doc/src/ct.xml | 6 +- lib/common_test/doc/src/ct_hooks.xml | 2 +- lib/common_test/doc/src/ct_hooks_chapter.xml | 8 +- lib/common_test/doc/src/ct_ssh.xml | 106 +++++++++++----------- lib/common_test/doc/src/ct_telnet.xml | 2 +- lib/common_test/doc/src/event_handler_chapter.xml | 6 +- lib/common_test/doc/src/introduction.xml | 2 +- lib/common_test/doc/src/run_test_chapter.xml | 6 +- lib/common_test/doc/src/write_test_chapter.xml | 10 +- 10 files changed, 75 insertions(+), 75 deletions(-) (limited to 'lib/common_test/doc') diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml index 3f83747485..48ffe653e4 100644 --- a/lib/common_test/doc/src/common_test_app.xml +++ b/lib/common_test/doc/src/common_test_app.xml @@ -566,7 +566,7 @@ (which also causes the test case process to terminate).

Elements from the Config list can, for example, be read - with proplists:get_value/2 in STDLIB + with proplists:get_value/2 in STDLIB (or the macro ?config defined in ct.hrl).

If you decide not to run the test case after all, return diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml index 264bcff251..ffc64cba67 100644 --- a/lib/common_test/doc/src/ct.xml +++ b/lib/common_test/doc/src/ct.xml @@ -777,7 +777,7 @@ caught by any installed event manager.

See also - stdlib:gen_event(3).

+ gen_event(3).

@@ -1236,7 +1236,7 @@ Millisecs = integer() | float() -

This function, similar to timer:sleep/1 in STDLIB, +

This function, similar to timer:sleep/1 in STDLIB, suspends the test case for a specified time. However, this function also multiplies Time with the multiply_timetraps value (if set) and under certain @@ -1330,7 +1330,7 @@ caught by any installed event manager.

See also - stdlib:gen_event(3). + gen_event(3).

diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml index 3b1e564b66..c2cf29c530 100644 --- a/lib/common_test/doc/src/ct_hooks.xml +++ b/lib/common_test/doc/src/ct_hooks.xml @@ -94,7 +94,7 @@ ct_hooks:id/1, or a reference (created using erlang:make_ref/0 - in ERTS) if + in ERTS) if ct_hooks:id/1 is not implemented.

diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml index 1998f15697..0e4c35e11f 100644 --- a/lib/common_test/doc/src/ct_hooks_chapter.xml +++ b/lib/common_test/doc/src/ct_hooks_chapter.xml @@ -374,7 +374,7 @@ Example CTH

The following CTH logs information about a test run into a format parseable by file:consult/1 - (in Kernel): + (in Kernel):

%%% @doc Common Test Example Common Test Hook module. @@ -499,13 +499,13 @@ cth_log_redirect

Built-in

-

Captures all error_logger and SASL logging +

Captures all error_logger and SASL logging events and prints them to the current test case log. If an event cannot be associated with a test case, it is printed in the Common Test framework log. This happens for test cases running in parallel and events occuring in-between test cases. You can configure the level of - SASL events report - using the normal SASL mechanisms.

+ SASL events report + using the normal SASL mechanisms.

 cth_surefire diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml index d00737aa5a..137e4c3f1d 100644 --- a/lib/common_test/doc/src/ct_ssh.xml +++ b/lib/common_test/doc/src/ct_ssh.xml @@ -64,7 +64,7 @@

ConnType = ssh | sftp.

For other types, see - ssh:ssh(3).

+ ssh(3).

All time-out parameters in ct_ssh functions are values in milliseconds.

@@ -88,7 +88,7 @@ ssh_sftp_return() = term()

Return value from an - ssh:ssh_sftp + ssh_sftp function.

 @@ -104,7 +104,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -118,7 +118,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -132,7 +132,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -146,7 +146,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -160,7 +160,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -174,7 +174,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -188,7 +188,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -202,7 +202,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -216,7 +216,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -230,7 +230,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -310,7 +310,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -324,7 +324,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -338,7 +338,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -352,7 +352,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -423,7 +423,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -437,7 +437,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -451,7 +451,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -465,7 +465,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -479,7 +479,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -493,7 +493,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -507,7 +507,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -521,7 +521,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -535,7 +535,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -549,7 +549,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -563,7 +563,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -577,7 +577,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -591,7 +591,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -605,7 +605,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -619,7 +619,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -633,7 +633,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -647,7 +647,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -661,7 +661,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -675,7 +675,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -689,7 +689,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -703,7 +703,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -717,7 +717,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -731,7 +731,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -745,7 +745,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -759,7 +759,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -773,7 +773,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -787,7 +787,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -801,7 +801,7 @@

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -853,7 +853,7 @@ ChannelId, End, DefaultTimeout).

If End is a fun, this fun is called with one argument, the data value in a received ssh_cm message (see - ssh:ssh_connection(3). + ssh_connection(3). The fun is to return either true to end the receiving operation (and have the so far collected data returned) or false to wait for more data from the server. Even if a fun @@ -872,7 +872,7 @@ ChannelId, End, DefaultTimeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -886,7 +886,7 @@ ChannelId, End, DefaultTimeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -1070,7 +1070,7 @@ ChannelId, 0, Data, End, Timeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -1084,7 +1084,7 @@ ChannelId, 0, Data, End, Timeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -1098,7 +1098,7 @@ ChannelId, 0, Data, End, Timeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -1112,7 +1112,7 @@ ChannelId, 0, Data, End, Timeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -1126,7 +1126,7 @@ ChannelId, 0, Data, End, Timeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 @@ -1140,7 +1140,7 @@ ChannelId, 0, Data, End, Timeout).

For information and other types, see - ssh:ssh_sftp(3).

+ ssh_sftp(3).

 diff --git a/lib/common_test/doc/src/ct_telnet.xml b/lib/common_test/doc/src/ct_telnet.xml index e2a45e894b..eba3c3030d 100644 --- a/lib/common_test/doc/src/ct_telnet.xml +++ b/lib/common_test/doc/src/ct_telnet.xml @@ -198,7 +198,7 @@

Regular expression matching all possible prompts for a specific target type. regexp must not have any groups, that is, when - matching, re:run/3 (in STDLIB) must return a list with + matching, re:run/3 (in STDLIB) must return a list with one single element.

 diff --git a/lib/common_test/doc/src/event_handler_chapter.xml b/lib/common_test/doc/src/event_handler_chapter.xml index 2978226a19..bd9ed21cb4 100644 --- a/lib/common_test/doc/src/event_handler_chapter.xml +++ b/lib/common_test/doc/src/event_handler_chapter.xml @@ -50,7 +50,7 @@ pass the information on. The event handlers are Erlang modules implemented by the Common Test user according to the gen_event behavior (for details, see module - stdlib:gen_event and + gen_event and section gen_event Behaviour in OTP Design Principles in the System Documentation). @@ -69,8 +69,8 @@ manager, either by telling Common Test to install them before the test run (described later), or by adding the handlers dynamically during the test run using - stdlib:gen_event:add_handler/3 or - stdlib:gen_event:add_sup_handler/3. + gen_event:add_handler/3 or + gen_event:add_sup_handler/3. In the latter scenario, the reference of the Common Test event manager is required. To get it, call ct:get_event_mgr_ref/0 diff --git a/lib/common_test/doc/src/introduction.xml b/lib/common_test/doc/src/introduction.xml index 40724f24e9..df12bea6dd 100644 --- a/lib/common_test/doc/src/introduction.xml +++ b/lib/common_test/doc/src/introduction.xml @@ -45,7 +45,7 @@

Common Test also integrates use of the OTP cover tool in application - Tools for code coverage analysis of Erlang/OTP programs.

+ Tools for code coverage analysis of Erlang/OTP programs.

Common Test executes test suite programs automatically, without operator interaction. Test progress and results are diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index 43e36adfb6..76e306c4ed 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -274,7 +274,7 @@

Directories passed to Common Test can have either relative or absolute paths.

-

Any start flags to the Erlang runtime system (application ERTS) can also be passed as +

Any start flags to the Erlang runtime system (application ERTS) can also be passed as parameters to ct_run. It is, for example, useful to be able to pass directories to be added to the Erlang code server search path with flag -pa or -pz. If you have common help- or library @@ -286,7 +286,7 @@

The absolute path of directory chat_server/ebin is here passed to the code server. This is essential because relative paths are stored by the code server as relative, and Common Test changes - the current working directory of ERTS during the test run.

+ the current working directory of ERTS during the test run.

The ct_run program sets the exit status before shutting down. The following values @@ -1258,7 +1258,7 @@

The minor log files contain full details of every single test case, each in a separate file. This way, it is straightforward to compare the latest results to that of previous - test runs, even if the set of test cases changes. If application SASL + test runs, even if the set of test cases changes. If application SASL is running, its logs are also printed to the current minor log file by the cth_log_redirect built-in hook. diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml index 83daf771a6..7bd2ccf588 100644 --- a/lib/common_test/doc/src/write_test_chapter.xml +++ b/lib/common_test/doc/src/write_test_chapter.xml @@ -269,10 +269,10 @@

As parameter Config is a list of key-value tuples, that is, a data type called a property list, it can be handled by the - stdlib:proplists module. + proplists module. A value can, for example, be searched for and returned with function proplists:get_value/2. - Also, or alternatively, the general stdlib:lists + Also, or alternatively, the general lists module contains useful functions. Normally, the only operations performed on Config is insert (adding a tuple to the head of the list) and lookup. Common Test provides a simple macro named ?config, @@ -652,7 +652,7 @@ Parallel Test Cases and I/O

A parallel test case has a private I/O server as its group leader. (For a description of the group leader concept, see - ERTS). + ERTS). The central I/O server process, which handles the output from regular test cases and configuration functions, does not respond to I/O messages during execution of parallel groups. This is important to understand @@ -1032,8 +1032,8 @@ 6. Categorized error, importance = 99

The arguments Format and FormatArgs in ct:log/print/pal are - always passed on to the stdlib function io:format/3 (For details, - see the stdlib:io manual page).

+ always passed on to the STDLIB function io:format/3 (For details, + see the io manual page).

ct:pal/4 and ct:log/5 add headers to strings being printed to the log file. The strings are also wrapped in div tags with a CSS class -- cgit v1.2.3