Return-Path: X-Original-To: apmail-trafficserver-commits-archive@www.apache.org Delivered-To: apmail-trafficserver-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 5C6AD101AF for ; Thu, 17 Apr 2014 16:45:53 +0000 (UTC) Received: (qmail 43428 invoked by uid 500); 17 Apr 2014 16:44:43 -0000 Delivered-To: apmail-trafficserver-commits-archive@trafficserver.apache.org Received: (qmail 42504 invoked by uid 500); 17 Apr 2014 16:44:13 -0000 Mailing-List: contact commits-help@trafficserver.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@trafficserver.apache.org Delivered-To: mailing list commits@trafficserver.apache.org Received: (qmail 42072 invoked by uid 99); 17 Apr 2014 16:44:04 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 17 Apr 2014 16:44:04 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 0CD54951C25; Thu, 17 Apr 2014 16:44:02 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: zwoop@apache.org To: commits@trafficserver.apache.org Date: Thu, 17 Apr 2014 16:44:46 -0000 Message-Id: <8afb562a02554cafaf902772a50abc43@git.apache.org> In-Reply-To: <351826385d73485cb9d04070ff625194@git.apache.org> References: <351826385d73485cb9d04070ff625194@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [47/50] git commit: docs: Fix visible hyperlink target on Read the Docs (should only show the link text) docs: Fix visible hyperlink target on Read the Docs (should only show the link text) This closes #72 Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/9d12a5db Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/9d12a5db Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/9d12a5db Branch: refs/heads/5.0.x Commit: 9d12a5db757e20033a60b92926890abf13453a46 Parents: b25b2c2 Author: Jack Bates Authored: Tue Apr 15 11:10:59 2014 -0700 Committer: James Peach Committed: Wed Apr 16 12:43:20 2014 -0700 ---------------------------------------------------------------------- doc/sdk/actions-guide.en.rst | 4 +- doc/sdk/actions-guide/hosts-lookup-api.en.rst | 4 +- doc/sdk/http-headers/http-headers.en.rst | 46 +++++------ doc/sdk/http-headers/mime-headers.en.rst | 84 ++++++++++---------- doc/sdk/http-headers/urls.en.rst | 56 ++++++------- .../adding-hooks.en.rst | 10 +-- .../http-sessions.en.rst | 4 +- .../http-transactions.en.rst | 34 ++++---- .../initiate-http-connection.en.rst | 2 +- .../intercepting-http-transactions.en.rst | 2 +- doc/sdk/io-guide.en.rst | 16 ++-- doc/sdk/io-guide/io-buffers.en.rst | 2 +- doc/sdk/io-guide/transformations.en.rst | 4 +- doc/sdk/io-guide/vios.en.rst | 22 ++--- doc/sdk/misc-interface-guide.en.rst | 10 +-- .../memory-allocation.en.rst | 10 +-- .../thread-functions.en.rst | 8 +- .../misc-interface-guide/tsfopen-family.en.rst | 12 +-- doc/sdk/mutex-guide.en.rst | 16 ++-- doc/sdk/plugin-configurations.en.rst | 8 +- .../guide-to-the-logging-api.en.rst | 16 ++-- ...trafficserver-settings-and-statistics.en.rst | 10 +-- 22 files changed, 190 insertions(+), 190 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/actions-guide.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/actions-guide.en.rst b/doc/sdk/actions-guide.en.rst index f73d12d..ec9a53d 100644 --- a/doc/sdk/actions-guide.en.rst +++ b/doc/sdk/actions-guide.en.rst @@ -175,6 +175,6 @@ cancel the action. The following sample code implements this: The action functions are: -- ```TSActionCancel`` `__ -- ```TSActionDone`` `__ +- :c:func:`TSActionCancel` +- :c:func:`TSActionDone` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/actions-guide/hosts-lookup-api.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/actions-guide/hosts-lookup-api.en.rst b/doc/sdk/actions-guide/hosts-lookup-api.en.rst index 66fc687..d77ee71 100644 --- a/doc/sdk/actions-guide/hosts-lookup-api.en.rst +++ b/doc/sdk/actions-guide/hosts-lookup-api.en.rst @@ -23,6 +23,6 @@ lookup of a host name, much like a DNS lookup. The hosts lookup functions are as follows: -- ```TSHostLookup`` `__ -- ```TSHostLookupResultAddrGet`` `__ +- :c:func:`TSHostLookup` +- :c:func:`TSHostLookupResultAddrGet` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-headers/http-headers.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-headers/http-headers.en.rst b/doc/sdk/http-headers/http-headers.en.rst index 7208840..f74f8a0 100644 --- a/doc/sdk/http-headers/http-headers.en.rst +++ b/doc/sdk/http-headers/http-headers.en.rst @@ -159,28 +159,28 @@ known schemes, since this removes the possibility of a spelling error. The **HTTP Header Functions** are listed below: -- ```TSHttpHdrClone`` `__ -- ```TSHttpHdrCopy`` `__ -- ```TSHttpHdrCreate`` `__ -- ```TSHttpHdrDestroy`` `__ -- ```TSHttpHdrLengthGet`` `__ -- ```TSHttpHdrMethodGet`` `__ -- ```TSHttpHdrMethodSet`` `__ -- ```TSHttpHdrPrint`` `__ -- ```TSHttpHdrReasonGet`` `__ -- ```TSHttpHdrReasonLookup`` `__ -- ```TSHttpHdrReasonSet`` `__ -- ```TSHttpHdrStatusGet`` `__ -- ```TSHttpHdrStatusSet`` `__ -- ```TSHttpHdrTypeGet`` `__ -- ```TSHttpHdrTypeSet`` `__ -- ```TSHttpHdrUrlGet`` `__ -- ```TSHttpHdrUrlSet`` `__ -- ```TSHttpHdrVersionGet`` `__ -- ```TSHttpHdrVersionSet`` `__ -- ```TSHttpParserClear`` `__ -- ```TSHttpParserCreate`` `__ +- :c:func:`TSHttpHdrClone` +- :c:func:`TSHttpHdrCopy` +- :c:func:`TSHttpHdrCreate` +- :c:func:`TSHttpHdrDestroy` +- :c:func:`TSHttpHdrLengthGet` +- :c:func:`TSHttpHdrMethodGet` +- :c:func:`TSHttpHdrMethodSet` +- :c:func:`TSHttpHdrPrint` +- :c:func:`TSHttpHdrReasonGet` +- :c:func:`TSHttpHdrReasonLookup` +- :c:func:`TSHttpHdrReasonSet` +- :c:func:`TSHttpHdrStatusGet` +- :c:func:`TSHttpHdrStatusSet` +- :c:func:`TSHttpHdrTypeGet` +- :c:func:`TSHttpHdrTypeSet` +- :c:func:`TSHttpHdrUrlGet` +- :c:func:`TSHttpHdrUrlSet` +- :c:func:`TSHttpHdrVersionGet` +- :c:func:`TSHttpHdrVersionSet` +- :c:func:`TSHttpParserClear` +- :c:func:`TSHttpParserCreate` - `TSHttpParserDestroy `__ -- ```TSHttpHdrParseReq`` `__ -- ```TSHttpHdrParseResp`` `__ +- :c:func:`TSHttpHdrParseReq` +- :c:func:`TSHttpHdrParseResp` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-headers/mime-headers.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-headers/mime-headers.en.rst b/doc/sdk/http-headers/mime-headers.en.rst index ec9b0e8..7796678 100644 --- a/doc/sdk/http-headers/mime-headers.en.rst +++ b/doc/sdk/http-headers/mime-headers.en.rst @@ -74,7 +74,7 @@ a MIME header location. If an HTTP header location is passed to these functions, then the system locates the MIME header associated with that HTTP header and executes the corresponding MIME header operations specified by the functions (see the example in the description of -```TSMimeHdrCopy`` `__). +:c:func:`TSMimeHdrCopy`). **Note:** MIME headers may contain more than one MIME field with the same name. Previous versions of Traffic Server joined multiple fields @@ -393,45 +393,45 @@ object in one of the MIME headers associated with the object. The MIME header functions are listed below: -- ```TSMimeHdrFieldAppend`` `__ -- ```TSMimeHdrFieldClone`` `__ -- ```TSMimeHdrFieldCopy`` `__ -- ```TSMimeHdrFieldCopyValues`` `__ -- ```TSMimeHdrFieldCreate`` `__ -- ```TSMimeHdrFieldDestroy`` `__ -- ```TSMimeHdrFieldLengthGet`` `__ -- ```TSMimeHdrFieldNameGet`` `__ -- ```TSMimeHdrFieldNameSet`` `__ -- ```TSMimeHdrFieldNext`` `__ -- ```TSMimeHdrFieldNextDup`` `__ -- ```TSMimeHdrFieldValueAppend`` `__ -- ```TSMimeHdrFieldValueAppend`` `__ -- ```TSMimeHdrFieldValueDateGet`` `__ -- ```TSMimeHdrFieldValueDateInsert`` `__ -- ```TSMimeHdrFieldValueDateSet`` `__ -- ```TSMimeHdrFieldValueIntGet`` `__ -- ```TSMimeHdrFieldValueIntSet`` `__ -- ```TSMimeHdrFieldValueStringGet`` `__ -- ```TSMimeHdrFieldValueStringInsert`` `__ -- ```TSMimeHdrFieldValueStringSet`` `__ -- ```TSMimeHdrFieldValueUintGet`` `__ -- ```TSMimeHdrFieldValueUintInsert`` `__ -- ```TSMimeHdrFieldValueUintSet`` `__ -- ```TSMimeHdrFieldValuesClear`` `__ -- ```TSMimeHdrFieldValuesCount`` `__ -- ```TSMimeHdrClone`` `__ -- ```TSMimeHdrCopy`` `__ -- ```TSMimeHdrCreate`` `__ -- ```TSMimeHdrDestroy`` `__ -- ```TSMimeHdrFieldFind`` `__ -- ```TSMimeHdrFieldGet`` `__ -- ```TSMimeHdrFieldRemove`` `__ -- ```TSMimeHdrFieldsClear`` `__ -- ```TSMimeHdrFieldsCount`` `__ -- ```TSMimeHdrLengthGet`` `__ -- ```TSMimeHdrParse`` `__ -- ```TSMimeParserClear`` `__ -- ```TSMimeParserCreate`` `__ -- ```TSMimeParserDestroy`` `__ -- ```TSMimeHdrPrint`` `__ +- :c:func:`TSMimeHdrFieldAppend` +- :c:func:`TSMimeHdrFieldClone` +- :c:func:`TSMimeHdrFieldCopy` +- :c:func:`TSMimeHdrFieldCopyValues` +- :c:func:`TSMimeHdrFieldCreate` +- :c:func:`TSMimeHdrFieldDestroy` +- :c:func:`TSMimeHdrFieldLengthGet` +- :c:func:`TSMimeHdrFieldNameGet` +- :c:func:`TSMimeHdrFieldNameSet` +- :c:func:`TSMimeHdrFieldNext` +- :c:func:`TSMimeHdrFieldNextDup` +- :c:func:`TSMimeHdrFieldValueAppend` +- :c:func:`TSMimeHdrFieldValueAppend` +- :c:func:`TSMimeHdrFieldValueDateGet` +- :c:func:`TSMimeHdrFieldValueDateInsert` +- :c:func:`TSMimeHdrFieldValueDateSet` +- :c:func:`TSMimeHdrFieldValueIntGet` +- :c:func:`TSMimeHdrFieldValueIntSet` +- :c:func:`TSMimeHdrFieldValueStringGet` +- :c:func:`TSMimeHdrFieldValueStringInsert` +- :c:func:`TSMimeHdrFieldValueStringSet` +- :c:func:`TSMimeHdrFieldValueUintGet` +- :c:func:`TSMimeHdrFieldValueUintInsert` +- :c:func:`TSMimeHdrFieldValueUintSet` +- :c:func:`TSMimeHdrFieldValuesClear` +- :c:func:`TSMimeHdrFieldValuesCount` +- :c:func:`TSMimeHdrClone` +- :c:func:`TSMimeHdrCopy` +- :c:func:`TSMimeHdrCreate` +- :c:func:`TSMimeHdrDestroy` +- :c:func:`TSMimeHdrFieldFind` +- :c:func:`TSMimeHdrFieldGet` +- :c:func:`TSMimeHdrFieldRemove` +- :c:func:`TSMimeHdrFieldsClear` +- :c:func:`TSMimeHdrFieldsCount` +- :c:func:`TSMimeHdrLengthGet` +- :c:func:`TSMimeHdrParse` +- :c:func:`TSMimeParserClear` +- :c:func:`TSMimeParserCreate` +- :c:func:`TSMimeParserDestroy` +- :c:func:`TSMimeHdrPrint` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-headers/urls.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-headers/urls.en.rst b/doc/sdk/http-headers/urls.en.rst index 5f32b82..91b74b5 100644 --- a/doc/sdk/http-headers/urls.en.rst +++ b/doc/sdk/http-headers/urls.en.rst @@ -104,31 +104,31 @@ schemes, since doing so can prevent the possibility of spelling errors. Traffic Server **URL functions** are listed below: -```TSUrlClone`` `__ -```TSUrlCopy`` `__ -```TSUrlCreate`` `__ -```TSUrlDestroy`` `__ -```TSUrlPrint`` `__ -```TSUrlFtpTypeGet`` `__ -```TSUrlFtpTypeSet`` `__ -```TSUrlHostGet`` `__ -```TSUrlHostSet`` `__ -```TSUrlHttpFragmentGet`` `__ -```TSUrlHttpFragmentSet`` `__ -```TSUrlHttpParamsGet`` `__ -```TSUrlHttpParamsSet`` `__ -```TSUrlHttpQueryGet`` `__ -```TSUrlHttpQuerySet`` `__ -```TSUrlLengthGet`` `__ -```TSUrlParse`` `__ -```TSUrlPasswordGet`` `__ -```TSUrlPasswordSet`` `__ -```TSUrlPathGet`` `__ -```TSUrlPathSet`` `__ -```TSUrlPortGet`` `__ -```TSUrlPortSet`` `__ -```TSUrlSchemeGet`` `__ -```TSUrlSchemeSet`` `__ -```TSUrlStringGet`` `__ -```TSUrlUserGet`` `__ -```TSUrlUserSet`` `__ +:c:func:`TSUrlClone` +:c:func:`TSUrlCopy` +:c:func:`TSUrlCreate` +:c:func:`TSUrlDestroy` +:c:func:`TSUrlPrint` +:c:func:`TSUrlFtpTypeGet` +:c:func:`TSUrlFtpTypeSet` +:c:func:`TSUrlHostGet` +:c:func:`TSUrlHostSet` +:c:func:`TSUrlHttpFragmentGet` +:c:func:`TSUrlHttpFragmentSet` +:c:func:`TSUrlHttpParamsGet` +:c:func:`TSUrlHttpParamsSet` +:c:func:`TSUrlHttpQueryGet` +:c:func:`TSUrlHttpQuerySet` +:c:func:`TSUrlLengthGet` +:c:func:`TSUrlParse` +:c:func:`TSUrlPasswordGet` +:c:func:`TSUrlPasswordSet` +:c:func:`TSUrlPathGet` +:c:func:`TSUrlPathSet` +:c:func:`TSUrlPortGet` +:c:func:`TSUrlPortSet` +:c:func:`TSUrlSchemeGet` +:c:func:`TSUrlSchemeSet` +:c:func:`TSUrlStringGet` +:c:func:`TSUrlUserGet` +:c:func:`TSUrlUserSet` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-hooks-and-transactions/adding-hooks.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-hooks-and-transactions/adding-hooks.en.rst b/doc/sdk/http-hooks-and-transactions/adding-hooks.en.rst index 2f862e2..04e3e94 100644 --- a/doc/sdk/http-hooks-and-transactions/adding-hooks.en.rst +++ b/doc/sdk/http-hooks-and-transactions/adding-hooks.en.rst @@ -34,7 +34,7 @@ There are several ways to add hooks to your plugin. - **Transformation hooks** Transformation hooks are a special case of transaction hooks. See - ```TSVConnCacheObjectSizeGet`` `__ + :c:func:`TSVConnCacheObjectSizeGet` for more information about transformation hooks. You add a transformation hook using ``TSHttpTxnHookAdd``, as described in `HTTP Transactions `__. @@ -55,9 +55,9 @@ There are several ways to add hooks to your plugin. information on the alternate selection mechanism. All of the hook addition functions -(```TSHttpHookAdd`` `__, -```TSHttpSsnHookAdd`` `__, -```TSHttpSsnReenable`` `__) +(:c:func:`TSHttpHookAdd`, +:c:func:`TSHttpSsnHookAdd`, +:c:func:`TSHttpSsnReenable`) take ``TSHttpHookID`` (identifies the hook to add on to) and ``TSCont`` (the basic callback mechanism in Traffic Server). A single ``TSCont`` can be added to any number of hooks at a time. @@ -150,4 +150,4 @@ values for ``TSHttpHookID`` are: was left open for keep alive has new data available. The function you use to add a global HTTP hook is -```TSHttpHookAdd`` `__. +:c:func:`TSHttpHookAdd`. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-hooks-and-transactions/http-sessions.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-hooks-and-transactions/http-sessions.en.rst b/doc/sdk/http-hooks-and-transactions/http-sessions.en.rst index 8d45478..b4014e5 100644 --- a/doc/sdk/http-hooks-and-transactions/http-sessions.en.rst +++ b/doc/sdk/http-hooks-and-transactions/http-sessions.en.rst @@ -47,6 +47,6 @@ processing a session hook. The session hook functions are listed below: -- ```TSHttpSsnHookAdd`` `__ -- ```TSHttpSsnReenable`` `__ +- :c:func:`TSHttpSsnHookAdd` +- :c:func:`TSHttpSsnReenable` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-hooks-and-transactions/http-transactions.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-hooks-and-transactions/http-transactions.en.rst b/doc/sdk/http-hooks-and-transactions/http-transactions.en.rst index 35550fd..e859fb2 100644 --- a/doc/sdk/http-hooks-and-transactions/http-transactions.en.rst +++ b/doc/sdk/http-hooks-and-transactions/http-transactions.en.rst @@ -158,12 +158,12 @@ for an illustration of the steps involved in a typical HTTP transaction. The HTTP transaction functions are: -- ```TSHttpTxnCacheLookupStatusGet`` `__ +- :c:func:`TSHttpTxnCacheLookupStatusGet` -- ```TSHttpTxnCachedReqGet`` `__ +- :c:func:`TSHttpTxnCachedReqGet` - Note that it is an error to modify cached headers. -- ```TSHttpTxnCachedRespGet`` `__ +- :c:func:`TSHttpTxnCachedRespGet` - Note that it is an error to modify cached headers. - `TSHttpTxnClientIncomingPortGet `__ @@ -172,34 +172,34 @@ The HTTP transaction functions are: - `TSHttpTxnClientRemotePortGet `__ -- ```TSHttpTxnClientReqGet`` `__ +- :c:func:`TSHttpTxnClientReqGet` - Plugins that must read client request headers use this call to retrieve the HTTP header. -- ```TSHttpTxnClientRespGet`` `__ +- :c:func:`TSHttpTxnClientRespGet` -- ```TSHttpTxnErrorBodySet`` `__ +- :c:func:`TSHttpTxnErrorBodySet` -- ```TSHttpTxnHookAdd`` `__ +- :c:func:`TSHttpTxnHookAdd` -- ```TSHttpTxnNextHopAddrGet`` `__ +- :c:func:`TSHttpTxnNextHopAddrGet` -- ```TSHttpTxnParentProxySet`` `__ +- :c:func:`TSHttpTxnParentProxySet` -- ```TSHttpTxnReenable`` `__ +- :c:func:`TSHttpTxnReenable` -- ```TSHttpTxnServerAddrGet`` `__ +- :c:func:`TSHttpTxnServerAddrGet` -- ```TSHttpTxnServerReqGet`` `__ +- :c:func:`TSHttpTxnServerReqGet` -- ```TSHttpTxnServerRespGet`` `__ +- :c:func:`TSHttpTxnServerRespGet` -- ```TSHttpTxnSsnGet`` `__ +- :c:func:`TSHttpTxnSsnGet` -- ```TSHttpTxnTransformedRespCache`` `__ +- :c:func:`TSHttpTxnTransformedRespCache` -- ```TSHttpTxnTransformRespGet`` `__ +- :c:func:`TSHttpTxnTransformRespGet` -- ```TSHttpTxnUntransformedRespCache`` `__ +- :c:func:`TSHttpTxnUntransformedRespCache` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-hooks-and-transactions/initiate-http-connection.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-hooks-and-transactions/initiate-http-connection.en.rst b/doc/sdk/http-hooks-and-transactions/initiate-http-connection.en.rst index 059747d..e5921ad 100644 --- a/doc/sdk/http-hooks-and-transactions/initiate-http-connection.en.rst +++ b/doc/sdk/http-hooks-and-transactions/initiate-http-connection.en.rst @@ -21,5 +21,5 @@ Initiate HTTP Connection This function enables plugins to initiate HTTP transactions. The initiate HTTP connection function is: -- ```TSHttpConnect`` `__ +- :c:func:`TSHttpConnect` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.rst b/doc/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.rst index 9dd7682..9a7d59b 100644 --- a/doc/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.rst +++ b/doc/sdk/http-hooks-and-transactions/intercepting-http-transactions.en.rst @@ -26,5 +26,5 @@ for reading ``POST`` bodies in plugins as well as using alternative transports to the origin server.The intercepting HTTP transaction functions are: -- ```TSHttpTxnIntercept`` `__ +- :c:func:`TSHttpTxnIntercept` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/io-guide.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/io-guide.en.rst b/doc/sdk/io-guide.en.rst index 40bf54d..7e95cf3 100644 --- a/doc/sdk/io-guide.en.rst +++ b/doc/sdk/io-guide.en.rst @@ -182,13 +182,13 @@ Plugins <../http-transformation-plugin#WritingContentTransformPlugins>`__. The vconnection functions are listed below: -- ```TSVConnAbort`` `__ -- ```TSVConnClose`` `__ -- ```TSVConnClosedGet`` `__ -- ```TSVConnRead`` `__ -- ```TSVConnReadVIOGet`` `__ -- ```TSVConnShutdown`` `__ -- ```TSVConnWrite`` `__ -- ```TSVConnWriteVIOGet`` `__ +- :c:func:`TSVConnAbort` +- :c:func:`TSVConnClose` +- :c:func:`TSVConnClosedGet` +- :c:func:`TSVConnRead` +- :c:func:`TSVConnReadVIOGet` +- :c:func:`TSVConnShutdown` +- :c:func:`TSVConnWrite` +- :c:func:`TSVConnWriteVIOGet` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/io-guide/io-buffers.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/io-guide/io-buffers.en.rst b/doc/sdk/io-guide/io-buffers.en.rst index 8c4cc40..a43bab9 100644 --- a/doc/sdk/io-guide/io-buffers.en.rst +++ b/doc/sdk/io-guide/io-buffers.en.rst @@ -35,7 +35,7 @@ structure. Since only a single writer is allowed, there is no corresponding ``TSIOBufferWriter`` data structure. The writer simply modifies the IO buffer directly. To see an example that illustrates how to use IOBuffers, refer to the sample code in the description of -```TSIOBufferBlockReadStart`` `__. +:c:func:`TSIOBufferBlockReadStart`. Additional information about IO buffer functions: http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/io-guide/transformations.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/io-guide/transformations.en.rst b/doc/sdk/io-guide/transformations.en.rst index 667e611..e627000 100644 --- a/doc/sdk/io-guide/transformations.en.rst +++ b/doc/sdk/io-guide/transformations.en.rst @@ -177,6 +177,6 @@ Here's how to make sure that all incoming data is consumed: because it knows it already holds the mutex. The transformation functions are: \* -```TSTransformCreate`` `__ +:c:func:`TSTransformCreate` \* -```TSTransformOutputVConnGet`` `__ +:c:func:`TSTransformOutputVConnGet` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/io-guide/vios.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/io-guide/vios.en.rst b/doc/sdk/io-guide/vios.en.rst index 48e5d12..61718c2 100644 --- a/doc/sdk/io-guide/vios.en.rst +++ b/doc/sdk/io-guide/vios.en.rst @@ -45,15 +45,15 @@ as follows: The VIO functions below access and modify various parts of the data structure. -- ```TSVIOBufferGet`` `__ -- ```TSVIOVConnGet`` `__ -- ```TSVIOContGet`` `__ -- ```TSVIOMutexGet`` `__ -- ```TSVIONBytesGet`` `__ -- ```TSVIONBytesSet`` `__ -- ```TSVIONDoneGet`` `__ -- ```TSVIONDoneSet`` `__ -- ```TSVIONTodoGet`` `__ -- ```TSVIOReaderGet`` `__ -- ```TSVIOReenable`` `__ +- :c:func:`TSVIOBufferGet` +- :c:func:`TSVIOVConnGet` +- :c:func:`TSVIOContGet` +- :c:func:`TSVIOMutexGet` +- :c:func:`TSVIONBytesGet` +- :c:func:`TSVIONBytesSet` +- :c:func:`TSVIONDoneGet` +- :c:func:`TSVIONDoneSet` +- :c:func:`TSVIONTodoGet` +- :c:func:`TSVIOReaderGet` +- :c:func:`TSVIOReenable` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/misc-interface-guide.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/misc-interface-guide.en.rst b/doc/sdk/misc-interface-guide.en.rst index 2b4675c..067068b 100644 --- a/doc/sdk/misc-interface-guide.en.rst +++ b/doc/sdk/misc-interface-guide.en.rst @@ -39,22 +39,22 @@ all Traffic Server-support platforms). Debugging Functions ------------------- -- ```TSDebug`` `__ +- :c:func:`TSDebug` prints out a formatted statement if you are running Traffic Server in debug mode. -- ```TSIsDebugTagSet`` `__ +- :c:func:`TSIsDebugTagSet` checks to see if a debug tag is set. If the debug tag is set, then Traffic Server prints out all debug statements associated with the tag. -- ```TSError`` `__ +- :c:func:`TSError` prints error messages to Traffic Server's error log -- ```TSAssert`` `__ +- :c:func:`TSAssert` enables the use of assertion in a plugin. -- ```TSReleaseAssert`` `__ +- :c:func:`TSReleaseAssert` enables the use of assertion in a plugin. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/misc-interface-guide/memory-allocation.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/misc-interface-guide/memory-allocation.en.rst b/doc/sdk/misc-interface-guide/memory-allocation.en.rst index f2e2e88..b270feb 100644 --- a/doc/sdk/misc-interface-guide/memory-allocation.en.rst +++ b/doc/sdk/misc-interface-guide/memory-allocation.en.rst @@ -33,14 +33,14 @@ leaks. The memory allocation functions are: -- ```TSfree`` `__ +- :c:func:`TSfree` -- ```TSmalloc`` `__ +- :c:func:`TSmalloc` -- ```TSrealloc`` `__ +- :c:func:`TSrealloc` -- ```TSstrdup`` `__ +- :c:func:`TSstrdup` -- ```TSstrndup`` `__ +- :c:func:`TSstrndup` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/misc-interface-guide/thread-functions.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/misc-interface-guide/thread-functions.en.rst b/doc/sdk/misc-interface-guide/thread-functions.en.rst index 65fdf3c..a39f515 100644 --- a/doc/sdk/misc-interface-guide/thread-functions.en.rst +++ b/doc/sdk/misc-interface-guide/thread-functions.en.rst @@ -27,8 +27,8 @@ shared resources and data using the ``TSMutex`` type, as described in The thread functions are listed below: -- ```TSThreadCreate`` `__ -- ```TSThreadDestroy`` `__ -- ```TSThreadInit`` `__ -- ```TSThreadSelf`` `__ +- :c:func:`TSThreadCreate` +- :c:func:`TSThreadDestroy` +- :c:func:`TSThreadInit` +- :c:func:`TSThreadSelf` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/misc-interface-guide/tsfopen-family.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/misc-interface-guide/tsfopen-family.en.rst b/doc/sdk/misc-interface-guide/tsfopen-family.en.rst index 0952a4b..b0900b0 100644 --- a/doc/sdk/misc-interface-guide/tsfopen-family.en.rst +++ b/doc/sdk/misc-interface-guide/tsfopen-family.en.rst @@ -39,16 +39,16 @@ corresponding usage of the ``fopen`` family of functions is inappropriate due to file descriptor and portability limitations. The ``TSfopen`` family of functions consists of the following: -- ```TSfclose`` `__ +- :c:func:`TSfclose` -- ```TSfflush`` `__ +- :c:func:`TSfflush` -- ```TSfgets`` `__ +- :c:func:`TSfgets` -- ```TSfopen`` `__ +- :c:func:`TSfopen` -- ```TSfread`` `__ +- :c:func:`TSfread` -- ```TSfwrite`` `__ +- :c:func:`TSfwrite` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/mutex-guide.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/mutex-guide.en.rst b/doc/sdk/mutex-guide.en.rst index 0aa6239..de2eaad 100644 --- a/doc/sdk/mutex-guide.en.rst +++ b/doc/sdk/mutex-guide.en.rst @@ -81,24 +81,24 @@ created in ``TSPluginInit``. The ``blacklist-1.c`` code uses information, see the ```blacklist-1.c`` <../sample-source-code#Sample_blacklist-1.c>`__ code; start by looking at the -```TSPluginInit`` `__ +:c:func:`TSPluginInit` function. General guidelines for locking shared data are as follows: 1. Create a mutex for the shared data with - ```TSMutexCreate`` `__. + :c:func:`TSMutexCreate`. 2. Whenever you need to read or modify this data, first lock it by calling - ```TSMutexLockTry`` `__; + :c:func:`TSMutexLockTry`; then read or modify the data. 3. When you are done with the data, unlock it with - ```TSMutexUnlock`` `__. + :c:func:`TSMutexUnlock`. If you are unlocking data accessed during the processing of an HTTP transaction, then you must unlock it before calling - ```TSHttpTxnReenable`` `__. + :c:func:`TSHttpTxnReenable`. Protecting a Continuation's Data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -405,7 +405,7 @@ continuation created in ``txn_handler``: The mutex functions are listed below: -- ```TSMutexCreate`` `__ -- ```TSMutexLock`` `__ -- ```TSMutexLockTry`` `__ +- :c:func:`TSMutexCreate` +- :c:func:`TSMutexLock` +- :c:func:`TSMutexLockTry` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/plugin-configurations.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/plugin-configurations.en.rst b/doc/sdk/plugin-configurations.en.rst index b9dc89b..994f519 100644 --- a/doc/sdk/plugin-configurations.en.rst +++ b/doc/sdk/plugin-configurations.en.rst @@ -105,12 +105,12 @@ Here's how the interface works: The configuration functions are: -- ```TSConfigDataGet`` `__ +- :c:func:`TSConfigDataGet` -- ```TSConfigGet`` `__ +- :c:func:`TSConfigGet` -- ```TSConfigRelease`` `__ +- :c:func:`TSConfigRelease` -- ```TSConfigSet`` `__ +- :c:func:`TSConfigSet` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/doc/sdk/plugin-management/guide-to-the-logging-api.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/plugin-management/guide-to-the-logging-api.en.rst b/doc/sdk/plugin-management/guide-to-the-logging-api.en.rst index 4c3aec2..ad0b193 100644 --- a/doc/sdk/plugin-management/guide-to-the-logging-api.en.rst +++ b/doc/sdk/plugin-management/guide-to-the-logging-api.en.rst @@ -27,28 +27,28 @@ you can set log properties. The logging API enables you to: - Establish a custom text log for your plugin: see - ```TSTextLogObjectCreate`` `__ + :c:func:`TSTextLogObjectCreate` - Set the log header for your custom text log: see - ```TSTextLogObjectHeaderSet`` `__ + :c:func:`TSTextLogObjectHeaderSet` - Enable or disable rolling your custom text log: see - ```TSTextLogObjectRollingEnabledSet`` `__ + :c:func:`TSTextLogObjectRollingEnabledSet` - Set the rolling interval (in seconds) for your custom text log: see - ```TSTextLogObjectRollingIntervalSecSet`` `__ + :c:func:`TSTextLogObjectRollingIntervalSecSet` - Set the rolling offset for your custom text log: see - ```TSTextLogObjectRollingOffsetHrSet`` `__ + :c:func:`TSTextLogObjectRollingOffsetHrSet` - Write text entries to the custom text log: see - ```TSTextLogObjectWrite`` `__ + :c:func:`TSTextLogObjectWrite` - Flush the contents of the custom text log's write buffer to disk: see - ```TSTextLogObjectFlush`` `__ + :c:func:`TSTextLogObjectFlush` - Destroy custom text logs when you are done with them: see - ```TSTextLogObjectDestroy`` `__ + :c:func:`TSTextLogObjectDestroy` The steps below show how the logging API is used in the ``blacklist-1.c`` sample plugin. For the complete source code, see the http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9d12a5db/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 b3341a6..e203198 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 @@ -40,16 +40,16 @@ the `Traffic Server Administrator's Guide <../../admin/>`__. Depending on the result type, you'll use ``TSMgmtIntGet``, ``TSMgmtCounterGet``, ``TSMgmtFloatGet``, or ``TSMgmtStringGet`` to obtain the variable value (see the example for -```TSMgmtIntGet`` `__. +:c:func:`TSMgmtIntGet`. The ``TSMgmt*Get`` functions are: -- ```TSMgmtCounterGet`` `__ +- :c:func:`TSMgmtCounterGet` -- ```TSMgmtFloatGet`` `__ +- :c:func:`TSMgmtFloatGet` -- ```TSMgmtIntGet`` `__ +- :c:func:`TSMgmtIntGet` -- ```TSMgmtStringGet`` `__ +- :c:func:`TSMgmtStringGet`