Document the ReceiveBufferSize change done in r157583

Submitted by: Murray Nesbitt <murray@cpan.org>]

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@280384 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/CHANGES b/CHANGES
index c81e7bdc863397e8c299dc33de5ca0d7f7e26f02..49c7050a773f3231d6dfcafff4d9fad6fdaf59e2 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -2,6 +2,9 @@
 Changes with Apache 2.3.0
   [Remove entries to the current 2.0 and 2.2 section below, when backported]
 
+  *) Document the ReceiveBufferSize change done in r157583 [Murray
+     Nesbitt <murray@cpan.org>]
+
   *) Fix mod_dbd's config [Brian J. France <list firehawksystems.com>]
 
   *) New provider function to list all available provider names in a

diff --git a/docs/manual/mod/beos.xml b/docs/manual/mod/beos.xml
index beeaffef75f8c3e85dbeb2537ed1bc0c2ce35970..a9658fa4eecbd356092655e47a8cda24b9531b44 100644 (file)
--- a/docs/manual/mod/beos.xml
+++ b/docs/manual/mod/beos.xml
@@ -43,6 +43,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ListenBacklog</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>StartThreads</name>

diff --git a/docs/manual/mod/leader.xml b/docs/manual/mod/leader.xml
index 4224f5ea2a8084a5ecd31f7b3c2552b27355557b..b053ccfc3e14e01a10872748e89ae701f1435367 100644 (file)
--- a/docs/manual/mod/leader.xml
+++ b/docs/manual/mod/leader.xml
@@ -66,6 +66,8 @@ MPM</description>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ListenBacklog</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>LockFile</name>

diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml
index 347f4cb6e32cac69e063c6919cca6cbe6a603699..2142ba3c9c18a55b4c511da704ff788e08b78a4f 100644 (file)
--- a/docs/manual/mod/mpm_common.xml
+++ b/docs/manual/mod/mpm_common.xml
@@ -661,6 +661,26 @@ the child processes</description>
 Apache</a></seealso>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>ReceiveBufferSize</name>
+<description>TCP receive buffer size</description>
+<syntax>ReceiveBufferSize <var>bytes</var></syntax>
+<default>ReceiveBufferSize 0</default>
+<contextlist><context>server config</context></contextlist>
+<modulelist><module>beos</module><module>leader</module>
+<module>mpm_netware</module><module>mpm_winnt</module>
+<module>mpmt_os2</module><module>perchild</module><module>prefork</module>
+<module>threadpool</module><module>worker</module></modulelist>
+
+<usage>
+    <p>The server will set the TCP receive buffer size to the number of
+    bytes specified.</p>
+
+    <p>If set to the value of <code>0</code>, the server will use the
+    OS default.</p>
+</usage>
+</directivesynopsis>
+
 <directivesynopsis>
 <name>SendBufferSize</name>
 <description>TCP buffer size</description>
@@ -673,13 +693,13 @@ Apache</a></seealso>
 <module>threadpool</module><module>worker</module></modulelist>
 
 <usage>
-    <p>The server will set the TCP buffer size to the number of bytes
+    <p>The server will set the TCP send buffer size to the number of bytes
     specified. Very useful to increase past standard OS defaults on
     high speed high latency (<em>i.e.</em>, 100ms or so, such as
     transcontinental fast pipes).</p>
 
     <p>If set to the value of <code>0</code>, the server will use the
-    OS deault.</p>
+    OS default.</p>
 </usage>
 </directivesynopsis>
 

diff --git a/docs/manual/mod/mpm_netware.xml b/docs/manual/mod/mpm_netware.xml
index 7985902c647b4583f49dc3ad74a3c92789765db4..126a6a369ee6f51856e89d6fba702bdf481961f9 100644 (file)
--- a/docs/manual/mod/mpm_netware.xml
+++ b/docs/manual/mod/mpm_netware.xml
@@ -73,6 +73,8 @@
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>MaxRequestsPerChild</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>MaxSpareThreads</name>

diff --git a/docs/manual/mod/mpm_winnt.xml b/docs/manual/mod/mpm_winnt.xml
index 93f2ff88d37f27746a5bb89278b38b03b8d8cbf9..0968963c36de3698a705fc6b060e103cf16d13cc 100644 (file)
--- a/docs/manual/mod/mpm_winnt.xml
+++ b/docs/manual/mod/mpm_winnt.xml
@@ -50,6 +50,8 @@ NT.</description>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ScoreBoardFile</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ThreadLimit</name>

diff --git a/docs/manual/mod/mpmt_os2.xml b/docs/manual/mod/mpmt_os2.xml
index 479c43990f15393c7e3e692c6265e6d37832deea..d39d20252a3b1cd19a70cf3cf7188e276fa3bae0 100644 (file)
--- a/docs/manual/mod/mpmt_os2.xml
+++ b/docs/manual/mod/mpmt_os2.xml
@@ -55,6 +55,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ListenBacklog</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>MaxRequestsPerChild</name>

diff --git a/docs/manual/mod/perchild.xml b/docs/manual/mod/perchild.xml
index f386849b15713b11aa785f7c4ee4871992f85ec9..735ba54d04ef3c9fd963146d0feb9f0d00927d43 100644 (file)
--- a/docs/manual/mod/perchild.xml
+++ b/docs/manual/mod/perchild.xml
@@ -168,6 +168,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ScoreBoardFile</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ServerLimit</name>

diff --git a/docs/manual/mod/prefork.xml b/docs/manual/mod/prefork.xml
index 10b9af1a205cec8e8289e445fa05a7037ebf3011..cd7e33953bc09704f5d038d6bce165b307d0bc8a 100644 (file)
--- a/docs/manual/mod/prefork.xml
+++ b/docs/manual/mod/prefork.xml
@@ -105,6 +105,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ScoreBoardFile</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ServerLimit</name>

diff --git a/docs/manual/mod/threadpool.xml b/docs/manual/mod/threadpool.xml
index 2c4b6f7015b94f79daf0db95ba481b55dd251a36..8b3376791b8376c358602120c2be3a26748fcb2c 100644 (file)
--- a/docs/manual/mod/threadpool.xml
+++ b/docs/manual/mod/threadpool.xml
@@ -60,6 +60,8 @@
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ListenBacklog</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>LockFile</name>

diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml
index f68520fdac51834b70b83a8a898ebeee00348556..904c37e13df1f180fbd32bb84c216ee71c8e4a5e 100644 (file)
--- a/docs/manual/mod/worker.xml
+++ b/docs/manual/mod/worker.xml
@@ -167,6 +167,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ScoreBoardFile</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>ReceiveBufferSize</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ServerLimit</name>

diff --git a/docs/manual/vhosts/details.xml b/docs/manual/vhosts/details.xml
index 2da46607a746530948e7512ecf5157bc7b0ce133..5b022778779dbe096c74e1b358c7afd55cb451f7 100644 (file)
--- a/docs/manual/vhosts/details.xml
+++ b/docs/manual/vhosts/details.xml
@@ -191,6 +191,7 @@
       <directive module="core">KeepAliveTimeout</directive>,
       <directive module="core">KeepAlive</directive>,
       <directive module="core">MaxKeepAliveRequests</directive>,
+      <directive module="core">ReceiveBufferSize</directive>,
       or <directive module="core">SendBufferSize</directive>
       directive then the respective value is inherited from the
       main_server. (That is, inherited from whatever the final