trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From iga...@apache.org
Subject git commit: links&formatting in the Configuring The Cache Docs
Date Sun, 18 Aug 2013 20:41:12 GMT
Updated Branches:
  refs/heads/master 2b91482fe -> 039a5de78


links&formatting in the Configuring The Cache Docs

* in particular, we also document the change brought by TS-1994, that the
RAM Cache Size now is 10x bigger than before.
* Along with the changes to this document, we fix up volume.config and
storage.config, which are strongly linked: We take care to consistently
use the group Unix `tserver` instead of mixing random groups.

unrelated to this, we fix-up the syntax of .. note:: and .. important::

TODO: The getting started documentation should strongly recommend users
to create a dedicated Unix user for Apache Traffic Server rather than
`nobody:nogroup`. We should recommend `tserver` and consistently in the
documentation use `tserver:tserver`.


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

Branch: refs/heads/master
Commit: 039a5de78864e16b70f75bb57494de8927b5f045
Parents: 2b91482
Author: Igor Galić <i.galic@brainsware.org>
Authored: Sun Aug 18 22:34:48 2013 +0200
Committer: Igor Galić <i.galic@brainsware.org>
Committed: Sun Aug 18 22:34:48 2013 +0200

----------------------------------------------------------------------
 doc/admin/cluster-howto.en.rst                  |   2 +
 doc/admin/configuring-cache.en.rst              | 129 ++++++++--------
 doc/admin/getting-started.en.rst                |   2 +
 doc/admin/hierachical-caching.en.rst            |   2 +-
 doc/admin/reverse-proxy-http-redirects.en.rst   |   2 +-
 doc/reference/commands/traffic_logcat.en.rst    |   2 +-
 .../configuration/logs_xml.config.en.rst        |  22 +--
 .../configuration/records.config.en.rst         | 146 +++++++++++--------
 .../configuration/storage.config.en.rst         |  19 ++-
 .../configuration/volume.config.en.rst          |  13 +-
 proxy/config/records.config.default.in          |   4 +-
 11 files changed, 179 insertions(+), 164 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/admin/cluster-howto.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/cluster-howto.en.rst b/doc/admin/cluster-howto.en.rst
index dd60695..ee6a575 100644
--- a/doc/admin/cluster-howto.en.rst
+++ b/doc/admin/cluster-howto.en.rst
@@ -1,3 +1,5 @@
+.. _traffic-server-cluster:
+
 Traffic Server Cluster
 **********************
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/admin/configuring-cache.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuring-cache.en.rst b/doc/admin/configuring-cache.en.rst
index 6af06db..8b147cc 100644
--- a/doc/admin/configuring-cache.en.rst
+++ b/doc/admin/configuring-cache.en.rst
@@ -51,12 +51,10 @@ fail, then Traffic Server goes into proxy-only mode.
 You can perform the following cache configuration tasks:
 
 -  Change the total amount of disk space allocated to the cache: refer
-   to `Changing Cache Capacity <#ChangingCacheCapacity>`_.
+   to `Changing Cache Capacity`_.
 -  Partition the cache by reserving cache disk space for specific
-   protocols and origin servers/domains: refer to `Partitioning the
-   Cache <#PartitioningCache>`_.
--  Delete all data in the cache: refer to `Clearing the
-   Cache <#ClearingCache>`_.
+   protocols and origin servers/domains: refer to `Partitioning the Cache`_.
+-  Delete all data in the cache: refer to `Clearing the Cache`_.
 
 The RAM Cache
 =============
@@ -89,13 +87,12 @@ its previous value.
 To change the RAM cache size:
 
 1. Stop Traffic Server.
-2. Set the variable
-   `*``proxy.config.cache.ram_cache.size``* <../configuration-files/records.config#proxy.config.cache.ram_cache.size>`_
+2. Set the variable :ts:cv:`proxy.config.cache.ram_cache.size`
    to specify the size of the RAM cache. The default value of -1 means
    that the RAM cache is automatically sized at approximately 1MB per
    gigabyte of disk.
-3. Restart Traffic Server. If you increase the RAM cache to a size or
-   1GB or more, then restart with the ``start_traffic_server`` command
+3. Restart Traffic Server. If you increase the RAM cache to a size of
+   1GB or more, then restart with the :program:`trafficserver` command
    (refer to :ref:`start-traffic-server`).
 
  
@@ -105,8 +102,7 @@ Changing Cache Capacity
 
 You can increase or reduce the total amount of disk space allocated to
 the cache without clearing the content. To check the size of the cache
