From: Graham Leggett <minfrin@apache.org>
Date: Sun, 16 Nov 2008 19:32:13 +0000 (+0000)
Subject: Clarify the documentation for mod_buffer to better explain where the
X-Git-Tag: 2.3.0~99
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d3b023e835aeafe210ffa036eb84f862deb82dcd;p=thirdparty%2Fapache%2Fhttpd.git

Clarify the documentation for mod_buffer to better explain where the
buffer might be useful, and that buffering is not guaranteed to improve
performance in all cases.


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

diff --git a/docs/manual/mod/mod_buffer.xml b/docs/manual/mod/mod_buffer.xml
index a4bc39ee0a0..cd8aaf15593 100644
--- a/docs/manual/mod/mod_buffer.xml
+++ b/docs/manual/mod/mod_buffer.xml
@@ -58,6 +58,14 @@
         AddOutputFilterByType INCLUDES;BUFFER text/html<br />
       </example>
 
+    <note type="warning">The buffer filters read the request/response into
+        RAM and then repack the request/response into the fewest memory
+        buckets possible, at the cost of CPU time. When the request/response
+        is already efficiently packed, buffering the request/response could
+        cause the request/response to be slower than not using a buffer at
+        all. These filters should be used with care, and only where
+        necessary.</note>
+    
 </summary>
 <seealso><a href="../filter.html">Filters</a></seealso>