add info about new early/late arguments and a note about

the directives whose context is limited.

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

diff --git a/docs/manual/mod/mod_lua.html.en b/docs/manual/mod/mod_lua.html.en
index eaae1a6b00d5935a617b68f3cd09c355a7eeea7d..e8e5bc60c234ec68da5e4330811e4760ab5f9e1c 100644 (file)
--- a/docs/manual/mod/mod_lua.html.en
+++ b/docs/manual/mod/mod_lua.html.en
@@ -451,25 +451,29 @@ end
 <div class="directive-section"><h2><a name="LuaHookAccessChecker" id="LuaHookAccessChecker">LuaHookAccessChecker</a> <a name="luahookaccesschecker" id="luahookaccesschecker">Directive</a></h2>
 <table class="directive">
 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the access_checker phase of request processing</td></tr>
-<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAccessChecker  /path/to/lua/script.lua  hook_function_name</code></td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAccessChecker  /path/to/lua/script.lua  hook_function_name [early|late]</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>All</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
 </table>
 <p>Add your hook to the access_checker phase.  An access checker
 hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
+   <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></div>
 
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="directive-section"><h2><a name="LuaHookAuthChecker" id="LuaHookAuthChecker">LuaHookAuthChecker</a> <a name="luahookauthchecker" id="luahookauthchecker">Directive</a></h2>
 <table class="directive">
 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the auth_checker phase of request processing</td></tr>
-<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAuthChecker  /path/to/lua/script.lua hook_function_name</code></td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAuthChecker  /path/to/lua/script.lua hook_function_name [early|late]</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>All</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
 </table>
 <p>Invoke a lua function in the auth_checker phase of processing
 a request.  This can be used to implement arbitrary authentication
@@ -507,18 +511,24 @@ function authcheck_hook(r)
    return apache2.OK
 end
 </pre></div>
+   <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></div>
 
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="directive-section"><h2><a name="LuaHookCheckUserID" id="LuaHookCheckUserID">LuaHookCheckUserID</a> <a name="luahookcheckuserid" id="luahookcheckuserid">Directive</a></h2>
 <table class="directive">
 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the check_user_id phase of request processing</td></tr>
-<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookCheckUserID  /path/to/lua/script.lua hook_function_name</code></td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookCheckUserID  /path/to/lua/script.lua hook_function_name [early|late]</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>All</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
 </table><p>...</p>
+   <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></div>
+
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="directive-section"><h2><a name="LuaHookFixups" id="LuaHookFixups">LuaHookFixups</a> <a name="luahookfixups" id="luahookfixups">Directive</a></h2>
@@ -562,11 +572,12 @@ processing</td></tr>
 <div class="directive-section"><h2><a name="LuaHookTranslateName" id="LuaHookTranslateName">LuaHookTranslateName</a> <a name="luahooktranslatename" id="luahooktranslatename">Directive</a></h2>
 <table class="directive">
 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the translate name phase of request processing</td></tr>
-<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookTranslateName  /path/to/lua/script.lua  hook_function_name</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#Syntax">Syntax:</a></th><td><code>LuaHookTranslateName  /path/to/lua/script.lua  hook_function_name [early|late]</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#Override">Override:</a></th><td>All</td></tr>
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
 </table><p>
     Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
     request processing. The hook function receives a single
@@ -599,6 +610,13 @@ function silly_mapper(r)
 end
 </pre></div>
 
+   <div class="note"><h3>Context</h3><p>This directive is not valid in <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>, <code class="directive"><a href="../mod/core.html#files">&lt;Files&gt;</a></code>, or htaccess
+   context.</p></div>
+
+   <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></div>
+
+
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="directive-section"><h2><a name="LuaHookTypeChecker" id="LuaHookTypeChecker">LuaHookTypeChecker</a> <a name="luahooktypechecker" id="luahooktypechecker">Directive</a></h2>
@@ -688,6 +706,9 @@ end
 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
 </table><p>...</p>
