From 0e6795f3e1f8340ed3b64a9ba60c96ac8af92ee4 Mon Sep 17 00:00:00 2001 From: Rich Bowen Date: Thu, 22 Apr 2010 11:34:01 +0000 Subject: [PATCH] Add more of the descriptions from the code. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@936789 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/directives.html.en | 2 + docs/manual/mod/mod_lua.html.en | 54 ++++++++++++++++---------- docs/manual/mod/mod_lua.xml | 23 +++++++++-- docs/manual/mod/quickreference.html.en | 25 ++++++------ 4 files changed, 69 insertions(+), 35 deletions(-) diff --git a/docs/manual/mod/directives.html.en b/docs/manual/mod/directives.html.en index aac98d6a9a..2bba6ecd1e 100644 --- a/docs/manual/mod/directives.html.en +++ b/docs/manual/mod/directives.html.en @@ -302,6 +302,7 @@
  • LuaHookAuthChecker
  • LuaHookAuthChecker
  • LuaHookCheckUserID
    • +
  • LuaHookFixups
  • LuaHookInsertFilter
  • LuaHookMapToStorage
  • LuaHookTranslateName
    • @@ -309,6 +310,7 @@
  • LuaMapHandler
  • LuaPackageCPath
  • LuaPackagePath
    • +
  • LuaQuickHandler
  • LuaRoot
  • LuaScope
  • MaxClients
    • diff --git a/docs/manual/mod/mod_lua.html.en b/docs/manual/mod/mod_lua.html.en index 3975f56b9c..70c89b3287 100644 --- a/docs/manual/mod/mod_lua.html.en +++ b/docs/manual/mod/mod_lua.html.en @@ -36,12 +36,12 @@ request processing

    Directives

    @@ -155,21 +156,11 @@ handlers (or hooks, or filters) in the same script. r:emerg("This is an emerg log message")

    - -
    top
    -

    Directive

    - - - - - - -
    Description:
    Syntax:LuaHookFixups /path/to/lua/script.lua hook_function_name
    Context:
    Status:Experimental
    Module:mod_lua
    top

    LuaCodeCache Directive

    - + @@ -227,7 +218,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaHookCheckUserID Directive

    Description:
    Description:Configure the compiled code cache.
    Syntax:LuaCodeCache stat|forever|never
    Context:
    Status:Experimental
    - + @@ -235,6 +226,17 @@ handlers (or hooks, or filters) in the same script.
    Description:
    Description:Provide a hook for the check_user_id phase of request processing
    Syntax:LuaHookCheckUserID /path/to/lua/script.lua hook_function_name
    Context:
    Status:Experimental

    ...

    top
    +

    LuaHookFixups Directive

    + + + + + + +
    Description:Provide a hook for the fixups phase of request +processing
    Syntax:LuaHookFixups /path/to/lua/script.lua hook_function_name
    Context:
    Status:Experimental
    Module:mod_lua
    +
    +
    top

    LuaHookInsertFilter Directive

    @@ -247,7 +249,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaHookMapToStorage Directive

    Description:
    - + @@ -257,7 +259,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaHookTranslateName Directive

    Description:
    Description:Provide a hook for the map_to_storage phase of request processing
    Syntax:LuaHookMapToStorage /path/to/lua/script.lua hook_function_name
    Context:
    Status:Experimental
    - + @@ -296,7 +298,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaHookTypeChecker Directive

    Description:
    Description:Provide a hook for the translate name phase of request processing
    Syntax:LuaHookTranslateName /path/to/lua/script.lua hook_function_name
    Context:
    Status:Experimental
    - + @@ -306,7 +308,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaMapHandler Directive

    Description:
    Description:Provide a hook for the type_checker phase of request processing
    Syntax:LuaHookTypeChecker /path/to/lua/script.lua hook_function_name
    Context:
    Status:Experimental
    - + @@ -337,7 +339,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaPackageCPath Directive

    Description:
    Description:Map a path to a lua handler
    Syntax:LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]
    Context:
    Status:Experimental
    - + @@ -352,7 +354,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaPackagePath Directive

    Description:
    Description:Add a directory to lua's package.cpath
    Syntax:LuaPackageCPath /path/to/include/?.soa
    Context:
    Status:Experimental
    - + @@ -366,11 +368,21 @@ handlers (or hooks, or filters) in the same script. LuaPackagePath /scripts/lib/?/init.lua

    + +
    top
    +

    LuaQuickHandler Directive

    +
    Description:
    Description:Add a directory to lua's package.path
    Syntax:LuaPackagePath /path/to/include/?.lua
    Context:
    Status:Experimental
    + + + + + +
    Description:Provide a hook for the quick handler of request processing
    Syntax:
    Context:
    Status:Experimental
    Module:mod_lua

    ...

    top

    LuaRoot Directive

    - + @@ -385,7 +397,7 @@ handlers (or hooks, or filters) in the same script.
    top

    LuaScope Directive

    Description:Specify the base path
    Description:Specify the base path for resolving relative paths for mod_lua directives
    Syntax:LuaRoot /path/to/a/directory
    Context:
    Status:Experimental
    - + diff --git a/docs/manual/mod/mod_lua.xml b/docs/manual/mod/mod_lua.xml index 14eea66f48..285a72c600 100644 --- a/docs/manual/mod/mod_lua.xml +++ b/docs/manual/mod/mod_lua.xml @@ -134,7 +134,7 @@ handlers (or hooks, or filters) in the same script. LuaRoot -Specify the base path +Specify the base path for resolving relative paths for mod_lua directives LuaRoot /path/to/a/directory @@ -147,6 +147,7 @@ handlers (or hooks, or filters) in the same script. LuaScope +One of once, request, conn, server -- default is once LuaScope once|request|conn|server [max|min max] @@ -172,9 +173,9 @@ handlers (or hooks, or filters) in the same script. - LuaMapHandler +Map a path to a lua handler LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]

    This directive matches a uri pattern to invoke a specific @@ -202,6 +203,7 @@ handlers (or hooks, or filters) in the same script. LuaPackagePath +Add a directory to lua's package.path LuaPackagePath /path/to/include/?.lua

    Add a path to lua's module search path. Follows the same conventions as lua. This just munges the package.path in the @@ -216,6 +218,7 @@ handlers (or hooks, or filters) in the same script. LuaPackageCPath +Add a directory to lua's package.cpath LuaPackageCPath /path/to/include/?.soa @@ -228,6 +231,7 @@ handlers (or hooks, or filters) in the same script. LuaCodeCache +Configure the compiled code cache. LuaCodeCache stat|forever|never

    @@ -253,6 +257,7 @@ handlers (or hooks, or filters) in the same script. LuaHookTranslateName +Provide a hook for the translate name phase of request processing LuaHookTranslateName /path/to/lua/script.lua hook_function_name

    @@ -288,25 +293,30 @@ handlers (or hooks, or filters) in the same script. +LuaHookFixups +Provide a hook for the fixups phase of request +processing LuaHookFixups /path/to/lua/script.lua hook_function_name Just like LuaHookTranslateName, but executed at the fixups phase - LuaHookMapToStorage +Provide a hook for the map_to_storage phase of request processing LuaHookMapToStorage /path/to/lua/script.lua hook_function_name

    ...

         LuaHookCheckUserID +Provide a hook for the check_user_id phase of request processing LuaHookCheckUserID /path/to/lua/script.lua hook_function_name

    ...

         LuaHookTypeChecker +Provide a hook for the type_checker phase of request processing LuaHookTypeChecker /path/to/lua/script.lua hook_function_name

    ...

         @@ -335,5 +345,12 @@ handlers (or hooks, or filters) in the same script.

    Not Yet Implemented

         + +LuaQuickHandler +Provide a hook for the quick handler of request processing + +

    ...

     +     + diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index f3043a5134..e4f30aad99 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -494,20 +494,23 @@ matching URLs - + - - - - - - - - - - + + + + + + + + + + + +
    Description:
    Description:One of once, request, conn, server -- default is once
    Syntax:LuaScope once|request|conn|server [max|min max]
    Context:
    Status:Experimental
    LogFormat format|nickname [nickname] "%h %l %u %t \"%r\" +svB
    Describes a format for use in a log file
    LogLevel level warn svC
    Controls the verbosity of the ErrorLog
    LuaCodeCache stat|forever|neverX
    -
    LuaCodeCache stat|forever|neverX
    Configure the compiled code cache.
    LuaHookAccessChecker /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookAuthChecker /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookAuthChecker /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookCheckUserID /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookInsertFilter /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookMapToStorage /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookTranslateName /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookTypeChecker /path/to/lua/script.lua hook_function_nameX
    -
    LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]X
    -
    LuaPackageCPath /path/to/include/?.soaX
    -
    LuaPackagePath /path/to/include/?.luaX
    -
    LuaRoot /path/to/a/directoryX
    Specify the base path
    LuaScope once|request|conn|server [max|min max]X
    -
    LuaHookCheckUserID /path/to/lua/script.lua hook_function_nameX
    Provide a hook for the check_user_id phase of request processing
    LuaHookFixups /path/to/lua/script.lua hook_function_nameX
    Provide a hook for the fixups phase of request +processing
    LuaHookInsertFilter /path/to/lua/script.lua hook_function_nameX
    -
    LuaHookMapToStorage /path/to/lua/script.lua hook_function_nameX
    Provide a hook for the map_to_storage phase of request processing
    LuaHookTranslateName /path/to/lua/script.lua hook_function_nameX
    Provide a hook for the translate name phase of request processing
    LuaHookTypeChecker /path/to/lua/script.lua hook_function_nameX
    Provide a hook for the type_checker phase of request processing
    LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]X
    Map a path to a lua handler
    LuaPackageCPath /path/to/include/?.soaX
    Add a directory to lua's package.cpath
    LuaPackagePath /path/to/include/?.luaX
    Add a directory to lua's package.path
    X
    Provide a hook for the quick handler of request processing
    LuaRoot /path/to/a/directoryX
    Specify the base path for resolving relative paths for mod_lua directives
    LuaScope once|request|conn|server [max|min max]X
    One of once, request, conn, server -- default is once
    MaxClients numbersM
    Maximum number of connections that will be processed simultaneously
    MaxKeepAliveRequests number 100 svC
    Number of requests allowed on a persistent -- 2.40.0