You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficserver.apache.org by "ASF subversion and git services (JIRA)" <ji...@apache.org> on 2016/01/13 19:40:40 UTC

[jira] [Commented] (TS-3703) fix broken links during "make html"

    [ https://issues.apache.org/jira/browse/TS-3703?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15096755#comment-15096755 ] 

ASF subversion and git services commented on TS-3703:
-----------------------------------------------------

Commit 40500c710b8b4aad0bf223c1ae4962cdf0725973 in trafficserver's branch refs/heads/master from [~jsime]
[ https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;h=40500c7 ]

Docs: build cleanups and multiple Jira issues.

[TS-4037] Table of Contents fixes
[TS-4086] Minimum size for proxy.config.log.rolling_size_mb
[TS-4077] Doc build warnings and errors
[TS-3704] ^^
[TS-3703] ^^
[TS-3288] Confirmed documentation is accurate that any uid != 0 is accepted by traffic_manager

This closes #419


> fix broken links during "make html"
> -----------------------------------
>
>                 Key: TS-3703
>                 URL: https://issues.apache.org/jira/browse/TS-3703
>             Project: Traffic Server
>          Issue Type: Bug
>          Components: Docs
>            Reporter: Oknet Xu
>            Assignee: Jon Sime
>             Fix For: Docs
>
>
> here is the patch:
> {code}
> diff --git a/doc/admin/configuring-cache.en.rst b/doc/admin/configuring-cache.en.rst
> index 22a31e0..5b5a75f 100644
> --- a/doc/admin/configuring-cache.en.rst
> +++ b/doc/admin/configuring-cache.en.rst
> @@ -1,4 +1,4 @@
> -.. _configuring-the-cache:
> +.. _admin-configuring-the-cache:
>  
>  Configuring the Cache
>  *********************
> diff --git a/doc/admin/event-logging-formats.en.rst b/doc/admin/event-logging-formats.en.rst
> index 4e1c7cc..c16b452 100644
> --- a/doc/admin/event-logging-formats.en.rst
> +++ b/doc/admin/event-logging-formats.en.rst
> @@ -1,4 +1,4 @@
> -.. _event-logging-formats:
> +.. _admin-event-logging-formats:
>  
>  Event Logging Formats
>  *********************
> diff --git a/doc/admin/hierachical-caching.en.rst b/doc/admin/hierachical-caching.en.rst
> index 5c4443e..743534b 100644
> --- a/doc/admin/hierachical-caching.en.rst
> +++ b/doc/admin/hierachical-caching.en.rst
> @@ -1,4 +1,4 @@
> -.. _hierarchical-caching:
> +.. _admin-hierarchical-caching:
>  
>  Hierarchical Caching
>  ********************
> diff --git a/doc/admin/http-proxy-caching.en.rst b/doc/admin/http-proxy-caching.en.rst
> index 2ef0700..a2ac5c7 100644
> --- a/doc/admin/http-proxy-caching.en.rst
> +++ b/doc/admin/http-proxy-caching.en.rst
> @@ -701,7 +701,7 @@ Traffic Server does network I/O in large chunks (32K or so) and therefore the
>  granularity of transaction buffering control is limited to a similar precision.
>  
>  The buffer size calculations include all elements in the transaction, including
> -any buffers associated with :ref:`transform plugins <transform-plugin>`.
> +any buffers associated with :ref:`transform-plugins <http-transformation-plugin>`.
>  
>  Transaction buffering control can be enabled globally by using configuration
>  variables or by :c:func:`TSHttpTxnConfigIntSet` in a plugin.
> @@ -720,7 +720,7 @@ 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
>  :c:data:`TS_HTTP_READ_RESPONSE_HDR_HOOK`.
>  
> -.. _reducing-origin-server-requests:
> +.. _admin-reducing-origin-server-requests:
>  
>  Reducing Origin Server Requests (Avoiding the Thundering Herd)
>  ==============================================================
> diff --git a/doc/admin/security-options.en.rst b/doc/admin/security-options.en.rst
> index a2afccb..6641303 100644
> --- a/doc/admin/security-options.en.rst
> +++ b/doc/admin/security-options.en.rst
> @@ -78,7 +78,7 @@ termination option.
>  -  Enable and configure SSL termination for Traffic Server/origin server
>     connections: :ref:`admin-traffic-server-and-origin-server-connections`
>  
> -.. _client-and-traffic-server-connections:
> +.. _admin-client-and-traffic-server-connections:
>  
>  Client and Traffic Server Connections
>  -------------------------------------
> @@ -173,7 +173,7 @@ Client/Traffic Server connections, you must do the following:
>     local node or :option:`traffic_line -M` to restart Traffic Server on all
>     the nodes in a cluster.
>  
> -.. _traffic-server-and-origin-server-connections:
> +.. _admin-traffic-server-and-origin-server-connections:
>  
>  Traffic Server and Origin Server Connections
>  --------------------------------------------
> diff --git a/doc/admin/working-log-files.en.rst b/doc/admin/working-log-files.en.rst
> index 85f1fd3..3266edc 100644
> --- a/doc/admin/working-log-files.en.rst
> +++ b/doc/admin/working-log-files.en.rst
> @@ -725,7 +725,7 @@ To configure Traffic Server to collate event log files, you must perform
>  the following tasks:
>  
>  -  Either :ref:`admin-configuring-traffic-server-to-be-a-collation-server` or install
> -   and configure a :ref:`admin-using-a-standalone-collator:`.
> +   and configure a :ref:`admin-using-a-standalone-collator`.
>  
>  -  :ref:`admin-configuring-traffic-server-to-be-a-collation-server`
>  
> @@ -945,7 +945,7 @@ Field  Symbol    Description
>  3      chi       The IP address of the client’s host machine.
>  4      crc/pssc  The cache result code; how the cache responded to the request:
>                   ``HIT``, ``MISS``, and so on. Cache result codes are described in
> -                 :ref:`<squid-netscape-result-codes>`.
> +                 :ref:`squid-netscape-result-codes`.
>                   The proxy response status code (the HTTP response status code from
>                   Traffic Server to client).
>  5      psql      The length of the Traffic Server response to the client in bytes,
> @@ -1077,8 +1077,8 @@ Field  Symbol    Description
>                   to the origin server completed successfully or ``INTR`` if the
>                   request was interrupted.
>  20     crc       The cache result code; how the Traffic Server cache responded to the
> -                 request: HIT, MISS, and so on. Cache result codes are described
> -                 :ref:`here <squid-netscape-result-codes>`.
> +                 request: HIT, MISS, and so on. Cache result codes are described here
> +                 :ref:`squid-netscape-result-codes`.
>  ====== ========= =============================================================================
>  
>  Netscape Extended2 in XML
> diff --git a/doc/getting-started.en.rst b/doc/getting-started.en.rst
> index ef4583a..4570064 100644
> --- a/doc/getting-started.en.rst
> +++ b/doc/getting-started.en.rst
> @@ -327,7 +327,7 @@ be the sole entry in :file:`storage.config`::
>  .. note:: Changes to the cache configuration require a restart of |TS|.
>  
>  You may also wish to use raw devices, or partition your cache storage. Details
> -on these features may be found in the :ref:`configuring-the-cache` section of
> +on these features may be found in the :ref:`admin-configuring-the-cache` section of
>  the Administrator's Guide.
>  
>  Final Configurations
> @@ -447,5 +447,5 @@ that you consult the :ref:`performance-tuning` guide.
>  You may also want to learn more about :ref:`monitoring-traffic`, or ensuring
>  that your installation is properly secured by reading the :ref:`security-options`
>  section. Properly sizing your cache, both the on-disk cache and the companion
> -memory cache, are important topics covered in :ref:`configuring-the-cache`.
> +memory cache, are important topics covered in :ref:`admin-configuring-the-cache`.
>  
> diff --git a/doc/glossary.en.rst b/doc/glossary.en.rst
> index 758523e..1b32889 100644
> --- a/doc/glossary.en.rst
> +++ b/doc/glossary.en.rst
> @@ -15,6 +15,8 @@
>     specific language governing permissions and limitations
>     under the License.
>  
> +.. _glossary:
> +
>  =============
>  Glossary
>  =============
> diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
> index 2c7267b..ba7ffcb 100644
> --- a/doc/reference/configuration/records.config.en.rst
> +++ b/doc/reference/configuration/records.config.en.rst
> @@ -911,7 +911,7 @@ Parent Proxy Configuration
>  .. ts:cv:: CONFIG proxy.config.http.parent_proxy_routing_enable INT 0
>     :reloadable:
>  
> -   Enables (``1``) or disables (``0``) the parent caching option. Refer to :ref:`hierarchical-caching`.
> +   Enables (``1``) or disables (``0``) the parent caching option. Refer to :ref:`admin-hierarchical-caching`.
>  
>  .. ts:cv:: CONFIG proxy.config.http.parent_proxy.retry_time INT 300
>     :reloadable:
> @@ -1269,8 +1269,7 @@ Cache Control
>     be satisfied by the partially written response.
>  
>     Several other configuration values need to be set for this to be
> -   usable. See :ref:`Reducing Origin Server Requests
> -   <http-proxy-caching.en.html#reducing-origin-server-requests-avoiding-the-thundering-herd>`.
> +   usable. See :ref:`Reducing Origin Server Requests <admin-reducing-origin-server-requests>`.
>  
>  .. ts:cv:: CONFIG proxy.config.cache.force_sector_size INT 4096
>     :reloadable:
> @@ -2486,7 +2485,7 @@ ICP Configuration
>     -  ``1`` = allows Traffic Server to receive ICP queries only
>     -  ``2`` = allows Traffic Server to send and receive ICP queries
>  
> -   Refer to :ref:`<admin-icp-peering>`.
> +   Refer to :ref:`admin-icp-peering`.
>  
>  .. ts:cv:: CONFIG proxy.config.icp.icp_interface STRING your_interface
>  
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)