trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From js...@apache.org
Subject [1/3] trafficserver git commit: TS-4077: docs: build warnings cleanup
Date Wed, 23 Mar 2016 16:01:00 GMT
Repository: trafficserver
Updated Branches:
  refs/heads/master 8607bb073 -> 4e4a01aab


TS-4077: docs: build warnings cleanup


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/4e4a01aa
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/4e4a01aa
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/4e4a01aa

Branch: refs/heads/master
Commit: 4e4a01aabec2851af465282cd4a66e6439b1a5a5
Parents: eeb001c
Author: Jon Sime <jsime@apache.org>
Authored: Wed Mar 23 15:16:30 2016 +0000
Committer: Jon Sime <jsime@apache.org>
Committed: Wed Mar 23 16:00:42 2016 +0000

----------------------------------------------------------------------
 doc/admin-guide/introduction.en.rst             |   2 +-
 .../monitoring/logging/log-collation.en.rst     |   4 +-
 .../monitoring/logging/log-formats.en.rst       |   4 +-
 .../monitoring/logging/managing-logs.en.rst     |  12 +-
 .../monitoring/logging/summary-logs.en.rst      |   8 +-
 .../monitoring/statistics/core/log.en.rst       |   4 +-
 .../statistics/plugin-statistics.en.rst         |   2 +-
 doc/admin-guide/plugins/cacheurl.en.rst         |   2 +-
 .../plugins/collapsed_forwarding.en.rst         |  33 +++---
 doc/admin-guide/plugins/url_sig.en.rst          |   5 +-
 doc/admin-guide/plugins/webp_transform.en.rst   |  36 +++---
 doc/appendices/glossary.en.rst                  |   9 ++
 .../api/functions/TSConfigGet.en.rst            |   2 +-
 .../api/functions/TSDebug.en.rst                |   6 +-
 .../api/functions/TSHttpTxnIsInternal.en.rst    |   9 +-
 .../api/functions/TSLifecycleHookAdd.en.rst     |  77 ++++++++-----
 .../api/functions/TSVConnFdCreate.en.rst        |   2 +-
 doc/developer-guide/plugins/index.en.rst        | 110 -------------------
 .../plugin-management/logging-api.en.rst        |   7 +-
 19 files changed, 128 insertions(+), 206 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/introduction.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/introduction.en.rst b/doc/admin-guide/introduction.en.rst
index 84730c3..14c4183 100644
--- a/doc/admin-guide/introduction.en.rst
+++ b/doc/admin-guide/introduction.en.rst
@@ -104,7 +104,7 @@ in some cases Traffic Server's internal APIs or architectural restrictions
 won't make it easy:
 
 * Load Balancing - note that there is an experimental plugin for this,
-:ref:`admin-plugins-balancer`.
+  :ref:`admin-plugins-balancer`.
 
 .. XXX needs re-work: the leadin states there's "a number" of scenarios, and then only lists
one -- one's a number, but not much of a list
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/monitoring/logging/log-collation.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/log-collation.en.rst b/doc/admin-guide/monitoring/logging/log-collation.en.rst
index b8c5cbe..f95db30 100644
--- a/doc/admin-guide/monitoring/logging/log-collation.en.rst
+++ b/doc/admin-guide/monitoring/logging/log-collation.en.rst
@@ -178,9 +178,7 @@ To collate custom event log files:
 
 #. On each collation client, edit :file:`logs_xml.config` and add the
    :ref:`CollationHosts <logs-xml-logobject-collationhost>` attribute to the
-   :ref:`LogObject` specification:
-
-   .. code-block:: xml
+   :ref:`LogObject` specification::
 
        <LogObject>
          <Format = "squid"/>

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/monitoring/logging/log-formats.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/log-formats.en.rst b/doc/admin-guide/monitoring/logging/log-formats.en.rst
index ce55519..bd294dc 100644
--- a/doc/admin-guide/monitoring/logging/log-formats.en.rst
+++ b/doc/admin-guide/monitoring/logging/log-formats.en.rst
@@ -263,9 +263,7 @@ summarization and are covered elsewhere):
 
 A very simple example format, which contains only the timestamp of when the
 event began and the canonical URL of the request, and named *myformat* would
