From 57c50be011a5005639d2be38f1c9f538d9f00f75 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= <egil@erlang.org>
Date: Fri, 13 Apr 2012 17:38:14 +0200
Subject: kernel: Document ifaddr option

  * same as ip option
---
 lib/kernel/doc/src/gen_tcp.xml | 14 +++++++++-----
 lib/kernel/doc/src/gen_udp.xml |  8 ++++++++
 2 files changed, 17 insertions(+), 5 deletions(-)

(limited to 'lib')

diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml
index e4f1cf7612..869e305690 100644
--- a/lib/kernel/doc/src/gen_tcp.xml
+++ b/lib/kernel/doc/src/gen_tcp.xml
@@ -102,6 +102,12 @@ do_recv(Sock, Bs) ->
               specifies which one to use.</p>
           </item>
 
+		  <tag><c>{ifaddr, ip_address()}</c></tag>
+          <item>
+			  <p>Same as <c>{ip, ip_address()}</c>. If the host has several network interfaces, this option
+              specifies which one to use.</p>
+		  </item>
+
           <tag><c>{fd, integer() >= 0}</c></tag>
           <item>
             <p>If a socket has somehow been connected without using
@@ -109,10 +115,6 @@ do_recv(Sock, Bs) ->
               descriptor for it.</p>
           </item>
 
-		  <tag><c>{ifaddr, ip_address()}</c></tag>
-          <item> <p>TODO: Document</p>
-		  </item>
-
           <tag><c>inet</c></tag>
           <item>
             <p>Set up the socket for IPv4.</p>
@@ -207,7 +209,9 @@ do_recv(Sock, Bs) ->
           </item>
 
 		  <tag><c>{ifaddr, ip_address()}</c></tag>
-          <item> <p>TODO: Document</p>
+          <item>
+			  <p>Same as <c>{ip, ip_address()}</c>. If the host has several network interfaces, this option
+              specifies which one to use.</p>
 		  </item>
 
           <tag><c>inet6</c></tag>
diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml
index 7cf8a6da4c..77e6182884 100644
--- a/lib/kernel/doc/src/gen_udp.xml
+++ b/lib/kernel/doc/src/gen_udp.xml
@@ -72,6 +72,14 @@
             <p>If the host has several network interfaces, this option
               specifies which one to use.</p>
           </item>
+
+		  <tag><c>{ifaddr, ip_address()}</c></tag>
+          <item>
+			  <p>Same as <c>{ip, ip_address()}</c>. If the host has several network interfaces, this option
+              specifies which one to use.</p>
+		  </item>
+
+
           <tag><c>{fd, integer() >= 0}</c></tag>
           <item>
             <p>If a socket has somehow been opened without using
-- 
cgit v1.2.3