add some explanations how to use AOFBT correctly.

related to: PR 15045
Reviewed by: Astrid Ke�ler <kess@kess-net.de>

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

diff --git a/docs/manual/mod/core.html.en b/docs/manual/mod/core.html.en
index f6989619438049dafa7dd248ec8fdb1abb2581c0..99cedab5edc6332135df772965d499845e63a99e 100644 (file)
--- a/docs/manual/mod/core.html.en
+++ b/docs/manual/mod/core.html.en
@@ -222,10 +222,20 @@ response without an explicit character set</td></tr><tr><th><a href="directive-d
     &lt;/Location&gt;
     </code></p></div>
 
-    <div class="note"><h3>Note:</h3>
-    <p>The output filters are not applied on proxy requests.</p>
+    <div class="warning"><h3>Note:</h3>
+      <p>Enabling filters with <code class="directive">AddOutputFilterByType</code>
+      may fail partially or completely in some cases. For expample, no
+      filters are applied if the content type falls back to the <code class="directive"><a href="#defaulttype">DefaultType</a></code>, even if the <code class="directive"><a href="#defaulttype">DefaultType</a></code> is the same.</p>
+
+      <p>However, if you want to make sure, that the filters will be
+      applied, assign the content type to a resource explicitely, for
+      example with <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> or
+      <code class="directive"><a href="#forcetype">ForceType</a></code>. Setting the
+      content type within a (non-nph) CGI script is also safe.</p>
+
+      <p>The output filters are never applied on proxy requests.</p>
     </div>
-<h3>See also</h3><ul><li><code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code></li><li><code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code></li><li><code class="module"><a href="../mod/mod_include.html">mod_include</a></code></li><li><code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code></li><li><a href="../filter.html">The filters documentation</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
+<h3>See also</h3><ul><li><code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code></li><li><code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code></li><li><a href="../filter.html">filters</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
               </a></th><td>Types of directives that are allowed in
 .htaccess files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
               </a></th><td><code>AllowOverride All|None|<var>directive-type</var> 

diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml
index a5467279d41880d625f9e41b43647ea2839fcf0a..ccac304776687b330264ad4ddf171de7dc0d5c60 100644 (file)
--- a/docs/manual/mod/core.xml
+++ b/docs/manual/mod/core.xml
@@ -190,16 +190,26 @@ response without an explicit character set</description>
     &lt;/Location&gt;
     </example>
 
-    <note><title>Note:</title>
-    <p>The output filters are not applied on proxy requests.</p>
+    <note type="warning"><title>Note:</title>
+      <p>Enabling filters with <directive>AddOutputFilterByType</directive>
+      may fail partially or completely in some cases. For expample, no
+      filters are applied if the content type falls back to the <directive
+      module="core">DefaultType</directive>, even if the <directive
+      module="core">DefaultType</directive> is the same.</p>
+
+      <p>However, if you want to make sure, that the filters will be
+      applied, assign the content type to a resource explicitely, for
+      example with <directive module="mod_mime">AddType</directive> or
+      <directive module="core">ForceType</directive>. Setting the
+      content type within a (non-nph) CGI script is also safe.</p>
+
+      <p>The output filters are never applied on proxy requests.</p>
     </note>
 </usage>
 
 <seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
 <seealso><directive module="core">SetOutputFilter</directive></seealso>
-<seealso><module>mod_include</module></seealso>
-<seealso><module>mod_deflate</module></seealso>
-<seealso><a href="../filter.html">The filters documentation</a></seealso>
+<seealso><a href="../filter.html">filters</a></seealso>
 </directivesynopsis>
 
 <directivesynopsis>