-be written as follows:
-
-.. code-block:: xml
+be written as follows::
 
    <LogFormat>
      <Name = "myformat"/>

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/monitoring/logging/managing-logs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/managing-logs.en.rst b/doc/admin-guide/monitoring/logging/managing-logs.en.rst
index 2ce9564..13b24bd 100644
--- a/doc/admin-guide/monitoring/logging/managing-logs.en.rst
+++ b/doc/admin-guide/monitoring/logging/managing-logs.en.rst
@@ -45,13 +45,13 @@ space window for a long period of time.  After you establish a space limit,
 space dwindles to the headroom limit, it enters a low space state and takes the
 following actions:
 
--  If the autodelete option (discussed in `Rolling Event Log Files`_)
-   is *enabled*, then |TS| identifies previously-rolled log files (log files
-   with the ``.old`` extension). It starts deleting files one by one, beginning
-   with the oldest file, until it emerges from the low state. |TS| logs a
-   record of all deleted files in the system error log.
+-  If the autodelete option (discussed in `Rolling Logs`_) is enabled, then
+   |TS| identifies previously-rolled log files (log files with the ``.old``
+   extension). It starts deleting files one by one, beginning with the oldest
+   file, until it emerges from the low state. |TS| logs a record of all deleted
+   files in the system error log.
 
--  If the autodelete option is *disabled* or there are not enough old log files
+-  If the autodelete option is disabled or there are not enough old log files
    to delete for the system to emerge from its low space state, then |TS|
    issues a warning and continues logging until space is exhausted. When
    available space is consumed, event logging stops. |TS| resumes event logging

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/monitoring/logging/summary-logs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/logging/summary-logs.en.rst b/doc/admin-guide/monitoring/logging/summary-logs.en.rst
index 7fd1bf8..5424a1c 100644
--- a/doc/admin-guide/monitoring/logging/summary-logs.en.rst
+++ b/doc/admin-guide/monitoring/logging/summary-logs.en.rst
@@ -41,9 +41,7 @@ fields, over a specified interval.
 
 To create a summary log file format:
 
-#. Define the format of the log file in :file:`logs_xml.config` as follows:
-
-   .. code-block:: xml
+#. Define the format of the log file in :file:`logs_xml.config` as follows::
 
        <LogFormat>
          <Name = "summary"/>
@@ -64,9 +62,7 @@ To create a summary log file format:
 The following example format generates one entry every 10 seconds. Each entry
 contains the timestamp of the last entry of the interval, a count of the number
 of entries seen within that 10-second interval, and the sum of all bytes sent
-to the client:
-
-.. code-block:: xml
+to the client::
 
     <LogFormat>
       <Name = "summary"/>

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/monitoring/statistics/core/log.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/core/log.en.rst b/doc/admin-guide/monitoring/statistics/core/log.en.rst
index 986fcca..0c00b78 100644
--- a/doc/admin-guide/monitoring/statistics/core/log.en.rst
+++ b/doc/admin-guide/monitoring/statistics/core/log.en.rst
@@ -48,7 +48,7 @@ Logging
    :ungathered:
 
 .. ts:stat:: global proxy.node.log.bytes_received_from_network_avg_10s integer
-   :type: int
+   :type: derivative
    :unit: bytes
    :ungathered:
 
@@ -58,7 +58,7 @@ Logging
    :ungathered:
 
 .. ts:stat:: global proxy.node.log.bytes_sent_to_network_avg_10s integer
-   :type: int
+   :type: derivative
    :unit: bytes
    :ungathered:
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/monitoring/statistics/plugin-statistics.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/monitoring/statistics/plugin-statistics.en.rst b/doc/admin-guide/monitoring/statistics/plugin-statistics.en.rst
index 7bf9b57..d15aec6 100644
--- a/doc/admin-guide/monitoring/statistics/plugin-statistics.en.rst
+++ b/doc/admin-guide/monitoring/statistics/plugin-statistics.en.rst
@@ -17,7 +17,7 @@
 
 .. include:: ../../../common.defs
 
