Repository: trafficserver Updated Branches: refs/heads/master ee1b245a2 -> 32d6b60ea
[TS-3881] More docs formatting. Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/32d6b60e Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/32d6b60e Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/32d6b60e Branch: refs/heads/master Commit: 32d6b60eadf2574e77ae0c68a11d543c51453ec1 Parents: ee1b245 Author: Sudheer Vinukonda <[email protected]> Authored: Wed Sep 16 19:41:13 2015 +0000 Committer: Sudheer Vinukonda <[email protected]> Committed: Wed Sep 16 19:41:13 2015 +0000 ---------------------------------------------------------------------- doc/reference/api/TSHttpTxnInfoIntGet.en.rst | 32 +++++++++++------------ 1 file changed, 16 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/32d6b60e/doc/reference/api/TSHttpTxnInfoIntGet.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSHttpTxnInfoIntGet.en.rst b/doc/reference/api/TSHttpTxnInfoIntGet.en.rst index dc696d9..975dcbb 100644 --- a/doc/reference/api/TSHttpTxnInfoIntGet.en.rst +++ b/doc/reference/api/TSHttpTxnInfoIntGet.en.rst @@ -29,43 +29,43 @@ Synopsis Description ----------- :c:func:`TSHttpTxnInfoIntGet` returns arbitrary integer-typed info about a transaction as defined in -:c:type:TSHttpTxnInfoKey. The API will be part of a generic API umbrella that can support returning +:c:type:`TSHttpTxnInfoKey`. The API will be part of a generic API umbrella that can support returning arbitrary info about a transaction using custom log tags. It works on multiple hooks depending on the -requested info. For example, cache related info may be available only at or after :c:data:CACHE_LOOKUP_COMPLETE hook. +requested info. For example, cache related info may be available only at or after :c:data:`CACHE_LOOKUP_COMPLETE` hook. -The :c:type:TSHttpTxnInfoKey currently supports the below integer-based info about a transaction :: +The :c:type:`TSHttpTxnInfoKey` currently supports the below integer-based info about a transaction - :c:data:TS_TXN_INFO_CACHE_HIT_RAM + :c:data:`TS_TXN_INFO_CACHE_HIT_RAM` - This info is available at or after :c:data:CACHE_LOOKUP_COMPLETE hook. A value of 1 indicates that the response + This info is available at or after :c:data:`CACHE_LOOKUP_COMPLETE` hook. A value of 1 indicates that the response is returned from RAM cache. A value of 0 indicates otherwise. - :c:data:TS_TXN_INFO_CACHE_COMPRESSED_IN_RAM + :c:data:`TS_TXN_INFO_CACHE_COMPRESSED_IN_RAM` - This info is available at or after :c:data:CACHE_LOOKUP_COMPLETE hook. A value of 1 indicates that the response + This info is available at or after :c:data:`CACHE_LOOKUP_COMPLETE` hook. A value of 1 indicates that the response is returned from RAM cache and is compressed. A value of 0 indicates otherwise. - :c:data:TS_TXN_INFO_CACHE_HIT_RWW + :c:data:`TS_TXN_INFO_CACHE_HIT_RWW` - This info is available at or after :c:data:CACHE_LOOKUP_COMPLETE hook. A value of 1 indicates that the response + This info is available at or after :c:data:`CACHE_LOOKUP_COMPLETE` hook. A value of 1 indicates that the response is returned via Read-While-Writer functionality. A value of 0 indicates otherwise. - :c:data:TS_TXN_INFO_CACHE_OPEN_READ_TRIES + :c:data:`TS_TXN_INFO_CACHE_OPEN_READ_TRIES` - This info is available at or after :c:data:CACHE_LOOKUP_COMPLETE hook. The value indicates the number of cache open + This info is available at or after :c:data:`CACHE_LOOKUP_COMPLETE` hook. The value indicates the number of cache open read reattempts made by the transaction on cache open read failure. - :c:data:TS_TXN_INFO_CACHE_OPEN_WRITE_TRIES + :c:data:`TS_TXN_INFO_CACHE_OPEN_WRITE_TRIES` - This info is available at or after :c:data:CACHE_LOOKUP_COMPLETE hook. The value indicates the number of cache open + This info is available at or after :c:data:`CACHE_LOOKUP_COMPLETE` hook. The value indicates the number of cache open write reattempts made by the transaction on cache open write failure. - :c:data:TS_TXN_INFO_CACHE_VOLUME + :c:data:`TS_TXN_INFO_CACHE_VOLUME` - This info is available at or after :c:data:CACHE_LOOKUP_COMPLETE hook. The value indicates the cache volume ID used + This info is available at or after :c:data:`CACHE_LOOKUP_COMPLETE` hook. The value indicates the cache volume ID used for the cache object associated with the transaction. Return values ============= -The API returns :c:data:TS_SUCCESS, if the requested info is supported, :c:data:TS_ERROR otherwise. +The API returns :c:data:`TS_SUCCESS`, if the requested info is supported, :c:data:`TS_ERROR` otherwise.
