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 2017/01/12 01:20:26 UTC

[trafficserver] branch master updated: Doc: Updates to prevent dangling references.

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  934e5d3   Doc: Updates to prevent dangling references.
934e5d3 is described below

commit 934e5d3fbbf295fa351b473ac856acd06c8a39f4
Author: Unknown <me...@gmail.com>
AuthorDate: Mon Jan 2 14:06:41 2017 -0600

    Doc: Updates to prevent dangling references.
---
 .../api/functions/TSHttpOverridableConfig.en.rst   |  1 -
 doc/developer-guide/api/functions/TSTypes.en.rst   | 26 ----------------------
 .../types/{SystemTypes.en.rst => CoreTypes.en.rst} | 16 +++++++++----
 doc/developer-guide/api/types/SystemTypes.en.rst   | 23 +++++++++++++++----
 4 files changed, 31 insertions(+), 35 deletions(-)

diff --git a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
index 3ae4790..3c9c3fe 100644
--- a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
@@ -29,7 +29,6 @@ Synopsis
 
 `#include <ts/ts.h>`
 
-.. type:: TSOverridableConfigKey
 
 .. function:: TSReturnCode TSHttpTxnConfigIntSet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtInt value)
 .. function:: TSReturnCode TSHttpTxnConfigIntGet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtInt* value)
diff --git a/doc/developer-guide/api/functions/TSTypes.en.rst b/doc/developer-guide/api/functions/TSTypes.en.rst
index b820082..c837de6 100644
--- a/doc/developer-guide/api/functions/TSTypes.en.rst
+++ b/doc/developer-guide/api/functions/TSTypes.en.rst
@@ -118,36 +118,16 @@ more widely. Those are described on this page.
 
 .. type:: TSMutex
 
-.. type:: TSParseResult
-
-   This set of enums are possible values returned by
-   :func:`TSHttpHdrParseReq` and :func:`TSHttpHdrParseResp`.
-
 .. type:: TSPluginRegistrationInfo
 
    The following struct is used by :func:`TSPluginRegister`.
 
    It stores registration information about the plugin.
 
-.. type:: TSRecordDataType
-
-   An enumeration that specifies the type of a value in an internal data structure that is accessible via the API.
-
 .. type:: TSRemapInterface
 
 .. type:: TSRemapRequestInfo
 
-.. type:: TSReturnCode
-
-   An indicator of the results of an API call. A value of :const:`TS_SUCCESS` means the call was successful. Any other value
-   indicates a failure and is specific to the API call.
-
-.. type:: TSSDKVersion
-
-   Starting 2.0, SDK now follows same versioning as Traffic Server.
-
-.. type:: TSServerState
-
 .. type:: TSTextLogObject
 
    This type represents a custom log file that you create with
@@ -160,12 +140,6 @@ more widely. Those are described on this page.
 
 .. type:: TSThreadFunc
 
-.. type:: TSThreadPool
-
-.. type:: TSUuid
-
-   Opaque type that refers to an allocated UUID.
-
 .. type:: TSUuidVersion
 
    A version value for at :type:`TSUuid`.
diff --git a/doc/developer-guide/api/types/SystemTypes.en.rst b/doc/developer-guide/api/types/CoreTypes.en.rst
similarity index 93%
copy from doc/developer-guide/api/types/SystemTypes.en.rst
copy to doc/developer-guide/api/types/CoreTypes.en.rst
index 8ff4fc8..801ee8b 100644
--- a/doc/developer-guide/api/types/SystemTypes.en.rst
+++ b/doc/developer-guide/api/types/CoreTypes.en.rst
@@ -16,8 +16,6 @@
 
 .. include:: ../../../common.defs
 
-.. default-domain:: c
-
 .. This is basically a holding pen to avoid dangling references as I can't find a better way to deal with
    non-ATS types. Some of this was handled by the "EXTERNAL_TYPES" in ext/traffic-server.py but that's
    even uglier than this.
@@ -35,6 +33,16 @@ Description
 
 These types are provided by the compiler ("built-in") or from a required operating system, POSIX, or package header.
 
-.. type:: off_t
 
-   `Reference <https://linux.die.net/include/unistd.h>`_.
+   
+.. cpp:type:: uint24_t
+   
+
+   
+.. cpp:type:: Event
+
+
+.. cpp:type:: DLL
+
+
+.. cpp:type:: INK_MD5
\ No newline at end of file
diff --git a/doc/developer-guide/api/types/SystemTypes.en.rst b/doc/developer-guide/api/types/SystemTypes.en.rst
index 8ff4fc8..5c1a369 100644
--- a/doc/developer-guide/api/types/SystemTypes.en.rst
+++ b/doc/developer-guide/api/types/SystemTypes.en.rst
@@ -16,8 +16,6 @@
 
 .. include:: ../../../common.defs
 
-.. default-domain:: c
-
 .. This is basically a holding pen to avoid dangling references as I can't find a better way to deal with
    non-ATS types. Some of this was handled by the "EXTERNAL_TYPES" in ext/traffic-server.py but that's
    even uglier than this.
@@ -35,6 +33,23 @@ Description
 
 These types are provided by the compiler ("built-in") or from a required operating system, POSIX, or package header.
 
-.. type:: off_t
+.. c:type:: off_t
+
+   `Reference <https://linux.die.net/include/unistd.h>`__.
+
+.. cpp:type:: off_t
+
+   `Reference <https://linux.die.net/include/unistd.h>`__.
+   
+.. cpp:type:: uint64_t
+
+   `Reference <https://linux.die.net/include/stdint.h>`__.
+   
+.. cpp:type:: uint32_t
+
+   `Reference <https://linux.die.net/include/stdint.h>`__.
+   
+.. cpp:type:: uint8_t
 
-   `Reference <https://linux.die.net/include/unistd.h>`_.
+   `Reference <https://linux.die.net/include/stdint.h>`__.
+   
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>'].