-(in bytes), enter the command
-``traffic_line -r proxy.process.cache.bytes_total``.
+(in bytes), enter the command :option:`traffic_line -r` ``proxy.process.cache.bytes_total``.
 
 Increasing Cache Capacity
 -------------------------
@@ -117,9 +113,8 @@ steps below:
 
 1. Stop Traffic Server.
 2. Add hardware, if necessary.
-3. Edit :file:`storage.config` to
-   increase the amount of disk space allocated to the cache on existing
-   disks or describe the new hardware you are adding.
+3. Edit :file:`storage.config` to increase the amount of disk space allocated
+   to the cache on existing disks or describe the new hardware you are adding.
 4. Restart Traffic Server.
 
 Reducing Cache Capacity
@@ -131,13 +126,13 @@ steps below:
 
 1. Stop Traffic Server.
 2. Remove hardware, if necessary.
-3. Edit :file:`storage.config` to
-   reduce the amount of disk space allocated to the cache on existing
-   disks or delete the reference to the hardware you're removing.
+3. Edit :file:`storage.config` to reduce the amount of disk space allocated
+   to the cache on existing disks or delete the reference to the hardware you're removing.
 4. Restart Traffic Server.
 
-**IMPORTANT:** In :file:`storage.config`, a formatted or raw disk
-must be at least 128 MB.
+.. important:: In :file:`storage.config`, a formatted or raw disk must be at least 128 MB.
+
+.. _partitioning-the-cache:
 
 Partitioning the Cache
 ======================
@@ -146,7 +141,7 @@ You can manage your cache space more efficiently and restrict disk usage
 by creating cache volumes with different sizes for specific protocols.
 You can further configure these volumes to store data from specific
 origin servers and/or domains. The volume configuration must be the same
-on all nodes in a cluster.
+on all nodes in a :ref:`cluster <traffic-server-cluster>`.
 
 Creating Cache Partitions for Specific Protocols
 ------------------------------------------------
@@ -156,10 +151,11 @@ store content according to protocol. This ensures that a certain amount
 of disk space is always available for a particular protocol. Traffic
 Server currently supports the **http** partition type for HTTP objects.
 
+.. XXX: but not https?
+
 To partition the cache according to protocol:
 
-1. Enter a line in the
-   ```volume.config`` <../configuration-files/volume.config>`_ file for
+1. Enter a line in the :file:`volume.config` file for
    each volume you want to create
 2. Restart Traffic Server.
 
@@ -181,8 +177,7 @@ note the following:
    specified in percentages will increase proportionately.
 -  A lot of changes to volume sizes might result in disk fragmentation,
    which affects performance and hit rate. You should clear the cache
-   before making many changes to cache volume sizes (refer to `Clearing
-   the Cache <#ClearingCache>`_).
+   before making many changes to cache volume sizes (refer to `Clearing the Cache`_).
 
 Partitioning the Cache According to Origin Server or Domain
 -----------------------------------------------------------
@@ -200,31 +195,30 @@ generic volume is also used if the partitions for a particular origin
 server or domain become corrupt. If you do not assign a generic volume,
 then Traffic Server will run in proxy-only mode.
 
-**Note:** You do *not* need to stop Traffic Server before you assign
-volumes to particular hosts or domains. However, this type of
-configuration is time-consuming and can cause a spike in memory usage.
-Therefore, it's best to configure partition assignment during periods of
-low traffic.
+.. note::
+
+    You do *not* need to stop Traffic Server before you assign
+    volumes to particular hosts or domains. However, this type of
+    configuration is time-consuming and can cause a spike in memory usage.
+    Therefore, it's best to configure partition assignment during periods of
+    low traffic.
 
 To partition the cache according to hostname and domain:
 
 1. Configure the cache volumes according to size and protocol, as
-   described in `Creating Cache Partitions for Specific
-   Protocols <#CreatingCachePartitionsSpecificProtocols>`_.
+   described in `Creating Cache Partitions for Specific Protocols`_.
 2. Create a separate volume based on protocol for each host and domain,
    as well as an additional generic partition to use for content that
    does not belong to these origin servers or domains. The volumes do
    not need to be the same size.
-3. Enter a line in the
-   ```hosting.config`` <../configuration-files/hosting.config>`_ file to
+3. Enter a line in the :file:`hosting.config` file to
    allocate the volume(s) used for each origin server and/or domain
 4. Assign a generic volume to use for content that does not belong to
    any of the origin servers or domains listed in the file. If all
    volumes for a particular origin server become corrupt, then Traffic
    Server will also use the generic volume to store content for that
