From bbf554a601aad3a63cc6cbf4cc61e1cc777d67eb Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 1 Jun 2017 19:23:57 +0200
Subject: ssh: re-formulate timeouts in ssh_sftp:start_channel

---
 lib/ssh/doc/src/ssh_sftp.xml | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'lib')

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>
-- 
cgit v1.2.3