ssh: Change handling of forbidden sock options

1 files changed, 33 insertions, 2 deletions

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index ca6a02117b..8e31ee6b24 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -179,6 +179,17 @@
       <p>Options for <seemfa marker="#connect/3">clients</seemfa>.
       The individual options are further explained below or by following the hyperlinks.
       </p>
+      <p>Note that not every
+      <seetype marker="kernel:gen_tcp#connect_option">gen_tcp:connect_option()</seetype>
+      is accepted. See
+      <seemfa marker="ssh#set_sock_opts/2">set_sock_opts/2</seemfa>
+      for a list of prohibited options.
+      </p>
+      <p>Also note that setting a
+      <seetype marker="kernel:gen_tcp#connect_option">gen_tcp:connect_option()</seetype>
+      could change the socket in a way that impacts the ssh client's behaviour
+      negatively. You use it on your own risk.
+      </p>
       </desc>
     </datatype>
 
@@ -341,6 +352,17 @@
       <p>Options for <seemfa marker="#daemon/1">daemons</seemfa>.
       The individual options are further explained below or by following the hyperlinks.
       </p>
+      <p>Note that not every
+      <seetype marker="kernel:gen_tcp#listen_option">gen_tcp:listen_option()</seetype>
+      is accepted. See
+      <seemfa marker="ssh#set_sock_opts/2">set_sock_opts/2</seemfa>
+      for a list of prohibited options.
+      </p>
+      <p>Also note that setting a
+      <seetype marker="kernel:gen_tcp#listen_option">gen_tcp:listen_option()</seetype>
+      could change the socket in a way that impacts the ssh deamon's behaviour
+      negatively. You use it on your own risk.
+      </p>
       </desc>
     </datatype>
 
@@ -1221,8 +1243,17 @@
        <p>This function calls the
        <seemfa marker="kernel:inet#setopts/2">inet:setopts/2</seemfa>, read that documentation and
        for <seetype marker="kernel:gen_tcp#option">gen_tcp:option()</seetype>.
-       All gen_tcp socket options except <c>active</c>, <c>deliver</c>, <c>mode</c> and <c>packet</c>
-       are allowed. The excluded options are reserved by the SSH application.
+       </p>
+       <p>
+       All gen_tcp socket options except
+       </p>
+       <list>
+	 <item><c>active</c></item>
+	 <item><c>deliver</c></item>
+	 <item><c>mode</c> and</item>
+	 <item><c>packet</c></item>
+       </list>
+       <p>are allowed. The excluded options are reserved by the SSH application.
        </p>
        <warning>
 	 <p>This is an extremly dangerous function. You use it on your own risk.</p>