-   origin server as per
-   `hosting.config <../configuration-files/hosting.config>`_.
-5. Run the command ``traffic_line -x`` to apply the configuration
+   origin server as per :file:`hosting.config`.
+5. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
 
 Configuring the Cache Object Size Limit
@@ -234,13 +228,14 @@ By default, Traffic Server allows objects of any size to be cached.
You
 can change the default behavior and specify a size limit for objects in
 the cache via the steps below:
 
-1. Set
-   `*``proxy.config.cache.max_doc_size``* <../configuration-files/records.config#proxy.config.cache.max_doc_size>`_
+1. Set :ts:cv:`proxy.config.cache.max_doc_size`
    to specify the maximum size allowed for objects in the cache in
    bytes. ``0`` (zero) if you do not want a size limit.
-2. Run the command ``traffic_line -x`` to apply the configuration
+2. Run the command :option:`traffic_line -x` to apply the configuration
    changes.
 
+.. _clearing-the-cache:
+
 Clearing the Cache
 ==================
 
@@ -251,11 +246,8 @@ cannot clear the cache when Traffic Server is running.
 
 To clear the cache:
 
-1. Stop Traffic Server (refer to `Stopping Traffic
-   Server <../getting-started#StoppingTS>`_).
-2. Enter the following command to clear the cache:
-
-   ::
+1. Stop Traffic Server (refer to :ref:`Stopping Traffic Server <stop-traffic-server>`)
+2. Enter the following command to clear the cache: ::
 
         traffic_server -Cclear
 
@@ -263,8 +255,7 @@ To clear the cache:
    host database. Traffic Server does not prompt you to confirm the
    deletion.
 
-3. Restart Traffic Server (refer to `Starting Traffic
-   Server <../getting-started#StoppingTS>`_).
+3. Restart Traffic Server (refer to :ref:`Starting Traffic Server <start-traffic-server>`).
 
 Removing an Object From the Cache
 =================================
@@ -276,25 +267,23 @@ cache and is successfully removed, then Traffic Server responds with
a
 returned.
 
 In the following example, Traffic Server is running on the domain
-*``example.com``* and you want to remove the image ``remove_me.jpg``
+``example.com`` and you want to remove the image ``remove_me.jpg``
 from cache. Because by default we do not permit ``PURGE`` requests from
-any other IP, we connect to the daemon via localhost:
-
-::
+any other IP, we connect to the daemon via localhost: ::
 
       $ curl -X PURGE -H 'Host: example.com' -v "http://localhost/remove_me.jpg"
