From d7d109ca8ab68d7a62772305d543123233d4eea4 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Wed, 1 Jun 2016 16:43:29 +0200
Subject: ssh: update connect doc

---
 lib/ssh/doc/src/ssh.xml      | 13 ++++++++-----
 lib/ssh/doc/src/ssh_sftp.xml | 11 ++++++-----
 2 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index bd330e479f..501ca36b09 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -124,10 +124,10 @@
     </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) -> 
+      <name>connect(Host, Port, Options, Timeout) -> </name>
+      <name>connect(TcpSocket, Options) -> </name>
+      <name>connect(TcpSocket, Options, Timeout) -> 
       {ok, ssh_connection_ref()} | {error, Reason}</name>
       <fsummary>Connects to an SSH server.</fsummary>
       <type>
@@ -140,7 +140,7 @@
 	<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>
+	<d>The socket is supposed to be from <seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect</seealso> or <seealso marker="kernel:gen_tcp#accept-1">gen_tcp:accept</seealso> with option <c>{active,false}</c></d>
       </type>
       <desc>
 	<p>Connects to an SSH server. No channel is started. This is done
@@ -722,12 +722,15 @@
     <func>
       <name>shell(Host) -> </name>
       <name>shell(Host, Option) -> </name>
-      <name>shell(Host, Port, Option) -> _</name>
+      <name>shell(Host, Port, Option) -> </name>
+      <name>shell(TcpSocket) -> _</name>
       <fsummary>Starts an interactive shell over an SSH server.</fsummary>
       <type>
         <v>Host = string()</v>
 	<v>Port = integer()</v>
 	<v>Options - see ssh:connect/3</v>
+	<v>TcpSocket = port()</v>
+	<d>The socket is supposed to be from <seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect</seealso> or <seealso marker="kernel:gen_tcp#accept-1">gen_tcp:accept</seealso> with option <c>{active,false}</c></d>
       </type>
       <desc>
         <p>Starts an interactive shell over an SSH server on the
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 67531b7d99..eb6f43d417 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -526,10 +526,6 @@
     </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) ->
       {ok, Pid} | {error, reason()|term()}</name>
@@ -537,13 +533,18 @@
       <name>start_channel(Host, Options) -></name>
       <name>start_channel(Host, Port, Options) -> 
       {ok, Pid, ConnectionRef} | {error, reason()|term()}</name>
+
+      <name>start_channel(TcpSocket) -></name>
+      <name>start_channel(TcpSocket, 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>
+	<d>The socket is supposed to be from <seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect</seealso> or <seealso marker="kernel:gen_tcp#accept-1">gen_tcp:accept</seealso> with option <c>{active,false}</c></d>
         <v>Options = [{Option, Value}]</v>
       </type>
       <desc>
-- 
cgit v1.2.3