Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

updated docs to reflect recent changes.

  • Loading branch information...
commit c746674070c79d9056e29a392d7a54510e4eefb7 1 parent bbac7d6
Yichun Zhang authored March 22, 2012
12  README
@@ -8,8 +8,8 @@ Status
8 8
     This module is under active development and is production ready.
9 9
 
10 10
 Version
11  
-    This document describes ngx_lua v0.5.0rc19
12  
-    (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 15
  11
+    This document describes ngx_lua v0.5.0rc21
  12
+    (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 22
13 13
     March 2012.
14 14
 
15 15
 Synopsis
@@ -1010,7 +1010,7 @@ Nginx API for Lua
1010 1010
       ngx.HTTP_POST
1011 1011
       ngx.HTTP_DELETE
1012 1012
 
1013  
-    These constants are usually used in ngx.location.catpure and
  1013
+    These constants are usually used in ngx.location.capture and
1014 1014
     ngx.location.capture_multi method calls.
1015 1015
 
1016 1016
   HTTP status constants
@@ -1797,7 +1797,7 @@ Nginx API for Lua
1797 1797
   ngx.req.get_post_args
1798 1798
     syntax: *ngx.req.get_post_args(count_limit?)*
1799 1799
 
1800  
-    context: *set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*,
  1800
+    context: *rewrite_by_lua*, access_by_lua*, content_by_lua*,
1801 1801
     header_filter_by_lua**
1802 1802
 
1803 1803
     Returns a Lua table holding all the current request POST query arguments
@@ -2646,6 +2646,10 @@ Nginx API for Lua
2646 2646
 
2647 2647
     Returns the binary form of the SHA-1 digest of the "str" argument.
2648 2648
 
  2649
+    This function requires enabling SHA-1 support in your Nginx build
  2650
+    (usually you just need to install OpenSSL to your system while building
  2651
+    Nginx).
  2652
+
2649 2653
     This function was first introduced in the "v0.5.0rc6".
2650 2654
 
2651 2655
   ngx.today
8  README.markdown
Source Rendered
@@ -13,7 +13,7 @@ This module is under active development and is production ready.
13 13
 Version
14 14
 =======
15 15
 
16  
-This document describes ngx_lua [v0.5.0rc19](https://github.com/chaoslawful/lua-nginx-module/tags) released on 15 March 2012.
  16
+This document describes ngx_lua [v0.5.0rc21](https://github.com/chaoslawful/lua-nginx-module/tags) released on 22 March 2012.
17 17
 
18 18
 Synopsis
19 19
 ========
@@ -944,7 +944,7 @@ HTTP method constants
944 944
       ngx.HTTP_DELETE
945 945
 
946 946
 
947  
-These constants are usually used in [ngx.location.catpure](http://wiki.nginx.org/HttpLuaModule#ngx.location.capture) and [ngx.location.capture_multi](http://wiki.nginx.org/HttpLuaModule#ngx.location.capture_multi) method calls.
  947
+These constants are usually used in [ngx.location.capture](http://wiki.nginx.org/HttpLuaModule#ngx.location.capture) and [ngx.location.capture_multi](http://wiki.nginx.org/HttpLuaModule#ngx.location.capture_multi) method calls.
948 948
 
949 949
 HTTP status constants
950 950
 ---------------------
@@ -1746,7 +1746,7 @@ ngx.req.get_post_args
1746 1746
 ---------------------
1747 1747
 **syntax:** *ngx.req.get_post_args(count_limit?)*
1748 1748
 
1749  
-**context:** *set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua**
  1749
+**context:** *rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua**
1750 1750
 
1751 1751
 Returns a Lua table holding all the current request POST query arguments (of the MIME type `application/x-www-form-urlencoded`). Call [ngx.req.read_body](http://wiki.nginx.org/HttpLuaModule#ngx.req.read_body) to read the request body first or turn on the [lua_need_request_body](http://wiki.nginx.org/HttpLuaModule#lua_need_request_body) directive to avoid Lua exception errors.
1752 1752
 
@@ -2538,6 +2538,8 @@ ngx.sha1_bin
2538 2538
 
2539 2539
 Returns the binary form of the SHA-1 digest of the `str` argument.
2540 2540
 
  2541
+This function requires enabling SHA-1 support in your Nginx build (usually you just need to install OpenSSL to your system while building Nginx).
  2542
+
2541 2543
 This function was first introduced in the `v0.5.0rc6`.
2542 2544
 
2543 2545
 ngx.today
8  doc/HttpLuaModule.wiki
Source Rendered
@@ -10,7 +10,7 @@ This module is under active development and is production ready.
10 10
 
11 11
 = Version =
12 12
 
13  
-This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.0rc19] released on 15 March 2012.
  13
+This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.5.0rc21] released on 22 March 2012.
14 14
 
15 15
 = Synopsis =
16 16
 <geshi lang="nginx">
@@ -908,7 +908,7 @@ The <code>ngx.DECLINED</code> constant was first introduced in the <code>v0.5.0r
908 908
   ngx.HTTP_DELETE
909 909
 </geshi>
910 910
 
911  
-These constants are usually used in [[#ngx.location.capture|ngx.location.catpure]] and [[#ngx.location.capture_multi|ngx.location.capture_multi]] method calls.
  911
+These constants are usually used in [[#ngx.location.capture|ngx.location.capture]] and [[#ngx.location.capture_multi|ngx.location.capture_multi]] method calls.
912 912
 
913 913
 == HTTP status constants ==
914 914
 '''context:''' ''set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*''
@@ -1698,7 +1698,7 @@ Removing the <code>count_limit</code> cap is strongly discouraged.
1698 1698
 == ngx.req.get_post_args ==
1699 1699
 '''syntax:''' ''ngx.req.get_post_args(count_limit?)''
1700 1700
 
1701  
-'''context:''' ''set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*''
  1701
+'''context:''' ''rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*''
1702 1702
 
1703 1703
 Returns a Lua table holding all the current request POST query arguments (of the MIME type <code>application/x-www-form-urlencoded</code>). Call [[#ngx.req.read_body|ngx.req.read_body]] to read the request body first or turn on the [[#lua_need_request_body|lua_need_request_body]] directive to avoid Lua exception errors.
1704 1704
 
@@ -2459,6 +2459,8 @@ See [[#ngx.md5|ngx.md5]] if the hexadecimal form of the MD5 digest is required.
2459 2459
 
2460 2460
 Returns the binary form of the SHA-1 digest of the <code>str</code> argument.
2461 2461
 
  2462
+This function requires enabling SHA-1 support in your Nginx build (usually you just need to install OpenSSL to your system while building Nginx).
  2463
+
2462 2464
 This function was first introduced in the <code>v0.5.0rc6</code>.
2463 2465
 
2464 2466
 == ngx.today ==

0 notes on commit c746674

Please sign in to comment.
Something went wrong with that request. Please try again.