aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2017-06-13 10:26:07 +0200
committerHans Nilsson <[email protected]>2017-06-13 10:26:07 +0200
commit5ad7181e0ff5fb5060177a56562e0241e9f5a212 (patch)
tree99f160a35d9a7f8a3ea82fb811677e6c5b66e592
parent854fa6c03a397f838a8b7e6aa6c826acfe8f6572 (diff)
parentbbf554a601aad3a63cc6cbf4cc61e1cc777d67eb (diff)
downloadotp-5ad7181e0ff5fb5060177a56562e0241e9f5a212.tar.gz
otp-5ad7181e0ff5fb5060177a56562e0241e9f5a212.tar.bz2
otp-5ad7181e0ff5fb5060177a56562e0241e9f5a212.zip
Merge branch 'hans/ssh/doc_clearify_timeouts/OTP-14216'
-rw-r--r--lib/ssh/doc/src/ssh_sftp.xml10
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index eb6f43d417..2822bf808f 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -558,8 +558,14 @@
<taglist>
<tag><c><![CDATA[{timeout, timeout()}]]></c></tag>
<item>
- <p>The time-out is passed to the <c>ssh_channel</c> start function,
- and defaults to <c>infinity</c>.</p>
+ <p>There are two ways to set a timeout for the underlying ssh connection:</p>
+ <list>
+ <item>If the connection timeout option <c>connect_timeout</c> is set, that value
+ is used also for the negotiation timeout and this option (<c>timeout</c>) is ignored.</item>
+ <item>Otherwise, this option (<c>timeout</c>) is used as the negotiation timeout
+ only and there is no connection timeout set</item>
+ </list>
+ <p>The value defaults to <c>infinity</c>.</p>
</item>
<tag>
<c><![CDATA[{sftp_vsn, integer()}]]></c>