Commit 8b6c0c6f authored by Nick Kew's avatar Nick Kew
Browse files

Update mod_filter docs to mention API functions and promote 

out of experimental.


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

docs/manual/mod/mod_filter.html.en

+6 −6
Changes for docs/manual/mod/mod_filter.html.en: 6 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ 
<p><span>Available Languages: </span><a href="../en/mod/mod_filter.html" title="English">&nbsp;en&nbsp;</a></p>

</div>

<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Context-sensitive smart filter configuration module</td></tr>

<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>filter_module</td></tr>

<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_filter.c</td></tr>

<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.1 and higher</td></tr></table>
@@ -233,7 +233,7 @@ 
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FilterChain [+=-@!]<var>filter-name</var> <var>...</var></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_filter</td></tr>

</table>

    <p>This configures an actual filter chain, from declared filters.
@@ -269,7 +269,7 @@ 
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FilterDeclare <var>filter-name</var> <var>[type]</var></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_filter</td></tr>

</table>

    <p>This directive declares an output filter together with a
@@ -294,7 +294,7 @@ 
    <var>proto-flags</var></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_filter</td></tr>

</table>

    <p>This directs <code class="module"><a href="../mod/mod_filter.html">mod_filter</a></code> to deal with ensuring the
@@ -343,7 +343,7 @@ 
 [req|resp|env]=<var>dispatch</var> <var>match</var></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>

<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_filter</td></tr>

</table>

    <p>This directive registers a <em>provider</em> for the smart filter.
@@ -399,7 +399,7 @@ 
    <code class="module"><a href="../mod/mod_filter.html">mod_filter</a></code></td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FilterTrace <var>filter-name</var> <var>level</var></code></td></tr>

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_filter</td></tr>

</table>

    <p>This directive generates debug information from

docs/manual/mod/mod_filter.xml

+10 −2
Changes for docs/manual/mod/mod_filter.xml: 10 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ 


<name>mod_filter</name>

<description>Context-sensitive smart filter configuration module</description>

<status>Experimental</status>

<status>Base</status>

<sourcefile>mod_filter.c</sourcefile>

<identifier>filter_module</identifier>

<compatibility>Version 2.1 and higher</compatibility>
@@ -207,13 +207,21 @@ 
    details of filter implementation, reducing the complexity required of

    content filter modules. This is work-in-progress; the

    <directive module="mod_filter">FilterProtocol</directive> implements

    some of this functionality, but there are no API calls yet.</p>

    some of this functionality for back-compatibility with Apache 2.0

    modules.  For httpd 2.1 and up, the

    <code>ap_register_output_filter_protocol</code> and

    <code>ap_filter_protocol</code> API enables filter modules to

    declare their own behaviour.</p>



    <p>At the same time, <module>mod_filter</module> should not interfere

    with a filter that wants to handle all aspects of the protocol.  By

    default (i.e. in the absence of any <directive module="mod_filter"

    >FilterProtocol</directive> directives), <module>mod_filter</module>

    will leave the headers untouched.</p>



    <p>At the time of writing, this feature is largely untested,

    as modules in common use are designed to work with 2.0.

    Modules using it should test it carefully.</p>

</section>



<directivesynopsis>