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.xml | 10 +++++----- lib/ssh/doc/src/ssh_client_channel.xml | 32 ++++++++++++++++---------------- lib/ssh/doc/src/ssh_client_key_api.xml | 8 ++++---- lib/ssh/doc/src/ssh_connection.xml | 4 ++-- lib/ssh/doc/src/ssh_file.xml | 12 ++++++------ lib/ssh/doc/src/ssh_server_channel.xml | 10 +++++----- lib/ssh/doc/src/ssh_server_key_api.xml | 6 +++--- lib/ssh/doc/src/ssh_sftp.xml | 4 ++-- 8 files changed, 43 insertions(+), 43 deletions(-) (limited to 'lib/ssh') diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 8435fced11..759c66d63c 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -1068,7 +1068,7 @@ connect(Host, Port, Options) -> Result connect(Host, Port, Options, NegotiationTimeout) -> Result - connect(TcpSocket, Options) -> Result + connect(TcpSocket, Options) -> Result connect(TcpSocket, Options, NegotiationTimeout) -> Result Connects to an SSH server. @@ -1154,7 +1154,7 @@ - + Get info about a daemon

Returns a key-value list with information about the daemon.

@@ -1164,7 +1164,7 @@ - + Get a list declaring the supported algorithms

Returns a key-value list, where the keys are the different types of algorithms and the values are the @@ -1227,7 +1227,7 @@ - + Stops the listener and all connections started by the listener.

Stops the listener and all connections started by the listener.

@@ -1237,7 +1237,7 @@ - + Stops the listener, but leaves existing connections started by the listener operational.

Stops the listener, but leaves existing connections started by the listener operational.

diff --git a/lib/ssh/doc/src/ssh_client_channel.xml b/lib/ssh/doc/src/ssh_client_channel.xml index 9be4007c68..cd28b95fd3 100644 --- a/lib/ssh/doc/src/ssh_client_channel.xml +++ b/lib/ssh/doc/src/ssh_client_channel.xml @@ -29,7 +29,7 @@ - ssh_client_channel + ssh_client_channel -behaviour(ssh_client_channel). (Replaces ssh_channel) @@ -68,8 +68,8 @@ - call(ChannelRef, Msg) -> - call(ChannelRef, Msg, Timeout) -> Reply | {error, Reason} + call(ChannelRef, Msg) -> + call(ChannelRef, Msg, Timeout) -> Reply | {error, Reason} Makes a synchronous call to a channel. ChannelRef = pid() @@ -92,7 +92,7 @@ - cast(ChannelRef, Msg) -> ok + cast(ChannelRef, Msg) -> ok Sends an asynchronous message to the channel ChannelRef and returns ok. @@ -111,7 +111,7 @@ - enter_loop(State) -> _ + enter_loop(State) -> _ Makes an existing process an ssh_client_channel (replaces ssh_channel) process. State = term() @@ -131,7 +131,7 @@ - init(Options) -> {ok, State} | {ok, State, Timeout} | {stop, Reason} + init(Options) -> {ok, State} | {ok, State, Timeout} | {stop, Reason} Initiates an ssh_client_channel process. Options = [{Option, Value}] @@ -173,7 +173,7 @@ - reply(Client, Reply) -> _ + reply(Client, Reply) -> _ Sends a reply to a client. Client = opaque() @@ -193,8 +193,8 @@ - start(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> - start_link(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> + start(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> + start_link(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> {ok, ChannelRef} | {error, Reason} Starts a process that handles an SSH channel. @@ -244,7 +244,7 @@ - Module:code_change(OldVsn, State, Extra) -> {ok, + Module:code_change(OldVsn, State, Extra) -> {ok, NewState} Converts process state when code is changed. @@ -287,7 +287,7 @@ - Module:init(Args) -> {ok, State} | {ok, State, timeout()} | + Module:init(Args) -> {ok, State} | {ok, State, timeout()} | {stop, Reason} Makes necessary initializations and returns the initial channel state if the initializations succeed. @@ -307,7 +307,7 @@ - Module:handle_call(Msg, From, State) -> Result + Module:handle_call(Msg, From, State) -> Result Handles messages sent by calling call/[2,3]. @@ -334,7 +334,7 @@ - Module:handle_cast(Msg, State) -> Result + Module:handle_cast(Msg, State) -> Result Handles messages sent by calling cast/2. @@ -355,7 +355,7 @@ - Module:handle_msg(Msg, State) -> {ok, State} | + Module:handle_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles other messages than SSH connection protocol, @@ -389,7 +389,7 @@ - Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, + Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles ssh connection protocol messages. @@ -416,7 +416,7 @@ - Module:terminate(Reason, State) -> _ + Module:terminate(Reason, State) -> _ Does cleaning up before channel process termination. diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml index bc77756147..9f2f3013e5 100644 --- a/lib/ssh/doc/src/ssh_client_key_api.xml +++ b/lib/ssh/doc/src/ssh_client_key_api.xml @@ -29,7 +29,7 @@ - ssh_client_key_api + ssh_client_key_api -behaviour(ssh_client_key_api). @@ -86,7 +86,7 @@ - Module:add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason} + Module:add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason} Adds a host key to the set of trusted host keys. HostNames = string() @@ -103,7 +103,7 @@ - Module:is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result + Module:is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result Checks if a host key is trusted. Key = public_key:public_key() @@ -125,7 +125,7 @@ - Module:user_key(Algorithm, ConnectOptions) -> + Module:user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason} Fetches the users public key matching the Algorithm. 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. diff --git a/lib/ssh/doc/src/ssh_file.xml b/lib/ssh/doc/src/ssh_file.xml index 6681d9c306..f1fef09083 100644 --- a/lib/ssh/doc/src/ssh_file.xml +++ b/lib/ssh/doc/src/ssh_file.xml @@ -28,7 +28,7 @@ - ssh_file + ssh_file Default callback module for the client's and server's database operations in the ssh application

This module is the default callback handler for the client's and the server's user and host "database" operations. @@ -169,7 +169,7 @@ - host_key(Algorithm, DaemonOptions) -> {ok, Key} | {error, Reason} + host_key(Algorithm, DaemonOptions) -> {ok, Key} | {error, Reason}

Types and description

@@ -195,7 +195,7 @@ - is_auth_key(PublicUserKey, User, DaemonOptions) -> Result + is_auth_key(PublicUserKey, User, DaemonOptions) -> Result

Types and description

@@ -216,7 +216,7 @@ - add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason} + add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason}

