From 5f8c0d0a439d1ff993c8485403b74aa2a9294248 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= <egil@erlang.org>
Date: Fri, 13 Apr 2012 14:28:13 +0200
Subject: 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
---
 lib/kernel/doc/src/inet.xml | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'lib/kernel/doc/src/inet.xml')

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>
-- 
cgit v1.2.3