aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/src/ct_ssh.erl
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2012-08-27 11:39:27 +0200
committerLukas Larsson <[email protected]>2012-08-27 11:39:27 +0200
commitc44761ce22e76d9d07241ea5942e4b7e2c7aeb28 (patch)
treed164b84559e573aa61156a1b96869ee1fd45410c /lib/common_test/src/ct_ssh.erl
parent4877acc0598fe257315e8398dc9e11428d757000 (diff)
parenta95a238719369feb1002daeacf4e1485439a38d2 (diff)
downloadotp-c44761ce22e76d9d07241ea5942e4b7e2c7aeb28.tar.gz
otp-c44761ce22e76d9d07241ea5942e4b7e2c7aeb28.tar.bz2
otp-c44761ce22e76d9d07241ea5942e4b7e2c7aeb28.zip
Merge branch 'lukas/common_test/deep_get_config/OTP-9626' into maint
* lukas/common_test/deep_get_config/OTP-9626: Add more cross reference links to ct docs Remove config option from common_test args Update user config to use nested tuple keys
Diffstat (limited to 'lib/common_test/src/ct_ssh.erl')
-rw-r--r--lib/common_test/src/ct_ssh.erl7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/common_test/src/ct_ssh.erl b/lib/common_test/src/ct_ssh.erl
index 09cd4ef02a..d0d94e1e6e 100644
--- a/lib/common_test/src/ct_ssh.erl
+++ b/lib/common_test/src/ct_ssh.erl
@@ -133,10 +133,11 @@ connect(KeyOrName, ExtraOpts) when is_list(ExtraOpts) ->
%%% is used to identify the connection, this name may
%%% be used as connection reference for subsequent calls.
%%% It's only possible to have one open connection at a time
-%%% associated with <code>Name</code>. If <code>Key</code> is
+%%% associated with <code>Name</code>. If <code>Key</code> is
%%% used, the returned handle must be used for subsequent calls
%%% (multiple connections may be opened using the config
-%%% data specified by <code>Key</code>).</p>
+%%% data specified by <code>Key</code>). See <c>ct:require/2</c>
+%%% for how to create a new <c>Name</c></p>
%%%
%%% <p><code>ConnType</code> will always override the type
%%% specified in the address tuple in the configuration data (and
@@ -152,6 +153,8 @@ connect(KeyOrName, ExtraOpts) when is_list(ExtraOpts) ->
%%% The extra options will override any existing options with the
%%% same key in the config data. For details on valid SSH
%%% options, see the documentation for the OTP ssh application.</p>
+%%%
+%%% @see ct:require/2
connect(KeyOrName, ConnType, ExtraOpts) ->
case ct:get_config(KeyOrName) of
undefined ->