-.. _admin-stats:
+.. _admin-plugin-specific-stats:
 
 Plugin Specific Statistics
 **************************

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/plugins/cacheurl.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/plugins/cacheurl.en.rst b/doc/admin-guide/plugins/cacheurl.en.rst
index 1c176f5..775cf69 100644
--- a/doc/admin-guide/plugins/cacheurl.en.rst
+++ b/doc/admin-guide/plugins/cacheurl.en.rst
@@ -67,7 +67,7 @@ Configuration
    so on, which will be replaced with the appropriate matching group from
    ``<pattern>``.
 
-#. Reload your |TS| configuration with :option:`traffic_ctl reload`.
+#. Reload your |TS| configuration with :option:`traffic_ctl config reload`.
 
 Logging
 =======

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/plugins/collapsed_forwarding.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/plugins/collapsed_forwarding.en.rst b/doc/admin-guide/plugins/collapsed_forwarding.en.rst
index 65bd960..e1451c0 100644
--- a/doc/admin-guide/plugins/collapsed_forwarding.en.rst
+++ b/doc/admin-guide/plugins/collapsed_forwarding.en.rst
@@ -1,25 +1,26 @@
-.. _admin-plugins-collapsed-forwarding:
-
-Collapsed Forwarding Plugin
-***************************
-
 .. Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
-  distributed with this work for additional information
-  regarding copyright ownership.  The ASF licenses this file
-  to you under the Apache License, Version 2.0 (the
-  "License"); you may not use this file except in compliance
-  with the License.  You may obtain a copy of the License at
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
-  Unless required by applicable law or agreed to in writing,
-  software distributed under the License is distributed on an
-  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-  KIND, either express or implied.  See the License for the
-  specific language governing permissions and limitations
-  under the License.
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
 
+.. include:: ../../common.defs
+
+.. _admin-plugins-collapsed-forwarding:
+
+Collapsed Forwarding Plugin
+***************************
 
 This is a plugin for Apache Traffic Server that allows to achieve
 effective connection collapse by blocking all but one of the multiple

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/plugins/url_sig.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/plugins/url_sig.en.rst b/doc/admin-guide/plugins/url_sig.en.rst
index 4282f3a..cabbcf1 100644
--- a/doc/admin-guide/plugins/url_sig.en.rst
+++ b/doc/admin-guide/plugins/url_sig.en.rst
@@ -250,7 +250,8 @@ for :ts:cv:`proxy.config.diags.debug.enabled` and
     CONFIG proxy.config.diags.debug.enabled INT 1
     CONFIG proxy.config.diags.debug.tags STRING url_sig
 
-Once updated, issue a :option:`traffic_ctl reload` to make the settings active.
+Once updated, issue a :option:`traffic_ctl config reload` to make the settings
+active.
 
 Example
 =======
@@ -294,7 +295,7 @@ Example
 
 #. Reload your |TS| configuration to ensure the changes are active::
 
-    traffic_ctl reload
+    traffic_ctl config reload
 
 #. Attempt to access the now-protected URL without a valid signature. This will
    fail, and that is a good thing, as it demonstrates that |TS| now rejects any

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/admin-guide/plugins/webp_transform.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/plugins/webp_transform.en.rst b/doc/admin-guide/plugins/webp_transform.en.rst
index 280aca6..dc0c2a7 100644
--- a/doc/admin-guide/plugins/webp_transform.en.rst
+++ b/doc/admin-guide/plugins/webp_transform.en.rst
@@ -1,24 +1,26 @@
-.. _webp_transform:
-
-WebpTransform Plugin
-****************
-
 .. Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
