Permalink
Browse files

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
  • Loading branch information...
1 parent 14867ef commit 5f8c0d0a439d1ff993c8485403b74aa2a9294248 @psyeugenic psyeugenic committed Apr 13, 2012
Showing with 7 additions and 1 deletion.
  1. +7 −1 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>

0 comments on commit 5f8c0d0

Please sign in to comment.