diff options
| author | Siri Hansen <[email protected]> | 2016-03-09 13:07:49 +0100 |
|---|---|---|
| committer | Siri Hansen <[email protected]> | 2016-03-10 12:32:05 +0100 |
| commit | 12f4a305208c26a7c2a1185cac6ecf5dbc1a8d00 (patch) | |
| tree | d244331a2a0cd708dccfcb4f46ecb05334b9021e /lib/common_test/doc/src/ct_netconfc.xml | |
| parent | b9e468fb03a595d4c3c4555a9fe5085342887729 (diff) | |
| download | otp-12f4a305208c26a7c2a1185cac6ecf5dbc1a8d00.tar.gz otp-12f4a305208c26a7c2a1185cac6ecf5dbc1a8d00.tar.bz2 otp-12f4a305208c26a7c2a1185cac6ecf5dbc1a8d00.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.xml | 18 |
1 files changed, 10 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..1355488916 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,14 @@ <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()} | SshConnectOption</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><c>SshConnectOption</c> is any valid option to + <seealso marker="ssh:ssh#connect-3"><c>ssh:connect/3,4</c></seealso>. + Common options used are <c>user</c>, <c>password</c> + and <c>user_dir</c>. The <c>SshConnectOptions</c> are + verfied by the SSH application.</p></item> <tag><c>options() = [option()]</c></tag> <item><marker id="type-options"/> @@ -887,7 +889,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> |