You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2013/07/23 01:56:45 UTC
[05/11] git commit: TS-2041: use the :file: semantic markup to refer
to records.config
TS-2041: use the :file: semantic markup to refer to records.config
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/7065a3a9
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/7065a3a9
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/7065a3a9
Branch: refs/heads/master
Commit: 7065a3a9704a191ca5ed5326e69f538fa5fa1e4b
Parents: 35ebd8b
Author: James Peach <jp...@apache.org>
Authored: Fri Jul 19 15:13:27 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Mon Jul 22 16:52:03 2013 -0700
----------------------------------------------------------------------
.../congestion.config.en.rst | 2 +-
.../configuration-files/logs_xml.config.en.rst | 6 ++---
.../configuration-files/records.config.en.rst | 8 +++----
.../configuration-files/remap.config.en.rst | 2 +-
.../ssl_multicert.config.en.rst | 2 +-
doc/admin/configuring-cache.en.rst | 2 +-
doc/admin/configuring-traffic-server.en.rst | 8 +++----
doc/admin/faqs.en.rst | 2 +-
doc/admin/forward-proxy.en.rst | 2 +-
doc/admin/hierachical-caching.en.rst | 2 +-
doc/admin/monitoring-traffic.en.rst | 2 +-
doc/admin/reverse-proxy-http-redirects.en.rst | 4 ++--
doc/admin/security-options.en.rst | 6 ++---
doc/admin/traffic-server-error-messages.en.rst | 2 +-
doc/admin/transparent-proxy/bridge.en.rst | 2 +-
.../transparent-proxy/router-inline.en.rst | 2 +-
.../transparent-proxy/wccp-configuration.en.rst | 2 +-
doc/admin/working-log-files.en.rst | 24 ++++++++++----------
doc/sdk/getting-started.en.rst | 2 +-
doc/sdk/getting-started/a-simple-plugin.en.rst | 6 ++---
doc/sdk/man/TSAPI.en.rst | 8 +++----
...trafficserver-settings-and-statistics.en.rst | 10 ++++----
.../debugging-memory-leaks.en.rst | 2 +-
.../unable-to-debug-tags.en.rst | 2 +-
.../unable-to-load-plugins.en.rst | 2 +-
.../using-a-debugger.en.rst | 2 +-
26 files changed, 57 insertions(+), 57 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/configuration-files/congestion.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/congestion.config.en.rst b/doc/admin/configuration-files/congestion.config.en.rst
index f755874..684a668 100644
--- a/doc/admin/configuration-files/congestion.config.en.rst
+++ b/doc/admin/configuration-files/congestion.config.en.rst
@@ -167,7 +167,7 @@ only. If you specify no tags in the rule, then Traffic Server uses the
default values.
You can override any of the default tag values by adding configuration
-variables at the end of ``records.config`` as follows:
+variables at the end of :file:`records.config` as follows:
::
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/configuration-files/logs_xml.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/logs_xml.config.en.rst b/doc/admin/configuration-files/logs_xml.config.en.rst
index 05d8bde..c562c31 100644
--- a/doc/admin/configuration-files/logs_xml.config.en.rst
+++ b/doc/admin/configuration-files/logs_xml.config.en.rst
@@ -225,7 +225,7 @@ The following list shows the ``LogObject`` specifications.
Enables or disables log file rolling for the ``LogObject``. This
setting overrides the value for the
*``proxy.config.log.rolling_enabled``* variable in the
- ``records.config`` file. Set *``truth value``* to one of the
+ :file:`records.config` file. Set *``truth value``* to one of the
following values:
- ``0`` to disable rolling for this particular ``LogObject``.
@@ -249,7 +249,7 @@ The following list shows the ``LogObject`` specifications.
This setting overrides the value for
*``proxy.config.log.rolling_interval_sec``* in the
- ``records.config`` file.
+ :file:`records.config` file.
*``<RollingOffsetHr = "hour"/>``* {#LogsXMLObjectRollingOffsetHr}
Optional
@@ -258,7 +258,7 @@ The following list shows the ``LogObject`` specifications.
produced only at that time. The impact of this setting is only
noticeable if the rolling interval is larger than one hour. This
setting overrides the configuration setting for
- *``proxy.config.log.rolling_offset_hr``* in the ``records.config``
+ *``proxy.config.log.rolling_offset_hr``* in the :file:`records.config`
file.
*``<RollingSizeMb = "size_in_MB"/>``*
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/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 3e868a8..b25f918 100644
--- a/doc/admin/configuration-files/records.config.en.rst
+++ b/doc/admin/configuration-files/records.config.en.rst
@@ -18,11 +18,11 @@ records.config
specific language governing permissions and limitations
under the License.
-The ``records.config`` file is a list of configurable variables used by
+The :file:`records.config` file is a list of configurable variables used by
the Traffic Server software. Many of the variables in the
-``records.config`` file are set automatically when you set configuration
+:file:`records.config` file are set automatically when you set configuration
options in Traffic Line or Traffic Shell. After you modify the
-``records.config`` file, navigate to the Traffic Server\ ``bin``
+:file:`records.config` file, navigate to the Traffic Server\ ``bin``
directory and run the command ``traffic_line -x`` to apply the changes.
When you apply changes to one node in a cluster, Traffic Server
automatically applies the changes to all other nodes in the cluster.
@@ -70,7 +70,7 @@ Configuration Variables
=======================
The following list describes the configuration variables available in
-the ``records.config`` file.
+the :file:`records.config` file.
System Variables
================
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/configuration-files/remap.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/remap.config.en.rst b/doc/admin/configuration-files/remap.config.en.rst
index f2887e8..d882ff7 100644
--- a/doc/admin/configuration-files/remap.config.en.rst
+++ b/doc/admin/configuration-files/remap.config.en.rst
@@ -219,7 +219,7 @@ When acting as a reverse proxy for multiple servers, Traffic Server is
unable to route to URLs from older browsers that do not send the
``Host:`` header. As a solution, set the variable
*``proxy.config.header.parse.no_host_url_redirect``* in the
-``records.config`` file to the URL to which Traffic Server will redirect
+:file:`records.config` file to the URL to which Traffic Server will redirect
requests without host headers.
Redirect Mapping Rules
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/configuration-files/ssl_multicert.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/ssl_multicert.config.en.rst b/doc/admin/configuration-files/ssl_multicert.config.en.rst
index 7aea5e9..5730471 100644
--- a/doc/admin/configuration-files/ssl_multicert.config.en.rst
+++ b/doc/admin/configuration-files/ssl_multicert.config.en.rst
@@ -40,7 +40,7 @@ SSL private key. If the private key is located in the certificate file,
then you do not need to specify the name of the private key.
Additionally *``ssl_ca_name``* can be used to specify the location of a
Certification Authorithy change in case that differs from what is
-specified under ```records.config`` <../records.config>`_'s
+specified under `:file:`records.config` <../records.config>`_'s
```proxy.config.ssl.CA.cert.filename`` <../records.config#proxy.config.ssl.CA.cert.filename>`_.
Traffic Server will try to find the files specified in
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/configuring-cache.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuring-cache.en.rst b/doc/admin/configuring-cache.en.rst
index 72ed7a1..287a9ee 100644
--- a/doc/admin/configuring-cache.en.rst
+++ b/doc/admin/configuring-cache.en.rst
@@ -319,7 +319,7 @@ Accessing the Cache Inspector Utility
To access the Cache Inspector utility, follow the steps below:
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file add the following variable:
2. `*``CONFIG proxy.config.http_ui_enabled INT 1``* <../configuration-files/records.config#proxy.config.http_ui_enabled>`_
3. To access the cache inspector in reverse proxy mode, you must add a
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/configuring-traffic-server.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuring-traffic-server.en.rst b/doc/admin/configuring-traffic-server.en.rst
index b0a43a3..10a70a1 100644
--- a/doc/admin/configuring-traffic-server.en.rst
+++ b/doc/admin/configuring-traffic-server.en.rst
@@ -65,15 +65,15 @@ Configure Traffic Server Using Configuration Files
As an alternative to using Traffic Line or Traffic Shell, you can change
Traffic Server configuration options by manually editing specific
variables in the
-```records.config`` <../configuration-files/records.config>`_ file.
+`:file:`records.config` <../configuration-files/records.config>`_ file.
After modifying the
-```records.config`` <../configuration-files/records.config>`_ file,
+`:file:`records.config` <../configuration-files/records.config>`_ file,
Traffic Server must reread the configuration files: enter the Traffic
Line command ``traffic_line -x``. You may need to restart Traffic Server
to apply some of the configuration changes.
The following is a sample portion of the
-```records.config`` <../configuration-files/records.config>`_ file:
+`:file:`records.config` <../configuration-files/records.config>`_ file:
.. figure:: ../static/images/admin/records.jpg
:align: center
@@ -82,7 +82,7 @@ The following is a sample portion of the
Sample records.config file
In addition to the
-```records.config`` <../configuration-files/records.config>`_ file,
+`:file:`records.config` <../configuration-files/records.config>`_ file,
Traffic Server provides other configuration files that are used to
configure specific features. You can manually edit all configuration
files as described in `Configuration Files <../configuration-files>`_.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/faqs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/faqs.en.rst b/doc/admin/faqs.en.rst
index 8755306..e3e9bbd 100644
--- a/doc/admin/faqs.en.rst
+++ b/doc/admin/faqs.en.rst
@@ -123,7 +123,7 @@ does *not* serve requests that fail to match a map rule), then you must
set the configuration variable
`proxy.config.url_remap.remap_required <../configuration-files/records.config#proxy.config.url_remap.remap_required>`_
to ``1`` in the
-```records.config`` <../configuration-files/records.config>`_ file.
+`:file:`records.config` <../configuration-files/records.config>`_ file.
How do I enable forward proxy mode
----------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/forward-proxy.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/forward-proxy.en.rst b/doc/admin/forward-proxy.en.rst
index 00b4e91..cc606d0 100644
--- a/doc/admin/forward-proxy.en.rst
+++ b/doc/admin/forward-proxy.en.rst
@@ -55,7 +55,7 @@ Configuration
In order to configure Apache Traffic Server as forward proxy you will
have to edit
-```records.config`` <../configuration-files/records.config>`_ and set
+`:file:`records.config` <../configuration-files/records.config>`_ and set
- ``CONFIG``
```proxy.config.url_remap.remap_required`` <../configuration-files/records.config#proxy.config.url_remap.remap_required>`_
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/hierachical-caching.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/hierachical-caching.en.rst b/doc/admin/hierachical-caching.en.rst
index 3eb38d0..e41cc7a 100644
--- a/doc/admin/hierachical-caching.en.rst
+++ b/doc/admin/hierachical-caching.en.rst
@@ -110,7 +110,7 @@ configuration is needed for the Traffic Server parent cache.
Configure Traffic Server to use a parent cache by editing the following
variable
`*``proxy.config.http.parent_proxy_routing_enable``* <configuration-files/records.config#proxy.config.http.parent_proxy_routing_enable>`_
-in ``records.config`` file.
+in :file:`records.config` file.
Edit the ```parent.config`` <../configuration-files/parent.config>`_
file located in the Traffic Server ``config`` directory to set parent
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/monitoring-traffic.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/monitoring-traffic.en.rst b/doc/admin/monitoring-traffic.en.rst
index f5af50e..50a451b 100644
--- a/doc/admin/monitoring-traffic.en.rst
+++ b/doc/admin/monitoring-traffic.en.rst
@@ -57,7 +57,7 @@ Configuring Traffic Server to Email Alarms
To configure Traffic Server to send an email to a specific address
whenever an alarm occurs, follow the steps below:
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file
2. Set the
`*``proxy.config.alarm_email``* <../configuration-files/records.config#proxy.config.alarm_email>`_
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/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 7642817..d9fa706 100644
--- a/doc/admin/reverse-proxy-http-redirects.en.rst
+++ b/doc/admin/reverse-proxy-http-redirects.en.rst
@@ -264,7 +264,7 @@ Enabling HTTP Reverse Proxy
To enable HTTP reverse proxy, follow the steps below.
1. Edit the following variable in
- ```records.config`` <configuration-files/records.config>`_
+ `:file:`records.config` <configuration-files/records.config>`_
- `*``proxy.config.reverse_proxy.enabled``* <configuration-files/records.config#proxy.config.reverse_proxy.enabled>`_
@@ -275,7 +275,7 @@ Setting Optional HTTP Reverse Proxy Options
-------------------------------------------
Traffic Server provides several reverse proxy configuration options in
-```records.config`` <configuration-files/records.config>`_ that
+`:file:`records.config` <configuration-files/records.config>`_ that
enable you to:
- Configure Traffic Server to retain the client host header information
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/security-options.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/security-options.en.rst b/doc/admin/security-options.en.rst
index d1ca46c..2e3c56a 100644
--- a/doc/admin/security-options.en.rst
+++ b/doc/admin/security-options.en.rst
@@ -59,7 +59,7 @@ To do this, we
2. Add rules to the ``splitdns.config`` file. (Refer to
```splitdns.config`` <../configuration-files/splitdns.config>`_.
-3. In the file ``records.config`` the variable
+3. In the file :file:`records.config` the variable
`*``proxy.process.dns.splitDNS.enabled``* <configuration-files/records.config#proxy.process.dns.splitDNS.enabled>`_
to ``1`` to enable split DNS.
4. Run the command ``traffic_line -x`` to apply the configuration
@@ -156,7 +156,7 @@ client/Traffic Server connections, you must do the following:
In order to accomplish this, we
2. Edit the following variables in the ``SSL Termination`` section of
- the ``records.config`` file:
+ the :file:`records.config` file:
- `*``proxy.config.ssl.enabled``* <configuration-files/records.config#proxy.config.ssl.enabled>`_
- `*``proxy.config.ssl.server_port``* <configuration-files/records.config#proxy.config.ssl.server_port>`_
@@ -229,7 +229,7 @@ Traffic Server and origin server connections, you must do the following:
In order to accomplish this, we:
2. Edit the following variables in the ``SSL Termination`` section of
- the ``records.config`` file:
+ the :file:`records.config` file:
- `*``proxy.config.ssl.auth.enabled``* <configuration-files/records.config#proxy.config.ssl.auth.enabled>`_
- ```proxy.config.ssl.server_port`` <configuration-files/records.config#proxy.config.ssl.server_port>`_
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/traffic-server-error-messages.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/traffic-server-error-messages.en.rst b/doc/admin/traffic-server-error-messages.en.rst
index 2d7f692..c333aed 100644
--- a/doc/admin/traffic-server-error-messages.en.rst
+++ b/doc/admin/traffic-server-error-messages.en.rst
@@ -42,7 +42,7 @@ Traffic Server Process Fatal
============================
``Accept port is not between 1 and 65535. Please check configuration``
- The port specified in the ``records.config`` file that accepts
+ The port specified in the :file:`records.config` file that accepts
incoming HTTP requests is not valid.
``Self loop is detected in parent proxy configuration``
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/transparent-proxy/bridge.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/transparent-proxy/bridge.en.rst b/doc/admin/transparent-proxy/bridge.en.rst
index 9f97bed..2341422 100644
--- a/doc/admin/transparent-proxy/bridge.en.rst
+++ b/doc/admin/transparent-proxy/bridge.en.rst
@@ -134,7 +134,7 @@ The marking used is arbitrary but it must be consistent between
1..253.
To configure Traffic Server set the following values in
-``records.config``
+:file:`records.config`
``proxy.config.http.server_port``
``STRING``
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/transparent-proxy/router-inline.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/transparent-proxy/router-inline.en.rst b/doc/admin/transparent-proxy/router-inline.en.rst
index 6e4a244..5e6b64c 100644
--- a/doc/admin/transparent-proxy/router-inline.en.rst
+++ b/doc/admin/transparent-proxy/router-inline.en.rst
@@ -71,7 +71,7 @@ The marking used is arbitrary but it must be consistent between
1..253.
To configure Traffic Server set the following values in
-``records.config``
+:file:`records.config`
``proxy.config.http.server_port``
``STRING``
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/admin/transparent-proxy/wccp-configuration.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/transparent-proxy/wccp-configuration.en.rst b/doc/admin/transparent-proxy/wccp-configuration.en.rst
index c5292f8..4ed7598 100644
--- a/doc/admin/transparent-proxy/wccp-configuration.en.rst
+++ b/doc/admin/transparent-proxy/wccp-configuration.en.rst
@@ -69,7 +69,7 @@ roughly the same way as the standard transparency use.
Finally Traffic Server itself must be configured for transparency and
use of WCCP. The former is again very similar to the standard use, while
WCCP configuration is specific to WCCP and uses a separate configuration
-file, referred to by the ``records.config`` file.
+file, referred to by the :file:`records.config` file.
The primary concern for configuration in which of three basic topologies
are to be used.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/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 935a575..b4e31e7 100644
--- a/doc/admin/working-log-files.en.rst
+++ b/doc/admin/working-log-files.en.rst
@@ -72,7 +72,7 @@ keeps three types of log files:
By default, Traffic Server creates both error and event log files and
records system information in system log files. You can disable event
logging and/or error logging by setting the configuration variable
-``_proxy.config.log.logging_enabled_`` (in the ``records.config`` file)
+``_proxy.config.log.logging_enabled_`` (in the :file:`records.config` file)
to one of the following values:
- ``0`` to disable both event and error logging
@@ -201,7 +201,7 @@ Setting Log File Management Options
To set log management options, follow the steps below:
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file, edit the following variables
- `*``proxy.config.log.logfile_dir``* <../configuration-files/records.config#proxy.config.log.logfile_dir>`_
@@ -241,7 +241,7 @@ Custom Format <#UsingCustomFormat>`_.
Set standard log file format options by following the steps below:
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file, edit the following variables
2. Edit the following variables to use the Squid format:
@@ -333,7 +333,7 @@ for each ``LogObject`` definition).
In order to accomplish this, we
1. edit the following variables in the
- ```records.config`` <../configuration-files/records.config>`_ file:
+ `:file:`records.config` <../configuration-files/records.config>`_ file:
2. `*``proxy.config.log.custom_logs_enabled``* <../configuration-files/records.config#proxy.config.log.custom_logs_enabled>`_
3. In the
```logs_xml.config`` <../configuration-files/logs_xml.config>`_ file
@@ -658,7 +658,7 @@ Setting Log File Rolling Options
To set log file rolling options and/or configure Traffic Server to roll
log files when they reach a certain size, follow the steps below:
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file, edit the following variables
- `*``proxy.config.log.rolling_enabled``* <../configuration-files/records.config#proxy.config.log.rolling_enabled>`_
@@ -676,7 +676,7 @@ specification in the
The custom log file uses the rolling settings in its
```LogObject`` <../configuration-files/logs_xml.config#LogObject>`_,
which override the default settings you specify in Traffic Manager or
-the ```records.config`` <../configuration-files/records.config>`_ file
+the `:file:`records.config` <../configuration-files/records.config>`_ file
described above.
Splitting Event Log Files
@@ -746,7 +746,7 @@ Setting Log Splitting Options
To set log splitting options, follow the steps below:
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file, edit the following variables
- `*``proxy.config.log.separate_icp_logs``* <../configuration-files/records.config#proxy.config.log.separate_icp_logs>`_
@@ -848,7 +848,7 @@ Configuring Traffic Server to Be a Collation Server
To configure a Traffic Server node to be a collation server, simply edit
a configuration file via the steps below.
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file, edit the following variables
- `*``proxy.config.log.collation_mode``* <../configuration-files/records.config#proxy.config.log.collation_mode>`_
@@ -885,14 +885,14 @@ To install and configure a standalone collator:
5. Create a directory called *``internal``* in the ``config`` directory
you created in Step 4 (above). This directory is used internally by
the standalone collator to store lock files.
-6. Copy the ``records.config`` file from a Traffic Server node
+6. Copy the :file:`records.config` file from a Traffic Server node
configured to be a log collation client to the ``config`` directory
you created in Step 4 on the standalone collator.
- The ``records.config`` file contains the log collation secret and
+ The :file:`records.config` file contains the log collation secret and
the port you specified when configuring Traffic Server nodes to be
collation clients. The collation port and secret must be the same for
all collation clients and servers.
-7. In the ```records.config`` <../configuration-files/records.config>`_
+7. In the `:file:`records.config` <../configuration-files/records.config>`_
file, edit the following variable
- `*``proxy.config.log.logfile_dir``* <../configuration-files/records.config#proxy.config.log.logfile_dir>`_
@@ -912,7 +912,7 @@ steps below. If you modify the ``collation_port`` or ``secret`` after
connections between the collation clients and the collation server have
been established, then you must restart Traffic Server.
-1. In the ```records.config`` <../configuration-files/records.config>`_
+1. In the `:file:`records.config` <../configuration-files/records.config>`_
file, edit the following variables:
- `*``proxy.config.log.collation_mode``* <../configuration-files/records.config#proxy.config.log.collation_mode>`_:
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/getting-started.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/getting-started.en.rst b/doc/sdk/getting-started.en.rst
index 36a4d94..81f6e55 100644
--- a/doc/sdk/getting-started.en.rst
+++ b/doc/sdk/getting-started.en.rst
@@ -157,7 +157,7 @@ When Traffic Server is first started, it consults the ``plugin.config``
file to determine the names of all shared plugin libraries that need to
be loaded. The ``plugin.config`` file also defines arguments that are to
be passed to each plugin's initialization function, ``TSPluginInit``.
-The ``records.config`` file defines the path to each plugin shared
+The :file:`records.config` file defines the path to each plugin shared
library, as described in `Specify the Plugin's
Location <SpecifyingPluginLocation.html>`__.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/getting-started/a-simple-plugin.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/getting-started/a-simple-plugin.en.rst b/doc/sdk/getting-started/a-simple-plugin.en.rst
index 30bd81d..31f4733 100644
--- a/doc/sdk/getting-started/a-simple-plugin.en.rst
+++ b/doc/sdk/getting-started/a-simple-plugin.en.rst
@@ -29,7 +29,7 @@ simple Traffic Server plugin. You'll follow the steps below:
3. Add an entry to your plugin's ``plugin.config`` file.
4. Add the path to your plugin shared library into the
- ``records.config`` file.
+ :file:`records.config` file.
5. Restart Traffic Server.
@@ -82,7 +82,7 @@ Specify the Plugin's Location
All plugins must be located in the directory specified by the
configuration variable ``proxy.config.plugin.plugin_dir``, which is
-located in the ``records.config`` file. The directory can be specified
+located in the :file:`records.config` file. The directory can be specified
as an absolute or relative path.
If a relative path is used, then the starting directory will be the
@@ -113,6 +113,6 @@ plugin.
**Note:** in the example above, Traffic Server notes are directed to the
console by specifying ``E`` for ``proxy.config.diags.output.note`` in
-``records.config``. The second note shows Traffic Server attempting to
+:file:`records.config`. The second note shows Traffic Server attempting to
load the ``hello-world`` plugin. The third line of Traffic Server output
is from your plugin.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/man/TSAPI.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/man/TSAPI.en.rst b/doc/sdk/man/TSAPI.en.rst
index 62a97aa..d2ab1b2 100644
--- a/doc/sdk/man/TSAPI.en.rst
+++ b/doc/sdk/man/TSAPI.en.rst
@@ -16,9 +16,9 @@
.. default-domain:: c
-=========
-``TSAPI``
-=========
+=======
+`TSAPI`
+=======
Synopsis
========
@@ -136,7 +136,7 @@ notification.
Files
=====
-:file:`$CONFIG_DIR/plugin.config`, :file:`$CONFIG_DIR/records.config`
+:file:`{CONFIG_DIR}/plugin.config`, :file:`{CONFIG_DIR}/records.config`
See also
========
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.rst b/doc/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.rst
index eaec39c..ab80e7c 100644
--- a/doc/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.rst
+++ b/doc/sdk/plugin-management/reading-trafficserver-settings-and-statistics.en.rst
@@ -20,7 +20,7 @@ Reading Traffic Server Settings and Statistics
Your plugin might need to know information about Traffic Server's
current configuration and performance. The functions described in this
-section read this information from the Traffic Server ``records.config``
+section read this information from the Traffic Server :file:`records.config`
file. Configuration settings are stored in ``CONFIG`` variables and
statistics are stored in ``PROCESS`` variables.
@@ -30,15 +30,15 @@ statistics are stored in ``PROCESS`` variables.
[Caution]
**Caution**
-Not all ``CONFIG`` and ``PROCESS`` variables in ``records.config`` are
+Not all ``CONFIG`` and ``PROCESS`` variables in :file:`records.config` are
relevant to Traffic Server's configuration and statistics. Therefore,
-retrieve only the ``records.config`` variables that are documented in
+retrieve only the :file:`records.config` variables that are documented in
the `Traffic Server Administrator's Guide <../../admin/>`__.
To retrieve a variable, you need to know its type (``int``, ``counter``,
-``float``, or ``string``). Plugins store the ``records.config`` values
+``float``, or ``string``). Plugins store the :file:`records.config` values
as an ``TSMgmtInt``, ``TSMgmtCounter``, ``TSMgmtFloat``, or
-``TSMgmtString``. You can look up ``records.config`` variable types in
+``TSMgmtString``. You can look up :file:`records.config` variable types in
the `Traffic Server Administrator's Guide <../../admin/>`__.
Depending on the result type, you'll use ``TSMgmtIntGet``,
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/troubleshooting-tips/debugging-memory-leaks.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/troubleshooting-tips/debugging-memory-leaks.en.rst b/doc/sdk/troubleshooting-tips/debugging-memory-leaks.en.rst
index 4021e07..d8db570 100644
--- a/doc/sdk/troubleshooting-tips/debugging-memory-leaks.en.rst
+++ b/doc/sdk/troubleshooting-tips/debugging-memory-leaks.en.rst
@@ -20,7 +20,7 @@ Debugging Memory Leaks
Memory leaks in a plugin can be detected using e.g. an MRTG graph
related to memory - you can use memory dump information. Enable
-``mem dump`` in ``records.config`` as follows:
+``mem dump`` in :file:`records.config` as follows:
::
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst b/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
index 8e3a30b..5ed5877 100644
--- a/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
+++ b/doc/sdk/troubleshooting-tips/unable-to-debug-tags.en.rst
@@ -37,7 +37,7 @@ below:
:::text
traffic_server -T"my-plugin"
-Set the following variables in ``records.config`` (in the Traffic Server
+Set the following variables in :file:`records.config` (in the Traffic Server
``config`` directory):
::
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/troubleshooting-tips/unable-to-load-plugins.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/troubleshooting-tips/unable-to-load-plugins.en.rst b/doc/sdk/troubleshooting-tips/unable-to-load-plugins.en.rst
index 70d21bd..606c144 100644
--- a/doc/sdk/troubleshooting-tips/unable-to-load-plugins.en.rst
+++ b/doc/sdk/troubleshooting-tips/unable-to-load-plugins.en.rst
@@ -27,7 +27,7 @@ To load plugins, follow the steps below.
3. Add an entry to the ``plugin.config`` file for your plugin.
-4. Add the path to your plugin shared library to the ``records.config``
+4. Add the path to your plugin shared library to the :file:`records.config`
file.
5. Restart Traffic Server.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/7065a3a9/doc/sdk/troubleshooting-tips/using-a-debugger.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/troubleshooting-tips/using-a-debugger.en.rst b/doc/sdk/troubleshooting-tips/using-a-debugger.en.rst
index 82a0165..8af57d2 100644
--- a/doc/sdk/troubleshooting-tips/using-a-debugger.en.rst
+++ b/doc/sdk/troubleshooting-tips/using-a-debugger.en.rst
@@ -21,7 +21,7 @@ Using a Debugger
A debugger can set breakpoints in a plugin. Use a Traffic Server debug
build and compile the plugin with the ``-g`` option. A debugger can also
be used to analyze a core dump. To generate core, set the size limit of
-the core files in the ``records.config`` file to -1 as follows:
+the core files in the :file:`records.config` file to -1 as follows:
::