Skip to content

Commit 138bc9d

Browse files
committed
documented the new ngx.config.debug API and also updated docs to reflect other recent changes.
1 parent c752049 commit 138bc9d

File tree

3 files changed

+52
-17
lines changed

3 files changed

+52
-17
lines changed

README

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Status
88
This module is under active development and is production ready.
99

1010
Version
11-
This document describes ngx_lua v0.8.6
12-
(<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 6
13-
August 2013.
11+
This document describes ngx_lua v0.8.7
12+
(<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 2
13+
September 2013.
1414

1515
Synopsis
1616
# set search paths for pure Lua external libraries (';;' is the default path):
@@ -5450,6 +5450,18 @@ Nginx API for Lua
54505450

54515451
This API was first introduced in the "v0.8.0" release.
54525452

5453+
ngx.config.debug
5454+
syntax: *debug = ngx.config.debug*
5455+
5456+
context: *set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*,
5457+
header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*,
5458+
init_by_lua**
5459+
5460+
This boolean field indicates whether the current Nginx is a debug build,
5461+
i.e., being built by the "./configure" option "--with-debug".
5462+
5463+
This field was first introduced in the 0.8.7.
5464+
54535465
ndk.set_var.DIRECTIVE
54545466
syntax: *res = ndk.set_var.DIRECTIVE_NAME*
54555467

@@ -5926,7 +5938,9 @@ Typical Uses
59265938
Nginx Compatibility
59275939
The latest module is compatible with the following versions of Nginx:
59285940

5929-
* 1.4.x (last tested: 1.4.1)
5941+
* 1.5.x (last tested: 1.5.4)
5942+
5943+
* 1.4.x (last tested: 1.4.2)
59305944

59315945
* 1.3.x (last tested: 1.3.11)
59325946

@@ -5971,9 +5985,9 @@ Installation
59715985

59725986
Build the source with this module:
59735987

5974-
wget 'http://nginx.org/download/nginx-1.4.1.tar.gz'
5975-
tar -xzvf nginx-1.4.1.tar.gz
5976-
cd nginx-1.4.1/
5988+
wget 'http://nginx.org/download/nginx-1.4.2.tar.gz'
5989+
tar -xzvf nginx-1.4.2.tar.gz
5990+
cd nginx-1.4.2/
59775991

59785992
# tell nginx's build system where to find LuaJIT:
59795993
export LUAJIT_LIB=/path/to/luajit/lib

README.markdown

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This module is under active development and is production ready.
1818
Version
1919
=======
2020

21-
This document describes ngx_lua [v0.8.6](https://github.com/chaoslawful/lua-nginx-module/tags) released on 6 August 2013.
21+
This document describes ngx_lua [v0.8.7](https://github.com/chaoslawful/lua-nginx-module/tags) released on 2 September 2013.
2222

2323
Synopsis
2424
========
@@ -4878,6 +4878,16 @@ this context.
48784878

48794879
This API was first introduced in the `v0.8.0` release.
48804880

4881+
ngx.config.debug
4882+
----------------
4883+
**syntax:** *debug = ngx.config.debug*
4884+
4885+
**context:** *set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, init_by_lua**
4886+
4887+
This boolean field indicates whether the current Nginx is a debug build, i.e., being built by the `./configure` option `--with-debug`.
4888+
4889+
This field was first introduced in the `0.8.7`.
4890+
48814891
ndk.set_var.DIRECTIVE
48824892
---------------------
48834893
**syntax:** *res = ndk.set_var.DIRECTIVE_NAME*
@@ -5261,7 +5271,8 @@ Nginx Compatibility
52615271
===================
52625272
The latest module is compatible with the following versions of Nginx:
52635273

5264-
* 1.4.x (last tested: 1.4.1)
5274+
* 1.5.x (last tested: 1.5.4)
5275+
* 1.4.x (last tested: 1.4.2)
52655276
* 1.3.x (last tested: 1.3.11)
52665277
* 1.2.x (last tested: 1.2.9)
52675278
* 1.1.x (last tested: 1.1.5)
@@ -5289,9 +5300,9 @@ Alternatively, ngx_lua can be manually compiled into Nginx:
52895300
Build the source with this module:
52905301

52915302

5292-
wget 'http://nginx.org/download/nginx-1.4.1.tar.gz'
5293-
tar -xzvf nginx-1.4.1.tar.gz
5294-
cd nginx-1.4.1/
5303+
wget 'http://nginx.org/download/nginx-1.4.2.tar.gz'
5304+
tar -xzvf nginx-1.4.2.tar.gz
5305+
cd nginx-1.4.2/
52955306

52965307
# tell nginx's build system where to find LuaJIT:
52975308
export LUAJIT_LIB=/path/to/luajit/lib

doc/HttpLuaModule.wiki

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This module is under active development and is production ready.
1010

1111
= Version =
1212

13-
This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.8.6] released on 6 August 2013.
13+
This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.8.7] released on 2 September 2013.
1414

1515
= Synopsis =
1616
<geshi lang="nginx">
@@ -4721,6 +4721,15 @@ this context.
47214721
47224722
This API was first introduced in the <code>v0.8.0</code> release.
47234723
4724+
== ngx.config.debug ==
4725+
'''syntax:''' ''debug = ngx.config.debug''
4726+
4727+
'''context:''' ''set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, init_by_lua*''
4728+
4729+
This boolean field indicates whether the current Nginx is a debug build, i.e., being built by the <code>./configure</code> option <code>--with-debug</code>.
4730+
4731+
This field was first introduced in the <code>0.8.7</code>.
4732+
47244733
== ndk.set_var.DIRECTIVE ==
47254734
'''syntax:''' ''res = ndk.set_var.DIRECTIVE_NAME''
47264735
@@ -5086,7 +5095,8 @@ On a ThinkPad T400 2.80 GHz laptop, the Hello World example readily achieves 28k
50865095
= Nginx Compatibility =
50875096
The latest module is compatible with the following versions of Nginx:
50885097
5089-
* 1.4.x (last tested: 1.4.1)
5098+
* 1.5.x (last tested: 1.5.4)
5099+
* 1.4.x (last tested: 1.4.2)
50905100
* 1.3.x (last tested: 1.3.11)
50915101
* 1.2.x (last tested: 1.2.9)
50925102
* 1.1.x (last tested: 1.1.5)
@@ -5112,9 +5122,9 @@ Alternatively, ngx_lua can be manually compiled into Nginx:
51125122
Build the source with this module:
51135123
51145124
<geshi lang="bash">
5115-
wget 'http://nginx.org/download/nginx-1.4.1.tar.gz'
5116-
tar -xzvf nginx-1.4.1.tar.gz
5117-
cd nginx-1.4.1/
5125+
wget 'http://nginx.org/download/nginx-1.4.2.tar.gz'
5126+
tar -xzvf nginx-1.4.2.tar.gz
5127+
cd nginx-1.4.2/
51185128
51195129
# tell nginx's build system where to find LuaJIT:
51205130
export LUAJIT_LIB=/path/to/luajit/lib

0 commit comments

Comments
 (0)