From 84051a76ee4c07f7453ba2bf24fe32c8cf8c7b48 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 26 May 2016 15:33:18 +0200
Subject: ssh: ssh:connect, ssh:shell and ssh_sftp:start_subsystem supports
 client tcp-socket as input

---
 lib/ssh/doc/src/ssh.xml      |  8 ++++++--
 lib/ssh/doc/src/ssh_sftp.xml | 14 +++++++++++---
 2 files changed, 17 insertions(+), 5 deletions(-)

(limited to 'lib/ssh/doc')

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index ff2d6e082a..bd330e479f 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -124,9 +124,11 @@
     </func>
     
     <func>
+      <name>connect(TcpSocket, Options) -> </name>
+      <name>connect(TcpSocket, Options, Timeout) -> </name>
       <name>connect(Host, Port, Options) -> </name>
-      <name>connect(Host, Port, Options, Timeout) -> {ok,
-      ssh_connection_ref()} | {error, Reason}</name>
+      <name>connect(Host, Port, Options, Timeout) -> 
+      {ok, ssh_connection_ref()} | {error, Reason}</name>
       <fsummary>Connects to an SSH server.</fsummary>
       <type>
         <v>Host = string()</v>
@@ -137,6 +139,8 @@
 	<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>
+	<v>TcpSocket = port()</v>
+	<d>The socket is supposed to be from <c>gen_tcp:connect</c> with option <c>{active,false}</c></d>
       </type>
       <desc>
 	<p>Connects to an SSH server. No channel is started. This is done
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 071d46ec57..67531b7d99 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -526,16 +526,24 @@
     </func>
 
     <func>
+      <name>start_channel(TcpSocket) -></name>
+      <name>start_channel(TcpSocket, Options) ->
+      {ok, Pid, ConnectionRef} | {error, reason()|term()}</name>
+
       <name>start_channel(ConnectionRef) -></name>
-      <name>start_channel(ConnectionRef, Options) -></name>
+      <name>start_channel(ConnectionRef, Options) ->
+      {ok, Pid} | {error, reason()|term()}</name>
+
       <name>start_channel(Host, Options) -></name>
-      <name>start_channel(Host, Port, Options) -> {ok, Pid} | {ok, Pid, ConnectionRef} |
-      {error, reason()|term()}</name>
+      <name>start_channel(Host, Port, Options) -> 
+      {ok, Pid, ConnectionRef} | {error, reason()|term()}</name>
       <fsummary>Starts an SFTP client.</fsummary>
       <type>
         <v>Host = string()</v>
         <v>ConnectionRef = ssh_connection_ref()</v>
         <v>Port = integer()</v>
+	<v>TcpSocket = port()</v>
+	<d>The socket is supposed to be from <c>gen_tcp:connect</c> with option <c>{active,false}</c></d>
         <v>Options = [{Option, Value}]</v>
       </type>
       <desc>
-- 
cgit v1.2.3