diff --git a/README.markdown b/README.markdown index 383f5f87b..eed0c068a 100644 --- a/README.markdown +++ b/README.markdown @@ -144,7 +144,7 @@ cd lua-resty-core sudo make install LUA_LIB_DIR=/opt/nginx/lualib ``` -After that, you need to add the above directory to the LuaJIT search direcotries with `lua_package_path` nginx directive in the http context and stream context. +After that, you need to add the above directory to the LuaJIT search directories with `lua_package_path` nginx directive in the http context and stream context. ``` lua_package_path "/opt/nginx/lualib/?.lua;;"; diff --git a/lib/ngx/base64.md b/lib/ngx/base64.md index 0005cc2c9..d714772e7 100644 --- a/lib/ngx/base64.md +++ b/lib/ngx/base64.md @@ -66,7 +66,7 @@ decode\_base64url Decode `input` using base64url rules. Returns the decoded string. -If the `input` is not a valid base64url encoded string, `decoded `will be `nil` +If the `input` is not a valid base64url encoded string, `decoded` will be `nil` and `err` will be a string describing the error. [Back to TOC](#table-of-contents) diff --git a/lib/ngx/pipe.md b/lib/ngx/pipe.md index 43569cb5d..96f7146c7 100644 --- a/lib/ngx/pipe.md +++ b/lib/ngx/pipe.md @@ -150,7 +150,7 @@ Some more examples: ```lua local proc, err = ngx_pipe.spawn({"ls", "-l"}) -local proc, err = ngx_pipe.spawn({"perl", "-e", "print 'hello, wolrd'"}) +local proc, err = ngx_pipe.spawn({"perl", "-e", "print 'hello, world'"}) ``` If `args` is specified as a string, it will be executed by the operating system diff --git a/lib/ngx/req.md b/lib/ngx/req.md index 47e00461f..1786bda91 100644 --- a/lib/ngx/req.md +++ b/lib/ngx/req.md @@ -65,7 +65,7 @@ This method adds the specified header and its value to the current request. It works similarly as [ngx.req.set_header](https://github.com/openresty/lua-nginx-module#ngxreqset_header), with the exception that when the header already exists, the specified value(s) -will be appended instead of overriden. +will be appended instead of overridden. The first argument `header_name` must be a non-empty string. diff --git a/lib/ngx/resp.md b/lib/ngx/resp.md index 0e09deb55..9c77977f3 100644 --- a/lib/ngx/resp.md +++ b/lib/ngx/resp.md @@ -40,7 +40,7 @@ ngx_resp.add_header("Foo", "baz") ngx_resp.set(531, "user defined error") ---> the response line will be: 531 user defiend error +--> the response line will be: 531 user defined error ``` [Back to TOC](#table-of-contents) diff --git a/lib/ngx/ssl.md b/lib/ngx/ssl.md index e50ea5ea4..2c7453b30 100644 --- a/lib/ngx/ssl.md +++ b/lib/ngx/ssl.md @@ -225,7 +225,7 @@ set_der_priv_key **context:** *ssl_certificate_by_lua** -Sets the DER-formatted prviate key for the current SSL connection. +Sets the DER-formatted private key for the current SSL connection. Returns `true` on success, or a `nil` value and a string describing the error otherwise. @@ -502,7 +502,7 @@ parse_pem_cert **context:** *any* -Converts the PEM-formated SSL certificate chain data into an opaque cdata pointer (for later uses +Converts the PEM-formatted SSL certificate chain data into an opaque cdata pointer (for later uses in the [set_cert](#set_cert) function, for example). @@ -541,7 +541,7 @@ parse_der_cert **context:** *any* -Converts the DER-formated SSL certificate chain data into an opaque cdata pointer (for later uses +Converts the DER-formatted SSL certificate chain data into an opaque cdata pointer (for later uses in the [set_cert](#set_cert) function, for example). diff --git a/lib/ngx/ssl/clienthello.md b/lib/ngx/ssl/clienthello.md index 51cd30346..18a023a03 100644 --- a/lib/ngx/ssl/clienthello.md +++ b/lib/ngx/ssl/clienthello.md @@ -99,7 +99,7 @@ get_client_hello_server_name Returns the TLS SNI (Server Name Indication) name set by the client. -Return `nil` when then the extension does not exist. +Return `nil` when the extension does not exist. In case of errors, it returns `nil` and a string describing the error. @@ -117,7 +117,7 @@ get_supported_versions Returns the table of ssl hello supported versions set by the client. -Return `nil` when then the extension does not exist. +Return `nil` when the extension does not exist. In case of errors, it returns `nil` and a string describing the error. diff --git a/lib/ngx/ssl/proxysslcert.md b/lib/ngx/ssl/proxysslcert.md index fbf9763ee..4f122f650 100644 --- a/lib/ngx/ssl/proxysslcert.md +++ b/lib/ngx/ssl/proxysslcert.md @@ -209,7 +209,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND [Back to TOC](#table-of-contents) -See AlsoCopyright +See Also ======== * the ngx_lua module: https://github.com/openresty/lua-nginx-module * the [proxy_ssl_certificate_by_lua*](https://github.com/openresty/lua-nginx-module/#proxy_ssl_certificate_by_lua_block) directive. diff --git a/lib/ngx/ssl/proxysslverify.md b/lib/ngx/ssl/proxysslverify.md index b78de8c74..e02790ff1 100644 --- a/lib/ngx/ssl/proxysslverify.md +++ b/lib/ngx/ssl/proxysslverify.md @@ -178,7 +178,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND [Back to TOC](#table-of-contents) -See AlsoCopyright +See Also ======== * the ngx_lua module: https://github.com/openresty/lua-nginx-module * the [proxy_ssl_verify_by_lua*](https://github.com/openresty/lua-nginx-module/#proxy_ssl_verify_by_lua_block) directive.