aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src/ct_netconfc.xml
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2016-03-09 13:07:49 +0100
committerSiri Hansen <[email protected]>2016-03-09 13:07:49 +0100
commitd7da92821e8136c5d20d7dae17740282ce27c52d (patch)
tree398f508b56ba662e7d58be313f26630c321678f9 /lib/common_test/doc/src/ct_netconfc.xml
parentb9e468fb03a595d4c3c4555a9fe5085342887729 (diff)
downloadotp-d7da92821e8136c5d20d7dae17740282ce27c52d.tar.gz
otp-d7da92821e8136c5d20d7dae17740282ce27c52d.tar.bz2
otp-d7da92821e8136c5d20d7dae17740282ce27c52d.zip
Document that any ssh option is allowed in ct_netconfc
The code was changed by OTP-13338, commit bf309240cb531df880989702ae901316e8b5e97d.
Diffstat (limited to 'lib/common_test/doc/src/ct_netconfc.xml')
-rw-r--r--lib/common_test/doc/src/ct_netconfc.xml17
1 files changed, 9 insertions, 8 deletions
diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml
index 8139d8afdb..d181afbb76 100644
--- a/lib/common_test/doc/src/ct_netconfc.xml
+++ b/lib/common_test/doc/src/ct_netconfc.xml
@@ -201,10 +201,8 @@
information, see module <seealso marker="ct"><c>ct</c></seealso>.</p>
</item>
- <tag><c>host() = hostname() | ip_address()</c></tag>
- <item><marker id="type-host"/>
- <p>For <c>hostname()</c> and <c>ip_address()</c>, see module
- <seealso marker="kernel:inet"><c>kernel:inet</c></seealso></p></item>
+ <tag><c>host() = <seealso marker="kernel:inet#type-hostname"><c>inet:hostname()</c></seealso> | <seealso marker="kernel:inet#type-ip_address"><c>inet:ip_address()</c></seealso></c></tag>
+ <item><marker id="type-host"/></item>
<tag><c>key_or_name() = server_id() | target_name()</c></tag>
<item><marker id="type-key_or_name"/>
@@ -220,10 +218,13 @@
<tag><c>notification_content() = [event_time() | simple_xml()]</c></tag>
<item><marker id="type-notification_content"/> </item>
- <tag><c>option() = {ssh, host()} | {port, port_number()} | {user, string()} | {password, string()} | {user_dir, string()} | {timeout, timeout()}</c></tag>
+ <tag><c>option() = {ssh, host()} | {port, <seealso marker="kernel:inet#type-port_number"><c>inet:port_number()</c></seealso>} | {timeout, timeout()} | ssh_connect_option()</c></tag>
<item><marker id="type-option"/>
- <p>For <c>port_number()</c>, see module
- <seealso marker="kernel:inet"><c>kernel:inet</c></seealso></p></item>
+ <p>For <c>ssh_connect_option()</c>, see
+ <seealso marker="ssh:ssh#connect-3"><c>ssh:connect/3,4</c></seealso>. Common
+ SSH connect options are <c>user</c>, <c>password</c>
+ and <c>user_dir</c>, but any option that is verified as valid
+ by application <c>SSH</c> is allowed.</p></item>
<tag><c>options() = [option()]</c></tag>
<item><marker id="type-options"/>
@@ -887,7 +888,7 @@ SessionId, infinity)</c></seealso>.</p>
<seealso marker="#open-2"><c>ct_netconfc:open/2</c></seealso>
instead.</p>
- <p>The opaque <c>handler()</c> reference returned from this
+ <p>The opaque <c>handle()</c> reference returned from this
function is required as client identifier when calling any other
function in this module.</p>