From 0ef9dd12e5e77d67244dca580c1a706878c272bf Mon Sep 17 00:00:00 2001
From: vans163 <vans_163@yahoo.com>
Date: Tue, 31 Jan 2017 14:07:27 -0500
Subject: Update inet.xml. Note buffer relation to MTU

The documentation does not indicate this is the buffer responsible for the maximum bytes we can receive from a recv call.
---
 lib/kernel/doc/src/inet.xml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'lib/kernel/doc')

diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index 4c4a5c39cb..d557efb6a8 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -659,7 +659,8 @@ get_tcpi_sacked(Sock) ->
           <tag><c>{buffer, Size}</c></tag>
           <item>
             <p>The size of the user-level software buffer used by
-              the driver. Not to be confused with options <c>sndbuf</c>
+              the driver. 
+              Not to be confused with options <c>sndbuf</c>
               and <c>recbuf</c>, which correspond to the
               Kernel socket buffers. It is recommended
               to have <c>val(buffer) &gt;= max(val(sndbuf),val(recbuf))</c> to
@@ -670,6 +671,9 @@ get_tcpi_sacked(Sock) ->
               usually become larger, you are encouraged to use
               <seealso marker="#getopts/2"><c>getopts/2</c></seealso>
               to analyze the behavior of your operating system.</p>
+            <p>Note that this is also the maximum amount of data that can be
+	       received from a single recv call. If you are using higher than 
+	       normal MTU consider setting buffer higher.</p> 
           </item>
           <tag><c>{delay_send, Boolean}</c></tag>
           <item>
-- 
cgit v1.2.3