diff options
author | Björn-Egil Dahlberg <egil@erlang.org> | 2012-04-13 14:28:13 +0200 |
---|---|---|
committer | Björn-Egil Dahlberg <egil@erlang.org> | 2012-04-13 14:28:13 +0200 |
commit | 5f8c0d0a439d1ff993c8485403b74aa2a9294248 (patch) | |
tree | 393d0db4adadd71cd0f189cbdafc1fff7d5d1d7f | |
parent | 14867ef618386d5008adf19b8d7a76e56f869145 (diff) | |
download | otp-5f8c0d0a439d1ff993c8485403b74aa2a9294248.tar.gz otp-5f8c0d0a439d1ff993c8485403b74aa2a9294248.tar.bz2 otp-5f8c0d0a439d1ff993c8485403b74aa2a9294248.zip |
kernel: Document bit8 option in inet:setopts/2
* This is a highly specialized option which is
probably not used and will be removed in R16
-rw-r--r-- | lib/kernel/doc/src/inet.xml | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index 05946f1f18..522a27dcfa 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -447,7 +447,13 @@ fe80::204:acff:fe17:bf38 </item> <tag><c>{bit8, clear | set | on | off}</c></tag> - <item> <p>TODO: Document</p> + <item> + <p> + Scans every byte in received data-packets and checks if the 8 bit + is set in any of them. Information is retrieved with + <c>inet:getopts/2</c>. + <note>Deprecated! Will be removed in Erlang/OTP R16.</note> + </p> </item> <tag><c>{broadcast, Boolean}</c>(UDP sockets)</tag> |