aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src/ct_slave.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/common_test/doc/src/ct_slave.xml')
-rw-r--r--lib/common_test/doc/src/ct_slave.xml22
1 files changed, 11 insertions, 11 deletions
diff --git a/lib/common_test/doc/src/ct_slave.xml b/lib/common_test/doc/src/ct_slave.xml
index 4533de92f7..ceebf51f1a 100644
--- a/lib/common_test/doc/src/ct_slave.xml
+++ b/lib/common_test/doc/src/ct_slave.xml
@@ -12,12 +12,12 @@
<rev>A</rev>
<file>ct_slave.xml</file></header>
<module>ct_slave</module>
-<modulesummary>Common Test Framework functions for starting and stopping nodes for
+<modulesummary>Common Test Framework functions for starting and stopping nodes for
Large Scale Testing.</modulesummary>
<description>
-<p>Common Test Framework functions for starting and stopping nodes for
+<p>Common Test Framework functions for starting and stopping nodes for
Large Scale Testing.</p>
-
+
<p>This module exports functions which are used by the Common Test Master
to start and stop "slave" nodes. It is the default callback module for the
<c>{init, node_start}</c> term of the Test Specification.</p></description>
@@ -56,16 +56,16 @@ Large Scale Testing.</p>
<p>Starts an Erlang node with name <c>Node</c> on host
<c>Host</c> as specified by the combination of options in
<c>Opts</c>.</p>
-
+
<p>Options <c>Username</c> and <c>Password</c> will be used
to log in onto the remote host <c>Host</c>.
Username, if omitted, defaults to the current user name,
and password is empty by default.</p>
-
+
<p>A list of functions specified in the <c>Startup</c> option will be
executed after startup of the node. Note that all used modules should be
present in the code path on the <c>Host</c>.</p>
-
+
<p>The timeouts are applied as follows:
<list>
<item>
@@ -87,18 +87,18 @@ Large Scale Testing.</p>
<c>{error, startup_timeout, NodeName}</c> is returned.
</item>
</list></p>
-
+
<p>Option <c>monitor_master</c> specifies, if the slave node should be
stopped in case of master node stop. Defaults to false.</p>
-
+
<p>Option <c>kill_if_fail</c> specifies, if the slave node should be
killed in case of a timeout during initialization or startup.
Defaults to true. Note that node also may be still alive it the boot
timeout occurred, but it will not be killed in this case.</p>
-
+
<p>Option <c>erlang_flags</c> specifies, which flags will be added
to the parameters of the <c>erl</c> executable.</p>
-
+
<p>Special return values are:
<list>
<item><c>{error, already_started, NodeName}</c> - if the node with
@@ -109,7 +109,7 @@ Large Scale Testing.</p>
<c>ct_slave:start/3</c> is called, is not alive. Note that
<c>NodeName</c> is the name of current node in this case.</item>
</list></p>
-
+
</desc></func>
<func>
<name>stop(Node) -&gt; Result</name>