File 3392-kernel-Add-note-s-for-not-supported-options.patch of Package erlang
From f62f24490e4b6ed1cd5933ba66802217a7cdc03f Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 7 Nov 2023 11:08:30 +0100
Subject: [PATCH] [kernel] Add note(s) for not supported options
Add note(s) in the doc regarding *currently* unsupported
socket options. gen_tcp (actually inet) documents Windows
specific socket options; reuseport, reuseport_lb and exclusiveaddruse
These options are *not* supported if the socket is created
with inet_backend = socket.
---
lib/kernel/doc/src/inet.xml | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index fc58e62ebf..1707d4dec5 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -1134,6 +1134,10 @@ get_tcpi_sacked(Sock) ->
has been set on <c><anno>Socket</anno></c>. On non-Windows
systems this option is silently ignored.
</p>
+ <note>
+ <p>This option is <em>currently</em> not supported for
+ socket created with <c>inet_backend = socket</c></p>
+ </note>
</item>
<tag><c>{header, Size}</c></tag>
<item>
@@ -1678,7 +1682,7 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code>
See also the
<seeerl marker="#option-exclusiveaddruse"><c>exclusiveaddruse</c></seeerl>
option.
- </p>
+ </p>
</note>
<note>
<p>
@@ -1691,7 +1695,11 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code>
by enabling <c>reuseport</c> and then disabling
<c>reuseport_lb</c> both will end up being disabled.
</p>
- </note>
+ </note>
+ <note>
+ <p>This option is <em>currently</em> not supported for
+ socket created with <c>inet_backend = socket</c></p>
+ </note>
</item>
<tag><c>{reuseport_lb, Boolean}</c><marker id="option-reuseport_lb"/></tag>
<item>
@@ -1712,6 +1720,10 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code>
<c>reuseport</c> both will end up being disabled.
</p>
</note>
+ <note>
+ <p>This option is <em>currently</em> not supported for
+ socket created with <c>inet_backend = socket</c></p>
+ </note>
</item>
<tag><c>{send_timeout, Integer}</c></tag>
<item>
--
2.35.3