diff options
| author | Björn-Egil Dahlberg <egil@erlang.org> | 2012-04-13 17:38:14 +0200 |
|---|---|---|
| committer | Björn-Egil Dahlberg <egil@erlang.org> | 2012-04-16 15:03:35 +0200 |
| commit | 57c50be011a5005639d2be38f1c9f538d9f00f75 (patch) | |
| tree | 68d7b68006018323de5e90f1da45372971f4d647 /lib/kernel | |
| parent | d64479bcc536c64b15e0c9fa28ecb73bc7e385a4 (diff) | |
| download | erlang-57c50be011a5005639d2be38f1c9f538d9f00f75.tar.gz | |
kernel: Document ifaddr option
* same as ip option
Diffstat (limited to 'lib/kernel')
| -rw-r--r-- | lib/kernel/doc/src/gen_tcp.xml | 14 | ||||
| -rw-r--r-- | lib/kernel/doc/src/gen_udp.xml | 8 |
2 files changed, 17 insertions, 5 deletions
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 |