Repository: trafficserver Updated Branches: refs/heads/master 29d72d393 -> 078e8abd2
Docs: some cleanup. This closes #79 Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/078e8abd Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/078e8abd Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/078e8abd Branch: refs/heads/master Commit: 078e8abd25142d9a562921cf4f824d2730c042a6 Parents: 29d72d3 Author: Alan M. Carroll <[email protected]> Authored: Tue Apr 28 16:19:51 2015 -0500 Committer: Alan M. Carroll <[email protected]> Committed: Tue Apr 28 16:26:38 2015 -0500 ---------------------------------------------------------------------- doc/reference/plugins/ts_lua.en.rst | 32 +++++++++++++------------- doc/sdk/http-transformation-plugin.en.rst | 10 ++++---- 2 files changed, 21 insertions(+), 21 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/078e8abd/doc/reference/plugins/ts_lua.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/plugins/ts_lua.en.rst b/doc/reference/plugins/ts_lua.en.rst index a3e9a11..ff65090 100644 --- a/doc/reference/plugins/ts_lua.en.rst +++ b/doc/reference/plugins/ts_lua.en.rst @@ -1589,7 +1589,7 @@ Here is an example: `TOP <#ts-lua-plugin>`_ ts.http.resp_transform.set_downstream_bytes ------------------------------------------ +------------------------------------------- **syntax:** *ts.http.resp_transform.set_downstream_bytes(NUMBER)* **context:** transform handler @@ -1603,7 +1603,7 @@ data is returned from the transform handler. `TOP <#ts-lua-plugin>`_ ts.http.skip_remapping_set -------------------------- +-------------------------- **syntax:** *ts.http.skip_remapping_set(BOOL)* **context:** do_global_read_request @@ -1772,7 +1772,7 @@ Here is an example: `TOP <#ts-lua-plugin>`_ ts.base64_encode ------------ +---------------- **syntax:** *value = ts.base64_encode(str)* **context:** global @@ -1792,7 +1792,7 @@ Here is an example: `TOP <#ts-lua-plugin>`_ ts.base64_decode ------------ +---------------- **syntax:** *value = ts.base64_decode(str)* **context:** global @@ -1813,7 +1813,7 @@ Here is an example: `TOP <#ts-lua-plugin>`_ ts.escape_uri ------------ +------------- **syntax:** *value = ts.escape_uri(str)* **context:** global @@ -1832,7 +1832,7 @@ Here is an example: `TOP <#ts-lua-plugin>`_ ts.unescape_uri ------------ +--------------- **syntax:** *value = ts.unescape_uri(str)* **context:** global @@ -1908,7 +1908,7 @@ Issuing a post request: `TOP <#ts-lua-plugin>`_ ts.fetch_multi ------------- +-------------- **syntax:** *vec = ts.fetch_multi({{url, table?}, {url, table?}, ...})* **context:** after do_remap @@ -1937,7 +1937,7 @@ Here is an example: ts.http.intercept ------------- +----------------- **syntax:** *ts.http.intercept(FUNCTION, param1?, param2?, ...)* **context:** do_remap or do_global_* @@ -1997,7 +1997,7 @@ Then we will get the response like this: `TOP <#ts-lua-plugin>`_ ts.http.server_intercept ------------- +------------------------ **syntax:** *ts.http.server_intercept(FUNCTION, param1?, param2?, ...)* **context:** do_remap or do_global_* @@ -2350,7 +2350,7 @@ Timeout constants `TOP <#ts-lua-plugin>`_ ts.http.client_packet_mark_set ----------------------- +------------------------------ **syntax:** *ts.http.client_packet_mark_set(NUMBER)* **context:** do_remap or do_global_* or later. @@ -2369,7 +2369,7 @@ Here is an example: `TOP <#ts-lua-plugin>`_ ts.http.server_packet_mark_set -------------------------- +------------------------------ **syntax:** *ts.http.server_packet_mark_set(NUMBER)* **context:** do_remap or do_global_* or later. @@ -2380,7 +2380,7 @@ ts.http.server_packet_mark_set `TOP <#ts-lua-plugin>`_ ts.http.client_packet_tos_set -------------------------- +----------------------------- **syntax:** *ts.http.client_packet_tos_set(NUMBER)* **context:** do_remap or do_global_* or later. @@ -2391,7 +2391,7 @@ ts.http.client_packet_tos_set `TOP <#ts-lua-plugin>`_ ts.http.server_packet_tos_set -------------------------- +----------------------------- **syntax:** *ts.http.server_packet_tos_set(NUMBER)* **context:** do_remap or do_global_* or later. @@ -2402,7 +2402,7 @@ ts.http.server_packet_tos_set `TOP <#ts-lua-plugin>`_ ts.http.client_packet_dscp_set -------------------------- +------------------------------ **syntax:** *ts.http.client_packet_dscp_set(NUMBER)* **context:** do_remap or do_global_* or later. @@ -2413,7 +2413,7 @@ ts.http.client_packet_dscp_set `TOP <#ts-lua-plugin>`_ ts.http.server_packet_dscp_set -------------------------- +------------------------------ **syntax:** *ts.http.server_packet_dscp_set(NUMBER)* **context:** do_remap or do_global_* or later. @@ -2473,7 +2473,7 @@ Http control channel constants `TOP <#ts-lua-plugin>`_ ts.http.milestone_get ----------------- +--------------------- **syntax:** *val = ts.http.milestone_get(MILESTONE_TYPE)* **context:** do_remap or do_global_* or later. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/078e8abd/doc/sdk/http-transformation-plugin.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-transformation-plugin.en.rst b/doc/sdk/http-transformation-plugin.en.rst index f446401..ae6c0b5 100644 --- a/doc/sdk/http-transformation-plugin.en.rst +++ b/doc/sdk/http-transformation-plugin.en.rst @@ -77,25 +77,25 @@ another, one ``VConnection``'s input ``VIO`` is another ``VConnection``'s output ``VIO``. A ``VConnection``'s input ``VIO`` is also called its **write ``VIO``** because the input ``VIO`` refers to a write operation performed on the ``VConnection`` itself. Similarly, the -outpt ``VIO`` is also called the **read ``VIO``**. For transformations, +output ``VIO`` is also called the **read ``VIO``**. For transformations, which are designed to pass data in one direction, you can picture the relationship between the transformation ``VConnection`` and its ``VIO``\ s as follows: -**Transformation and its ``VIO``\ s** {#TransformationAndVIOs} +.. _transformationAndItsVIOs: .. figure:: /static/images/sdk/vconnection.jpg :alt: A Transformation and its VIOs + :align: center - A Transformation and its VIOs + **A Transformation and its VIOs** Because the Traffic Server API places transformations directly in the response or request data stream, the transformation ``VConnection`` is responsible only for reading the data from the input buffer, transforming it, and then writing it to the output buffer. The upstream ``VConnection`` writes the incoming data to the transformation's input -buffer. In the figure above, `A Transformation and its -``VIO``\ s <#TransformationAndVIOs>`__, the input ``VIO`` describes the +buffer. In the figure above, :ref:`TransformationAndItsVIOs`, the input ``VIO`` describes the progress of the upstream ``VConnection``'s write operation on the transformation, while the output ``VIO`` describes the progress of the transformation's write operation on the output (downstream)
