From: Georg Brandl <georg@python.org>
Date: Mon, 26 Dec 2005 23:07:46 +0000 (+0000)
Subject: Bug #756104: document that bufsize in socket.recv() should be small
X-Git-Tag: v2.5a0~948
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=10141742d517144afe7fbba7e08ca5eddea70d69;p=thirdparty%2FPython%2Fcpython.git

Bug #756104: document that bufsize in socket.recv() should be small
---

diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
index 51c4a2fc5f5f..e3d9a92a85b4 100644
--- a/Doc/lib/libsocket.tex
+++ b/Doc/lib/libsocket.tex
@@ -557,6 +557,8 @@ the data received.  The maximum amount of data to be received
 at once is specified by \var{bufsize}.  See the \UNIX{} manual page
 \manpage{recv}{2} for the meaning of the optional argument
 \var{flags}; it defaults to zero.
+\note{For best match with hardware and network realities, the value of 
+\var{bufsize} should be a relatively small power of 2, for example, 4096.}
 \end{methoddesc}
 
 \begin{methoddesc}[socket]{recvfrom}{bufsize\optional{, flags}}