From db2d5310b3c266734dbe04479e77361cfa75e4bd Mon Sep 17 00:00:00 2001 From: "agentzh (Yichun Zhang)" Date: Sat, 13 Oct 2012 20:02:59 -0700 Subject: [PATCH] docs: massive wording improvements from Dayo. also bumped version to 0.7.1. --- README | 303 ++++++++++++++++++++--------------------- README.markdown | 145 ++++++++++---------- doc/HttpLuaModule.wiki | 145 ++++++++++---------- 3 files changed, 284 insertions(+), 309 deletions(-) diff --git a/README b/README index 95de91c20a..ff4959e917 100644 --- a/README +++ b/README @@ -8,8 +8,8 @@ Status This module is under active development and is production ready. Version - This document describes ngx_lua v0.7.0 - () released on 10 + This document describes ngx_lua v0.7.1 + () released on 13 October 2012. Synopsis @@ -257,9 +257,9 @@ Directives to to reload the config file are to send a "HUP" signal or to restart Nginx. - The "ngx_lua" module does not currently support the "stat" mode - available with the Apache "mod_lua" module but this is planned for - implementation in the future. + The ngx_lua module does not currently support the "stat" mode available + with the Apache "mod_lua" module but this is planned for implementation + in the future. Disabling the Lua code cache is strongly discouraged for production use and should only be used during development as it has a significant @@ -628,7 +628,7 @@ Directives fastcgi_pass ...; } - can be implemented in "ngx_lua" as: + can be implemented in ngx_lua as: location = /check-spam { internal; @@ -751,7 +751,7 @@ Directives # proxy_pass/fastcgi_pass/postgres_pass/... } - can be implemented in "ngx_lua" as: + can be implemented in ngx_lua as: location / { access_by_lua ' @@ -1073,8 +1073,8 @@ Directives client_body_buffer_size must have the same value as client_max_body_size. Because when the content length exceeds client_body_buffer_size but less than client_max_body_size, Nginx will - automatically buffer the data into a temporary file on the disk, which - will lead to empty value in the $request_body variable. + buffer the data into a temporary file on the disk, which will lead to + empty value in the $request_body variable. If the current location includes rewrite_by_lua or rewrite_by_lua_file directives, then the request body will be read just before the @@ -1205,9 +1205,9 @@ Directives Default to 30 connections for every pool. - When the connection pool is exceeding the size limit, the least recently - used (idle) connection already in the pool will be closed automatically - to make room for the current connection. + When the connection pool exceeds the available size limit, the least + recently used (idle) connection already in the pool will be closed to + make room for the current connection. Note that the cosocket connection pool is per nginx worker process rather than per nginx server instance, so so size limit specified here @@ -1224,8 +1224,8 @@ Directives This directive controls the default maximal idle time of the connections in the cosocket built-in connection pool. When this timeout reaches, - idle connections will be closed automatically and removed from the pool. - This setting can be overridden by cosocket objects' setkeepalive method. + idle connections will be closed and removed from the pool. This setting + can be overridden by cosocket objects' setkeepalive method. The "