From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Tue, 11 Dec 2018 17:42:39 +0100 Subject: Add "since" attributes in xml for new functions and modules introduced after OTP_R13B03. --- lib/ssh/doc/src/ssh_connection.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/ssh/doc/src/ssh_connection.xml') diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 8e1cf156a8..7933cff511 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -298,8 +298,8 @@ - ptty_alloc(ConnectionRef, ChannelId, Options) -> - ptty_alloc(ConnectionRef, ChannelId, Options, Timeout) -> > ssh_request_status() | + ptty_alloc(ConnectionRef, ChannelId, Options) -> + ptty_alloc(ConnectionRef, ChannelId, Options, Timeout) -> > ssh_request_status() | {error, reason()} Sends an SSH Connection Protocol pty_req, to allocate a pseudo-terminal. -- cgit v1.2.3 From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/ssh/doc/src/ssh_connection.xml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'lib/ssh/doc/src/ssh_connection.xml') diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 7933cff511..2a701929f6 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -30,7 +30,7 @@ - ssh_connection + ssh_connection This module provides API functions to send SSH Connection Protocol events to the other side of an SSH channel. @@ -201,7 +201,7 @@ - adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok + adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok Adjusts the SSH flow control window. ConnectionRef = connection_ref() @@ -221,7 +221,7 @@ - close(ConnectionRef, ChannelId) -> ok + close(ConnectionRef, ChannelId) -> ok Sends a close message on the channel ChannelId. ConnectionRef = connection_ref() @@ -240,7 +240,7 @@ - exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | + exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | {error, reason()} Requests that the server starts the execution of the given command. @@ -284,7 +284,7 @@ - exit_status(ConnectionRef, ChannelId, Status) -> ok + exit_status(ConnectionRef, ChannelId, Status) -> ok Sends the exit status of a command to the client. ConnectionRef = connection_ref() @@ -339,7 +339,7 @@ - reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok + reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok Sends status replies to requests that want such replies. ConnectionRef = connection_ref() @@ -357,10 +357,10 @@ - send(ConnectionRef, ChannelId, Data) -> - send(ConnectionRef, ChannelId, Data, Timeout) -> - send(ConnectionRef, ChannelId, Type, Data) -> - send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> + send(ConnectionRef, ChannelId, Data) -> + send(ConnectionRef, ChannelId, Data, Timeout) -> + send(ConnectionRef, ChannelId, Type, Data) -> + send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> ok | {error, timeout} | {error, closed} Sends channel data. @@ -380,7 +380,7 @@ - send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} + send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} Sends EOF on channel ChannelId. ConnectionRef = connection_ref() @@ -392,8 +392,8 @@ - session_channel(ConnectionRef, Timeout) -> - session_channel(ConnectionRef, InitialWindowSize, + session_channel(ConnectionRef, Timeout) -> + session_channel(ConnectionRef, InitialWindowSize, MaxPacketSize, Timeout) -> {ok, channel_id()} | {error, reason()} Opens a channel for an SSH session. @@ -410,7 +410,7 @@ - setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | + setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | {error, reason()} Environment variables can be passed to the shell/command to be started later. @@ -428,7 +428,7 @@ - shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} + shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} Requests that the user default shell (typically defined in /etc/passwd in Unix systems) is to be executed at the server end. @@ -448,7 +448,7 @@ - subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | + subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | {error, reason()} Requests to execute a predefined subsystem on the server. -- cgit v1.2.3