aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc/src/ssh_server_channel.xml
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2019-08-19 15:16:52 +0200
committerHans Nilsson <[email protected]>2019-08-19 15:16:52 +0200
commit8922f87db2a9496aabb5bc5e9abc97c7a8d2e5e6 (patch)
tree1c4b2cc4dd80991fb5adb3ab973fabea990c5499 /lib/ssh/doc/src/ssh_server_channel.xml
parent8722bd998d51c4063e3e75242d429c9d1225453d (diff)
parenta5f5feb9b4c4bedfa027b07e33a5d1ccc9fb240b (diff)
downloadotp-8922f87db2a9496aabb5bc5e9abc97c7a8d2e5e6.tar.gz
otp-8922f87db2a9496aabb5bc5e9abc97c7a8d2e5e6.tar.bz2
otp-8922f87db2a9496aabb5bc5e9abc97c7a8d2e5e6.zip
Merge branch 'hans/ssh/gendoc/OTP-15395' into maint
* hans/ssh/gendoc/OTP-15395: ssh: Use new ssh_connection:event() type in channel defs ssh: change type names ssh: The ssh_connection documentation is now generated ssh: Update ssh_sftp:start_channel documentation and code ssh: The ssh_sftp documentation is now generated ssh: The ssh_sftpd documentation is now generated
Diffstat (limited to 'lib/ssh/doc/src/ssh_server_channel.xml')
-rw-r--r--lib/ssh/doc/src/ssh_server_channel.xml8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/ssh/doc/src/ssh_server_channel.xml b/lib/ssh/doc/src/ssh_server_channel.xml
index a4e18bbfbf..87c745c9fb 100644
--- a/lib/ssh/doc/src/ssh_server_channel.xml
+++ b/lib/ssh/doc/src/ssh_server_channel.xml
@@ -112,7 +112,7 @@
function and all channels are to handle the following message.</p>
<taglist>
- <tag><c>{ssh_channel_up, ssh:channel_id(), ssh:connection_ref()}</c></tag>
+ <tag><c>{ssh_channel_up, </c><seealso marker="ssh:ssh#type-channel_id">ssh:channel_id()</seealso><c>, </c><seealso marker="ssh:ssh#type-connection_ref">ssh:connection_ref()</seealso><c>}</c></tag>
<item><p>This is the first message that the channel receives.
This is especially useful if the
server wants to send a message to the client without first
@@ -129,21 +129,21 @@
ChannelId, State}</name>
<fsummary>Handles <c>ssh</c> connection protocol messages.</fsummary>
<type>
- <v>Msg = ssh_connection:event()</v>
+ <v>Msg = <seealso marker="ssh_connection#type-event">ssh_connection:event()</seealso></v>
<v>ChannelId = <seealso marker="ssh#type-channel_id">ssh:channel_id()</seealso></v>
<v>State = term()</v>
</type>
<desc>
<p>Handles SSH Connection Protocol messages that may need
service-specific attention. For details,
- see <seealso marker="ssh_connection"> ssh_connection:event()</seealso>.
+ see <seealso marker="ssh_connection#type-event">ssh_connection:event()</seealso>.
</p>
<p>The following message is taken care of by the
<c>ssh_server_channel</c> behavior.</p>
<taglist>
- <tag><c>{closed, ssh:channel_id()}</c></tag>
+ <tag><c>{closed, </c><seealso marker="ssh:ssh#type-channel_id">ssh:channel_id()</seealso><c>}</c></tag>
<item><p>The channel behavior sends a close message to the
other side, if such a message has not already been sent.
Then it terminates the channel with reason <c>normal</c>.</p></item>