summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnders Svensson <anders@erlang.org>2019-05-21 09:31:40 +0200
committerAnders Svensson <anders@erlang.org>2019-06-03 15:00:19 +0200
commit54f156f9249fbe9b1e1381caac92d7f62c7fb26d (patch)
tree90aa03d0afc4e96bf97d1d574a1fef736b08e304
parent2bf1245b49ce354882957ba02d9e6cf51a0f7047 (diff)
downloaderlang-54f156f9249fbe9b1e1381caac92d7f62c7fb26d.tar.gz
Document connect/hello timeout in one place
With the type, not separately for each function in which it's referenced.
-rw-r--r--lib/common_test/doc/src/ct_netconfc.xml26
1 files changed, 8 insertions, 18 deletions
diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml
index 09db14256c..c584fe8f3d 100644
--- a/lib/common_test/doc/src/ct_netconfc.xml
+++ b/lib/common_test/doc/src/ct_netconfc.xml
@@ -244,6 +244,14 @@
and <c>user_dir</c>. The <c>SshConnectOptions</c> are
verfied by the SSH application.</p>
+ <p>Option <c>timeout</c> specifies the number of
+ milliseconds to allow for connection establishment and, if the
+ function in question results in an outgoing hello message,
+ reception of the server hello. The timeout applies to
+ connection and hello independently;
+ one timeout for connection establishment, another for hello
+ reception.</p>
+
<p>Option <c>capability</c> specifies the content of a
corresponding element in an outgoing hello message: each
option specifies the content of a single element as a list of
@@ -365,10 +373,6 @@
function is required as connection identifier when opening
sessions over this connection, see
<seealso marker="#session-1"><c>session/1,2,3</c></seealso>.</p>
-
- <p>Option <c>timeout</c> (milliseconds) is used when setting up the
- SSH connection. It is not used for any other purposes during the
- lifetime of the connection.</p>
</desc>
</func>
@@ -403,10 +407,6 @@
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>Option <c>timeout</c> (milliseconds) is used when setting up the
- SSH connection. It is not used for any other purposes during the
- lifetime of the connection.</p>
</desc>
</func>
@@ -738,11 +738,6 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)</pre>
reference returned from this
function is required as client identifier when calling any other
function in this module.</p>
-
- <p>Option <c>timeout</c> (milliseconds) is used when setting up the
- SSH connection and when waiting for the <c>hello</c> message from
- the server. It is not used for any other purposes during the
- lifetime of the connection.</p>
</desc>
</func>
@@ -778,11 +773,6 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)</pre>
be used instead of
<seealso marker="#type-handle"><c>handle()</c></seealso>.</p>
- <p>Option <c>timeout</c> (milliseconds) is used when setting up the
- SSH connection and when waiting for the <c>hello</c> message from
- the server. It is not used for any other purposes during the
- lifetime of the connection.</p>
-
<p>See also
<seealso marker="ct#require-2"><c>ct:require/2</c></seealso>.</p>
</desc>