doc: minor formatting fixes
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/2585a31c Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/2585a31c Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/2585a31c Branch: refs/heads/5.0.x Commit: 2585a31cf8e0c981e37d0a80a3714bf8e4dcf9cd Parents: 49e8a7a Author: James Peach <[email protected]> Authored: Sun Sep 1 21:00:38 2013 -0700 Committer: James Peach <[email protected]> Committed: Mon Sep 2 08:13:04 2013 -0700 ---------------------------------------------------------------------- doc/admin/faqs.en.rst | 6 +++--- doc/admin/traffic-server-error-messages.en.rst | 6 +++--- doc/reference/api/TSLifecycleHookAdd.en.rst | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2585a31c/doc/admin/faqs.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/faqs.en.rst b/doc/admin/faqs.en.rst index d8b0894..0fac735 100644 --- a/doc/admin/faqs.en.rst +++ b/doc/admin/faqs.en.rst @@ -66,7 +66,7 @@ that sent the request) loads them. In Squid- and Netscape-format log files, what do the cache result codes mean? ----------------------------------------------------------------------------- -This is described in detail in the :ref:`log-formats-squid-format` +This is described in detail in the :ref:`log-formats-squid-format` documentation. What is recorded by the ``cqtx`` field in a custom log file? ------------------------------------------------------------ @@ -117,12 +117,12 @@ to ``1`` in the :file:`records.config` file. How do I enable forward proxy mode ---------------------------------- -Please refer to the :ref:`forward-proxy` documentation +Please refer to the :ref:`forward-proxy` documentation. How do I interpret the Via: header code? ---------------------------------------- -Take a look at our `Via decoder Ring <http://trafficserver.apache.org/tools/via>`_ +Take a look at our `Via decoder Ring <http://trafficserver.apache.org/tools/via>`_. Support for HTTP Expect: Header ------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2585a31c/doc/admin/traffic-server-error-messages.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/traffic-server-error-messages.en.rst b/doc/admin/traffic-server-error-messages.en.rst index 276f94d..df01cde 100644 --- a/doc/admin/traffic-server-error-messages.en.rst +++ b/doc/admin/traffic-server-error-messages.en.rst @@ -55,7 +55,7 @@ Traffic Server Warnings The specified client is not allowed to connect to Traffic Server; the client IP address is not listed in the ``ip_allow.config`` file. -``Could not rename log <filename> to <rolled filename`` +``Could not rename log <filename> to <rolled filename>`` System error when renaming log file during roll. ``Did <this amount> of backup; still to do <remaining amount>`` @@ -143,8 +143,8 @@ Traffic Server returns detailed error messages to browser clients when there are problems with the HTTP transactions requested by the browser. These Traffic Server response messages correspond to standard HTTP response codes, but provide more information. A list of the more -frequently-encountered HTTP response codes is provided in :ref:`Standard HTTP -Response Messages`. You can customize the Traffic Server response messages, if desired. +frequently-encountered HTTP response codes is provided in :ref:`standard-http-response-messages`. +You can customize the Traffic Server response messages, if desired. The following table lists the hard-coded Traffic Server HTTP messages, with corresponding HTTP response codes and customizable files. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2585a31c/doc/reference/api/TSLifecycleHookAdd.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSLifecycleHookAdd.en.rst b/doc/reference/api/TSLifecycleHookAdd.en.rst index b546b77..672707c 100644 --- a/doc/reference/api/TSLifecycleHookAdd.en.rst +++ b/doc/reference/api/TSLifecycleHookAdd.en.rst @@ -39,7 +39,7 @@ once during the execution of the Traffic Server process and therefore should be `TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` Called after the :ts:cv:`proxy server port <proxy.config.http.server_ports>` data structures have been initialized but before connections are accepted on those ports. The sockets corresponding to the ports may or may not be open - depending on how the `traffic_server` process was invoked. Other API functions that depend on server ports should be + depending on how the :program:`traffic_server` process was invoked. Other API functions that depend on server ports should be called from this hook and not :func:`TSPluginInit`. Invoked with the event `TS_EVENT_LIFECYCLE_PORTS_INITIALIZED` and `NULL` data. @@ -99,7 +99,7 @@ to be initialized and therefore does not work if called from :func:`TSPluginInit History ======= -Lifecycle hooks were introduced to solve process initialization ordering issues (TS-1487). Different API calls required +Lifecycle hooks were introduced to solve process initialization ordering issues (`TS-1487 <https://issues.apache.org/jira/browse/TS-1487>`_). Different API calls required different modules of Traffic Server to be initialized for the call to work, but others did not work that late in initialization, which was problematic because all of them could effectively only be called from :func:`TSPluginInit` . The solution was to move :func:`TSPluginInit` as early as possible in the process initialization and provide hooks for API calls that needed to be invoked later which served essentially as additional pluging initialization points.