-     * About to connect() to localhost port 80 (#0)
-     * Trying 127.0.0.1... connected
-     * Connected to localhost (127.0.0.1) port 80 (#0)
-
-     > PURGE /remove_me.jpg HTTP/1.1
-     > User-Agent: curl/7.19.7
-     > Host: example.com
-     > Accept: */*
-     >
-     < HTTP/1.1 200 Ok
-     < Date: Thu, 08 Jan 2010 20:32:07 GMT
-     < Connection: keep-alive
+      * About to connect() to localhost port 80 (#0)
+      * Trying 127.0.0.1... connected
+      * Connected to localhost (127.0.0.1) port 80 (#0)
+
+      > PURGE /remove_me.jpg HTTP/1.1
+      > User-Agent: curl/7.19.7
+      > Host: example.com
+      > Accept: */*
+      >
+      < HTTP/1.1 200 Ok
+      < Date: Thu, 08 Jan 2010 20:32:07 GMT
+      < Connection: keep-alive
 
 The next time Traffic Server receives a request for the removed object,
 it will contact the origin server to retrieve it (i.e., it has been
@@ -322,7 +311,9 @@ To access the Cache Inspector utility, follow the steps below:
 
 #. Set :ts:cv:`proxy.config.http_ui_enabled` to ``1``.
 #. To access the cache inspector in reverse proxy mode, you must add a
-   remap rule to :file:`remap.config` to expose the URL. This should be restricted to a limited
set of hosts using the ``@src_ip`` option. To restrict access to the network 172.28.56.0/24,
use ::
+   remap rule to :file:`remap.config` to expose the URL. This should be
+   restricted to a limited set of hosts using the ``@src_ip`` option.
+   To restrict access to the network 172.28.56.0/24, use ::
 
       map http://yourhost.com/myCI http://{cache} @action=allow @src_ip=172.28.56.1-172.28.56.254
 
@@ -351,7 +342,7 @@ delete the contents of your cache:
 -  Click **Regex lookup** to search for URLs that match one or more
    regular expressions. From the display page, you can delete the URLs
    listed. For example, enter the following to search for all URLs that
-   end in html and are prefixed with http://www.dianes.com:
+   end in html and are prefixed with ``http://www.dianes.com``:
    ``http://www.dianes.com/.*\.html$``
 -  Click **Regex delete** to delete all URLs that match a specified
    regular expression. For example, enter the following to delete all
@@ -362,7 +353,9 @@ delete the contents of your cache:
    Server then contacts the origin server to check if the object is
    still fresh (revalidates) before serving it from the cache.
 
-**Note:** Only one administrator should delete and invalidate cache
-entries from the Cache page at any point in time. Changes made by
-multiple administrators at the same time can lead to unpredictable
-results.
+.. note::
+
+    Only one administrator should delete and invalidate cache
+    entries from the Cache page at any point in time. Changes made by
+    multiple administrators at the same time can lead to unpredictable
+    results.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/admin/getting-started.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/getting-started.en.rst b/doc/admin/getting-started.en.rst
index 80eb151..29906bf 100644
--- a/doc/admin/getting-started.en.rst
+++ b/doc/admin/getting-started.en.rst
@@ -177,6 +177,8 @@ administrator, is a poor choice for automation, especially that of
 monitoring. See our chapter on :ref:`monitoring-traffic`
 for how to do that better.
 
+.. _stop-traffic-server:
+
 Stop Traffic Server
 ===================
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/admin/hierachical-caching.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/hierachical-caching.en.rst b/doc/admin/hierachical-caching.en.rst
index 488d3d1..0a7a1c4 100644
--- a/doc/admin/hierachical-caching.en.rst
+++ b/doc/admin/hierachical-caching.en.rst
@@ -104,7 +104,7 @@ complete the following steps:
    cache so that when a parent cache is unavailable, requests are sent
    to another parent cache.
 
-.. note: You need to configure the child cache only. No additional configuration is needed
for the Traffic Server parent cache.
+.. note:: You need to configure the child cache only. No additional configuration is needed
for the Traffic Server parent cache.
 
 Configure Traffic Server to use a parent cache by editing the following
 variable :ts:cv:`proxy.config.http.parent_proxy_routing_enable` in :file:`records.config`
file.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/admin/reverse-proxy-http-redirects.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/reverse-proxy-http-redirects.en.rst b/doc/admin/reverse-proxy-http-redirects.en.rst
index 007c504..54fb3ed 100644
--- a/doc/admin/reverse-proxy-http-redirects.en.rst
+++ b/doc/admin/reverse-proxy-http-redirects.en.rst
@@ -119,7 +119,7 @@ Server IP address. When Traffic Server is configured as the origin
 server, the browser connects to Traffic Server rather than the origin
 server. For additional information, see `HTTP Reverse Proxy`_.
 
-.. note: To avoid a DNS conflict, the origin server’s hostname and its advertised hostname
must not be the same.
+.. note:: To avoid a DNS conflict, the origin server’s hostname and its advertised hostname
must not be the same.
 
 HTTP Reverse Proxy
 ==================

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/reference/commands/traffic_logcat.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_logcat.en.rst b/doc/reference/commands/traffic_logcat.en.rst
index ff67657..7169503 100644
--- a/doc/reference/commands/traffic_logcat.en.rst
+++ b/doc/reference/commands/traffic_logcat.en.rst
@@ -85,7 +85,7 @@ Attempt to transform the input to Netscape Extended-2 format, if possible.
    Print version information and exit.
 
 
-.. note: Use only one of the following options at any given time: ``-S``, ``-C``, ``-E``,
or ``-2``.
+.. note:: Use only one of the following options at any given time: ``-S``, ``-C``, ``-E``,
or ``-2``.
 
 If no input files are specified, then :program:`traffic_logcat` reads from the
 standard input (``stdin``). If you do not specify an output file, then

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/reference/configuration/logs_xml.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/logs_xml.config.en.rst b/doc/reference/configuration/logs_xml.config.en.rst
index 6a0cac6..54fd14f 100644
--- a/doc/reference/configuration/logs_xml.config.en.rst
+++ b/doc/reference/configuration/logs_xml.config.en.rst
@@ -276,9 +276,7 @@ Examples
 ========
 
 The following is an example of a ``LogFormat`` specification that
-collects information using three common fields:
-
-::
+collects information using three common fields: ::
 
          <LogFormat>
              <Name="minimal"/>
@@ -286,9 +284,7 @@ collects information using three common fields:
          </LogFormat>
 
 The following is an example of a ``LogFormat`` specification that
-uses aggregate operators:
-
-::
+uses aggregate operators: ::
 
          <LogFormat>
              <Name = "summary"/>
@@ -297,9 +293,7 @@ uses aggregate operators:
          </LogFormat>
 
 The following is an example of a ``LogFilter`` that will cause only
-``REFRESH_HIT`` entries to be logged:
-
-::
+``REFRESH_HIT`` entries to be logged: ::
 
          <LogFilter>
               <Name = "only_refresh_hits"/>
@@ -307,13 +301,11 @@ The following is an example of a ``LogFilter`` that will cause only
               <Condition = "%<pssc> MATCH REFRESH_HIT"/>
          </LogFilter>
 
-.. note:
+.. note::
 
     When specifying the field in the filter condition, you can
     omit the\ ``%<>``. This means that the filter below is equivalent to the
-    example directly above:
-
-::
+    example directly above: ::
 
          <LogFilter>
              <Name = "only_refresh_hits"/>
@@ -324,9 +316,7 @@ The following is an example of a ``LogFilter`` that will cause only
 The following is an example of a ``LogObject`` specification that
 creates a local log file for the minimal format defined earlier. The log
 filename will be ``minimal.log`` because this is an ASCII log file (the
-default).
-
-::
+default).::
 
          <LogObject>
              <Format = "minimal"/>

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
index 64eacd9..7fc2d71 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -502,12 +502,14 @@ Value Effect
    -  ``2`` Generate a chunked response if the server has returned HTTP/1.1 before
    -  ``3`` = Generate a chunked response if the client request is HTTP/1.1 and the origin
server has returned HTTP/1.1 before
 
-   **Note:** If HTTP/1.1 is used, then Traffic Server can use
-   keep-alive connections with pipelining to origin servers. If
-   HTTP/0.9 is used, then Traffic Server does not use ``keep-alive``
-   connections to origin servers. If HTTP/1.0 is used, then Traffic
-   Server can use ``keep-alive`` connections without pipelining to
-   origin servers.
+   .. note::
+
+       If HTTP/1.1 is used, then Traffic Server can use
+       keep-alive connections with pipelining to origin servers. If
+       HTTP/0.9 is used, then Traffic Server does not use ``keep-alive``
+       connections to origin servers. If HTTP/1.0 is used, then Traffic
+       Server can use ``keep-alive`` connections without pipelining to
+       origin servers.
 
 .. ts:cv:: CONFIG proxy.config.http.share_server_sessions INT 1
 
@@ -742,21 +744,23 @@ Negative Response Caching
    When enabled (``1``), Traffic Server caches negative responses (such as ``404 Not Found``)
when a requested page does not exist. The next
    time a client requests the same page, Traffic Server serves the negative response directly
from cache.
 
-   **Note**: ``Cache-Control`` directives from the server forbidding ache are ignored for
the following HTTP response codes, regardless
-   of the value specified for the `proxy.config.http.negative_caching_enabled`_ variable.
The
-   following negative responses are cached by Traffic Server:::
-
-        204  No Content
-        305  Use Proxy
-        400  Bad Request
-        403  Forbidden
-        404  Not Found
-        405  Method Not Allowed
-        500  Internal Server Error
-        501  Not Implemented
-        502  Bad Gateway
-        503  Service Unavailable
-        504  Gateway Timeout
+   .. note::
+   
+       ``Cache-Control`` directives from the server forbidding ache are ignored for the following
HTTP response codes, regardless
+       of the value specified for the `proxy.config.http.negative_caching_enabled`_ variable.
The
+       following negative responses are cached by Traffic Server:::
+
+            204  No Content
+            305  Use Proxy
+            400  Bad Request
+            403  Forbidden
+            404  Not Found
+            405  Method Not Allowed
+            500  Internal Server Error
+            501  Not Implemented
+            502  Bad Gateway
+            503  Service Unavailable
+            504  Gateway Timeout
 
     The cache lifetime for objects cached from this setting is controlled via
     ``proxy.config.http.negative_caching_lifetime``.
@@ -829,9 +833,11 @@ Security
    Enables (``1``) or disables (``0``) the HTTP ``PUSH`` option, which allows you to deliver
content directly to the cache without a user
    request.
 
-   **Important:** If you enable this option, then you must also specify
-   a filtering rule in the ip_allow.config file to allow only certain
-   machines to push content into the cache.
+   .. important::
+
+       If you enable this option, then you must also specify
+       a filtering rule in the ip_allow.config file to allow only certain
+       machines to push content into the cache.
 
 Cache Control
 =============
@@ -954,11 +960,13 @@ Cache Control
    When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Type:``
header that does not match the ``Accept:``
    header of the request.
 
-   **Note:** This option should only be enabled if you're having
-   problems with caching *and* one of the following is true:
+   .. note::
 
-   -  Your origin server sets ``Vary: Accept`` when doing content negotiation with ``Accept``
*OR*
-   -  The server does not send a ``406 (Not Acceptable)`` response for types that it cannot
serve.
+       This option should only be enabled if you're having
+       problems with caching *and* one of the following is true:
+
+       -  Your origin server sets ``Vary: Accept`` when doing content negotiation with ``Accept``
*OR*
+       -  The server does not send a ``406 (Not Acceptable)`` response for types that it
cannot serve.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ignore_accept_language_mismatch INT 0
    :reloadable:
@@ -966,10 +974,12 @@ Cache Control
    When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Language:``
header that does not match the
    ``Accept-Language:`` header of the request.
 
-   **Note:** This option should only be enabled if you're having
-   problems with caching and your origin server is guaranteed to set
-   ``Vary: Accept-Language`` when doing content negotiation with
-   ``Accept-Language``.
+   .. note::
+
+       This option should only be enabled if you're having
+       problems with caching and your origin server is guaranteed to set
+       ``Vary: Accept-Language`` when doing content negotiation with
+       ``Accept-Language``.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ignore_accept_charset_mismatch INT 0
    :reloadable:
@@ -977,10 +987,12 @@ Cache Control
    When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Type:``
header that does not match the
    ``Accept-Charset:`` header of the request.
 
-   **Note:** This option should only be enabled if you're having
-   problems with caching and your origin server is guaranteed to set
-   ``Vary: Accept-Charset`` when doing content negotiation with
-   ``Accept-Charset``.
+   .. note::
+
+       This option should only be enabled if you're having
+       problems with caching and your origin server is guaranteed to set
+       ``Vary: Accept-Charset`` when doing content negotiation with
+       ``Accept-Charset``.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
    :reloadable:
@@ -992,15 +1004,24 @@ Cache Control
 
    When enabled (``1``), Traffic Server will keep certain HTTP objects in the cache for a
certain time as specified in cache.config.
 
+RAM Cache
+=========
+
+
+.. :ts:cv:: CONFIG proxy.config.cache.ram_cache.size INT -1
+
+   By default the RAM cache size to is automatically determined, based on cache size (approximately
10 MB of RAM cache per GB of disk cache).
+   Alternatively, it can be set to a fixed value such as 21474836480 (20GB).
+
 Heuristic Expiration
 ====================
 
-.. ts::confvar:: proxy.config.http.cache.heuristic_min_lifetime INT 3600
+.. :ts:cv:: proxy.config.http.cache.heuristic_min_lifetime INT 3600
    :reloadable:
 
    The minimum amount of time an HTTP object without an expiration date can remain fresh
in the cache before is considered to be stale.
 
-.. ts::confvar:: proxy.config.http.cache.heuristic_max_lifetime INT 86400
+.. :ts:cv:: proxy.config.http.cache.heuristic_max_lifetime INT 86400
    :reloadable:
 
    The maximum amount of time an HTTP object without an expiration date can remain fresh
in the cache before is considered to be stale.
@@ -1196,19 +1217,24 @@ Logging Configuration
    :reloadable:
 
    The amount of space allocated to the logging directory (in MB).
-   **Note:** All files in the logging directory contribute to the space used, even if they
are not log files. In collation client mode, if
-   there is no local disk logging, or max_space_mb_for_orphan_logs is set to a higher value
than max_space_mb_for_logs, TS will
-   take proxy.config.log.max_space_mb_for_orphan_logs for maximum allowed log space.
+
+
+   .. note::
+       All files in the logging directory contribute to the space used, even if they are
not log files. In collation client mode, if
+       there is no local disk logging, or `max_space_mb_for_orphan_logs` is set to a higher
value than `max_space_mb_for_logs`_, TS will
+       take `proxy.config.log.max_space_mb_for_orphan_logs`_ for maximum allowed log space.
 
 .. ts:cv:: CONFIG proxy.config.log.max_space_mb_for_orphan_logs INT 25
    :reloadable:
 
    The amount of space allocated to the logging directory (in MB) if this node is acting
as a collation client.
 
-   **Note:** When max_space_mb_for_orphan_logs is take as the maximum allowedlog space in
the logging system, the same rule apply to
-   proxy.config.log.max_space_mb_for_logs also apply to proxy.config.log.max_space_mb_for_orphan_logs,
ie: All files in
-   the logging directory contribute to the space used, even if they are not log files. you
may need to consider this when you enable full
-   remote logging, and bump to the same size as proxy.config.log.max_space_mb_for_logs.
+   .. note::
+
+       When max_space_mb_for_orphan_logs is take as the maximum allowedlog space in the logging
system, the same rule apply to
+       proxy.config.log.max_space_mb_for_logs also apply to proxy.config.log.max_space_mb_for_orphan_logs,
ie: All files in
+       the logging directory contribute to the space used, even if they are not log files.
you may need to consider this when you enable full
+       remote logging, and bump to the same size as proxy.config.log.max_space_mb_for_logs.
 
 .. ts:cv:: CONFIG proxy.config.log.max_space_mb_headroom INT 10
    :reloadable:
@@ -1227,7 +1253,7 @@ Logging Configuration
 
    The full path to the logging directory. This can be an absolute path or a path relative
to the directory in which Traffic Server is installed.
 
-   **Note:** The directory you specify must already exist.
+   .. note:: The directory you specify must already exist.
 
 .. ts:cv:: CONFIG proxy.config.log.logfile_perm STRING rw-r--r--
    :reloadable:
@@ -1411,7 +1437,7 @@ server, refer to `logs_xml.config <logs_xml.config>`_.
 
    The log file rolling interval, in seconds. The minimum value is ``300`` (5 minutes). The
maximum, and default, value is 86400 seconds (one day).
 
-   **Note:** If you start Traffic Server within a few minutes of the next rolling time, then
rolling might not occur until the next rolling time.
+   .. note:: If you start Traffic Server within a few minutes of the next rolling time, then
rolling might not occur until the next rolling time.
 
 .. ts:cv:: CONFIG proxy.config.log.rolling_offset_hr INT 0
    :reloadable:
@@ -1649,10 +1675,12 @@ ICP Configuration
 
    Specifies the network interface used for ICP traffic.
 
-   **Note:** The Traffic Server installation script detects your
-   network interface and sets this variable appropriately. If your
-   system has multiple network interfaces, check that this variable
-   specifies the correct interface.
+   .. note::
+
+       The Traffic Server installation script detects your
+       network interface and sets this variable appropriately. If your
+       system has multiple network interfaces, check that this variable
+       specifies the correct interface.
 
 .. ts:cv:: CONFIG proxy.config.icp.icp_port INT 3130
    :reloadable:
@@ -1741,9 +1769,11 @@ Sockets
         TCP_NODELAY (1)
         SO_KEEPALIVE (2)
 
-   **Note:** This is a flag and you look at the bits set. Therefore,
-   you must set the value to ``3`` if you want to enable both options
-   above.
+   .. note::
+
+       This is a flag and you look at the bits set. Therefore,
+       you must set the value to ``3`` if you want to enable both options
+       above.
 
 .. ts:cv:: CONFIG proxy.config.net.sock_send_buffer_size_out INT 0
 
@@ -1761,9 +1791,11 @@ Sockets
         TCP_NODELAY (1)
         SO_KEEPALIVE (2)
 
-   **Note:** This is a flag and you look at the bits set. Therefore,
-   you must set the value to ``3`` if you want to enable both options
-   above.
+   .. note::
+
+        This is a flag and you look at the bits set. Therefore,
+        you must set the value to ``3`` if you want to enable both options
+        above.
 
 .. ts:cv:: CONFIG proxy.config.net.sock_mss_in INT 0
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/reference/configuration/storage.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/storage.config.en.rst b/doc/reference/configuration/storage.config.en.rst
index 072670d..f6bc746 100644
--- a/doc/reference/configuration/storage.config.en.rst
+++ b/doc/reference/configuration/storage.config.en.rst
@@ -52,9 +52,8 @@ raw disk must be at least 128 MB.
 
 When using raw disk or partitions, you should make sure the admin user,
 which is the traffic_server running at, have the read&write privileges.
-The admin user_id is set in
-```proxy.config.admin.user_id`` <records.config#proxy.config.admin.user_id>`_.
-One good practice is if the disk set with g+rw, put the admin user into
+The admin user_id is set in :ts:cv:`proxy.config.admin.user_id`.
+One good practice is if the disk set with 'g+rw', put the admin user into
 the group which have the privileges.
 
 Examples
@@ -91,16 +90,16 @@ system:::
     /dev/sdf volume=2
 
 In order to make sure :program:`traffic_server` will have access to this disk
-you can use ``udev`` to persistently set the right permissions. The
+you can use :manpage:`udev(7)` to persistently set the right permissions. The
 following rules are targeted for an Ubuntu system, and stored in
 ``/etc/udev/rules.d/51-cache-disk.rules``::
 
-    # Assign /dev/sde and /dev/sdf to the www group
+    # Assign /dev/sde and /dev/sdf to the tserver group
     # make the assignment final, no later changes allowed to the group!
-    SUBSYSTEM=="block", KERNEL=="sd[ef]", GROUP:="www"
+    SUBSYSTEM=="block", KERNEL=="sd[ef]", GROUP:="tserver"
 
-FreeBSD Example ## {#LinuxExample}
-----------------------------------
+FreeBSD Example
+---------------
 
 Starting with 5.1 FreeBSD dropped support for explicit raw devices. All
 devices on FreeBSD can be accessed raw now.
@@ -112,8 +111,8 @@ operating system::
     /dev/ada2
 
 In order to make sure :program:`traffic_server` will have access to this disk
-you can use ``devfs`` to persistently set the right permissions. The
-following rules are stored in ``/etc/devfs.conf``::
+you can use :manpage:`devfs(8)` to persistently set the right permissions. The
+following rules are stored in :manpage:`devfs.conf(5)`::
 
     # Assign /dev/ada1 and /dev/ada2 to the tserver user
     own    ada[12]  tserver:tserver

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/doc/reference/configuration/volume.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/volume.config.en.rst b/doc/reference/configuration/volume.config.en.rst
index 51f239f..7c6d594 100644
--- a/doc/reference/configuration/volume.config.en.rst
+++ b/doc/reference/configuration/volume.config.en.rst
@@ -32,22 +32,19 @@ volumes to store data from certain origin servers and/or domains in the
     The volume configuration must be the same on all nodes in
     a cluster. You must stop Traffic Server before you change the cache
     volume size and protocol assignment. For step-by-step instructions about
-    partitioning the cache, refer to `Partitioning the
-    Cache <../configuring-cache#PartitioningCache>`_.
+    partitioning the cache, refer to :ref:`partitioning-the-cache`.
 
 Format
 ======
 
 For each volume you want to create, enter a line with the following
-format:
-
-::
+format: ::
 
     volume=volume_number  scheme=protocol_type  size=volume_size
 
-where *``volume_number``* is a number between 1 and 255 (the maximum
-number of volumes is 255) and *``protocol_type``* is ``http``. Traffic
-Server supports ``http`` for HTTP volume types; *``volume_size``* is the
+where ``volume_number`` is a number between 1 and 255 (the maximum
+number of volumes is 255) and ``protocol_type`` is ``http``. Traffic
+Server supports ``http`` for HTTP volume types; ``volume_size`` is the
 amount of cache space allocated to the volume. This value can be either
 a percentage of the total cache space or an absolute value. The absolute
 value must be a multiple of 128 MB, where 128 MB is the smallest value.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/039a5de7/proxy/config/records.config.default.in
----------------------------------------------------------------------
diff --git a/proxy/config/records.config.default.in b/proxy/config/records.config.default.in
index d2649c0..549001a 100644
--- a/proxy/config/records.config.default.in
+++ b/proxy/config/records.config.default.in
@@ -329,8 +329,8 @@ CONFIG proxy.config.cluster.ethernet_interface STRING @default_loopback_iface@
 ##############################################################################
 CONFIG proxy.config.cache.permit.pinning INT 0
    # default the ram cache size to AUTO_SIZE (-1) based on cache size
-   #   (approximately 1 MB of RAM cache per GB of disk cache)
-   # alternatively, set to a fixed value such as 20971520 (20MB)
+   #   (approximately 10 MB of RAM cache per GB of disk cache)
+   # alternatively, set to a fixed value such as 21474836480 (20GB)
 CONFIG proxy.config.cache.ram_cache.size INT -1
 CONFIG proxy.config.cache.ram_cache_cutoff INT 4194304
    # Replacement algorithm


Mime
View raw message