Skip to content

Commit 9b22495

Browse files
committed
doc: readme: minor updates to align with the ngx_stream_lua module README.
1 parent 4c943b9 commit 9b22495

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

README.markdown

+10-9
Original file line numberDiff line numberDiff line change
@@ -319,10 +319,10 @@ patches](https://github.com/openresty/openresty/tree/master/patches).
319319

320320
Alternatively, ngx_lua can be manually compiled into Nginx:
321321

322-
1. LuaJIT can be downloaded from the [latest release of OpenResty's LuaJIT fork](https://github.com/openresty/luajit2/releases). The official LuaJIT 2.x releases are also supported, although performance will be significantly lower for reasons elaborated above..
323-
1. Download the latest version of the ngx_devel_kit (NDK) module [HERE](https://github.com/simplresty/ngx_devel_kit/tags).
324-
1. Download the latest version of ngx_lua [HERE](https://github.com/openresty/lua-nginx-module/tags).
325-
1. Download the latest version of Nginx [HERE](https://nginx.org/) (See [Nginx Compatibility](#nginx-compatibility))
322+
1. LuaJIT can be downloaded from the [latest release of OpenResty's LuaJIT fork](https://github.com/openresty/luajit2/releases). The official LuaJIT 2.x releases are also supported, although performance will be significantly lower for reasons elaborated above
323+
1. Download the latest version of the ngx_devel_kit (NDK) module [HERE](https://github.com/simplresty/ngx_devel_kit/tags)
324+
1. Download the latest version of ngx_lua [HERE](https://github.com/openresty/lua-nginx-module/tags)
325+
1. Download the latest supported version of Nginx [HERE](https://nginx.org/) (See [Nginx Compatibility](#nginx-compatibility))
326326

327327
Build the source with this module:
328328

@@ -413,7 +413,8 @@ The [openresty](https://groups.google.com/group/openresty) mailing list is for C
413413
Code Repository
414414
===============
415415

416-
The code repository of this project is hosted on github at [openresty/lua-nginx-module](https://github.com/openresty/lua-nginx-module).
416+
The code repository of this project is hosted on GitHub at
417+
[openresty/lua-nginx-module](https://github.com/openresty/lua-nginx-module).
417418

418419
[Back to TOC](#table-of-contents)
419420

@@ -7625,7 +7626,7 @@ tcpsock:settimeout
76257626

76267627
Set the timeout value in milliseconds for subsequent socket operations ([connect](#tcpsockconnect), [receive](#tcpsockreceive), and iterators returned from [receiveuntil](#tcpsockreceiveuntil)).
76277628

7628-
Settings done by this method takes priority over those config directives, i.e., [lua_socket_connect_timeout](#lua_socket_connect_timeout), [lua_socket_send_timeout](#lua_socket_send_timeout), and [lua_socket_read_timeout](#lua_socket_read_timeout).
7629+
Settings done by this method take priority over those specified via config directives (i.e. [lua_socket_connect_timeout](#lua_socket_connect_timeout), [lua_socket_send_timeout](#lua_socket_send_timeout), and [lua_socket_read_timeout](#lua_socket_read_timeout)).
76297630

76307631
Note that this method does *not* affect the [lua_socket_keepalive_timeout](#lua_socket_keepalive_timeout) setting; the `timeout` argument to the [setkeepalive](#tcpsocksetkeepalive) method should be used for this purpose instead.
76317632

@@ -7640,12 +7641,12 @@ tcpsock:settimeouts
76407641

76417642
**context:** *rewrite_by_lua*, access_by_lua*, content_by_lua*, ngx.timer.*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua**
76427643

7643-
Sets the connect timeout thresold, send timeout threshold, and read timeout threshold, respetively, in milliseconds, for subsequent socket
7644+
Respectively sets the connect, send, and read timeout thresholds (in milliseconds) for subsequent socket
76447645
operations ([connect](#tcpsockconnect), [send](#tcpsocksend), [receive](#tcpsockreceive), and iterators returned from [receiveuntil](#tcpsockreceiveuntil)).
76457646

7646-
Settings done by this method takes priority over those config directives, i.e., [lua_socket_connect_timeout](#lua_socket_connect_timeout), [lua_socket_send_timeout](#lua_socket_send_timeout), and [lua_socket_read_timeout](#lua_socket_read_timeout).
7647+
Settings done by this method take priority over those specified via config directives (i.e. [lua_socket_connect_timeout](#lua_socket_connect_timeout), [lua_socket_send_timeout](#lua_socket_send_timeout), and [lua_socket_read_timeout](#lua_socket_read_timeout)).
76477648

7648-
You are recommended to use [settimeouts](#tcpsocksettimeouts) instead of [settimeout](#tcpsocksettimeout).
7649+
It is recommended to use [settimeouts](#tcpsocksettimeouts) instead of [settimeout](#tcpsocksettimeout).
76497650

76507651
Note that this method does *not* affect the [lua_socket_keepalive_timeout](#lua_socket_keepalive_timeout) setting; the `timeout` argument to the [setkeepalive](#tcpsocksetkeepalive) method should be used for this purpose instead.
76517652

doc/HttpLuaModule.wiki

+10-9
Original file line numberDiff line numberDiff line change
@@ -254,10 +254,10 @@ patches].
254254

255255
Alternatively, ngx_lua can be manually compiled into Nginx:
256256

257-
# LuaJIT can be downloaded from the [https://github.com/openresty/luajit2/releases latest release of OpenResty's LuaJIT fork]. The official LuaJIT 2.x releases are also supported, although performance will be significantly lower for reasons elaborated above..
258-
# Download the latest version of the ngx_devel_kit (NDK) module [https://github.com/simplresty/ngx_devel_kit/tags HERE].
259-
# Download the latest version of ngx_lua [https://github.com/openresty/lua-nginx-module/tags HERE].
260-
# Download the latest version of Nginx [https://nginx.org/ HERE] (See [[#Nginx Compatibility|Nginx Compatibility]])
257+
# LuaJIT can be downloaded from the [https://github.com/openresty/luajit2/releases latest release of OpenResty's LuaJIT fork]. The official LuaJIT 2.x releases are also supported, although performance will be significantly lower for reasons elaborated above
258+
# Download the latest version of the ngx_devel_kit (NDK) module [https://github.com/simplresty/ngx_devel_kit/tags HERE]
259+
# Download the latest version of ngx_lua [https://github.com/openresty/lua-nginx-module/tags HERE]
260+
# Download the latest supported version of Nginx [https://nginx.org/ HERE] (See [[#Nginx Compatibility|Nginx Compatibility]])
261261
262262
Build the source with this module:
263263

@@ -328,7 +328,8 @@ The [https://groups.google.com/group/openresty openresty] mailing list is for Ch
328328

329329
= Code Repository =
330330

331-
The code repository of this project is hosted on github at [https://github.com/openresty/lua-nginx-module openresty/lua-nginx-module].
331+
The code repository of this project is hosted on GitHub at
332+
[https://github.com/openresty/lua-nginx-module openresty/lua-nginx-module].
332333

333334
= Bugs and Patches =
334335

@@ -6481,7 +6482,7 @@ This feature was first introduced in the <code>v0.5.0rc1</code> release.
64816482
64826483
Set the timeout value in milliseconds for subsequent socket operations ([[#tcpsock:connect|connect]], [[#tcpsock:receive|receive]], and iterators returned from [[#tcpsock:receiveuntil|receiveuntil]]).
64836484
6484-
Settings done by this method takes priority over those config directives, i.e., [[#lua_socket_connect_timeout|lua_socket_connect_timeout]], [[#lua_socket_send_timeout|lua_socket_send_timeout]], and [[#lua_socket_read_timeout|lua_socket_read_timeout]].
6485+
Settings done by this method take priority over those specified via config directives (i.e. [[#lua_socket_connect_timeout|lua_socket_connect_timeout]], [[#lua_socket_send_timeout|lua_socket_send_timeout]], and [[#lua_socket_read_timeout|lua_socket_read_timeout]]).
64856486
64866487
Note that this method does ''not'' affect the [[#lua_socket_keepalive_timeout|lua_socket_keepalive_timeout]] setting; the <code>timeout</code> argument to the [[#tcpsock:setkeepalive|setkeepalive]] method should be used for this purpose instead.
64876488
@@ -6493,12 +6494,12 @@ This feature was first introduced in the <code>v0.5.0rc1</code> release.
64936494
64946495
'''context:''' ''rewrite_by_lua*, access_by_lua*, content_by_lua*, ngx.timer.*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*''
64956496
6496-
Sets the connect timeout thresold, send timeout threshold, and read timeout threshold, respetively, in milliseconds, for subsequent socket
6497+
Respectively sets the connect, send, and read timeout thresholds (in milliseconds) for subsequent socket
64976498
operations ([[#tcpsock:connect|connect]], [[#tcpsock:send|send]], [[#tcpsock:receive|receive]], and iterators returned from [[#tcpsock:receiveuntil|receiveuntil]]).
64986499
6499-
Settings done by this method takes priority over those config directives, i.e., [[#lua_socket_connect_timeout|lua_socket_connect_timeout]], [[#lua_socket_send_timeout|lua_socket_send_timeout]], and [[#lua_socket_read_timeout|lua_socket_read_timeout]].
6500+
Settings done by this method take priority over those specified via config directives (i.e. [[#lua_socket_connect_timeout|lua_socket_connect_timeout]], [[#lua_socket_send_timeout|lua_socket_send_timeout]], and [[#lua_socket_read_timeout|lua_socket_read_timeout]]).
65006501
6501-
You are recommended to use [[#tcpsock:settimeouts|settimeouts]] instead of [[#tcpsock:settimeout|settimeout]].
6502+
It is recommended to use [[#tcpsock:settimeouts|settimeouts]] instead of [[#tcpsock:settimeout|settimeout]].
65026503
65036504
Note that this method does ''not'' affect the [[#lua_socket_keepalive_timeout|lua_socket_keepalive_timeout]] setting; the <code>timeout</code> argument to the [[#tcpsock:setkeepalive|setkeepalive]] method should be used for this purpose instead.
65046505

0 commit comments

Comments
 (0)