+   <div class="note"><h3>Context</h3><p>This directive is not valid in <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>, <code class="directive"><a href="../mod/core.html#files">&lt;Files&gt;</a></code>, or htaccess
+   context.</p></div>
+
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="directive-section"><h2><a name="LuaRoot" id="LuaRoot">LuaRoot</a> <a name="luaroot" id="luaroot">Directive</a></h2>

diff --git a/docs/manual/mod/mod_lua.xml b/docs/manual/mod/mod_lua.xml
index d8cc4c42ae2dae92d3852f3da5a679b5801c2104..01ebfe75b367c937625fa72202c4336861c804b2 100644 (file)
--- a/docs/manual/mod/mod_lua.xml
+++ b/docs/manual/mod/mod_lua.xml
@@ -543,9 +543,10 @@ end
 <directivesynopsis>
 <name>LuaHookTranslateName</name>
 <description>Provide a hook for the translate name phase of request processing</description>
-<syntax>LuaHookTranslateName  /path/to/lua/script.lua  hook_function_name</syntax>
+<syntax>LuaHookTranslateName  /path/to/lua/script.lua  hook_function_name [early|late]</syntax>
+<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
 <contextlist><context>server config</context><context>virtual host</context>
-<context>directory</context><context>.htaccess</context>
+<context>directory</context>
 </contextlist>
 <override>All</override>
 
@@ -580,6 +581,15 @@ function silly_mapper(r)
     end
 end
 </pre></example>
+
+   <note><title>Context</title><p>This directive is not valid in <directive
+   type="section" module="core">Directory</directive>, <directive
+   type="section" module="core">Files</directive>, or htaccess
+   context.</p></note>
+
+   <note><title>Ordering</title><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></note>
+
 </usage>
 </directivesynopsis>
 
@@ -613,12 +623,16 @@ processing</description>
 <directivesynopsis>
 <name>LuaHookCheckUserID</name>
 <description>Provide a hook for the check_user_id phase of request processing</description>
-<syntax>LuaHookCheckUserID  /path/to/lua/script.lua hook_function_name</syntax>
+<syntax>LuaHookCheckUserID  /path/to/lua/script.lua hook_function_name [early|late]</syntax>
+<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context>
 </contextlist>
 <override>All</override>
-    <usage><p>...</p></usage>
+<usage><p>...</p>
+   <note><title>Ordering</title><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></note>
+</usage>
 </directivesynopsis>
 
 <directivesynopsis>
@@ -635,7 +649,8 @@ processing</description>
 <directivesynopsis>
 <name>LuaHookAuthChecker</name>
 <description>Provide a hook for the auth_checker phase of request processing</description>
-<syntax>LuaHookAuthChecker  /path/to/lua/script.lua hook_function_name</syntax>
+<syntax>LuaHookAuthChecker  /path/to/lua/script.lua hook_function_name [early|late]</syntax>
+<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context>
 </contextlist>
@@ -677,13 +692,16 @@ function authcheck_hook(r)
    return apache2.OK
 end
 </pre></example>
+   <note><title>Ordering</title><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></note>
 </usage>
 </directivesynopsis>
 
 <directivesynopsis>
 <name>LuaHookAccessChecker</name>
 <description>Provide a hook for the access_checker phase of request processing</description>
-<syntax>LuaHookAccessChecker  /path/to/lua/script.lua  hook_function_name</syntax>
+<syntax>LuaHookAccessChecker  /path/to/lua/script.lua  hook_function_name [early|late]</syntax>
+<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context>
 </contextlist>
@@ -691,6 +709,8 @@ end
 <usage>
 <p>Add your hook to the access_checker phase.  An access checker
 hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
+   <note><title>Ordering</title><p>The optional arguments "early" or "late" 
+   control when this script runs relative to other modules.</p></note>
 </usage>
 </directivesynopsis>
 
@@ -713,7 +733,12 @@ hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
 <context>directory</context><context>.htaccess</context>
 </contextlist>
 <override>All</override>
-<usage><p>...</p></usage>
+<usage><p>...</p>
+   <note><title>Context</title><p>This directive is not valid in <directive
+   type="section" module="core">Directory</directive>, <directive
+   type="section" module="core">Files</directive>, or htaccess
+   context.</p></note>
+</usage>
 </directivesynopsis>
 
 </modulesynopsis>