-  distributed with this work for additional information
-  regarding copyright ownership.  The ASF licenses this file
-  to you under the Apache License, Version 2.0 (the
-  "License"); you may not use this file except in compliance
-  with the License.  You may obtain a copy of the License at
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
-  Unless required by applicable law or agreed to in writing,
-  software distributed under the License is distributed on an
-  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-  KIND, either express or implied.  See the License for the
-  specific language governing permissions and limitations
-  under the License.
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+.. include:: ../../common.defs
+
+.. _admin-plugins-webp-transform:
+
+Webp Transform Plugin
+*********************
 
 This plugin converts jpeg and png images and transforms them into webp format.
 All response with content-type 'image/jpeg' or 'image/png' will go through the transform.

@@ -33,7 +35,7 @@ Add the following line to :file:`plugin.config`::
 
 
 Note
-===================
+====
 
 This plugin only supports jpeg and png and requires Magick++ from ImageMagick.
 Other image formats can easily be supported.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/appendices/glossary.en.rst
----------------------------------------------------------------------
diff --git a/doc/appendices/glossary.en.rst b/doc/appendices/glossary.en.rst
index eaa2a58..282d00b 100644
--- a/doc/appendices/glossary.en.rst
+++ b/doc/appendices/glossary.en.rst
@@ -146,6 +146,15 @@ Glossary
       by Traffic Server.
 
    cache partition
+      A subdivision of the cache storage in |TS| which is dedicated to objects
+      for specific protocols, origins, or other rules. Defining and managing
+      cache partitions is discussed in :ref:`partitioning-the-cache`.
 
    global plugin
+      A plugin which operates on all transactions. Contrast with
+      :term:`remap plugin`.
 
+   remap plugin
+      A plugin which operates only on transactions matching specific remap
+      rules as defined in :file:`remap.config`. Contrast with
+      :term:`global plugin`.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/developer-guide/api/functions/TSConfigGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSConfigGet.en.rst b/doc/developer-guide/api/functions/TSConfigGet.en.rst
index f583081..8388bb8 100644
--- a/doc/developer-guide/api/functions/TSConfigGet.en.rst
+++ b/doc/developer-guide/api/functions/TSConfigGet.en.rst
@@ -16,7 +16,7 @@
 
 .. include:: ../../../common.defs
 
-.. defualt-domain:: c
+.. default-domain:: c
 
 TSConfigGet
 ***********

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/developer-guide/api/functions/TSDebug.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSDebug.en.rst b/doc/developer-guide/api/functions/TSDebug.en.rst
index 414bea6..14702c4 100644
--- a/doc/developer-guide/api/functions/TSDebug.en.rst
+++ b/doc/developer-guide/api/functions/TSDebug.en.rst
@@ -39,13 +39,13 @@ Synopsis
 .. function:: const char* TSHttpServerStateNameLookup(TSServerState state)
 .. function:: const char* TSHttpHookNameLookup(TSHttpHookID hook)
 .. function:: const char* TSHttpEventNameLookup(TSEvent event)
-.. macro:: void TSAssert(expression)
-.. macro:: void TSReleaseAssert(expression)
+.. macro:: void TSAssert( ... )
+.. macro:: void TSReleaseAssert( ... )
 
 Description
 ===========
 
-:func:`TSError` is similar to :func:`printf` except that instead
+:func:`TSError` is similar to ``printf`` except that instead
 of writing the output to the C standard output, it writes output
 to the Traffic Server error log.
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst b/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst
index 662d167..efdde33 100644
--- a/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpTxnIsInternal.en.rst
@@ -6,7 +6,7 @@
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0
+   http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,14 +16,14 @@
 
 .. default-domain:: c
 
-=======================
 TSHttpTxnIsInternal
-=======================
+*******************
 
 Test whether a request is internally-generated.
 
 Synopsis
 ========
+
 `#include <ts/ts.h>`
 
 .. function:: TSReturnCode TSHttpTxnIsInternal(TSHttpTxn txnp)
@@ -50,10 +50,11 @@ Examples
 The ESI plugin uses :func:`TSHttpTxnIsInternal` to ignore requests that is
 had generated while fetching portions of an ESI document:
 
-.. literalinclude:: ../../../plugins/experimental/esi/esi.cc
+.. literalinclude:: ../../../../plugins/experimental/esi/esi.cc
   :language: c
   :lines: 1395-1398
 
 See also
 ========
