]> granicus.if.org Git - apache/commitdiff
fix typos, expand on how r:flush works
authorDaniel Gruno <humbedooh@apache.org>
Sat, 20 Apr 2013 12:38:32 +0000 (12:38 +0000)
committerDaniel Gruno <humbedooh@apache.org>
Sat, 20 Apr 2013 12:38:32 +0000 (12:38 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1470158 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/mod_lua.xml

index bd73ed1d1e3a000a786f4446f0566d63d8f953ce..32bb52195060f35df7a3a10d5ecb50ac88ee8cd1 100644 (file)
@@ -193,8 +193,8 @@ LuaAuthzProvider foo authz_provider.lua authz_check_foo
 
 <p>Hook functions are how modules (and Lua scripts) participate in the
 processing of requests. Each type of hook exposed by the server exists for
-a specific purpose, such as mapping requests to the filesystem,
-performing access control, or setting mimetypes:</p>
+a specific purpose, such as mapping requests to the file system,
+performing access control, or setting mime types:</p>
 
 <table border="1" style="zebra">
     <tr>
@@ -272,7 +272,7 @@ performing access control, or setting mimetypes:</p>
 (except for LuaAuthzProvider, which also gets passed the arguments from 
 the Require directive).
 They can return any value, depending on the hook, but most commonly
-they'll return OK, DONE, or DECLINED, which you can write in lua as
+they'll return OK, DONE, or DECLINED, which you can write in Lua as
 <code>apache2.OK</code>, <code>apache2.DONE</code>, or
 <code>apache2.DECLINED</code>, or else an HTTP status code.</p>
 
@@ -324,7 +324,7 @@ end
         <dd>
         <p>The request_rec is mapped in as a userdata. It has a metatable
         which lets you do useful things with it. For the most part it
-        has the same fields as the request_rec struct, many of which are writeable as
+        has the same fields as the request_rec struct, many of which are writable as
         well as readable.  (The table fields' content can be changed, but the
         fields themselves cannot be set to different tables.)</p>
 
@@ -619,7 +619,8 @@ end
 <p>The request_rec object has (at least) the following methods:</p>
 
 <highlight language="lua">
-r:flush() -- flushes the output buffer:
+r:flush()   -- flushes the output buffer.
+            -- Returns true if the flush was successful, false otherwise.
 
 while we_have_stuff_to_send do
     r:puts("Bla bla bla\n") -- print something to client
@@ -802,7 +803,7 @@ r:set_context_info(prefix, docroot) -- Sets the context prefix and context docum
 </highlight>
 
 <highlight language="lua">
-r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependant way
+r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependent way
 </highlight>
 
 <highlight language="lua">
@@ -1169,7 +1170,7 @@ collectgarbage() -- close the handle via GC
 <override>All</override>
 
 <usage>
-    <p>Specify the lifecycle scope of the Lua interpreter which will
+    <p>Specify the life cycle scope of the Lua interpreter which will
     be used by handlers in this "Directory." The default is "once"</p>
 
    <dl>