Skip to content

doc: resty document style fix. #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2016
Merged

doc: resty document style fix. #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/ngx/balancer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ to call these methods.

set_current_peer
----------------
**syntax:** `ok, err = balancer.set_current_peer(host, port)`
**syntax:** *ok, err = balancer.set_current_peer(host, port)*

**context:** *balancer_by_lua**

Expand All @@ -113,7 +113,7 @@ and pass the results to the `balancer_by_lua*` handler via [ngx.ctx](https://git

set_more_tries
--------------
**syntax:** `ok, err = balancer.set_more_tries(count)`
**syntax:** *ok, err = balancer.set_more_tries(count)*

**context:** *balancer_by_lua**

Expand All @@ -132,7 +132,7 @@ is still a `true` value.

get_last_failure
----------------
**syntax:** `state_name, status_code = balancer.get_last_failure()`
**syntax:** *state_name, status_code = balancer.get_last_failure()*

**context:** *balancer_by_lua**

Expand Down
8 changes: 4 additions & 4 deletions lib/ngx/ocsp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Methods

get_ocsp_responder_from_der_chain
---------------------------------
**syntax:** `ocsp_url, err = ocsp.get_ocsp_responder_from_der_chain(der_cert_chain, max_len)`
**syntax:** *ocsp_url, err = ocsp.get_ocsp_responder_from_der_chain(der_cert_chain, max_len)*

**context:** *any*

Expand All @@ -172,7 +172,7 @@ In case of failures, returns `nil` and a string describing the error.

create_ocsp_request
-------------------
**syntax:** `ocsp_req, err = ocsp.create_ocsp_request(der_cert_chain, max_len)`
**syntax:** *ocsp_req, err = ocsp.create_ocsp_request(der_cert_chain, max_len)*

**context:** *any*

Expand All @@ -195,7 +195,7 @@ by the [get_ocsp_responder_from_der_chain](#get_ocsp_responder_from_der_chain) f

validate_ocsp_response
----------------------
**syntax:** `ok, err = ocsp.validate_ocsp_response(ocsp_resp, der_cert_chain, max_err_msg_len)`
**syntax:** *ok, err = ocsp.validate_ocsp_response(ocsp_resp, der_cert_chain, max_err_msg_len)*

**context:** *any*

Expand All @@ -214,7 +214,7 @@ being 4KB).

set_ocsp_status_resp
--------------------
**syntax:** `ok, err = ocsp.set_ocsp_status_resp(ocsp_resp)`
**syntax:** *ok, err = ocsp.set_ocsp_status_resp(ocsp_resp)*

**context:** *ssl_certificate_by_lua**

Expand Down
12 changes: 6 additions & 6 deletions lib/ngx/semaphore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ new
---
**syntax:** *sema, err = semaphore_module.new(n?)*

**context:** **init_by_lua*, init_worker_by_lua*, 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.**
**context:** *init_by_lua*, init_worker_by_lua*, 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.**

Creates and returns a new semaphore instance that has `n` (default to `0`) resources.

Expand All @@ -197,7 +197,7 @@ post
--------
**syntax:** *sema:post(n?)*

**context:** *init_by_lua*, init_worker_by_lua*, 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.**
**context:** *init_by_lua*, init_worker_by_lua*, 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.**

Releases `n` (default to `1`) "resources" to the semaphore instance.

Expand All @@ -221,7 +221,7 @@ wait
------------
**syntax:** *ok, err = sema:wait(timeout)*

**context:** *rewrite_by_lua*, access_by_lua*, content_by_lua*, ngx.timer.**
**context:** *rewrite_by_lua*, access_by_lua*, content_by_lua*, ngx.timer.**

Requests a resource from the semaphore instance.

Expand All @@ -244,10 +244,10 @@ See [Synopsis](#synopsis) for code examples.

count
--------
**syntax:** `count = sema:count()`
**syntax:** *count = sema:count()*

**context:** *init_by_lua*, init_worker_by_lua*, 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.**
**context:** *init_by_lua*, init_worker_by_lua*, 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.**

Returns the number of resources readily available in the `sema` semaphore instance (if any).

Expand Down
16 changes: 8 additions & 8 deletions lib/ngx/ssl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Methods

clear_certs
-----------
**syntax:** `ok, err = ssl.clear_certs()`
**syntax:** *ok, err = ssl.clear_certs()*

**context:** *ssl_certificate_by_lua**

Expand All @@ -133,7 +133,7 @@ Returns `true` on success, or a `nil` value and a string describing the error ot

cert_pem_to_der
---------------
**syntax:** `der_cert_chain, err = ssl.cert_pem_to_der(pem_cert_chain)`
**syntax:** *der_cert_chain, err = ssl.cert_pem_to_der(pem_cert_chain)*

**context:** *any*

Expand All @@ -155,7 +155,7 @@ This function can be called in whatever contexts.

set_der_cert
------------
**syntax:** `ok, err = ssl.set_der_cert(der_cert_chain)`
**syntax:** *ok, err = ssl.set_der_cert(der_cert_chain)*

**context:** *ssl_certificate_by_lua**

Expand All @@ -173,7 +173,7 @@ function to do the conversion first.

priv_key_pem_to_der
-------------------
**syntax:** `der_priv_key, err = ssl.priv_key_pem_to_der(pem_priv_key)`
**syntax:** *der_priv_key, err = ssl.priv_key_pem_to_der(pem_priv_key)*

**context:** *any*

Expand All @@ -195,7 +195,7 @@ This function can be called in whatever contexts.

set_der_priv_key
----------------
**syntax:** `ok, err = ssl.set_der_priv_key(der_cert_chain)`
**syntax:** *ok, err = ssl.set_der_priv_key(der_cert_chain)*

**context:** *ssl_certificate_by_lua**

Expand All @@ -216,7 +216,7 @@ openssl rsa -in key.pem -outform DER -out key.der

server_name
-----------
**syntax:** `name, err = ssl.server_name()`
**syntax:** *name, err = ssl.server_name()*

**context:** *any*

Expand All @@ -240,7 +240,7 @@ This function can be called in whatever contexts where downstream https is used.

raw_server_addr
---------------
**syntax:** `addr_data, addr_type, err = ssl.raw_server_addr()`
**syntax:** *addr_data, addr_type, err = ssl.raw_server_addr()*

**context:** *any*

Expand Down Expand Up @@ -290,7 +290,7 @@ This function can be called in whatever contexts where downstream https is used.

get_tls1_version
----------------
**syntax:** `ver, err = ssl.get_tls1_version()`
**syntax:** *ver, err = ssl.get_tls1_version()*

**context:** *any*

Expand Down