+
 :manpage:`TSAPI(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst b/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst
index ae18207..6674c6d 100644
--- a/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst
+++ b/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst
@@ -15,16 +15,18 @@
    specific language governing permissions and limitations
    under the License.
 
+.. include:: ../../../common.defs
+
 .. default-domain:: c
 
 .. _ts-lifecycle-hook-add:
 
-==================
 TSLifecycleHookAdd
-==================
+******************
 
 Synopsis
 ========
+
 `#include <ts/ts.h>`
 
 .. function:: void TSLifecycleHookAdd(TSLifecycleHookID id, TSCont contp)
@@ -32,44 +34,60 @@ Synopsis
 Description
 ===========
 
-:func:`TSLifecycleHookAdd` adds :arg:`contp` to the list of lifecycle hooks specified by
:arg:`id`. Lifecycle hooks are
-based on the Traffic Server process, not on any specific transaction or session. These will
typically be called only
-once during the execution of the Traffic Server process and therefore should be added in
:func:`TSPluginInit` (which could itself be considered a lifecyle hook). Unlike other hooks,
lifecycle hooks may not have a well defined ordering and use of them should not assume that
one of the hooks is always called before another unless specifically mentioned.
+:func:`TSLifecycleHookAdd` adds :arg:`contp` to the list of lifecycle hooks
+specified by :arg:`id`. Lifecycle hooks are based on the Traffic Server
+process, not on any specific transaction or session. These will typically be
+called only once during the execution of the Traffic Server process and
+therefore should be added in :func:`TSPluginInit` (which could itself be
+considered a lifecyle hook). Unlike other hooks, lifecycle hooks may not have a
+well defined ordering and use of them should not assume that one of the hooks
+is always called before another unless specifically mentioned.
 
 .. c:var:: 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 :program:`traffic_server` process was invoked. Other API functions
that depend on server ports should be
-   called from this hook and not :func:`TSPluginInit`.
+   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 :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 :c:data:`TS_EVENT_LIFECYCLE_PORTS_INITIALIZED` and :c:data:`NULL`
data.
+   Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_PORTS_INITIALIZED` and
+   ``NULL`` data.
 
 .. c:var:: TS_LIFECYCLE_PORTS_READY_HOOK
 
-   Called after enabling connections on the proxy server ports. Because Traffic Server is
threaded this may or may not
-   be called before any connections are accepted. The hook code may assume that any connection
to Traffic Server started
-   after this hook is called will be accepted by Traffic Server, making this a convenient
place to signal external
-   processes of that.
+   Called after enabling connections on the proxy server ports. Because |TS| is
+   threaded this may or may not be called before any connections are accepted.
+   The hook code may assume that any connection to |TS| started after this hook
+   is called will be accepted by |TS|, making this a convenient place to signal
+   external processes of that.
 
-   Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_PORTS_READY` and :c:data:`NULL` data.
+   Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_PORTS_READY` and ``NULL``
+   data.
 
 .. c:var:: TS_LIFECYCLE_CACHE_READY_HOOK
 
-   Called after Traffic Server cache initialization has finished.
+   Called after |TS| cache initialization has finished.
 
-   Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_CACHE_READY` and :c:data:`NULL` data.
+   Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_CACHE_READY` and ``NULL``
+   data.
 
 Ordering
 ========
 
-:c:data:`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` will always be called before :c:data:`TS_LIFECYCLE_PORTS_READY_HOOK`.
+:c:data:`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` will always be called before
+:c:data:`TS_LIFECYCLE_PORTS_READY_HOOK`.
 
 Examples
 ========
 
-The following example demonstrates how to correctly use :func:`TSNetAcceptNamedProtocol`,
which requires the proxy ports
-to be initialized and therefore does not work if called from :func:`TSPluginInit` directly.
::
+The following example demonstrates how to correctly use
+:func:`TSNetAcceptNamedProtocol`, which requires the proxy ports to be
+initialized and therefore does not work if called from :func:`TSPluginInit`
+directly.
+
+.. code-block:: c
 
    #include <ts/ts.h>
 
@@ -82,7 +100,7 @@ to be initialized and therefore does not work if called from :func:`TSPluginInit
    }
 
    static int
