Repository: trafficserver Updated Branches: refs/heads/master 32e968578 -> 7b8bb3306
docs: Minor edits This closes #88 Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/7b8bb330 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/7b8bb330 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/7b8bb330 Branch: refs/heads/master Commit: 7b8bb330686e9aad0c5b752c329d69f4947c5f21 Parents: 32e9685 Author: Jack Bates <[email protected]> Authored: Wed May 21 14:13:10 2014 -0700 Committer: James Peach <[email protected]> Committed: Wed May 21 14:27:52 2014 -0700 ---------------------------------------------------------------------- doc/admin/hierachical-caching.en.rst | 2 +- doc/admin/http-proxy-caching.en.rst | 16 ++++++++-------- doc/admin/working-log-files.en.rst | 2 +- doc/arch/cache/cache-arch.en.rst | 4 ++-- doc/arch/cache/tier-storage.en.rst | 4 ++-- doc/reference/commands/traffic_line.en.rst | 2 +- doc/reference/configuration/records.config.en.rst | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7b8bb330/doc/admin/hierachical-caching.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/hierachical-caching.en.rst b/doc/admin/hierachical-caching.en.rst index e2c0e22..66a1a5e 100644 --- a/doc/admin/hierachical-caching.en.rst +++ b/doc/admin/hierachical-caching.en.rst @@ -173,7 +173,7 @@ Run the command :option:`traffic_line -x` to apply the configuration changes. * :ts:cv:`proxy.config.icp.multicast_enabled` * :ts:cv:`proxy.config.icp.query_timeout` -.. Edit `icp.config` file located in the Traffic Server `config` directory: +.. Edit :file:`icp.config` file located in the Traffic Server `config` directory: For each ICP peer you want to identify, enter a separate rule in the :file:`icp.config` file. .. Run the command :option:`traffic_line -x` to apply the configuration changes. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7b8bb330/doc/admin/http-proxy-caching.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/http-proxy-caching.en.rst b/doc/admin/http-proxy-caching.en.rst index c366a47..e305007 100644 --- a/doc/admin/http-proxy-caching.en.rst +++ b/doc/admin/http-proxy-caching.en.rst @@ -763,18 +763,18 @@ The buffer size calculations include all elements in the transaction, including Transaction buffering control can be enabled globally by using configuration variables or by :c:func:`TSHttpTxnConfigIntSet` in a plugin. -================= ================================================== ======================================== -Value Variable `TSHttpTxnConfigIntSet` key -================= ================================================== ======================================== -Enable buffering :ts:cv:`proxy.config.http.flow_control.enabled` `TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED` -Set high water :ts:cv:`proxy.config.http.flow_control.high_water` `TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER` -Set low water :ts:cv:`proxy.config.http.flow_control.low_water` `TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER` -================= ================================================== ======================================== +================= ================================================== ================================================ +Value Variable :c:func:`TSHttpTxnConfigIntSet` key +================= ================================================== ================================================ +Enable buffering :ts:cv:`proxy.config.http.flow_control.enabled` :c:data:`TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED` +Set high water :ts:cv:`proxy.config.http.flow_control.high_water` :c:data:`TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER` +Set low water :ts:cv:`proxy.config.http.flow_control.low_water` :c:data:`TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER` +================= ================================================== ================================================ Be careful to always have the low water mark equal or less than the high water mark. If you set only one, the other will be set to the same value. -If using :c:func:`TSHttpTxnConfigIntSet`, it must be called no later than `TS_HTTP_READ_RESPONSE_HDR_HOOK`. +If using :c:func:`TSHttpTxnConfigIntSet`, it must be called no later than :c:data:`TS_HTTP_READ_RESPONSE_HDR_HOOK`. .. _reducing-origin-server-requests-avoiding-the-thundering-herd: http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7b8bb330/doc/admin/working-log-files.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/working-log-files.en.rst b/doc/admin/working-log-files.en.rst index 6c5626d..e4458d8 100644 --- a/doc/admin/working-log-files.en.rst +++ b/doc/admin/working-log-files.en.rst @@ -373,7 +373,7 @@ To create a summary log file format, we is the logging field you want to aggregate, and ``n`` is the interval (in seconds) between summary log entries. You can specify more than one ``operator`` in the format line. For more - information, refer to :file`logs_xml.config`. + information, refer to :file:`logs_xml.config`. 2. Run the command :option:`traffic_line -x` to apply configuration changes . http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7b8bb330/doc/arch/cache/cache-arch.en.rst ---------------------------------------------------------------------- diff --git a/doc/arch/cache/cache-arch.en.rst b/doc/arch/cache/cache-arch.en.rst index 8990d7d..85384ef 100644 --- a/doc/arch/cache/cache-arch.en.rst +++ b/doc/arch/cache/cache-arch.en.rst @@ -482,7 +482,7 @@ probe. Given an ID, the top half (64 bits) is used as a :ref:`segment <dir-segment>` index, taken modulo the number of segments in the directory. The bottom half is used as a :ref:`bucket <dir-bucket>` index, taken modulo the number of buckets per -segment. The :arg:`last_collision` value is used to mark the last matching entry returned by `dir_probe`. +segment. The :arg:`last_collision` value is used to mark the last matching entry returned by :cpp:func:`dir_probe`. After computing the appropriate bucket, the entries in that bucket are searched to find a match. In this case a match is detected by comparison of the bottom 12 bits of the cache ID (the *cache tag*). The search starts at the base entry for @@ -802,7 +802,7 @@ basically four types, * Disk * Raw device -After creating all the `Span` instances they are grouped by device id to internal linked lists attached to the +After creating all the :cpp:class:`Span` instances they are grouped by device id to internal linked lists attached to the :cpp:member:`Store::disk` array [#]_. Spans that refer to the same directory, disk, or raw device are coalesced in to a single span. Spans that refer to the same file with overlapping offsets are also coalesced [#]_. This is all done in :c:func:`ink_cache_init()` called during startup. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7b8bb330/doc/arch/cache/tier-storage.en.rst ---------------------------------------------------------------------- diff --git a/doc/arch/cache/tier-storage.en.rst b/doc/arch/cache/tier-storage.en.rst index 20bbfd6..933b02b 100644 --- a/doc/arch/cache/tier-storage.en.rst +++ b/doc/arch/cache/tier-storage.en.rst @@ -91,7 +91,7 @@ For a cache miss, all tiers marked `WRITE` will receive data from the origin ser This means, among other things, that if there is a tier with the object all other tiers that are written will get a local copy of the object, the origin server will not be used. In terms of implementation, currently a cache write to a -volume is done via the construction of an instance of `CacheVC` which recieves the object stream. For tiered storage the +volume is done via the construction of an instance of :cpp:class:`CacheVC` which recieves the object stream. For tiered storage the same thing is done for each target volume. For cache volume overrides (e.g. via :file:`hosting.config`) this same process is used except with only the volumes @@ -102,7 +102,7 @@ Copying ------- It may be necessary to provide a mechanism to copy objects between tiers outside of a client originated transaction. In -terms of implementation this is straight forward using `HttpTunnel` as if in a transaction only using a `CacheVC` +terms of implementation this is straight forward using :cpp:class:`HttpTunnel` as if in a transaction only using a :cpp:class:`CacheVC` instance for both the producer and consumer. The more difficult question is what event would trigger a possible copy. A signal could be provided whenever a volume directory entry is deleted although it should be noted that the object in question may have already been evicted when this event happens. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7b8bb330/doc/reference/commands/traffic_line.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/commands/traffic_line.en.rst b/doc/reference/commands/traffic_line.en.rst index 96bbd60..04e67bb 100644 --- a/doc/reference/commands/traffic_line.en.rst +++ b/doc/reference/commands/traffic_line.en.rst @@ -83,7 +83,7 @@ Options .. option:: -s VAR, --set_var VAR - Set the configuration variable named `VAR`. The value of the configuration + Set the configuration variable named *VAR*. The value of the configuration variable is given by the :option:`traffic_line -v` option. Refer to the :file:`records.config` documentation for a list of the configuration variables you can specify. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7b8bb330/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 a965d27..58c9891 100644 --- a/doc/reference/configuration/records.config.en.rst +++ b/doc/reference/configuration/records.config.en.rst @@ -2293,7 +2293,7 @@ Plug-in Configuration Sockets ======= -.. ts:cv:: CONFIG proxy.config.net.defer_accept INT `1` +.. ts:cv:: CONFIG proxy.config.net.defer_accept INT 1 default: ``1`` meaning ``on`` all Platforms except Linux: ``45`` seconds
