diff options
| author | Hans Nilsson <hans@erlang.org> | 2017-06-01 19:23:57 +0200 |
|---|---|---|
| committer | Hans Nilsson <hans@erlang.org> | 2017-06-12 15:20:32 +0200 |
| commit | bbf554a601aad3a63cc6cbf4cc61e1cc777d67eb (patch) | |
| tree | 3de77cbd0d114fd5cc9d8b8ada6a2bde1253d3ae /lib/ssh/doc/src | |
| parent | 49e7329b04af4f4f93d0f5c3e6900e3473d765d2 (diff) | |
| download | erlang-bbf554a601aad3a63cc6cbf4cc61e1cc777d67eb.tar.gz | |
ssh: re-formulate timeouts in ssh_sftp:start_channel
Diffstat (limited to 'lib/ssh/doc/src')
| -rw-r--r-- | lib/ssh/doc/src/ssh_sftp.xml | 10 |
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> |