trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a..@apache.org
Subject [1/2] git commit: Documentation: Fixing warnings and errors and spacing.
Date Mon, 29 Jul 2013 17:50:12 GMT
Updated Branches:
  refs/heads/master 19fe78ad9 -> 8226827fe


Documentation: Fixing warnings and errors and spacing.


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

Branch: refs/heads/master
Commit: d55a2ec9b9dc52e23fa25bfbbbcda21e548ca2f6
Parents: 19fe78a
Author: Alan M. Carroll <amc@network-geographics.com>
Authored: Mon Jul 29 12:16:58 2013 -0500
Committer: Alan M. Carroll <amc@network-geographics.com>
Committed: Mon Jul 29 12:16:58 2013 -0500

----------------------------------------------------------------------
 .../configuration-files/records.config.en.rst   | 75 ++++++++++---------
 doc/sdk/adding-statistics.en.rst                | 36 +++++----
 .../adding-statistics/coupled-statistics.en.rst | 13 ++--
 .../writing-handler-functions.en.rst            | 54 ++++++--------
 .../how-to-create-trafficserver-plugins.en.rst  | 41 +++++-----
 .../roadmap-for-creating-plugins.en.rst         | 35 +++++----
 doc/sdk/http-headers.en.rst                     | 78 ++++++++++----------
 ...e-to-trafficserver-http-header-system.en.rst | 65 ++++++++--------
 doc/sdk/http-headers/http-headers.en.rst        | 62 ++++++++--------
 9 files changed, 225 insertions(+), 234 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/admin/configuration-files/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/records.config.en.rst b/doc/admin/configuration-files/records.config.en.rst
index f5a6efd..6563379 100644
--- a/doc/admin/configuration-files/records.config.en.rst
+++ b/doc/admin/configuration-files/records.config.en.rst
@@ -1,22 +1,23 @@
 records.config
 **************
 
-.. Licensed to the Apache Software Foundation (ASF) under one
+..
+   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.
 
 The :file:`records.config` file is a list of configurable variables used by
 the Traffic Server software. Many of the variables in the
@@ -59,7 +60,7 @@ If the server name should be ``that_server`` the line would be ::
 
    CONFIG proxy.config.proxy_name STRING that_server
 
-In the following example, the variable `proxy.config.arm.enabled`_ is
+In the following example, the variable ``proxy.config.arm.enabled`` is
 a yes/no flag. A value of ``0`` (zero) disables the option; a value of
 ``1`` enables the option. ::
 
@@ -138,7 +139,7 @@ System Variables
 
 .. ts:confvar:: CONFIG proxy.config.cli_binary STRING traffic_line
 
-   The name of the executable that runs the command-line interface `traffic_line`_.
+   The name of the executable that runs the command-line interface :program:`traffic_line`.
 
 .. ts:confvar:: CONFIG proxy.config.watch_script STRING traffic_cop
 
@@ -300,20 +301,18 @@ Local Manager
 
    Option used to specify who to run the ``traffic_server`` process as; also used to specify
ownership of config and log files.
 
-   The nonprivileged user account designated to Traffic Server.
+The nonprivileged user account designated to Traffic Server.
 
