From 422ed9ecd9c95c25964381b7ca2888a0320a8ee4 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Wed, 6 Nov 2013 10:54:02 +0100
Subject: ssh: Simplify handling of connection attributes (e.i. user and
 sockname)

OTP-11296
---
 lib/ssh/doc/src/ssh.xml | 34 +++++-----------------------------
 1 file changed, 5 insertions(+), 29 deletions(-)

(limited to 'lib/ssh/doc')

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index b338241685..3409681af4 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -198,8 +198,11 @@
       Value}] </name>
       <fsummary> Retrieves information about a connection. </fsummary>
       <type>
-        <v>Option = client_version | server_version | peer</v>
-	<v>Value = term() </v>
+        <v>Option = client_version | server_version | user | peer | sockname </v>
+	<v>Value = [option_value()] </v>
+	<v>option_value() = {{Major::integer(), Minor::integer()}, VersionString::string()} | User::string() |
+	Peer::{inet:hostname(), {inet::ip_adress(), inet::port_number()}} |
+	Sockname::{inet::ip_adress(), inet::port_number()} () </v>
       </type>
       <desc>
         <p> Retrieves information about a connection. 
@@ -325,19 +328,6 @@
       </desc>
     </func>
 
-    <func>
-      <name>peername(ConnectionRef) -> {ok, {Address,Port}} | {error,Error} </name>
-      <fsummary> </fsummary>
-      <type>
-	<v> ConnectionRef = ssh_connection_ref()</v>
-        <v> Address = ip_address()</v>
-	<v> Port = integer()</v>
-      </type>
-      <desc>
-        <p>Returns the address and port for the other end of a connection.
-	</p>
-      </desc>
-    </func>
 
     <func>
       <name>shell(Host) -> </name>
@@ -358,20 +348,6 @@
       </desc>
     </func>
 
-    <func>
-      <name>sockname(ConnectionRef) -> {ok, {Address,Port}} | {error,Error} </name>
-      <fsummary> </fsummary>
-      <type>
-	<v> ConnectionRef = ssh_connection_ref()</v>
-        <v> Address = ip_address()</v>
-	<v> Port = integer()</v>
-      </type>
-      <desc>
-        <p>Returns the local address and port number for a connection.
-	</p>
-      </desc>
-    </func>
-
     <func>
       <name>start() -> </name>
       <name>start(Type) -> ok | {error, Reason}</name>
-- 
cgit v1.2.3