aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorRaimo Niskanen <[email protected]>2018-09-18 15:46:31 +0200
committerRaimo Niskanen <[email protected]>2018-09-19 14:52:09 +0200
commit9674ece7b2e57e265bd1dc55a623cc7888a1caa0 (patch)
tree1b85793525781132a50950d5ef13843a4f61caff /lib
parent2ad4b8f65e07423dd3cf230cecae635189b6f437 (diff)
downloadotp-9674ece7b2e57e265bd1dc55a623cc7888a1caa0.tar.gz
otp-9674ece7b2e57e265bd1dc55a623cc7888a1caa0.tar.bz2
otp-9674ece7b2e57e265bd1dc55a623cc7888a1caa0.zip
Elaborate the disclaimer for 'pktoptions'
Diffstat (limited to 'lib')
-rw-r--r--lib/kernel/doc/src/gen_tcp.xml14
1 files changed, 13 insertions, 1 deletions
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml
index cf649991d0..24d63693fd 100644
--- a/lib/kernel/doc/src/gen_tcp.xml
+++ b/lib/kernel/doc/src/gen_tcp.xml
@@ -74,13 +74,25 @@ do_recv(Sock, Bs) ->
<desc>
<p>
If the platform implements the IPv4 option
- <c>IP_PKTOPTIONS</c> (probably Linux specific), or the IPv6 option
+ <c>IP_PKTOPTIONS</c>, or the IPv6 option
<c>IPV6_PKTOPTIONS</c> or <c>IPV6_2292PKTOPTIONS</c> for the socket
this value is returned from
<seealso marker="inet#getopts/2"><c>inet:getopts/2</c></seealso>
when called with the option name
<seealso marker="#type-option_name"><c>pktoptions</c></seealso>.
</p>
+ <note>
+ <p>
+ This option appears to be VERY Linux specific,
+ and its existence in future Linux kernel versions
+ is also worrying since the option is part of RFC 2292
+ which is since long (2003) obsoleted by RFC 3542
+ that <em>explicitly</em> removes this possibility to get
+ packet information from a stream socket.
+ For comparision: it has existed in FreeBSD but is now removed,
+ at least since FreeBSD 10.
+ </p>
+ </note>
</desc>
</datatype>
<datatype>