From edbbc40fc3e4d5698408e109ac6f9fd301aae05f Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Mon, 5 Aug 2019 12:41:17 +0200
Subject: ssh: Update ssh_sftp:start_channel documentation and code

The Typing in the old documentation was not up-to-date.  The option
handling and definition is slightly re-worked in the code also.

Some comments added and a function moved inside the module.
---
 lib/ssh/doc/src/ssh_sftp.xml | 32 ++++++++++++++++++++------------
 1 file changed, 20 insertions(+), 12 deletions(-)

(limited to 'lib/ssh/doc/src')

diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 76d2b21946..f9f1e0953b 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -38,6 +38,12 @@
   </description>
   
   <datatypes>
+    <datatype>
+      <name name="sftp_option"/>
+      <desc>
+      </desc>
+    </datatype>
+
     <datatype_title>Error cause</datatype_title>
     <datatype>
       <name name="reason"/>
@@ -423,25 +429,27 @@
 
     <func>
       <name since="">start_channel(ConnectionRef) -></name>
-      <name since="">start_channel(ConnectionRef, Options) ->
-      {ok, Pid} | {error, reason()|term()}</name>
+      <name since="">start_channel(ConnectionRef, SftpOptions) ->
+      {ok, ChannelPid} | Error</name>
 
+      <name since="">start_channel(Host) -></name>
       <name since="">start_channel(Host, Options) -></name>
-      <name since="">start_channel(Host, Port, Options) -> 
-      {ok, Pid, ConnectionRef} | {error, reason()|term()}</name>
-
+      <name since="">start_channel(Host, Port, Options) -></name>
       <name since="">start_channel(TcpSocket) -></name>
       <name since="">start_channel(TcpSocket, Options) ->
-      {ok, Pid, ConnectionRef} | {error, reason()|term()}</name>
+      {ok, ChannelPid, ConnectionRef} | Error</name>
 
       <fsummary>Starts an SFTP client.</fsummary>
       <type>
-        <v>Host = string()</v>
-        <v>ConnectionRef = connection_ref()</v>
-        <v>Port = integer()</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>
-        <v>Options = [{Option, Value}]</v>
+        <v>Host = <seealso marker="ssh:ssh#type-host">ssh:host()</seealso></v>
+        <v>Port = <seealso marker="kernel:inet#type-port_number">inet:port_number()</seealso></v>
+	<v>TcpSocket = <seealso marker="ssh:ssh#type-open_socket">ssh:open_socket()</seealso></v>
+	<v>Options = [  <seealso marker="#type-sftp_option">sftp_option()</seealso>
+		      | <seealso marker="ssh:ssh#type-client_option">ssh:client_option()</seealso> ]</v>
+	<v>SftpOptions = [  <seealso marker="#type-sftp_option">sftp_option()</seealso> ]</v>
+	<v>ChannelPid = pid()</v>
+        <v>ConnectionRef = <seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso></v>
+	<v>Error = {error, <seealso marker="#type-reason">reason()</seealso>}</v>
       </type>
       <desc>
 	<p>If no connection reference is provided, a connection is set
-- 
cgit v1.2.3