-   As of version 2.1.1 if the user_id is prefixed with pound character
-   (#) the remaining of the string is considered to be ``numeric user
-   identifier <http://en.wikipedia.org/wiki/User_identifier>``_. If the
-   value is set to '#-1' Traffic Server will not change the user during
-   startup.
+As of version 2.1.1 if the user_id is prefixed with pound character (#) the remaining of
the string is considered to be
+``numeric user identifier <http://en.wikipedia.org/wiki/User_identifier>``_.
+If the value is set to ``#-1`` Traffic Server will not change the user during startup.
 
-   Setting ``user_id`` to ``root`` or ``#0`` is now forbidden to
-   increase security. Trying to do so, will cause the
-   ``traffic_server`` fatal failure. However there are two ways to
-   bypass that restriction: Specify ``-DBIG_SECURITY_HOLE`` in
-   ``CXXFLAGS`` during compilation Set the ``user_id=#-1`` and start
-   trafficserver as root.
+Setting ``user_id`` to ``root`` or ``#0`` is now forbidden to
+increase security. Trying to do so, will cause the
+``traffic_server`` fatal failure. However there are two ways to
+bypass that restriction: Specify ``-DBIG_SECURITY_HOLE`` in
+``CXXFLAGS`` during compilation. Set the ``user_id=#-1`` and start
+trafficserver as root.
 
 Process Manager
 ===============
@@ -532,7 +531,7 @@ Value Effect
 
    Enables (``1``) or disables (``0``) ``traffic_cop`` heartbeat ogging.
 
-.. ts:confvar:: proxy.config.http.use_client_target_addr  INT 0
+.. ts:confvar:: CONFIG proxy.config.http.use_client_target_addr  INT 0
 
    For fully transparent ports use the same origin server address as the client.
 
@@ -1134,15 +1133,19 @@ HostDB
 
    The number of seconds for which to use a stale NS record while initiating a background
fetch for the new data.
 
-.. ts:confvar:: proxy.config.hostdb.storage_size INT 200000
+.. ts:confvar:: CONFIG proxy.config.hostdb.storage_size INT 33554432
 
-   The amount of space (in bytes) used to store ``hostdb``. Thevalue of this variable must
be increased if you increase the sizeof the
+   The amount of space (in bytes) used to store ``hostdb``.
+   The value of this variable must be increased if you increase the size of the
    `proxy.config.hostdb.size`_ variable.
 
-   Default: ``200000`` : The maximum number of entries allowed in the host database.
+.. ts:confvar:: CONFIG proxy.config.hostdb.size INT 200000
+
+   The maximum number of entries that can be stored in the database.
+
+.. note::
 
-   **Note:** For values above ``200000``, you must increase the value ofthe `proxy.config.hostdb.storage_size`_
variable by at least 44 bytes per
-   entry.
+   For values above ``200000``, you must increase the value of the `proxy.config.hostdb.storage_size`_
  variable by at least 44 bytes per entry.
 
 .. ts:confvar:: CONFIG proxy.config.hostdb.ttl_mode INT 0
    :reloadable:
@@ -1208,7 +1211,7 @@ Logging Configuration
 .. ts:confvar:: CONFIG proxy.config.log.max_space_mb_headroom INT 10
    :reloadable:
 
-   The tolerance for the log space limit (in bytes). If the variable `proxy.config.log.auto_delete_rolled_file`_
is set to ``1``
+   The tolerance for the log space limit (in bytes). If the variable `proxy.config.log.auto_delete_rolled_files`_
is set to ``1``
    (enabled), then autodeletion of log files is triggered when the amount of free space available
in the logging directory is less than
    the value specified here.
 
@@ -1283,7 +1286,7 @@ Logging Configuration
 .. ts:confvar:: CONFIG proxy.config.log.common_log_header STRING NULL
    :reloadable:
 
-   The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>``_ file
header text.
+   The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>`_ file
header text.
 
 .. ts:confvar:: CONFIG proxy.config.log.extended_log_enabled INT 0
    :reloadable:

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/adding-statistics.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/adding-statistics.en.rst b/doc/sdk/adding-statistics.en.rst
index 95ce041..a49c26c 100644
--- a/doc/sdk/adding-statistics.en.rst
+++ b/doc/sdk/adding-statistics.en.rst
@@ -3,20 +3,20 @@ Adding Statistics
 
 .. 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.
 
 This chapter describes how to add statistics to your plugins. Statistics
 can be coupled or uncoupled; **coupled** statistics are quantities that
@@ -51,20 +51,18 @@ To add uncoupled statistics, follow the steps below:
 1. Declare your statistic as a global variable in your plugin. For
    example:
 
-   ::
+   .. code-block:: c
 
-       ::::c
-       static TSStat my_statistic;
+      static TSStat my_statistic;
 
 2. In ``TSPluginInit``, create new statistics using ``TSStatCreate``.
    When you create a new statistic, you need to give it an "external"
    name that the Traffic Server command line interface (Traffic Line)
    uses to access the statistic. For example:
 
-   ::
+   .. code-block:: c
 
-       ::::c
-       my_statistic = TSStatCreate ("my.statistic", TSSTAT_TYPE_INT64);
+      my_statistic = TSStatCreate ("my.statistic", TSSTAT_TYPE_INT64);
 
 3. Modify (increment, decrement, or other modification) your statistic
    in plugin functions.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/adding-statistics/coupled-statistics.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/adding-statistics/coupled-statistics.en.rst b/doc/sdk/adding-statistics/coupled-statistics.en.rst
index 035c59d..305350d 100644
--- a/doc/sdk/adding-statistics/coupled-statistics.en.rst
+++ b/doc/sdk/adding-statistics/coupled-statistics.en.rst
@@ -35,15 +35,12 @@ another, establish a coupled statistic category and make sure that each
 coupled statistic belongs to the appropriate category. When it is time
 to do the global update, specify the category to be updated.
 
-.. figure:: /images/docbook/note.png
-   :alt: [Note]
+.. note::
 
-   [Note]
-
-The local statistic copy must have a duplicate set of statistics as that
-of the master copy. Local statistics must also be added to the local
-statistic category in the same order as their master copy counterparts
-were originally added.
+   The local statistic copy must have a duplicate set of statistics as that
+   of the master copy. Local statistics must also be added to the local
+   statistic category in the same order as their master copy counterparts
+   were originally added.
 
 Below are the steps you need to follow, along with a code example taken
 from the ``redirect-1.c`` sample plugin.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/continuations/writing-handler-functions.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/continuations/writing-handler-functions.en.rst b/doc/sdk/continuations/writing-handler-functions.en.rst
index 3da9a40..07793a6 100644
--- a/doc/sdk/continuations/writing-handler-functions.en.rst
+++ b/doc/sdk/continuations/writing-handler-functions.en.rst
@@ -34,41 +34,35 @@ continuation is a handle to the same continuation that is invoked. The
 handler function typically has a switch statement to handle the events
 it receives:
 
-::
+.. code-block:: c
 
-        ::::c
-        static int some_handler (TScont contp, TSEvent event, void *edata)
-        {
-            .....
-                switch(event) {
-                    case TS_EVENT_SOME_EVENT_1:
-                        do_some_thing_1;
-                        return;
-                    case TS_EVENT_SOME_EVENT_2:
-                        do_some_thing_2;
-                        return;
-                    case TS_EVENT_SOME_EVENT_3:
-                        do_some_thing_3;
-                        return;
-                    default: break;
-                }
-            return 0;
-        }
+   static int some_handler (TScont contp, TSEvent event, void *edata)
+   {
+      // .....
+      switch(event) {
+         case TS_EVENT_SOME_EVENT_1:
+            do_some_thing_1;
+            return;
+         case TS_EVENT_SOME_EVENT_2:
+            do_some_thing_2;
+            return;
+         case TS_EVENT_SOME_EVENT_3:
+            do_some_thing_3;
+            return;
+         default: break;
+      }
+      return 0;
+   }
 
-.. figure:: /images/docbook/caution.png
-   :alt: [Caution]
+.. caution::
 
-   [Caution]
-
-**Caution**
-
-You might notice that a continuation cannot determine if more events are
-"in flight" toward it. Do not use ``TSContDestroy`` to delete a
-continuation before you make sure that all incoming events, such as
-those sent because of ``TSHttpTxnHookAdd``, have been handled.
+   You might notice that a continuation cannot determine if more events are
+   "in flight" toward it. Do not use ``TSContDestroy`` to delete a
+   continuation before you make sure that all incoming events, such as
+   those sent because of ``TSHttpTxnHookAdd``, have been handled.
 
 The following table lists events and the corresponding type of
-``void *``\ data passed to handler functions:
+``void* data`` passed to handler functions:
 
 ======================================== ======================================= ======================
 Event                                    Event Sender                            Data Type

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/how-to-create-trafficserver-plugins.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/how-to-create-trafficserver-plugins.en.rst b/doc/sdk/how-to-create-trafficserver-plugins.en.rst
index 5b8bc1d..55c69da 100644
--- a/doc/sdk/how-to-create-trafficserver-plugins.en.rst
+++ b/doc/sdk/how-to-create-trafficserver-plugins.en.rst
@@ -3,20 +3,20 @@ How to Create Traffic Server Plugins
 
 .. 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.
 
 .. toctree::
    :maxdepth: 2
@@ -83,10 +83,11 @@ back to sleep & waits for the next event.
 
 **Traffic Server Internals** {#TSInternals}
 
-.. figure:: /images/sdk/event_sys80.jpg
+.. figure:: /static/images/sdk/event_sys80.jpg
    :alt: Traffic Server Internals
 
    Traffic Server Internals
+   
 Plugins are typically implemented as continuations. All of the sample
 code plugins (except ``hello-world``) are continuations that are created
 when Traffic Server starts up; they then wait for events that trigger
@@ -94,10 +95,11 @@ them into activity.
 
 **Traffic Server with Plugins** {#TSwithPlugins}
 
-.. figure:: /images/sdk/evt_plugin120.jpg
+.. figure:: /static/images/sdk/evt_plugin120.jpg
    :alt: Traffic Server with Plugins
 
    Traffic Server with Plugins
+   
 A plugin may consist of just one static continuation that is called
 whenever certain events happen. Examples of such plugins include
 ``blacklist-1.c``, ``basic-auth.c``, and ``redirect-1.c``.
@@ -154,10 +156,11 @@ cache.
 
 **Simplified HTTP Transaction** {#SimplifiedHTTPTransaction}
 
-.. figure:: /images/sdk/transact75.jpg
+.. 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
@@ -177,10 +180,11 @@ the response content before it closes the transaction.
 
 **API Hooks Corresponding to States** {#APIHooksCorrespondingtoStates}
 
-.. figure:: /images/sdk/transact_hook75.jpg
+.. 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
@@ -191,10 +195,11 @@ Plugin <#BlacklistPlugin>`__ diagram below.
 
 **Blacklist Plugin** {#BlacklistPlugin}
 
-.. figure:: /images/sdk/blacklist75.jpg
+.. 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

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/how-to-create-trafficserver-plugins/roadmap-for-creating-plugins.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/how-to-create-trafficserver-plugins/roadmap-for-creating-plugins.en.rst
b/doc/sdk/how-to-create-trafficserver-plugins/roadmap-for-creating-plugins.en.rst
index 191b224..c9759e4 100644
--- a/doc/sdk/how-to-create-trafficserver-plugins/roadmap-for-creating-plugins.en.rst
+++ b/doc/sdk/how-to-create-trafficserver-plugins/roadmap-for-creating-plugins.en.rst
@@ -3,20 +3,20 @@ Roadmap for Creating Plugins
 
 .. 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
- 
-   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.
+   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.
 
 This chapter has provided an overview of Traffic Server's HTTP
 processing, API hooks, and the asynchronous event model. Next, you must
@@ -65,17 +65,17 @@ Below are some guidelines for creating a plugin:
    Diagram <../http-hoooks-and-transactions#HTTPTransactionStateDiagram>`__
 
 3. Read `Header-Based Plugin
-   Examples <../header-based-plugin-examples>`__ to learn the basics of
+   Examples <../header-based-plugin-examples>`_ to learn the basics of
    writing plugins: creating continuations and setting up hooks. If you
    want to write a plugin that transforms data, then read `HTTP
-   Transformation Plugins <HTTPTransformationPlugins.html>`__.
+   Transformation Plugins <HTTPTransformationPlugins.html>`_.
 
 4. Figure out what parts of the Traffic Server API you need to use and
    then read about the details of those APIs in this manual's reference
    chapters.
 
 5. Compile and load your plugin (see `Getting
-   Started <../getting-started>`__
+   Started <../getting-started>`_
 
 6. Depending on your plugin's functionality, you might start testing it
    by issuing requests by hand and checking for the desired behavior in
@@ -87,4 +87,3 @@ Below are some guidelines for creating a plugin:
    functional testing on your plugin; for more information see the
    ***Traffic Server SDKTest User's Guide***.
 
-

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/http-headers.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/http-headers.en.rst b/doc/sdk/http-headers.en.rst
index 811cf1c..fe4320f 100644
--- a/doc/sdk/http-headers.en.rst
+++ b/doc/sdk/http-headers.en.rst
@@ -3,20 +3,20 @@ HTTP Headers
 
 .. 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.
 
 This chapter explains the functions used to manipulate HTTP headers.
 
@@ -54,54 +54,53 @@ values. The values in a field are separated by commas. An HTTP header
 containing a request line is usually referred to as a **request**. The
 following example shows a typical request header.
 
-::
+.. code-block:: HTTP
 
-        ::::text
-    GET http://www.tiggerwigger.com/ HTTP/1.0
-    Proxy-Connection: Keep-Alive
-    User-Agent: Mozilla/5.0 [en] (X11; I; Linux 2.2.3 i686)
-    Host: www.tiggerwigger.com
-    Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, image/png, */
-    *
+   GET http://www.tiggerwigger.com/ HTTP/1.0
+   Proxy-Connection: Keep-Alive
+   User-Agent: Mozilla/5.0 [en] (X11; I; Linux 2.2.3 i686)
+   Host: www.tiggerwigger.com
+   Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, image/png, */*
 
-    Accept-Encoding: gzip
-    Accept-Language: en
-    Accept-Charset: iso-8859-1, *, utf-8
+   Accept-Encoding: gzip
+   Accept-Language: en
+   Accept-Charset: iso-8859-1, *, utf-8
 
 The **response header** for the above request might look like the
 following:
 
-::
+.. code-block:: HTTP
 
-        ::::plain
-    HTTP/1.0 200 OK
-    Date: Fri, 13 Nov 2009 06:57:43 GMT
-    Content-Location: http://locutus.tiggerwigger.com/index.html
-    Etag: "07db14afa76be1:1074"
-    Last-Modified: Thu, 05 Nov 2009 20:01:38 GMT
-    Content-Length: 7931
-    Content-Type: text/html
-    Server: Microsoft-IIS/4.0
-    Age: 922
-    Proxy-Connection: close
+   HTTP/1.0 200 OK
+   Date: Fri, 13 Nov 2009 06:57:43 GMT
+   Content-Location: http://locutus.tiggerwigger.com/index.html
+   Etag: "07db14afa76be1:1074"
+   Last-Modified: Thu, 05 Nov 2009 20:01:38 GMT
+   Content-Length: 7931
+   Content-Type: text/html
+   Server: Microsoft-IIS/4.0
+   Age: 922
+   Proxy-Connection: close
 
 The following figure illustrates an HTTP message with an expanded HTTP
 header.
 
 **Figure 10.1. HTTP Request/Response and Header Structure**
 
-.. figure:: /images/sdk/http_header_struct.jpg
+.. figure:: /static/images/sdk/http_header_struct.jpg
    :alt: HTTP Request/Response and Header Structure
 
    HTTP Request/Response and Header Structure
+   
 The figure below shows example HTTP request and response headers.
 
 **Figure 10.2. Examples of HTTP Request and Response Headers**
 
-.. figure:: /images/sdk/http_headers.jpg
+.. figure:: /static/images/sdk/http_headers.jpg
    :alt: Examples of HTTP Request and Response Headers
 
    Examples of HTTP Request and Response Headers
+   
 The marshal buffer or ``TSMBuffer`` is a heap data structure that stores
 parsed URLs, MIME headers, and HTTP headers. You can allocate new
 objects out of marshal buffers and change the values within the marshal
@@ -111,10 +110,11 @@ to the object (``TSMLoc``) and the marshal buffer containing the object
 
 **Figure 10.3. Marshal Buffers and Header Locations**
 
-.. figure:: /images/sdk/marshall_buffers.jpg
+.. figure:: /static/images/sdk/marshall_buffers.jpg
    :alt: Marshal Buffers and Header Locations
 
    Marshal Buffers and Header Locations
+   
 The figure above shows the following:
 
 -  The marshal buffer containing the HTTP request, ``reqest_bufp``

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/http-headers/guide-to-trafficserver-http-header-system.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/http-headers/guide-to-trafficserver-http-header-system.en.rst b/doc/sdk/http-headers/guide-to-trafficserver-http-header-system.en.rst
index 9fc32bd..01aaad0 100644
--- a/doc/sdk/http-headers/guide-to-trafficserver-http-header-system.en.rst
+++ b/doc/sdk/http-headers/guide-to-trafficserver-http-header-system.en.rst
@@ -2,20 +2,20 @@ Guide to Traffic Server HTTP Header System
 
 .. 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
- 
-   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.
+   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.
 
 
 No Null-Terminated Strings
@@ -31,33 +31,28 @@ value, then use ``TSstrndup`` to automatically null-terminate a string.
 The strings that come back and are not null-terminated **cannot** be
 passed into the common ``str*()`` routines
 
-.. figure:: /images/docbook/note.png
-   :alt: [Note]
+.. note::
+   Values returned from a marshall buffer can be ``NULL``, which means the
+   field or object requested does not exist.
 
-   [Note]
-**Note**
+For example (from the ``blacklist-1`` sample)
 
-Values returned from a marshall buffer can be ``NULL``, which means the
-field or object requested does not exist.
+.. code-block:: c
 
-For example (from the ``blacklist-1`` sample):
-
-::
-
-        :::c
-    char *host_string;
-    int host_length;
-    host_string = TSUrlHostGet (bufp, url_loc, &host_length);
-    for (i = 0; i < nsites; i++) {
-    if (strncmp (host_string, sites[i], host_length) == 0) {
-    ...
-    }
+   char *host_string;
+   int host_length;
+   host_string = TSUrlHostGet (bufp, url_loc, &host_length);
+   for (i = 0; i < nsites; i++) {
+   if (strncmp (host_string, sites[i], host_length) == 0) {
+      // ...
+   }
 
 See the sample plugins for additional examples.
+
 .. toctree::
    :maxdepth: 2
 
-   duplicate-mime-fields-are-not-coalesced.en
-   mime-fields-always-belong-to-an-associated-mime-header.en
-   release-marshal-buffer-handles.en
+   guide-to-trafficserver-http-header-system/duplicate-mime-fields-are-not-coalesced.en
+   guide-to-trafficserver-http-header-system/mime-fields-always-belong-to-an-associated-mime-header.en
+   guide-to-trafficserver-http-header-system/release-marshal-buffer-handles.en
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d55a2ec9/doc/sdk/http-headers/http-headers.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/http-headers/http-headers.en.rst b/doc/sdk/http-headers/http-headers.en.rst
index 260ef04..0bf67c9 100644
--- a/doc/sdk/http-headers/http-headers.en.rst
+++ b/doc/sdk/http-headers/http-headers.en.rst
@@ -48,100 +48,100 @@ defines several pre-allocated method names. These names correspond to
 the methods defined in the HTTP 1.1 specification
 
 ``TS_HTTP_METHOD_CONNECT``
-    "CONNECT"
+   "CONNECT"
 
 ``TS_HTTP_METHOD_DELETE``
-    "DELETE"
+   "DELETE"
 
 ``TS_HTTP_METHOD_GE``
-    "GET"
+   "GET"
 
 ``TS_HTTP_METHOD_HEAD``
-    "HEAD"
+   "HEAD"
 
 ``TS_HTTP_METHOD_ICP_QUERY``
-    "ICP\_QUERY"
+   "ICP\_QUERY"
 
 ``TS_HTTP_METHOD_OPTIONS``
-    "OPTIONS"
+   "OPTIONS"
 
 ``TS_HTTP_METHOD_POST``
-    "POST"
+   "POST"
 
 ``TS_HTTP_METHOD_PURGE``
-    "PURGE"
+   "PURGE"
 
 ``TS_HTTP_METHOD_PUT``
-    "PUT"
+   "PUT"
 
 ``TS_HTTP_METHOD_TRACE``
-    "TRACE"
+   "TRACE"
 
 Traffic Server also defines several common values that appear in HTTP
 headers.
 
 ``TS_HTTP_VALUE_BYTES``
-    "bytes"
+   "bytes"
 
 ``TS_HTTP_VALUE_CHUNKED``
-    "chunked"
+   "chunked"
 
 ``TS_HTTP_VALUE_CLOSE``
-    "close"
+   "close"
 
 ``TS_HTTP_VALUE_COMPRESS``
-    "compress"
+   "compress"
 
 ``TS_HTTP_VALUE_DEFLATE``
-    "deflate"
+   "deflate"
 
 ``TS_HTTP_VALUE_GZIP``
-    "gzip"
+   "gzip"
 
 ``TS_HTTP_VALUE_IDENTITY``
-    "identity"
+   "identity"
 
 ``TS_HTTP_VALUE_KEEP_ALIVE``
-    "keep-alive"
+   "keep-alive"
 
 ``TS_HTTP_VALUE_MAX_AGE``
-    "max-age"
+   "max-age"
 
 ``TS_HTTP_VALUE_MAX_STALE``
-    "max-stale"
+   "max-stale"
 
 ``TS_HTTP_VALUE_MIN_FRESH``
-    "min-fresh"
+   "min-fresh"
 
 ``TS_HTTP_VALUE_MUST_REVALIDATE``
-    "must-revalidate"
+   "must-revalidate"
 
 ``TS_HTTP_VALUE_NONE``
-    "none"
+   "none"
 
 ``TS_HTTP_VALUE_NO_CACHE``
-    "no-cache"
+   "no-cache"
 
 ``TS_HTTP_VALUE_NO_STORE``
-    "no-store"
+   "no-store"
 
 ``TS_HTTP_VALUE_NO_TRANSFORM``
-    "no-transform"
+   "no-transform"
 
 ``TS_HTTP_VALUE_ONLY_IF_CACHED``
-    "only-if-cached"
+   "only-if-cached"
 
 ``TS_HTTP_VALUE_PRIVATE``
-    "private"
+   "private"
 
 ``TS_HTTP_VALUE_PROXY_REVALIDATE``
-    "proxy-revalidate"
+   "proxy-revalidate"
 
 ``TS_HTTP_VALUE_PUBLIC``
-    "public"
+   "public"
 
 ``TS_HTTP_VALUE_S_MAX_AGE``
-    "s-maxage"
+   "s-maxage"
 
 The method names and header values above are defined in ``ts.h`` as
 ``const char*`` strings. When Traffic Server sets a method or a header


Mime
View raw message