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/common_test/doc/src/ct_ssh.xml | 148 ++++++++++++++++++------------------- 1 file changed, 74 insertions(+), 74 deletions(-) (limited to 'lib/common_test/doc/src/ct_ssh.xml') diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml index bb0aaa46b7..8d9f31aff8 100644 --- a/lib/common_test/doc/src/ct_ssh.xml +++ b/lib/common_test/doc/src/ct_ssh.xml @@ -32,7 +32,7 @@ A ct_ssh.xml - ct_ssh + ct_ssh SSH/SFTP client module. @@ -95,7 +95,7 @@ - apread(SSH, Handle, Position, Length) -> Result + apread(SSH, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -109,7 +109,7 @@ - apread(SSH, Server, Handle, Position, Length) -> Result + apread(SSH, Server, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -123,7 +123,7 @@ - apwrite(SSH, Handle, Position, Data) -> Result + apwrite(SSH, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -137,7 +137,7 @@ - apwrite(SSH, Server, Handle, Position, Data) -> Result + apwrite(SSH, Server, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -151,7 +151,7 @@ - aread(SSH, Handle, Len) -> Result + aread(SSH, Handle, Len) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -165,7 +165,7 @@ - aread(SSH, Server, Handle, Len) -> Result + aread(SSH, Server, Handle, Len) -> Result For inforamtion and other types, see ssh_sftp(3). SSH = connection() @@ -179,7 +179,7 @@ - awrite(SSH, Handle, Data) -> Result + awrite(SSH, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -193,7 +193,7 @@ - awrite(SSH, Server, Handle, Data) -> Result + awrite(SSH, Server, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -207,7 +207,7 @@ - close(SSH, Handle) -> Result + close(SSH, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -221,7 +221,7 @@ - close(SSH, Server, Handle) -> Result + close(SSH, Server, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -235,7 +235,7 @@ - connect(KeyOrName) -> {ok, Handle} | {error, Reason} + connect(KeyOrName) -> {ok, Handle} | {error, Reason} Equivalent to connect(KeyOrName, host, []).

Equivalent to @@ -245,7 +245,7 @@ - connect(KeyOrName, ConnType) -> {ok, Handle} | {error, Reason} + connect(KeyOrName, ConnType) -> {ok, Handle} | {error, Reason} Equivalent to connect(KeyOrName, ConnType, []).

Equivalent to @@ -255,7 +255,7 @@ - connect(KeyOrName, ConnType, ExtraOpts) -> {ok, Handle} | {error, Reason} + connect(KeyOrName, ConnType, ExtraOpts) -> {ok, Handle} | {error, Reason} Opens an SSH or SFTP connection using the information associated with KeyOrName. @@ -301,7 +301,7 @@ - del_dir(SSH, Name) -> Result + del_dir(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -315,7 +315,7 @@ - del_dir(SSH, Server, Name) -> Result + del_dir(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -329,7 +329,7 @@ - delete(SSH, Name) -> Result + delete(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -343,7 +343,7 @@ - delete(SSH, Server, Name) -> Result + delete(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -357,7 +357,7 @@ - disconnect(SSH) -> ok | {error, Reason} + disconnect(SSH) -> ok | {error, Reason} Closes an SSH/SFTP connection. SSH = connection() @@ -369,7 +369,7 @@ - exec(SSH, Command) -> {ok, Data} | {error, Reason} + exec(SSH, Command) -> {ok, Data} | {error, Reason} Equivalent to exec(SSH, Command, DefaultTimeout).

Equivalent to @@ -379,7 +379,7 @@ - exec(SSH, Command, Timeout) -> {ok, Data} | {error, Reason} + exec(SSH, Command, Timeout) -> {ok, Data} | {error, Reason} Requests server to perform Command. SSH = connection() @@ -396,7 +396,7 @@ - exec(SSH, ChannelId, Command, Timeout) -> {ok, Data} | {error, Reason} + exec(SSH, ChannelId, Command, Timeout) -> {ok, Data} | {error, Reason} Requests server to perform Command. SSH = connection() @@ -414,7 +414,7 @@ - get_file_info(SSH, Handle) -> Result + get_file_info(SSH, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -428,7 +428,7 @@ - get_file_info(SSH, Server, Handle) -> Result + get_file_info(SSH, Server, Handle) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -442,7 +442,7 @@ - list_dir(SSH, Path) -> Result + list_dir(SSH, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -456,7 +456,7 @@ - list_dir(SSH, Server, Path) -> Result + list_dir(SSH, Server, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -470,7 +470,7 @@ - make_dir(SSH, Name) -> Result + make_dir(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -484,7 +484,7 @@ - make_dir(SSH, Server, Name) -> Result + make_dir(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -498,7 +498,7 @@ - make_symlink(SSH, Name, Target) -> Result + make_symlink(SSH, Name, Target) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -512,7 +512,7 @@ - make_symlink(SSH, Server, Name, Target) -> Result + make_symlink(SSH, Server, Name, Target) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -526,7 +526,7 @@ - open(SSH, File, Mode) -> Result + open(SSH, File, Mode) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -540,7 +540,7 @@ - open(SSH, Server, File, Mode) -> Result + open(SSH, Server, File, Mode) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -554,7 +554,7 @@ - opendir(SSH, Path) -> Result + opendir(SSH, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -568,7 +568,7 @@ - opendir(SSH, Server, Path) -> Result + opendir(SSH, Server, Path) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -582,7 +582,7 @@ - position(SSH, Handle, Location) -> Result + position(SSH, Handle, Location) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -596,7 +596,7 @@ - position(SSH, Server, Handle, Location) -> Result + position(SSH, Server, Handle, Location) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -610,7 +610,7 @@ - pread(SSH, Handle, Position, Length) -> Result + pread(SSH, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -624,7 +624,7 @@ - pread(SSH, Server, Handle, Position, Length) -> Result + pread(SSH, Server, Handle, Position, Length) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -638,7 +638,7 @@ - pwrite(SSH, Handle, Position, Data) -> Result + pwrite(SSH, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -652,7 +652,7 @@ - pwrite(SSH, Server, Handle, Position, Data) -> Result + pwrite(SSH, Server, Handle, Position, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -666,7 +666,7 @@ - read(SSH, Handle, Len) -> Result + read(SSH, Handle, Len) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -680,7 +680,7 @@ - read(SSH, Server, Handle, Len) -> Result + read(SSH, Server, Handle, Len) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -694,7 +694,7 @@ - read_file(SSH, File) -> Result + read_file(SSH, File) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -708,7 +708,7 @@ - read_file(SSH, Server, File) -> Result + read_file(SSH, Server, File) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -722,7 +722,7 @@ - read_file_info(SSH, Name) -> Result + read_file_info(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -736,7 +736,7 @@ - read_file_info(SSH, Server, Name) -> Result + read_file_info(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -750,7 +750,7 @@ - read_link(SSH, Name) -> Result + read_link(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -764,7 +764,7 @@ - read_link(SSH, Server, Name) -> Result + read_link(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -778,7 +778,7 @@ - read_link_info(SSH, Name) -> Result + read_link_info(SSH, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -792,7 +792,7 @@ - read_link_info(SSH, Server, Name) -> Result + read_link_info(SSH, Server, Name) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -806,7 +806,7 @@ - receive_response(SSH, ChannelId) -> {ok, Data} | {error, Reason} + receive_response(SSH, ChannelId) -> {ok, Data} | {error, Reason} Equivalent to receive_response(SSH, ChannelId, close). @@ -817,7 +817,7 @@ ChannelId, close).

- receive_response(SSH, ChannelId, End) -> {ok, Data} | {error, Reason} + receive_response(SSH, ChannelId, End) -> {ok, Data} | {error, Reason} Equivalent to receive_response(SSH, ChannelId, End, DefaultTimeout). @@ -828,7 +828,7 @@ ChannelId, End, DefaultTimeout).

- receive_response(SSH, ChannelId, End, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason} + receive_response(SSH, ChannelId, End, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason} Receives expected data from server on the specified session channel. @@ -863,7 +863,7 @@ ChannelId, End, DefaultTimeout).

- rename(SSH, OldName, NewName) -> Result + rename(SSH, OldName, NewName) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -877,7 +877,7 @@ ChannelId, End, DefaultTimeout).

- rename(SSH, Server, OldName, NewName) -> Result + rename(SSH, Server, OldName, NewName) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -891,7 +891,7 @@ ChannelId, End, DefaultTimeout).

- send(SSH, ChannelId, Data) -> ok | {error, Reason} + send(SSH, ChannelId, Data) -> ok | {error, Reason} Equivalent to send(SSH, ChannelId, 0, Data, DefaultTimeout). @@ -901,7 +901,7 @@ ChannelId, End, DefaultTimeout).

- send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason} + send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason} Equivalent to send(SSH, ChannelId, 0, Data, Timeout).

Equivalent to ct_ssh:send(SSH, @@ -910,7 +910,7 @@ ChannelId, End, DefaultTimeout).

- send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason} + send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason} Sends data to server on specified session channel. SSH = connection() @@ -926,7 +926,7 @@ ChannelId, End, DefaultTimeout).

- send_and_receive(SSH, ChannelId, Data) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Data) -> {ok, Data} | {error, Reason} Equivalent to send_and_receive(SSH, ChannelId, Data, close). @@ -937,7 +937,7 @@ ChannelId, End, DefaultTimeout).

- send_and_receive(SSH, ChannelId, Data, End) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Data, End) -> {ok, Data} | {error, Reason} Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End, DefaultTimeout). @@ -948,7 +948,7 @@ ChannelId, 0, Data, End, DefaultTimeout).

- send_and_receive(SSH, ChannelId, Data, End, Timeout) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Data, End, Timeout) -> {ok, Data} | {error, Reason} Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End, Timeout). @@ -959,7 +959,7 @@ ChannelId, 0, Data, End, Timeout).

- send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> {ok, Data} | {error, Reason} + send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> {ok, Data} | {error, Reason} Sends data to server on specified session channel and waits to receive the server response. @@ -981,7 +981,7 @@ ChannelId, 0, Data, End, Timeout).

- session_close(SSH, ChannelId) -> ok | {error, Reason} + session_close(SSH, ChannelId) -> ok | {error, Reason} Closes an SSH session channel. SSH = connection() @@ -994,7 +994,7 @@ ChannelId, 0, Data, End, Timeout).

- session_open(SSH) -> {ok, ChannelId} | {error, Reason} + session_open(SSH) -> {ok, ChannelId} | {error, Reason} Equivalent to session_open(SSH, DefaultTimeout).

Equivalent to @@ -1004,7 +1004,7 @@ ChannelId, 0, Data, End, Timeout).

- session_open(SSH, Timeout) -> {ok, ChannelId} | {error, Reason} + session_open(SSH, Timeout) -> {ok, ChannelId} | {error, Reason} Opens a channel for an SSH session. SSH = connection() @@ -1018,7 +1018,7 @@ ChannelId, 0, Data, End, Timeout).

- sftp_connect(SSH) -> {ok, Server} | {error, Reason} + sftp_connect(SSH) -> {ok, Server} | {error, Reason} Starts an SFTP session on an already existing SSH connection. @@ -1061,7 +1061,7 @@ ChannelId, 0, Data, End, Timeout).

- subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason} + subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason} Equivalent to subsystem(SSH, ChannelId, Subsystem, DefaultTimeout). @@ -1072,7 +1072,7 @@ ChannelId, 0, Data, End, Timeout).

- subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Reason} + subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Reason} Sends a request to execute a predefined subsystem. SSH = connection() @@ -1088,7 +1088,7 @@ ChannelId, 0, Data, End, Timeout).

- write(SSH, Handle, Data) -> Result + write(SSH, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1102,7 +1102,7 @@ ChannelId, 0, Data, End, Timeout).

- write(SSH, Server, Handle, Data) -> Result + write(SSH, Server, Handle, Data) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1116,7 +1116,7 @@ ChannelId, 0, Data, End, Timeout).

- write_file(SSH, File, Iolist) -> Result + write_file(SSH, File, Iolist) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1130,7 +1130,7 @@ ChannelId, 0, Data, End, Timeout).

- write_file(SSH, Server, File, Iolist) -> Result + write_file(SSH, Server, File, Iolist) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1144,7 +1144,7 @@ ChannelId, 0, Data, End, Timeout).

- write_file_info(SSH, Name, Info) -> Result + write_file_info(SSH, Name, Info) -> Result For information and other types, see ssh_sftp(3). SSH = connection() @@ -1158,7 +1158,7 @@ ChannelId, 0, Data, End, Timeout).

- write_file_info(SSH, Server, Name, Info) -> Result + write_file_info(SSH, Server, Name, Info) -> Result For information and other types, see ssh_sftp(3). SSH = connection() -- cgit v1.2.3