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/common_test/doc/src/common_test_app.xml | 6 +-
lib/common_test/doc/src/ct.xml | 66 ++++++++--------
lib/common_test/doc/src/ct_cover.xml | 2 +-
lib/common_test/doc/src/ct_hooks.xml | 36 ++++-----
lib/common_test/doc/src/ct_master.xml | 4 +-
lib/common_test/doc/src/ct_netconfc.xml | 110 +++++++++++++--------------
lib/common_test/doc/src/ct_property_test.xml | 6 +-
lib/common_test/doc/src/ct_slave.xml | 12 +--
lib/common_test/doc/src/ct_snmp.xml | 10 +--
lib/common_test/doc/src/ct_ssh.xml | 4 +-
lib/common_test/doc/src/ct_telnet.xml | 4 +-
lib/common_test/doc/src/ct_testspec.xml | 4 +-
lib/common_test/doc/src/unix_telnet.xml | 2 +-
13 files changed, 133 insertions(+), 133 deletions(-)
(limited to 'lib/common_test/doc/src')
diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index a3b3f927eb..0401293444 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -272,7 +272,7 @@
- Module:group(GroupName) -> [Info]
+ Module:group(GroupName) -> [Info]
Test case group information function (providing default data
for a test case group, that is, its test cases and
subgroups).
@@ -486,7 +486,7 @@
- Module:Testcase() -> [Info]
+ Module:Testcase() -> [Info]
Test case information function.
Info = {timetrap,Time} | {require,Required} | {require,Name,Required} | {userdata,UserData} | {silent_connections,Conns}
@@ -560,7 +560,7 @@
- Module:Testcase(Config) -> term() | {skip,Reason} | {comment,Comment} | {save_config,SaveConfig} | {skip_and_save,Reason,SaveConfig} | exit()
+ Module:Testcase(Config) -> term() | {skip,Reason} | {comment,Comment} | {save_config,SaveConfig} | {skip_and_save,Reason,SaveConfig} | exit()
A test case.
Config = SaveConfig = [{Key,Value}]
diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml
index c0380c4142..e55637a7fe 100644
--- a/lib/common_test/doc/src/ct.xml
+++ b/lib/common_test/doc/src/ct.xml
@@ -157,7 +157,7 @@
- add_config(Callback, Config) -> ok | {error, Reason}
+ add_config(Callback, Config) -> ok | {error, Reason}
Loads configuration variables using the specified callback
module and configuration string.
@@ -176,7 +176,7 @@
- break(Comment) -> ok | {error, Reason}
+ break(Comment) -> ok | {error, Reason}
Cancels any active timetrap and pause the execution of the
current test case until the user calls function continue/0.
@@ -206,7 +206,7 @@
- break(TestCase, Comment) -> ok | {error, Reason}
+ break(TestCase, Comment) -> ok | {error, Reason}
Works the same way as break/1, only argument TestCase makes it
possible to pause a test case executing in a parallel group.
@@ -228,7 +228,7 @@
- capture_get() -> ListOfStrings
+ capture_get() -> ListOfStrings
Equivalent to capture_get([default]).
ListOfStrings = [string()]
@@ -240,7 +240,7 @@
- capture_get(ExclCategories) -> ListOfStrings
+ capture_get(ExclCategories) -> ListOfStrings
Returns and purges the list of text strings buffered during
the latest session of capturing printouts to stdout.
@@ -262,7 +262,7 @@
- capture_start() -> ok
+ capture_start() -> ok
Starts capturing all text strings printed to stdout
during execution of the test case.
@@ -276,7 +276,7 @@
- capture_stop() -> ok
+ capture_stop() -> ok
Stops capturing text strings (a session started with
capture_start/0).
@@ -307,7 +307,7 @@
- comment(Format, Args) -> ok
+ comment(Format, Args) -> ok
Prints the formatted string in the comment field in the
table on the test suite result page.
@@ -326,7 +326,7 @@
- continue() -> ok
+ continue() -> ok
This function must be called to continue after a test
case (not executing in a parallel group) has called break/1.
@@ -337,7 +337,7 @@
- continue(TestCase) -> ok
+ continue(TestCase) -> ok
This function must be called to continue after a test case
has called break/2.
@@ -454,7 +454,7 @@
- fail(Format, Args) -> ok
+ fail(Format, Args) -> ok
Terminates a test case with an error message specified by
a format string and a list of values (used as arguments to
io_lib:format/2).
@@ -554,7 +554,7 @@
- get_event_mgr_ref() -> EvMgrRef
+ get_event_mgr_ref() -> EvMgrRef
Gets a reference to the Common Test event manager.
EvMgrRef = atom()
@@ -572,7 +572,7 @@
- get_progname() -> string()
+ get_progname() -> string()
Returns the command used to start this Erlang instance.
Returns the command used to start this Erlang instance.
@@ -622,7 +622,7 @@
- get_testspec_terms() -> TestSpecTerms | undefined
+ get_testspec_terms() -> TestSpecTerms | undefined
Gets a list of all test specification terms used to
configure and run this test.
@@ -636,7 +636,7 @@
- get_testspec_terms(Tags) -> TestSpecTerms | undefined
+ get_testspec_terms(Tags) -> TestSpecTerms | undefined
Reads one or more terms from the test specification used to
configure and run this test.
@@ -663,7 +663,7 @@
- get_timetrap_info() -> {Time, {Scaling,ScaleVal}}
+ get_timetrap_info() -> {Time, {Scaling,ScaleVal}}
Reads information about the timetrap set for the current
test case.
@@ -682,7 +682,7 @@
- get_verbosity(Category) -> Level | undefined
+ get_verbosity(Category) -> Level | undefined
Read the verbosity level for a logging category.
Category = default | atom()
@@ -778,7 +778,7 @@
- log(X1, X2, X3, X4) -> ok
+ log(X1, X2, X3, X4) -> ok
Equivalent to log(Category, Importance, Format,
FormatArgs, Opts).
@@ -794,7 +794,7 @@
- log(Category, Importance, Format, FormatArgs, Opts) -> ok
+ log(Category, Importance, Format, FormatArgs, Opts) -> ok
Prints from a test case to the log file.
Category = atom()
@@ -825,7 +825,7 @@
- make_priv_dir() -> ok | {error, Reason}
+ make_priv_dir() -> ok | {error, Reason}
If the test has been started with option create_priv_dir
set to manual_per_tc, in order for the test case to use the private
directory, it must first create it by calling this function.
@@ -841,7 +841,7 @@
- notify(Name, Data) -> ok
+ notify(Name, Data) -> ok
Sends an asynchronous notification of type Name with Data
to the Common Test event manager.
@@ -898,7 +898,7 @@
- pal(X1, X2, X3, X4) -> ok
+ pal(X1, X2, X3, X4) -> ok
Equivalent to pal(Category, Importance, Format,
FormatArgs, Opts).
@@ -914,7 +914,7 @@
- pal(Category, Importance, Format, FormatArgs, Opts) -> ok
+ pal(Category, Importance, Format, FormatArgs, Opts) -> ok
Prints and logs from a test case.
Category = atom()
@@ -976,7 +976,7 @@
- print(X1, X2) -> ok
+ print(X1, X2) -> ok
Equivalent to print(Category, Importance, Format,
FormatArgs, []).
@@ -1005,7 +1005,7 @@
- print(X1, X2, X3, X4) -> ok
+ print(X1, X2, X3, X4) -> ok
Equivalent to print(Category, Importance, Format,
FormatArgs, Opts).
@@ -1021,7 +1021,7 @@
- print(Category, Importance, Format, FormatArgs, Opts) -> ok
+ print(Category, Importance, Format, FormatArgs, Opts) -> ok
Prints from a test case to the console.
Category = atom()
@@ -1048,7 +1048,7 @@
- reload_config(Required) -> ValueOrElement | {error, Reason}
+ reload_config(Required) -> ValueOrElement | {error, Reason}
Reloads configuration file containing specified configuration
key.
@@ -1071,7 +1071,7 @@
- remaining_test_procs() -> {TestProcs,SharedGL,OtherGLs}
+ remaining_test_procs() -> {TestProcs,SharedGL,OtherGLs}
>This function will return the identity of test- and group
leader processes that are still running at the time of this call.
@@ -1107,7 +1107,7 @@
- remove_config(Callback, Config) -> ok
+ remove_config(Callback, Config) -> ok
Removes configuration variables (together with
their aliases) that were loaded with specified callback module and
configuration string.
@@ -1375,7 +1375,7 @@
- set_verbosity(Category, Level) -> ok
+ set_verbosity(Category, Level) -> ok
Set the verbosity level for a logging category.
Category = default | atom()
@@ -1390,7 +1390,7 @@
- sleep(Time) -> ok
+ sleep(Time) -> ok
This function, similar to timer:sleep/1, suspends the
test case for a specified time.
@@ -1482,7 +1482,7 @@
- sync_notify(Name, Data) -> ok
+ sync_notify(Name, Data) -> ok
Sends a synchronous notification of type Name with Data to
the Common Test event manager.
@@ -1515,7 +1515,7 @@
- timetrap(Time) -> ok
+ timetrap(Time) -> ok
Sets a new timetrap for the running test case.
Time = {hours, Hours} | {minutes, Mins} | {seconds, Secs} | Millisecs | infinity | Func
diff --git a/lib/common_test/doc/src/ct_cover.xml b/lib/common_test/doc/src/ct_cover.xml
index 89d944acbe..f777fd1ce9 100644
--- a/lib/common_test/doc/src/ct_cover.xml
+++ b/lib/common_test/doc/src/ct_cover.xml
@@ -67,7 +67,7 @@
- cross_cover_analyse(Level, Tests) -> ok
+ cross_cover_analyse(Level, Tests) -> ok
Accumulates cover results over multiple tests.
Level = overview | details
diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml
index 954be0ffba..048552e4bb 100644
--- a/lib/common_test/doc/src/ct_hooks.xml
+++ b/lib/common_test/doc/src/ct_hooks.xml
@@ -32,7 +32,7 @@
PA1
ct_hooks.sgml
- ct_hooks
+ ct_hooks
A callback interface on top of Common Test.
@@ -75,7 +75,7 @@
- Module:init(Id, Opts) -> {ok, State} | {ok, State, Priority}
+ Module:init(Id, Opts) -> {ok, State} | {ok, State, Priority}
Initiates the Common Test Hook.
Id = reference() | term()
@@ -109,7 +109,7 @@
- Module:pre_init_per_suite(SuiteName, InitData, CTHState) -> Result
+ Module:pre_init_per_suite(SuiteName, InitData, CTHState) -> Result
Called before init_per_suite.
SuiteName = atom()
@@ -161,7 +161,7 @@
- Module:post_init_per_suite(SuiteName, Config, Return, CTHState) -> Result
+ Module:post_init_per_suite(SuiteName, Config, Return, CTHState) -> Result
Called after init_per_suite.
SuiteName = atom()
@@ -208,7 +208,7 @@
- Module:pre_init_per_group(SuiteName, GroupName, InitData, CTHState) -> Result
+ Module:pre_init_per_group(SuiteName, GroupName, InitData, CTHState) -> Result
Called before init_per_group.
SuiteName = atom()
@@ -241,7 +241,7 @@
- Module:post_init_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result
+ Module:post_init_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result
Called after init_per_group.
SuiteName = atom()
@@ -274,7 +274,7 @@
- Module:pre_init_per_testcase(SuiteName, TestcaseName, InitData, CTHState) -> Result
+ Module:pre_init_per_testcase(SuiteName, TestcaseName, InitData, CTHState) -> Result
Called before init_per_testcase.
SuiteName = atom()
@@ -311,7 +311,7 @@
- Module:post_init_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result
+ Module:post_init_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result
Called after init_per_testcase.
SuiteName = atom()
@@ -344,7 +344,7 @@
- Module:pre_end_per_testcase(SuiteName, TestcaseName, EndData, CTHState) -> Result
+ Module:pre_end_per_testcase(SuiteName, TestcaseName, EndData, CTHState) -> Result
Called before end_per_testcase.
SuiteName = atom()
@@ -380,7 +380,7 @@
- Module:post_end_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result
+ Module:post_end_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result
Called after end_per_testcase.
SuiteName = atom()
@@ -413,7 +413,7 @@
- Module:pre_end_per_group(SuiteName, GroupName, EndData, CTHState) -> Result
+ Module:pre_end_per_group(SuiteName, GroupName, EndData, CTHState) -> Result
Called before end_per_group.
SuiteName = atom()
@@ -446,7 +446,7 @@
- Module:post_end_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result
+ Module:post_end_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result
Called after end_per_group.
SuiteName = atom()
@@ -479,7 +479,7 @@
- Module:pre_end_per_suite(SuiteName, EndData, CTHState) -> Result
+ Module:pre_end_per_suite(SuiteName, EndData, CTHState) -> Result
Called before end_per_suite.
SuiteName = atom()
@@ -506,7 +506,7 @@
- Module:post_end_per_suite(SuiteName, Config, Return, CTHState) -> Result
+ Module:post_end_per_suite(SuiteName, Config, Return, CTHState) -> Result
Called after end_per_suite.
SuiteName = atom()
@@ -533,7 +533,7 @@
- Module:on_tc_fail(SuiteName, TestName, Reason, CTHState) -> NewCTHState
+ Module:on_tc_fail(SuiteName, TestName, Reason, CTHState) -> NewCTHState
Called after the CTH scope ends.
SuiteName = atom()
@@ -577,7 +577,7 @@
- Module:on_tc_skip(SuiteName, TestName, Reason, CTHState) -> NewCTHState
+ Module:on_tc_skip(SuiteName, TestName, Reason, CTHState) -> NewCTHState
Called after the CTH scope ends.
SuiteName = atom()
@@ -623,7 +623,7 @@
- Module:terminate(CTHState)
+ Module:terminate(CTHState)
Called after the CTH scope ends.
CTHState = term()
@@ -637,7 +637,7 @@
- Module:id(Opts) -> Id
+ Module:id(Opts) -> Id
Called before the init function of a CTH.
Opts = term()
diff --git a/lib/common_test/doc/src/ct_master.xml b/lib/common_test/doc/src/ct_master.xml
index 6bde4644c6..8afd7c537e 100644
--- a/lib/common_test/doc/src/ct_master.xml
+++ b/lib/common_test/doc/src/ct_master.xml
@@ -65,7 +65,7 @@
- basic_html(Bool) -> ok
+ basic_html(Bool) -> ok
If set to true, the ct_master logs are written on a primitive
HTML format, not using the Common Test CSS style sheet.
@@ -79,7 +79,7 @@
- get_event_mgr_ref() -> MasterEvMgrRef
+ get_event_mgr_ref() -> MasterEvMgrRef
Gets a reference to the Common Test master event
manager.
diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml
index 7ec8f23073..32a1175d81 100644
--- a/lib/common_test/doc/src/ct_netconfc.xml
+++ b/lib/common_test/doc/src/ct_netconfc.xml
@@ -32,7 +32,7 @@
A
ct_netconfc.xml
- ct_netconfc
+ ct_netconfc
NETCONF client module.
@@ -312,8 +312,8 @@
-
-
+
+
Executes an action.
Executes an action. If the return type is void, ok is
@@ -322,8 +322,8 @@
-
-
+
+
Requests graceful termination of the session associated with
the client.
@@ -339,7 +339,7 @@
-
+
Opens an SSH connection to a NETCONF server.
Opens an SSH connection to a NETCONF server.
@@ -361,7 +361,7 @@
-
+
Opens an SSH connection to a named NETCONF server.
Open an SSH connection to a named NETCONF server.
@@ -399,8 +399,8 @@
-
-
+
+
Copies configuration data.
Copies configuration data.
@@ -412,12 +412,12 @@
- create_subscription(Client) -> Result
- create_subscription(Client, Stream) -> Result
- create_subscription(Client, Stream, Filter) -> Result
- create_subscription(Client, Stream, Filter, Timeout) -> Result
-
-
+ create_subscription(Client) -> Result
+ create_subscription(Client, Stream) -> Result
+ create_subscription(Client, Stream, Filter) -> Result
+ create_subscription(Client, Stream, Filter, Timeout) -> Result
+
+
Creates a subscription for event notifications.
Creates a subscription for event notifications.
@@ -490,8 +490,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Deletes configuration data.
Deletes configuration data.
@@ -502,7 +502,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
+
Closes the given SSH connection.
Closes the given SSH connection.
@@ -514,10 +514,10 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
-
-
+
+
+
+
Edits configuration data.
Edits configuration data.
@@ -542,8 +542,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Gets data.
Gets data.
@@ -557,8 +557,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Returns the server side capabilities.
Returns the server side capabilities.
@@ -582,8 +582,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Gets configuration data.
Gets configuration data.
@@ -597,10 +597,10 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
-
-
+
+
+
+
Sends a request to get the specified event streams.
Sends a request to get the specified event streams.
@@ -637,8 +637,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Returns the session Id associated with the specified
client.
@@ -647,9 +647,9 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
-
+
+
+
Exchanges hello messages with the server.
Exchanges hello messages with the server.
@@ -660,8 +660,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Forces termination of the session associated with the supplied
session Id.
@@ -682,8 +682,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Locks the configuration target.
Locks the configuration target.
@@ -703,7 +703,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
+
Opens a NETCONF session, but does not send hello.
Opens a NETCONF session, but does not send hello.
@@ -714,7 +714,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
+
Opens a named NETCONF session, but does not send hello.
Opens a named NETCONF session, but does not send hello.
@@ -725,7 +725,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
+
Opens a NETCONF session and exchanges hello messages.
Opens a NETCONF session and exchanges hello messages.
@@ -749,7 +749,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
+
Opens a named NETCONF session and exchanges hello
messages.
@@ -791,8 +791,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Sends an XML document to the server.
Sends an XML document to the server.
@@ -804,8 +804,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Sends a NETCONF rpc request to the server.
Sends a NETCONF rpc request to the server.
@@ -820,10 +820,10 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
-
-
+
+
+
+
Opens a NETCONF session as a channel on the given SSH
connection, and exchanges hello messages with the
server.
@@ -848,8 +848,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
-
-
+
+
Unlocks the configuration target.
Unlocks the configuration target.
diff --git a/lib/common_test/doc/src/ct_property_test.xml b/lib/common_test/doc/src/ct_property_test.xml
index 028e5eb69f..1e01d9a5d7 100644
--- a/lib/common_test/doc/src/ct_property_test.xml
+++ b/lib/common_test/doc/src/ct_property_test.xml
@@ -32,7 +32,7 @@
A
ct_property_test.xml
- ct_property_test
+ ct_property_test
EXPERIMENTAL support in Common Test for calling
property-based tests.
@@ -79,7 +79,7 @@
- init_per_suite(Config) -> Config | {skip, Reason}
+ init_per_suite(Config) -> Config | {skip, Reason}
Initializes Config for property testing.
Initializes Config for property testing.
@@ -98,7 +98,7 @@
- quickcheck(Property, Config) -> true | {fail, Reason}
+ quickcheck(Property, Config) -> true | {fail, Reason}
Calls quickcheck and returns the result in a form suitable for
Common Test.
diff --git a/lib/common_test/doc/src/ct_slave.xml b/lib/common_test/doc/src/ct_slave.xml
index 9d9aa50051..84e619482d 100644
--- a/lib/common_test/doc/src/ct_slave.xml
+++ b/lib/common_test/doc/src/ct_slave.xml
@@ -32,7 +32,7 @@
A
ct_slave.xml
- ct_slave
+ ct_slave
Common Test framework functions for starting and stopping
nodes for Large-Scale Testing.
@@ -50,7 +50,7 @@
- start(Node) -> Result
+ start(Node) -> Result
Starts an Erlang node with name Node on the local
host.
@@ -68,7 +68,7 @@
- start(HostOrNode, NodeOrOpts) -> Result
+ start(HostOrNode, NodeOrOpts) -> Result
Starts an Erlang node with default options on a specified
host, or on the local host with specified options.
@@ -90,7 +90,7 @@
- start(Host, Node, Opts) -> Result
+ start(Host, Node, Opts) -> Result
Starts an Erlang node with name Node on host Host as
specified by the combination of options in Opts.
@@ -184,7 +184,7 @@
- stop(Node) -> Result
+ stop(Node) -> Result
Stops the running Erlang node with name Node on the local
host.
@@ -199,7 +199,7 @@
- stop(Host, Node) -> Result
+ stop(Host, Node) -> Result
Stops the running Erlang node with name Node on host
Host.
diff --git a/lib/common_test/doc/src/ct_snmp.xml b/lib/common_test/doc/src/ct_snmp.xml
index 0a5e52b16c..3d8c5d3e92 100644
--- a/lib/common_test/doc/src/ct_snmp.xml
+++ b/lib/common_test/doc/src/ct_snmp.xml
@@ -430,7 +430,7 @@
- unload_mibs(Mibs) -> ok | {error, Reason}
+ unload_mibs(Mibs) -> ok | {error, Reason}
Unloads the MIBs from agent snmp_master_agent.
Mibs = [MibName]
@@ -455,7 +455,7 @@
- unregister_agents(MgrAgentConfName, ManagedAgents) -> ok
+ unregister_agents(MgrAgentConfName, ManagedAgents) -> ok
Unregisters the specified managed agents.
MgrAgentConfName = atom()
@@ -480,7 +480,7 @@
- unregister_users(MgrAgentConfName, Users) -> ok
+ unregister_users(MgrAgentConfName, Users) -> ok
Unregisters the specified users.
MgrAgentConfName = atom()
@@ -493,7 +493,7 @@
- unregister_usm_users(MgrAgentConfName) -> ok
+ unregister_usm_users(MgrAgentConfName) -> ok
Unregisters all USM users.
MgrAgentConfName = atom()
@@ -505,7 +505,7 @@
- unregister_usm_users(MgrAgentConfName, UsmUsers) -> ok
+ unregister_usm_users(MgrAgentConfName, UsmUsers) -> ok
Unregisters the specified USM users.
MgrAgentConfName = atom()
diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml
index 0c7efed154..bb0aaa46b7 100644
--- a/lib/common_test/doc/src/ct_ssh.xml
+++ b/lib/common_test/doc/src/ct_ssh.xml
@@ -1034,7 +1034,7 @@ ChannelId, 0, Data, End, Timeout).
- shell(SSH, ChannelId) -> ok | {error, Reason}
+ shell(SSH, ChannelId) -> ok | {error, Reason}
Equivalent to shell(SSH, ChannelId, DefaultTimeout).
Equivalent to
@@ -1044,7 +1044,7 @@ ChannelId, 0, Data, End, Timeout).
- shell(SSH, ChannelId, Timeout) -> ok | {error, Reason}
+ shell(SSH, ChannelId, Timeout) -> ok | {error, Reason}
Requests that the user default shell is executed at the
server end.
diff --git a/lib/common_test/doc/src/ct_telnet.xml b/lib/common_test/doc/src/ct_telnet.xml
index 8e85cccc99..2d69338bca 100644
--- a/lib/common_test/doc/src/ct_telnet.xml
+++ b/lib/common_test/doc/src/ct_telnet.xml
@@ -541,7 +541,7 @@
- send(Connection, Cmd, Opts) -> ok | {error, Reason}
+ send(Connection, Cmd, Opts) -> ok | {error, Reason}
Sends a Telnet command and returns immediately.
Connection = connection()
@@ -576,7 +576,7 @@
- sendf(Connection, CmdFormat, Args, Opts) -> ok | {error, Reason}
+ sendf(Connection, CmdFormat, Args, Opts) -> ok | {error, Reason}
Sends a Telnet command and returns immediately (uses a format
string and a list of arguments to build the command).
diff --git a/lib/common_test/doc/src/ct_testspec.xml b/lib/common_test/doc/src/ct_testspec.xml
index 36893f66cf..9cb9a2ae9f 100644
--- a/lib/common_test/doc/src/ct_testspec.xml
+++ b/lib/common_test/doc/src/ct_testspec.xml
@@ -32,7 +32,7 @@
A
ct_testspec.xml
- ct_testspec
+ ct_testspec
Parsing of test specifications for Common Test.
@@ -46,7 +46,7 @@
- get_tests(SpecsIn) -> {ok, [{Specs,Tests}]} | {error, Reason}
+ get_tests(SpecsIn) -> {ok, [{Specs,Tests}]} | {error, Reason}
Parse the given test specification files and return the tests to run and skip.
SpecsIn = [string()] | [[string()]]
diff --git a/lib/common_test/doc/src/unix_telnet.xml b/lib/common_test/doc/src/unix_telnet.xml
index b2314a53ec..eaa184d8fc 100644
--- a/lib/common_test/doc/src/unix_telnet.xml
+++ b/lib/common_test/doc/src/unix_telnet.xml
@@ -80,7 +80,7 @@
- connect(ConnName, Ip, Port, Timeout, KeepAlive, TCPNoDelay, Extra) -> {ok, Handle} | {error, Reason}
+ connect(ConnName, Ip, Port, Timeout, KeepAlive, TCPNoDelay, Extra) -> {ok, Handle} | {error, Reason}
Callback for ct_telnet.erl.
ConnName = target_name()
--
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/common_test/doc/src/common_test_app.xml | 20 ++--
lib/common_test/doc/src/ct.xml | 76 +++++++-------
lib/common_test/doc/src/ct_cover.xml | 6 +-
lib/common_test/doc/src/ct_ftp.xml | 26 ++---
lib/common_test/doc/src/ct_master.xml | 20 ++--
lib/common_test/doc/src/ct_rpc.xml | 18 ++--
lib/common_test/doc/src/ct_snmp.xml | 28 +++---
lib/common_test/doc/src/ct_ssh.xml | 148 ++++++++++++++--------------
lib/common_test/doc/src/ct_telnet.xml | 30 +++---
lib/common_test/doc/src/unix_telnet.xml | 4 +-
10 files changed, 188 insertions(+), 188 deletions(-)
(limited to 'lib/common_test/doc/src')
diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index 0401293444..7887a2c3ea 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -32,7 +32,7 @@
PA1
common_test_app.sgml
- common_test
+ common_test
A framework for automated testing of any target nodes.
@@ -68,7 +68,7 @@
- Module:all() -> Tests | {skip,Reason}
+ Module:all() -> Tests | {skip,Reason}
Returns the list of all test case groups and test cases
in the module.
@@ -115,7 +115,7 @@
- Module:groups() -> GroupDefs
+ Module:groups() -> GroupDefs
Returns a list of test case group definitions.
GroupDefs = [Group]
@@ -140,7 +140,7 @@
- Module:suite() -> [Info]
+ Module:suite() -> [Info]
Test suite info function (providing default data
for the suite).
@@ -213,7 +213,7 @@
- Module:init_per_suite(Config) -> NewConfig | {skip,Reason} |
+ Module:init_per_suite(Config) -> NewConfig | {skip,Reason} |
{skip_and_save,Reason,SaveConfig}
Test suite initializations.
@@ -248,7 +248,7 @@
- Module:end_per_suite(Config) -> term() |
+ Module:end_per_suite(Config) -> term() |
{save_config,SaveConfig}
Test suite finalization.
@@ -352,7 +352,7 @@
- Module:init_per_group(GroupName, Config) -> NewConfig |
+ Module:init_per_group(GroupName, Config) -> NewConfig |
{skip,Reason}
Test case group initializations.
@@ -390,7 +390,7 @@
- Module:end_per_group(GroupName, Config) -> term() |
+ Module:end_per_group(GroupName, Config) -> term() |
{return_group_result,Status}
Test case group finalization.
@@ -424,7 +424,7 @@
- Module:init_per_testcase(TestCase, Config) -> NewConfig | {fail,Reason} | {skip,Reason}
+ Module:init_per_testcase(TestCase, Config) -> NewConfig | {fail,Reason} | {skip,Reason}
Test case initializations.
TestCase = atom()
@@ -454,7 +454,7 @@
- Module:end_per_testcase(TestCase, Config) -> term() | {fail,Reason} | {save_config,SaveConfig}
+ Module:end_per_testcase(TestCase, Config) -> term() | {fail,Reason} | {save_config,SaveConfig}
Test case finalization.
TestCase = atom()
diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml
index e55637a7fe..83c0ecb309 100644
--- a/lib/common_test/doc/src/ct.xml
+++ b/lib/common_test/doc/src/ct.xml
@@ -32,7 +32,7 @@
A
ct.xml
- ct
+ ct
Main user interface for the Common Test framework.
@@ -139,7 +139,7 @@
- abort_current_testcase(Reason) -> ok | {error, ErrorReason}
+ abort_current_testcase(Reason) -> ok | {error, ErrorReason}
Aborts the currently executing test case.
Reason = term()
@@ -290,7 +290,7 @@
- comment(Comment) -> ok
+ comment(Comment) -> ok
Prints the specified Comment in the comment field in the
table on the test suite result page.
@@ -353,7 +353,7 @@
- decrypt_config_file(EncryptFileName, TargetFileName) -> ok | {error, Reason}
+ decrypt_config_file(EncryptFileName, TargetFileName) -> ok | {error, Reason}
Decrypts EncryptFileName, previously generated with
encrypt_config_file/2,3.
@@ -372,7 +372,7 @@
- decrypt_config_file(EncryptFileName, TargetFileName, KeyOrFile) -> ok | {error, Reason}
+ decrypt_config_file(EncryptFileName, TargetFileName, KeyOrFile) -> ok | {error, Reason}
Decrypts EncryptFileName, previously generated with
encrypt_config_file/2,3.
@@ -390,7 +390,7 @@
- encrypt_config_file(SrcFileName, EncryptFileName) -> ok | {error, Reason}
+ encrypt_config_file(SrcFileName, EncryptFileName) -> ok | {error, Reason}
Encrypts the source configuration file with DES3 and saves the
result in file EncryptFileName.
@@ -416,7 +416,7 @@
- encrypt_config_file(SrcFileName, EncryptFileName, KeyOrFile) -> ok | {error, Reason}
+ encrypt_config_file(SrcFileName, EncryptFileName, KeyOrFile) -> ok | {error, Reason}
Encrypts the source configuration file with DES3 and saves the
result in the target file EncryptFileName.
@@ -442,7 +442,7 @@
- fail(Reason) -> ok
+ fail(Reason) -> ok
Terminates a test case with the specified error
Reason.
@@ -470,7 +470,7 @@
- get_config(Required) -> Value
+ get_config(Required) -> Value
Equivalent to get_config(Required, undefined, []).
Equivalent to ct:get_config(Required,
@@ -479,7 +479,7 @@
- get_config(Required, Default) -> Value
+ get_config(Required, Default) -> Value
Equivalent to get_config(Required, Default, []).
Equivalent to ct:get_config(Required,
@@ -488,7 +488,7 @@
- get_config(Required, Default, Opts) -> ValueOrElement
+ get_config(Required, Default, Opts) -> ValueOrElement
Reads configuration data values.
Required = KeyOrName | {KeyOrName, SubKey} | {KeyOrName, SubKey, SubKey}
@@ -582,7 +582,7 @@
- get_status() -> TestStatus | {error, Reason} | no_tests_running
+ get_status() -> TestStatus | {error, Reason} | no_tests_running
Returns status of ongoing test.
TestStatus = [StatusElem]
@@ -608,7 +608,7 @@
- get_target_name(Handle) -> {ok, TargetName} | {error, Reason}
+ get_target_name(Handle) -> {ok, TargetName} | {error, Reason}
Returns the name of the target that the specified connection
belongs to.
@@ -697,7 +697,7 @@
- install(Opts) -> ok | {error, Reason}
+ install(Opts) -> ok | {error, Reason}
Installs configuration files and event handlers.
Opts = [Opt]
@@ -724,7 +724,7 @@
- listenv(Telnet) -> [Env]
+ listenv(Telnet) -> [Env]
Performs command listenv on the specified Telnet connection
and returns the result as a list of key-value pairs.
@@ -740,7 +740,7 @@
- log(Format) -> ok
+ log(Format) -> ok
Equivalent to log(default, 50, Format, [], []).
Equivalent to
@@ -749,7 +749,7 @@
- log(X1, X2) -> ok
+ log(X1, X2) -> ok
Equivalent to log(Category, Importance, Format,
FormatArgs, []).
@@ -763,7 +763,7 @@
- log(X1, X2, X3) -> ok
+ log(X1, X2, X3) -> ok
Equivalent to log(Category, Importance, Format,
FormatArgs, Opts).
@@ -859,7 +859,7 @@
- pal(Format) -> ok
+ pal(Format) -> ok
Equivalent to pal(default, 50, Format, [], []).
Equivalent to
@@ -869,7 +869,7 @@
- pal(X1, X2) -> ok
+ pal(X1, X2) -> ok
Equivalent to pal(Category, Importance, Format,
FormatArgs, []).
@@ -883,7 +883,7 @@
- pal(X1, X2, X3) -> ok
+ pal(X1, X2, X3) -> ok
Equivalent to pal(Category, Importance, Format,
FormatArgs, Opts).
@@ -945,7 +945,7 @@
- parse_table(Data) -> {Heading, Table}
+ parse_table(Data) -> {Heading, Table}
Parses the printout from an SQL table and returns a list of
tuples.
@@ -967,7 +967,7 @@
- print(Format) -> ok
+ print(Format) -> ok
Equivalent to print(default, 50, Format, [], []).
Equivalent to ct:print(default,
@@ -990,7 +990,7 @@
- print(X1, X2, X3) -> ok
+ print(X1, X2, X3) -> ok
Equivalent to print(Category, Importance, Format,
FormatArgs, Opts).
@@ -1124,7 +1124,7 @@
- require(Required) -> ok | {error, Reason}
+ require(Required) -> ok | {error, Reason}
Checks if the required configuration is available.
Required = Key | {Key, SubKeys} | {Key, SubKey, SubKeys}
@@ -1178,7 +1178,7 @@
- require(Name, Required) -> ok | {error, Reason}
+ require(Name, Required) -> ok | {error, Reason}
Checks if the required configuration is available and gives
it a name.
@@ -1237,7 +1237,7 @@
- run(TestDirs) -> Result
+ run(TestDirs) -> Result
Runs all test cases in all suites in the specified
directories.
@@ -1251,7 +1251,7 @@
- run(TestDir, Suite) -> Result
+ run(TestDir, Suite) -> Result
Runs all test cases in the specified suite.
Runs all test cases in the specified suite.
@@ -1261,7 +1261,7 @@
- run(TestDir, Suite, Cases) -> Result
+ run(TestDir, Suite, Cases) -> Result
Runs the specified test cases.
TestDir = string()
@@ -1283,7 +1283,7 @@
- run_test(Opts) -> Result
+ run_test(Opts) -> Result
Runs tests as specified by the combination of options in
Opts.
@@ -1355,7 +1355,7 @@
- run_testspec(TestSpec) -> Result
+ run_testspec(TestSpec) -> Result
Runs a test specified by TestSpec.
TestSpec = [term()]
@@ -1412,7 +1412,7 @@
- start_interactive() -> ok
+ start_interactive() -> ok
Starts Common Test in interactive mode.
Starts Common Test in interactive mode.
@@ -1440,7 +1440,7 @@
- step(TestDir, Suite, Case) -> Result
+ step(TestDir, Suite, Case) -> Result
Steps through a test case with the debugger.
Case = atom()
@@ -1453,7 +1453,7 @@
- step(TestDir, Suite, Case, Opts) -> Result
+ step(TestDir, Suite, Case, Opts) -> Result
Steps through a test case with the debugger.
Case = atom()
@@ -1470,7 +1470,7 @@
- stop_interactive() -> ok
+ stop_interactive() -> ok
Exits the interactive mode.
Exits the interactive mode.
@@ -1501,7 +1501,7 @@
- testcases(TestDir, Suite) -> Testcases | {error, Reason}
+ testcases(TestDir, Suite) -> Testcases | {error, Reason}
Returns all test cases in the specified suite.
TestDir = string()
@@ -1539,7 +1539,7 @@
- userdata(TestDir, Suite) -> SuiteUserData | {error, Reason}
+ userdata(TestDir, Suite) -> SuiteUserData | {error, Reason}
Returns any data specified with tag userdata in the list of
tuples returned from Suite:suite/0.
@@ -1556,7 +1556,7 @@
- userdata(TestDir, Suite, Case::GroupOrCase) -> TCUserData | {error, Reason}
+ userdata(TestDir, Suite, Case::GroupOrCase) -> TCUserData | {error, Reason}
Returns any data specified with tag userdata in the list of
tuples returned from Suite:group(GroupName) or Suite:Case().
diff --git a/lib/common_test/doc/src/ct_cover.xml b/lib/common_test/doc/src/ct_cover.xml
index f777fd1ce9..61365d3522 100644
--- a/lib/common_test/doc/src/ct_cover.xml
+++ b/lib/common_test/doc/src/ct_cover.xml
@@ -32,7 +32,7 @@
A
ct_cover.xml
- ct_cover
+ ct_cover
Common Test framework code coverage support module.
@@ -47,7 +47,7 @@
- add_nodes(Nodes) -> {ok, StartedNodes} | {error, Reason}
+ add_nodes(Nodes) -> {ok, StartedNodes} | {error, Reason}
Adds nodes to current cover test (only works if cover support
is active).
@@ -83,7 +83,7 @@
- remove_nodes(Nodes) -> ok | {error, Reason}
+ remove_nodes(Nodes) -> ok | {error, Reason}
Removes nodes from the current cover test.
Nodes = [atom()]
diff --git a/lib/common_test/doc/src/ct_ftp.xml b/lib/common_test/doc/src/ct_ftp.xml
index 592c5eb05d..7ee6049486 100644
--- a/lib/common_test/doc/src/ct_ftp.xml
+++ b/lib/common_test/doc/src/ct_ftp.xml
@@ -32,7 +32,7 @@
A
ct_ftp.xml
- ct_ftp
+ ct_ftp
FTP client module (based on the FTP application).
@@ -59,7 +59,7 @@
- cd(Connection, Dir) -> ok | {error, Reason}
+ cd(Connection, Dir) -> ok | {error, Reason}
Changes directory on remote host.
Connection = connection()
@@ -71,7 +71,7 @@
- close(Connection) -> ok | {error, Reason}
+ close(Connection) -> ok | {error, Reason}
Closes the FTP connection.
Connection = connection()
@@ -82,7 +82,7 @@
- delete(Connection, File) -> ok | {error, Reason}
+ delete(Connection, File) -> ok | {error, Reason}
Deletes a file on remote host.
Connection = connection()
@@ -94,7 +94,7 @@
- get(KeyOrName, RemoteFile, LocalFile) -> ok | {error, Reason}
+ get(KeyOrName, RemoteFile, LocalFile) -> ok | {error, Reason}
Opens an FTP connection and fetches a file from the remote
host.
@@ -122,7 +122,7 @@
- ls(Connection, Dir) -> {ok, Listing} | {error, Reason}
+ ls(Connection, Dir) -> {ok, Listing} | {error, Reason}
Lists directory Dir.
Connection = connection()
@@ -135,7 +135,7 @@
- open(KeyOrName) -> {ok, Handle} | {error, Reason}
+ open(KeyOrName) -> {ok, Handle} | {error, Reason}
Opens an FTP connection to the specified node.
KeyOrName = Key | Name
@@ -164,7 +164,7 @@
- put(KeyOrName, LocalFile, RemoteFile) -> ok | {error, Reason}
+ put(KeyOrName, LocalFile, RemoteFile) -> ok | {error, Reason}
Opens an FTP connection and sends a file to the remote
host.
@@ -203,7 +203,7 @@
- recv(Connection, RemoteFile) -> ok | {error, Reason}
+ recv(Connection, RemoteFile) -> ok | {error, Reason}
Fetches a file over FTP.
Fetches a file over FTP.
@@ -215,7 +215,7 @@
- recv(Connection, RemoteFile, LocalFile) -> ok | {error, Reason}
+ recv(Connection, RemoteFile, LocalFile) -> ok | {error, Reason}
Fetches a file over FTP.
Connection = connection()
@@ -230,7 +230,7 @@
- send(Connection, LocalFile) -> ok | {error, Reason}
+ send(Connection, LocalFile) -> ok | {error, Reason}
Sends a file over FTP.
Sends a file over FTP.
@@ -243,7 +243,7 @@
- send(Connection, LocalFile, RemoteFile) -> ok | {error, Reason}
+ send(Connection, LocalFile, RemoteFile) -> ok | {error, Reason}
Sends a file over FTP.
Connection = connection()
@@ -258,7 +258,7 @@
- type(Connection, Type) -> ok | {error, Reason}
+ type(Connection, Type) -> ok | {error, Reason}
Changes the file transfer type.
Connection = connection()
diff --git a/lib/common_test/doc/src/ct_master.xml b/lib/common_test/doc/src/ct_master.xml
index 8afd7c537e..2ab421fe9e 100644
--- a/lib/common_test/doc/src/ct_master.xml
+++ b/lib/common_test/doc/src/ct_master.xml
@@ -32,7 +32,7 @@
A
ct_master.xml
- ct_master
+ ct_master
Distributed test execution control for Common Test.
@@ -46,7 +46,7 @@
- abort() -> ok
+ abort() -> ok
Stops all running tests.
Stops all running tests.
@@ -54,7 +54,7 @@
- abort(Nodes) -> ok
+ abort(Nodes) -> ok
Stops tests on specified nodes.
Nodes = atom() | [atom()]
@@ -98,7 +98,7 @@
- progress() -> [{Node, Status}]
+ progress() -> [{Node, Status}]
Returns test progress.
Node = atom()
@@ -112,7 +112,7 @@
- run(TestSpecs) -> ok
+ run(TestSpecs) -> ok
Equivalent to run(TestSpecs, false, [], []).
TestSpecs = string() | [SeparateOrMerged]
@@ -124,7 +124,7 @@
- run(TestSpecs, InclNodes, ExclNodes) -> ok
+ run(TestSpecs, InclNodes, ExclNodes) -> ok
Equivalent to run(TestSpecs, false, InclNodes, ExclNodes).
@@ -140,7 +140,7 @@
- run(TestSpecs, AllowUserTerms, InclNodes, ExclNodes) -> ok
+ run(TestSpecs, AllowUserTerms, InclNodes, ExclNodes) -> ok
Tests are spawned on the nodes as specified in TestSpecs.
@@ -162,7 +162,7 @@
- run_on_node(TestSpecs, Node) -> ok
+ run_on_node(TestSpecs, Node) -> ok
Equivalent to run_on_node(TestSpecs, false, Node).
TestSpecs = string() | [SeparateOrMerged]
@@ -177,7 +177,7 @@
- run_on_node(TestSpecs, AllowUserTerms, Node) -> ok
+ run_on_node(TestSpecs, AllowUserTerms, Node) -> ok
Tests are spawned on Node according to TestSpecs.
TestSpecs = string() | [SeparateOrMerged]
@@ -191,7 +191,7 @@
- run_test(Node, Opts) -> ok
+ run_test(Node, Opts) -> ok
Tests are spawned on Node using ct:run_test/1.
Node = atom()
diff --git a/lib/common_test/doc/src/ct_rpc.xml b/lib/common_test/doc/src/ct_rpc.xml
index 90e6b833f7..00a4dcec08 100644
--- a/lib/common_test/doc/src/ct_rpc.xml
+++ b/lib/common_test/doc/src/ct_rpc.xml
@@ -32,7 +32,7 @@
A
ct_rpc.xml
- ct_rpc
+ ct_rpc
Common Test specific layer on Erlang/OTP rpc.
@@ -43,7 +43,7 @@
- app_node(App, Candidates) -> NodeName
+ app_node(App, Candidates) -> NodeName
From a set of candidate nodes determines which of them is
running the application App.
@@ -61,7 +61,7 @@
- app_node(App, Candidates, FailOnBadRPC) -> NodeName
+ app_node(App, Candidates, FailOnBadRPC) -> NodeName
Same as app_node/2, except that argument FailOnBadRPC
determines if the search for a candidate node is to stop if
badrpc is received at some point.
@@ -81,7 +81,7 @@
- app_node(App, Candidates, FailOnBadRPC, Cookie) -> NodeName
+ app_node(App, Candidates, FailOnBadRPC, Cookie) -> NodeName
Same as app_node/2, except that argument FailOnBadRPC
determines if the search for a candidate node is to stop if badrpc is
received at some point.
@@ -105,7 +105,7 @@
- call(Node, Module, Function, Args) -> term() | {badrpc, Reason}
+ call(Node, Module, Function, Args) -> term() | {badrpc, Reason}
Same as call(Node, Module, Function, Args, infinity).
Same as call(Node, Module, Function, Args, infinity).
@@ -113,7 +113,7 @@
- call(Node, Module, Function, Args, TimeOut) -> term() | {badrpc, Reason}
+ call(Node, Module, Function, Args, TimeOut) -> term() | {badrpc, Reason}
Evaluates apply(Module, Function, Args) on the node
Node.
@@ -136,7 +136,7 @@
- call(Node, Module, Function, Args, TimeOut, Cookie) -> term() | {badrpc, Reason}
+ call(Node, Module, Function, Args, TimeOut, Cookie) -> term() | {badrpc, Reason}
Evaluates apply(Module, Function, Args) on the node
Node.
@@ -163,7 +163,7 @@
- cast(Node, Module, Function, Args) -> ok
+ cast(Node, Module, Function, Args) -> ok
Evaluates apply(Module, Function, Args) on the node
Node.
@@ -187,7 +187,7 @@
- cast(Node, Module, Function, Args, Cookie) -> ok
+ cast(Node, Module, Function, Args, Cookie) -> ok
Evaluates apply(Module, Function, Args) on the node
Node.
diff --git a/lib/common_test/doc/src/ct_snmp.xml b/lib/common_test/doc/src/ct_snmp.xml
index 3d8c5d3e92..343781814a 100644
--- a/lib/common_test/doc/src/ct_snmp.xml
+++ b/lib/common_test/doc/src/ct_snmp.xml
@@ -32,7 +32,7 @@
A
ct_snmp.xml
- ct_snmp
+ ct_snmp
Common Test user interface module for the SNMP application.
@@ -240,7 +240,7 @@
- get_next_values(Agent, Oids, MgrAgentConfName) -> SnmpReply
+ get_next_values(Agent, Oids, MgrAgentConfName) -> SnmpReply
Issues a synchronous SNMP get next request.
Agent = agent_name()
@@ -254,7 +254,7 @@
- get_values(Agent, Oids, MgrAgentConfName) -> SnmpReply
+ get_values(Agent, Oids, MgrAgentConfName) -> SnmpReply
Issues a synchronous SNMP get request.
Agent = agent_name()
@@ -268,7 +268,7 @@
- load_mibs(Mibs) -> ok | {error, Reason}
+ load_mibs(Mibs) -> ok | {error, Reason}
Loads the MIBs into agent snmp_master_agent.
Mibs = [MibName]
@@ -281,7 +281,7 @@
- register_agents(MgrAgentConfName, ManagedAgents) -> ok | {error, Reason}
+ register_agents(MgrAgentConfName, ManagedAgents) -> ok | {error, Reason}
Explicitly instructs the manager to handle this
agent.
@@ -300,7 +300,7 @@
- register_users(MgrAgentConfName, Users) -> ok | {error, Reason}
+ register_users(MgrAgentConfName, Users) -> ok | {error, Reason}
Registers the manager entity (=user) responsible for specific
agent(s).
@@ -319,7 +319,7 @@
- register_usm_users(MgrAgentConfName, UsmUsers) -> ok | {error, Reason}
+ register_usm_users(MgrAgentConfName, UsmUsers) -> ok | {error, Reason}
Explicitly instructs the manager to handle this USM user.
MgrAgentConfName = atom()
@@ -337,7 +337,7 @@
- set_info(Config) -> [{Agent, OldVarsAndVals, NewVarsAndVals}]
+ set_info(Config) -> [{Agent, OldVarsAndVals, NewVarsAndVals}]
Returns a list of all successful set requests performed in the
test case in reverse order.
@@ -357,7 +357,7 @@
- set_values(Agent, VarsAndVals, MgrAgentConfName, Config) -> SnmpReply
+ set_values(Agent, VarsAndVals, MgrAgentConfName, Config) -> SnmpReply
Issues a synchronous SNMP set request.
Agent = agent_name()
@@ -372,7 +372,7 @@
- start(Config, MgrAgentConfName) -> ok
+ start(Config, MgrAgentConfName) -> ok
Equivalent to start(Config, MgrAgentConfName,
undefined).
@@ -383,7 +383,7 @@
- start(Config, MgrAgentConfName, SnmpAppConfName) -> ok
+ start(Config, MgrAgentConfName, SnmpAppConfName) -> ok
Starts an SNMP manager and/or agent.
Config = [{Key, Value}]
@@ -415,7 +415,7 @@
- stop(Config) -> ok
+ stop(Config) -> ok
Stops the SNMP manager and/or agent, and removes all files
created.
@@ -443,7 +443,7 @@
- unregister_agents(MgrAgentConfName) -> ok
+ unregister_agents(MgrAgentConfName) -> ok
Unregisters all managed agents.
MgrAgentConfName = atom()
@@ -468,7 +468,7 @@
- unregister_users(MgrAgentConfName) -> ok
+ unregister_users(MgrAgentConfName) -> ok
Unregisters all users.
MgrAgentConfName = atom()
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()
diff --git a/lib/common_test/doc/src/ct_telnet.xml b/lib/common_test/doc/src/ct_telnet.xml
index 2d69338bca..9a12ce79ed 100644
--- a/lib/common_test/doc/src/ct_telnet.xml
+++ b/lib/common_test/doc/src/ct_telnet.xml
@@ -32,7 +32,7 @@
A
ct_telnet.xml
- ct_telnet
+ ct_telnet
Common Test specific layer on top of Telnet client ct_telnet_client.erl
@@ -205,7 +205,7 @@
- close(Connection) -> ok | {error, Reason}
+ close(Connection) -> ok | {error, Reason}
Closes the Telnet connection and stops the process managing
it.
@@ -223,7 +223,7 @@
- cmd(Connection, Cmd) -> {ok, Data} | {error, Reason}
+ cmd(Connection, Cmd) -> {ok, Data} | {error, Reason}
Equivalent to cmd(Connection, Cmd, []).
Equivalent to
@@ -233,7 +233,7 @@
- cmd(Connection, Cmd, Opts) -> {ok, Data} | {error, Reason}
+ cmd(Connection, Cmd, Opts) -> {ok, Data} | {error, Reason}
Sends a command through Telnet and waits for prompt.
Connection = connection()
@@ -262,7 +262,7 @@
- cmdf(Connection, CmdFormat, Args) -> {ok, Data} | {error, Reason}
+ cmdf(Connection, CmdFormat, Args) -> {ok, Data} | {error, Reason}
Equivalent to cmdf(Connection, CmdFormat, Args, []).
Equivalent to
@@ -272,7 +272,7 @@
- cmdf(Connection, CmdFormat, Args, Opts) -> {ok, Data} | {error, Reason}
+ cmdf(Connection, CmdFormat, Args, Opts) -> {ok, Data} | {error, Reason}
Sends a Telnet command and waits for prompt (uses a format
string and a list of arguments to build the command).
@@ -294,7 +294,7 @@
- expect(Connection, Patterns) -> term()
+ expect(Connection, Patterns) -> term()
Equivalent to expect(Connections, Patterns, []).
Equivalent to
@@ -304,7 +304,7 @@
- expect(Connection, Patterns, Opts) -> {ok, Match} | {ok, MatchList, HaltReason} | {error, Reason}
+ expect(Connection, Patterns, Opts) -> {ok, Match} | {ok, MatchList, HaltReason} | {error, Reason}
Gets data from Telnet and waits for the expected
pattern.
@@ -422,7 +422,7 @@
- get_data(Connection) -> {ok, Data} | {error, Reason}
+ get_data(Connection) -> {ok, Data} | {error, Reason}
Gets all data received by the Telnet client since the last
command was sent.
@@ -446,7 +446,7 @@
- open(Name) -> {ok, Handle} | {error, Reason}
+ open(Name) -> {ok, Handle} | {error, Reason}
Equivalent to open(Name, telnet).
Equivalent to
@@ -456,7 +456,7 @@
- open(Name, ConnType) -> {ok, Handle} | {error, Reason}
+ open(Name, ConnType) -> {ok, Handle} | {error, Reason}
Opens a Telnet connection to the specified target
host.
@@ -471,7 +471,7 @@
- open(KeyOrName, ConnType, TargetMod) -> {ok, Handle} | {error, Reason}
+ open(KeyOrName, ConnType, TargetMod) -> {ok, Handle} | {error, Reason}
Equivalent to open(KeyOrName, ConnType, TargetMod, []).
Equivalent to
@@ -481,7 +481,7 @@
- open(KeyOrName, ConnType, TargetMod, Extra) -> {ok, Handle} | {error, Reason}
+ open(KeyOrName, ConnType, TargetMod, Extra) -> {ok, Handle} | {error, Reason}
Opens a Telnet connection to the specified target
host.
@@ -531,7 +531,7 @@
- send(Connection, Cmd) -> ok | {error, Reason}
+ send(Connection, Cmd) -> ok | {error, Reason}
Equivalent to send(Connection, Cmd, []).
Equivalent to
@@ -566,7 +566,7 @@
- sendf(Connection, CmdFormat, Args) -> ok | {error, Reason}
+ sendf(Connection, CmdFormat, Args) -> ok | {error, Reason}
Equivalent to sendf(Connection, CmdFormat, Args, []).
Equivalent to
diff --git a/lib/common_test/doc/src/unix_telnet.xml b/lib/common_test/doc/src/unix_telnet.xml
index eaa184d8fc..03d91b7dbe 100644
--- a/lib/common_test/doc/src/unix_telnet.xml
+++ b/lib/common_test/doc/src/unix_telnet.xml
@@ -32,7 +32,7 @@
A
unix_telnet.xml
- unix_telnet
+ unix_telnet
Callback module for ct_telnet, for connecting to a Telnet
server on a UNIX host.
@@ -107,7 +107,7 @@
- get_prompt_regexp() -> PromptRegexp
+ get_prompt_regexp() -> PromptRegexp
Callback for ct_telnet.erl.
PromptRegexp = prompt_regexp()
--
cgit v1.2.3