Permalink
Browse files

updated docs and bumped version to 0.5.8.

  • Loading branch information...
1 parent a624ee9 commit c25689b93a681ed1f44192083798722b3471eedc @agentzh agentzh committed Jul 21, 2012
Showing with 12 additions and 13 deletions.
  1. +6 −7 README
  2. +3 −3 README.markdown
  3. +3 −3 doc/HttpLuaModule.wiki
View
13 README
@@ -8,8 +8,8 @@ Status
This module is under active development and is production ready.
Version
- This document describes ngx_lua v0.5.7
- (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 14
+ This document describes ngx_lua v0.5.8
+ (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 21
July 2012.
Synopsis
@@ -4572,12 +4572,11 @@ Known Issues
despite connection failures such as with "Connection Refused" errors.
However, later attempts to manipulate the cosocket object will fail and
- return the actual error status message generated by the failed
- connecting operation.
+ return the actual error status message generated by the failed connect
+ operation.
- This issue appears to be due to limitations in the Nginx event model
- that only affect Mac OS X and *not* other operating systems like Linux
- and FreeBSD.
+ This issue is due to limitations in the Nginx event model and only
+ appears to affect Mac OS X.
Lua Coroutine Yielding/Resuming
* As the module's predefined Nginx I/O API uses the coroutine
View
@@ -18,7 +18,7 @@ This module is under active development and is production ready.
Version
=======
-This document describes ngx_lua [v0.5.7](https://github.com/chaoslawful/lua-nginx-module/tags) released on 14 July 2012.
+This document describes ngx_lua [v0.5.8](https://github.com/chaoslawful/lua-nginx-module/tags) released on 21 July 2012.
Synopsis
========
@@ -4120,9 +4120,9 @@ TCP socket connect operation issues
-----------------------------------
The [tcpsock:connect](http://wiki.nginx.org/HttpLuaModule#tcpsock:connect) method may indicate `success` despite connection failures such as with `Connection Refused` errors.
-However, later attempts to manipulate the cosocket object will fail and return the actual error status message generated by the failed connecting operation.
+However, later attempts to manipulate the cosocket object will fail and return the actual error status message generated by the failed connect operation.
-This issue appears to be due to limitations in the Nginx event model that only affect Mac OS X and *not* other operating systems like Linux and FreeBSD.
+This issue is due to limitations in the Nginx event model and only appears to affect Mac OS X.
Lua Coroutine Yielding/Resuming
-------------------------------
View
@@ -10,7 +10,7 @@ This module is under active development and is production ready.
= Version =
-This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.7] released on 14 July 2012.
+This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.8] released on 21 July 2012.
= Synopsis =
<geshi lang="nginx">
@@ -3979,9 +3979,9 @@ If server wide data sharing is required:
== TCP socket connect operation issues ==
The [[#tcpsock:connect|tcpsock:connect]] method may indicate <code>success</code> despite connection failures such as with <code>Connection Refused</code> errors.
-However, later attempts to manipulate the cosocket object will fail and return the actual error status message generated by the failed connecting operation.
+However, later attempts to manipulate the cosocket object will fail and return the actual error status message generated by the failed connect operation.
-This issue appears to be due to limitations in the Nginx event model that only affect Mac OS X and ''not'' other operating systems like Linux and FreeBSD.
+This issue is due to limitations in the Nginx event model and only appears to affect Mac OS X.
== Lua Coroutine Yielding/Resuming ==
* As the module's predefined Nginx I/O API uses the coroutine yielding/resuming mechanism, user code should not call any Lua modules that use the Lua coroutine mechanism in order to prevent conflicts with the module's predefined Nginx API methods such as [[#ngx.location.capture|ngx.location.capture]] (Actually, coroutine modules have been masked off in [[#content_by_lua|content_by_lua]] directives and others). This limitation is significant and work is ongoing on an alternative coroutine implementation that can fit into the Nginx event model to address this. When this is done, it will be possible to use the Lua coroutine mechanism freely as it is in standard Lua implementations.

0 comments on commit c25689b

Please sign in to comment.