aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2015-04-23 15:31:04 +0200
committerHans Nilsson <[email protected]>2015-04-23 15:31:04 +0200
commit5e7158109d659d6b8668250e308c3c4dd57f15ae (patch)
tree2270c2cd41cafad082ef1ffe6b4c912dd83643a1
parent851db53855b5e47e0861da2616fe87b2b81d3cff (diff)
downloadotp-5e7158109d659d6b8668250e308c3c4dd57f15ae.tar.gz
otp-5e7158109d659d6b8668250e308c3c4dd57f15ae.tar.bz2
otp-5e7158109d659d6b8668250e308c3c4dd57f15ae.zip
ssh: Timeout unit and default added to some missing places
-rw-r--r--lib/ssh/doc/src/ssh.xml9
-rw-r--r--lib/ssh/doc/src/ssh_sftp.xml2
2 files changed, 6 insertions, 5 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 9034c5ee6d..35b5eb87cb 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -106,9 +106,9 @@
<d><c><![CDATA[22]]></c> is default, the assigned well-known port
number for SSH.</d>
<v>Options = [{Option, Value}]</v>
- <v>Timeout = infinity | integer(milliseconds)</v>
- <d>Negotiation time-out. For connection time-out, use option
- <c>{connect_timeout, timeout()}</c>.</d>
+ <v>Timeout = infinity | integer()</v>
+ <d>Negotiation time-out in milli-seconds. The default value is <c>infinity</c>.
+ For connection time-out, use option <c>{connect_timeout, timeout()}</c>.</d>
</type>
<desc>
<p>Connects to an SSH server. No channel is started. This is done
@@ -177,7 +177,8 @@
<tag><c><![CDATA[{connect_timeout, timeout()}]]></c></tag>
<item>
<p>Sets a time-out on the transport layer
- connection. Defaults to <c>infinity</c>.</p>
+ connection. For <c>gen_tcp</c> the time is in milli-seconds and the default value is
+ <c>infinity</c>.</p>
</item>
<tag><c><![CDATA[{user, string()}]]></c></tag>
<item>
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 4ed5a38de4..1a3705b341 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -46,7 +46,7 @@
<tag><c>ssh_connection_ref()</c></tag>
<item><p>Opaque to the user, returned by <c>ssh:connect/3</c></p></item>
<tag><c>timeout()</c></tag>
- <item><p>= <c>infinity | integer() in milliseconds</c></p></item>
+ <item><p>= <c>infinity | integer() in milliseconds. Default infinity.</c></p></item>
</taglist>
</section>