You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by am...@apache.org on 2016/11/24 22:21:55 UTC
[trafficserver] branch master updated: Doc: Tweaks to fix build
errors.
This is an automated email from the ASF dual-hosted git repository.
amc pushed a commit to branch master
in repository https://git-dual.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new a917716 Doc: Tweaks to fix build errors.
a917716 is described below
commit a917716fa4ced0bab87e8606fd81f523f0132cc5
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Thu Nov 24 16:21:06 2016 -0600
Doc: Tweaks to fix build errors.
---
doc/admin-guide/monitoring/diagnostic-files.en.rst | 2 +-
.../api/functions/TSHttpConnectWithPluginId.en.rst | 2 +-
.../api/functions/TSMimeHdrFieldAppend.en.rst | 2 +-
doc/developer-guide/api/functions/TSTypes.en.rst | 19 +++----------------
doc/developer-guide/api/types/TSHttpStatus.en.rst | 12 +++++++++---
doc/developer-guide/architecture/api-functions.en.rst | 12 ------------
6 files changed, 15 insertions(+), 34 deletions(-)
diff --git a/doc/admin-guide/monitoring/diagnostic-files.en.rst b/doc/admin-guide/monitoring/diagnostic-files.en.rst
index 67b1bc5..365fc4a 100644
--- a/doc/admin-guide/monitoring/diagnostic-files.en.rst
+++ b/doc/admin-guide/monitoring/diagnostic-files.en.rst
@@ -23,7 +23,7 @@ traffic.out
.. logfile:: traffic.out
-Debug level messages are written to this file. In particular if a :ref:`debug
+Debug level messages are written to this file. In particular if a :ts:cv:`debug
tag <proxy.config.diags.debug.tags>` is enabled output for that tag is placed in
this file. This applies to both the |TS| core and plugins. This file also
contains some generic operational messages which track |TS| starting and
diff --git a/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst b/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst
index 3d422ba..88e805c 100644
--- a/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpConnectWithPluginId.en.rst
@@ -64,7 +64,7 @@ stack via the loopback interface.
reserved to mean "not set" and can be used as a default if this
functionality is not needed.
-The virtual connection returned as the :c:type:`TSCVonn` is API
+The virtual connection returned as the :c:type:`TSVConn` is API
equivalent to a network virtual connection both to the plugin and
to internal mechanisms. Data is read and written to the connection
(and thence to the target system) by reading and writing on this
diff --git a/doc/developer-guide/api/functions/TSMimeHdrFieldAppend.en.rst b/doc/developer-guide/api/functions/TSMimeHdrFieldAppend.en.rst
index bbe32dd..24038da 100644
--- a/doc/developer-guide/api/functions/TSMimeHdrFieldAppend.en.rst
+++ b/doc/developer-guide/api/functions/TSMimeHdrFieldAppend.en.rst
@@ -39,7 +39,7 @@ each MIME field in the MIME header, a pointer comparison is done
between the field name and retrieved_str. This is a much quicker
retrieval function than :c:func:`TSMimeHdrFieldFind` since it obviates
the need for a string comparison. However, retrieved_str must be one
-of the predefined field names of the form :c:data:`TS_MIME_FIELD_XXX`
+of the predefined field names of the form ``TS_MIME_FIELD_XXX``
for the call to succeed. Release the returned :c:type:`TSMLoc` handle
with a call to :c:func:`TSHandleMLocRelease`.
diff --git a/doc/developer-guide/api/functions/TSTypes.en.rst b/doc/developer-guide/api/functions/TSTypes.en.rst
index 3387930..b820082 100644
--- a/doc/developer-guide/api/functions/TSTypes.en.rst
+++ b/doc/developer-guide/api/functions/TSTypes.en.rst
@@ -80,18 +80,6 @@ more widely. Those are described on this page.
An opaque type that represents a Traffic Server HTTP :term:`transaction`.
-.. type:: TSHttpType
-
- This set of enums represents the possible HTTP types that can be
- assigned to an HTTP header.
-
- When a header is created with :func:`TSHttpHdrCreate`, it is
- automatically assigned a type of :data:`TS_HTTP_TYPE_UNKNOWN`. You
- can modify the HTTP type ONCE after it the header is created, using
- :func:`TSHttpHdrTypeSet`. After setting the HTTP type once, you
- cannot set it again. Use :func:`TSHttpHdrTypeGet` to obtain the
- :type:`TSHttpType` of an HTTP header.
-
.. type:: TSIOBuffer
.. type:: TSIOBufferBlock
@@ -177,15 +165,15 @@ more widely. Those are described on this page.
.. type:: TSUuid
Opaque type that refers to an allocated UUID.
-
+
.. type:: TSUuidVersion
A version value for at :type:`TSUuid`.
-
+
.. member:: TS_UUID_V4
A version 4 UUID. Currently only this value is used.
-
+
.. var:: size_t TS_UUID_STRING_LEN
Length of a UUID string.
@@ -193,4 +181,3 @@ more widely. Those are described on this page.
.. type:: TSVConn
.. type:: TSVIO
-
diff --git a/doc/developer-guide/api/types/TSHttpStatus.en.rst b/doc/developer-guide/api/types/TSHttpStatus.en.rst
index 1d02557..9cfe9fe 100644
--- a/doc/developer-guide/api/types/TSHttpStatus.en.rst
+++ b/doc/developer-guide/api/types/TSHttpStatus.en.rst
@@ -26,8 +26,15 @@ Synopsis
.. c:type:: TSHttpStatus
-Enum typedef which defines the possible return values from
-:c:func:`TSHttpStatusGet`.
+This set of enums represents the possible HTTP types that can be
+assigned to an HTTP header.
+
+When a header is created with :func:`TSHttpHdrCreate`, it is
+automatically assigned a type of :data:`TS_HTTP_TYPE_UNKNOWN`. You
+can modify the HTTP type ONCE after it the header is created, using
+:func:`TSHttpHdrTypeSet`. After setting the HTTP type once, you
+cannot set it again. Use :func:`TSHttpHdrTypeGet` to obtain the
+:type:`TSHttpType` of an HTTP header.
Enumeration Members
===================
@@ -148,4 +155,3 @@ Enumeration Members
Description
===========
-
diff --git a/doc/developer-guide/architecture/api-functions.en.rst b/doc/developer-guide/architecture/api-functions.en.rst
index 16b4c1f..03aac7c 100644
--- a/doc/developer-guide/architecture/api-functions.en.rst
+++ b/doc/developer-guide/architecture/api-functions.en.rst
@@ -35,18 +35,6 @@ API functions
be called from ``TS_HTTP_READ_REQUEST_HDR_HOOK`` which is before cache lookup
but late enough that the HTTP request header is available.
-.. c:function:: TSReturnCode TSHttpTxnCacheLookupUrlGet(TSHttpTxn txnp, TSMBuffer bufp, TSMLoc offset)
-
- Get the current cache key URL, also referred to as the lookup URL. This must
- be stored in a properly allocated URL object, typically created with a
- :c:func:`TSUrlCreate()`.
-
-.. c:function:: TSReturnCode TSHttpTxnCacheLookupUrlSet(TSHttpTxn txnp, TSMBuffer bufp, TSMLoc offset)
-
- Set the current cache key URL, also referred to as the lookup URL. This must
- be stored in a properly allocated URL object, typically created with a
- :c:func:`TSUrlCreate()` or :c:func:`TSUrlClone()`.
-
The APIs that modify the cache key can be called as early as
``TS_HTTP_READ_REQUEST_HDR_HOOK`` but no later than
--
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>'].