Types and description

@@ -235,7 +235,7 @@ - is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result + is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result

Types and description

@@ -254,7 +254,7 @@ - user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason} + user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason}

Types and description

diff --git a/lib/ssh/doc/src/ssh_server_channel.xml b/lib/ssh/doc/src/ssh_server_channel.xml index 31ba9a3231..a4e18bbfbf 100644 --- a/lib/ssh/doc/src/ssh_server_channel.xml +++ b/lib/ssh/doc/src/ssh_server_channel.xml @@ -29,7 +29,7 @@ - ssh_server_channel + ssh_server_channel -behaviour(ssh_server_channel). (Replaces ssh_daemon_channel) @@ -70,7 +70,7 @@ - Module:init(Args) -> {ok, State} | {ok, State, timeout()} | + Module:init(Args) -> {ok, State} | {ok, State, timeout()} | {stop, Reason} Makes necessary initializations and returns the initial channel state if the initializations succeed. @@ -93,7 +93,7 @@ - Module:handle_msg(Msg, State) -> {ok, State} | + Module:handle_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles other messages than SSH connection protocol, @@ -125,7 +125,7 @@ - Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, + Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles ssh connection protocol messages. @@ -152,7 +152,7 @@ - Module:terminate(Reason, State) -> _ + Module:terminate(Reason, State) -> _ Does cleaning up before channel process termination. diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml index e2a31bd5f5..013a788a4a 100644 --- a/lib/ssh/doc/src/ssh_server_key_api.xml +++ b/lib/ssh/doc/src/ssh_server_key_api.xml @@ -29,7 +29,7 @@ - ssh_server_key_api + ssh_server_key_api -behaviour(ssh_server_key_api). @@ -87,7 +87,7 @@ - Module:host_key(Algorithm, DaemonOptions) -> + Module:host_key(Algorithm, DaemonOptions) -> {ok, Key} | {error, Reason} Fetches the host’s private key. @@ -111,7 +111,7 @@ - Module:is_auth_key(PublicUserKey, User, DaemonOptions) -> Result + Module:is_auth_key(PublicUserKey, User, DaemonOptions) -> Result Checks if the user key is authorized. PublicUserKey = public_key:public_key() diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 8c105147d6..780e132ae2 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -285,8 +285,8 @@ - open_tar(ChannelPid, Path, Mode) -> - open_tar(ChannelPid, Path, Mode, Timeout) -> {ok, Handle} | {error, reason()} + open_tar(ChannelPid, Path, Mode) -> + open_tar(ChannelPid, Path, Mode, Timeout) -> {ok, Handle} | {error, reason()} Opens a tar file on the server to which ChannelPid is connected and returns a handle. -- cgit v1.2.3