-   local_ssl_init(TSCont contp, TSEvent event, void *edata)
+   local_ssl_init(TSCont contp, TSEvent event, void * edata)
    {
       if (TS_EVENT_LIFECYCLE_PORTS_INITIALIZED == event) { // just to be safe.
          TSNetAcceptNamedProtocol(
@@ -94,7 +112,7 @@ to be initialized and therefore does not work if called from :func:`TSPluginInit
    }
 
    void
-   TSPluginInit (int argc, const char *argv[])
+   TSPluginInit (int argc, const char * argv[])
    {
       TSLifecycleHookAdd(TS_LIFECYCLE_PORTS_INITIALIZED_HOOK, TSContCreate(local_ssl_init,
NULL));
    }
@@ -102,11 +120,16 @@ 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
-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.
+Lifecycle hooks were introduced to solve process initialization ordering issues
+(TS-1487). Different API calls required different modules of |TS| 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.
 
-See also
+See Also
 ========
+
 :manpage:`TSAPI(3ts)`, :manpage:`TSContCreate(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/developer-guide/api/functions/TSVConnFdCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSVConnFdCreate.en.rst b/doc/developer-guide/api/functions/TSVConnFdCreate.en.rst
index a283b5e..4b6b472 100644
--- a/doc/developer-guide/api/functions/TSVConnFdCreate.en.rst
+++ b/doc/developer-guide/api/functions/TSVConnFdCreate.en.rst
@@ -52,7 +52,7 @@ in the Traffic Server source distribution. It demonstrates how to
 use :func:`TSVConnFdCreate` to construct a :type:`TSVConn` from a
 connected socket.
 
-.. literalinclude:: ../../../example/intercept/intercept.cc
+.. literalinclude:: ../../../../example/intercept/intercept.cc
   :language: c
   :lines: 288-336
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/developer-guide/plugins/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/plugins/index.en.rst b/doc/developer-guide/plugins/index.en.rst
index 323ebde..35ba0ff 100644
--- a/doc/developer-guide/plugins/index.en.rst
+++ b/doc/developer-guide/plugins/index.en.rst
@@ -42,113 +42,3 @@ Plugin Development
    adding-statistics.en
    example-plugins/index.en
 
-Traffic Server HTTP State Machine
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Traffic Server performs sophisticated HTTP caching and proxying.
-Important features include checking for alternates and document
-freshness, filtering, supporting cache hierarchies, and hosting. Traffic
-Server handles thousands of client requests at a time and each request
-is handled by an HTTP state machine. These machines follow a complex
-state diagram that includes all of the states required to support
-Traffic Server's features. The Traffic Server API provides hooks to a
-subset of these states, chosen for their relevance to plugins. You can
-view the API hooks and corresponding HTTP states in the
-:ref:`http-txn-state-diagram`.
-
-The example in this section (below) explains how a plugin typically
-intervenes and extends Traffic Server's processing of an HTTP
-transaction. Complete details about hooking on to Traffic Server
-processes are provided in :ref:`developer-plugins-hooks-and-transactions`.
-
-HTTP Transaction
-^^^^^^^^^^^^^^^^
-
-An HTTP transaction consists of a client request for a web document and
-Traffic Server's response. The response could be the requested web
-server content or it could be an error message. The content could come
-from the Traffic Server cache or Traffic Server might fetch it from the
-origin server. The following diagram shows some states in a typical
-transaction - specifically, the scenario wherein content is served from
-cache.
-
-**Simplified HTTP Transaction**
-
-.. _SimplifiedHTTPTransaction:
-
-.. figure:: /static/images/sdk/transact75.jpg
-   :alt: Simplified HTTP Transaction
-
-   Simplified HTTP Transaction
-
-In the diagram above, Traffic Server accepts the client connection,
-reads the request headers, looks up the origin server's IP address, and
-looks for the requested content in the cache. If the content is not in
-the cache (a "miss"), then Traffic Server opens a connection to the
-origin server and issues a request for the content. If the content is in
-the cache (a "hit"), then Traffic Server checks it for freshness.
-
-If the content is fresh, then Traffic Server sends a reply header to the
-client. If the content is stale, then Traffic Server opens a connection
-to the origin server and requests the content. The figure above,
-:ref:`SimplifiedHTTPTransaction`, does *not*
-show behavior in the event of an error. If there is an error at a any
-stage, then the HTTP state machine jumps to the "send reply header"
-state and sends a reply. If the reply is an error, then the transaction
-closes. If the reply is not an error, then Traffic Server first sends
-the response content before it closes the transaction.
-
-**API Hooks Corresponding to States**
-
-.. _APIHooksCorrespondingtoStates:
-
-.. figure:: /static/images/sdk/transact_hook75.jpg
-   :alt: API Hooks Corresponding to States Listed in
-
-   API Hooks Corresponding to States Listed in
-
-You use hooks as triggers to start your plugin. The name of a hook
-reflects the Traffic Server state that was *just completed*. For
-example, the "OS DNS lookup" hook wakes up a plugin right *after* the
-origin server DNS lookup. For a plugin that requires the IP address of
-the requested origin server, this hook is the right one to use. The
-Blacklist plugin works in this manner, as shown in the :ref:`BlackListPlugin`
-diagram below.
-
-**Blacklist Plugin**
-
-.. _BlackListPlugin:
-
-.. figure:: /static/images/sdk/blacklist75.jpg
-   :alt: Blacklist Plugin
-
-   Blacklist Plugin
-
-Traffic Server calls the Blacklist plugin right after the origin server
-DNS lookup. The plugin checks the requested host against a list of
-blacklisted servers; if the request is allowed, then the transaction
-proceeds. If the host is forbidden, then the Blacklist plugin sends the
-transaction into an error state. When the HTTP state machine gets to the
-"send reply header" state, it then calls the Blacklist plugin to provide
-the error message that's sent to the client.
-
-Types of Hooks
-^^^^^^^^^^^^^^
-
-The Blacklist plugin's hook to the origin server DNS lookup state is a *global
-hook*, meaning that the plugin is called every time there's an HTTP transaction
-with a DNS lookup event. The plugin's hook to the send reply header state is a
-*transaction hook*, meaning that this hook is only invoked for specified
-transactions (in the :ref:`developer-plugins-examples-blacklist` example, it's
-only used for requests to blacklisted servers). Several examples of setting up
-hooks are provided in :ref:`developer-plugins-header-based-examples` and
-:ref:`developer-plugins-http-transformations`.
-
-*Header manipulation plugins*, such as filtering, basic authorization,
-or redirects, usually have a global hook to the DNS lookup or the read
-request header states. If specific actions need to be done to the
-transaction further on, then the plugin adds itself to a transaction
-hook. *Transformation plugins* require a global hook to check
-all transactions for transformability followed by a transform hook,
-which is a type of transaction hook used specifically for transforms.
-

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4e4a01aa/doc/developer-guide/plugins/plugin-management/logging-api.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/plugins/plugin-management/logging-api.en.rst b/doc/developer-guide/plugins/plugin-management/logging-api.en.rst
index 36d73ab..16867e0 100644
--- a/doc/developer-guide/plugins/plugin-management/logging-api.en.rst
+++ b/doc/developer-guide/plugins/plugin-management/logging-api.en.rst
@@ -95,8 +95,11 @@ The steps below show how the logging API is used in the
 
    .. code-block:: c
 
-       for (i = 0; i < nsites; i++) { if (strncmp (host, sites[i],
-       host\_length) == 0) {
+       for (i = 0; i < nsites; i++) {
+         if (strncmp (host, sites[i], host_length) == 0) {
+           /* ... */
+         }
+       }
 
    If the host matches one of the blacklisted
    sites (such as ``sites[i]``), then the plugin writes a blacklist


Mime
View raw message