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 2019/06/24 18:10:12 UTC
[trafficserver] branch master updated: Doc: Improve
TSHttpTxnUrlEffectiveStringGet docs, cleanup other doc build errors.
This is an automated email from the ASF dual-hosted git repository.
amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new cee653e Doc: Improve TSHttpTxnUrlEffectiveStringGet docs, cleanup other doc build errors.
cee653e is described below
commit cee653efacd47007bd98c46618623473693e633c
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Mon Jun 24 11:00:32 2019 -0500
Doc: Improve TSHttpTxnUrlEffectiveStringGet docs, cleanup other doc build errors.
---
doc/admin-guide/plugins/lua.en.rst | 2 +-
.../api/functions/TSSslClientCertUpdate.en.rst | 11 +++---
.../api/functions/TSSslServerCertUpdate.en.rst | 10 ++---
.../api/functions/TSUrlStringGet.en.rst | 44 +++++++++++-----------
4 files changed, 33 insertions(+), 34 deletions(-)
diff --git a/doc/admin-guide/plugins/lua.en.rst b/doc/admin-guide/plugins/lua.en.rst
index 4ee716a..108d56b 100644
--- a/doc/admin-guide/plugins/lua.en.rst
+++ b/doc/admin-guide/plugins/lua.en.rst
@@ -696,7 +696,7 @@ ts.client_request.get_url
**context:** do_remap/do_os_response or do_global_* or later
-**description:** This function can be used to retrieve the client request url (:func:`TSHttpTxnEffectiveUrlStringGet`).
+**description:** This function can be used to retrieve the client request url (:c:func:`TSHttpTxnEffectiveUrlStringGet`).
Here is an example:
diff --git a/doc/developer-guide/api/functions/TSSslClientCertUpdate.en.rst b/doc/developer-guide/api/functions/TSSslClientCertUpdate.en.rst
index faf08a6..dc9d0f2 100644
--- a/doc/developer-guide/api/functions/TSSslClientCertUpdate.en.rst
+++ b/doc/developer-guide/api/functions/TSSslClientCertUpdate.en.rst
@@ -19,7 +19,7 @@
.. default-domain:: c
TSSslClientCertUpdate
-************************
+*********************
Traffic Server TLS client cert update
@@ -32,9 +32,8 @@ Synopsis
Description
===========
-:func:`TSSslClientCertUpdate` updates existing client certificates configured in :file:`sni.yaml` or `proxy.config.ssl.client.cert.filename`. :arg:`cert_path` should be exact match as provided in configurations.
-:func:`TSSslClientCertUpdate` returns `TS_SUCCESS` only if :arg:`cert_path` exists in configuration and reloaded to update the context.
-Type
-====
-.. type:: TSReturnCode
+:func:`TSSslClientCertUpdate` updates existing client certificates configured in :file:`sni.yaml` or
+`proxy.config.ssl.client.cert.filename`. :arg:`cert_path` should be exact match as provided in
+configurations. :func:`TSSslClientCertUpdate` returns `TS_SUCCESS` only if :arg:`cert_path` exists
+in configuration and reloaded to update the context.
diff --git a/doc/developer-guide/api/functions/TSSslServerCertUpdate.en.rst b/doc/developer-guide/api/functions/TSSslServerCertUpdate.en.rst
index 7a68f7d..44acf21 100644
--- a/doc/developer-guide/api/functions/TSSslServerCertUpdate.en.rst
+++ b/doc/developer-guide/api/functions/TSSslServerCertUpdate.en.rst
@@ -32,9 +32,9 @@ Synopsis
Description
===========
-:func:`TSSslServerCertUpdate` updates existing server certificates configured in :file:`ssl_multicert.config` based on the common name in :arg:`cert_path`. if :arg:`key_path` is set to nullptr, the function will use :arg:`cert_path` for both certificate and private key.
-:func:`TSSslServerCertUpdate` returns `TS_SUCCESS` only if there exists such a mapping, :arg:`cert_path` is a valid cert, and the context is updated to use that cert.
-Type
-====
-.. type:: TSReturnCode
+:func:`TSSslServerCertUpdate` updates existing server certificates configured in
+:file:`ssl_multicert.config` based on the common name in :arg:`cert_path`. if :arg:`key_path` is set
+to nullptr, the function will use :arg:`cert_path` for both certificate and private key.
+:func:`TSSslServerCertUpdate` returns `TS_SUCCESS` only if there exists such a mapping,
+:arg:`cert_path` is a valid cert, and the context is updated to use that cert.
diff --git a/doc/developer-guide/api/functions/TSUrlStringGet.en.rst b/doc/developer-guide/api/functions/TSUrlStringGet.en.rst
index 6da5d0b..46d7e23 100644
--- a/doc/developer-guide/api/functions/TSUrlStringGet.en.rst
+++ b/doc/developer-guide/api/functions/TSUrlStringGet.en.rst
@@ -37,36 +37,36 @@ Synopsis
Description
===========
-The URL data structure is a parsed version of a standard internet URL. The
-Traffic Server URL API provides access to URL data stored in marshal
-buffers. The URL functions can create, copy, retrieve or delete entire URLs,
-and retrieve or modify parts of URLs, such as their host, port or scheme
+The URL data structure is a parsed version of a standard internet URL. The Traffic Server URL API
+provides access to URL data stored in marshal buffers. The URL functions can create, copy, retrieve
+or delete entire URLs, and retrieve or modify parts of URLs, such as their host, port or scheme
information.
-:func:`TSUrlStringGet` constructs a string representation of the URL located
-at :arg:`offset` within the marshal buffer :arg:`bufp`. (However :arg:`bufp` is actually superfluous and may be null.)
-:func:`TSUrlStringGet` stores the length of the allocated string in the
-parameter :arg:`length`. This is the same length that :func:`TSUrlLengthGet`
-returns. The returned string is allocated by a call to :func:`TSmalloc` and
-must be freed by a call to :func:`TSfree`. If length is :literal:`NULL` then no
-attempt is made to de-reference it.
+:func:`TSUrlStringGet` constructs a string representation of the URL located at :arg:`offset` within
+the marshal buffer :arg:`bufp`. (However :arg:`bufp` is actually superfluous and may be null.)
+:func:`TSUrlStringGet` stores the length of the allocated string in the parameter :arg:`length`.
+This is the same length that :func:`TSUrlLengthGet` returns. The returned string is allocated by a
+call to :func:`TSmalloc` and must be freed by a call to :func:`TSfree`. If length is :literal:`NULL`
+then no attempt is made to de-reference it. The returned string is not guaranteed to have a null
+terminator - :arg:`length` must be used to correctly display the string.
:func:`TSHttpTxnEffectiveUrlStringGet` is similar to :func:`TSUrlStringGet`. The two differences are
-* The source is transaction :arg:`txn` in order to have access to the full request.
-* It combines, if needed, both the explicit url and the ``Host`` field. This is
- done if the explicit URL does not have a host and the ``Host`` field does.
+* The source is transaction :arg:`txn` and the URL is retrieved from the client request in that
+ transaction.
-This function is useful to guarantee a URL that is as complete as possible given
-the specific request.
+* If the client request URL has a host, that URL is returned, Otherwise, if there is a "Host" field
+ the value of that field is used as the host in the returned URL.
-:func:`TSUrlLengthGet` calculates the length of the URL located at
-:arg:`offset` within the marshal buffer bufp as if it were returned as a
-string. This length will be the same as the length returned by
-:func:`TSUrlStringGet`.
+This function is useful to guarantee a URL that is as complete as possible given the specific
+request.
-:func:`TSUrlPrint` formats a URL stored in an :type:`TSMBuffer` to an
-:type:`TSIOBuffer`.
+:func:`TSUrlLengthGet` calculates the length of the URL located at :arg:`offset` within the marshal
+buffer bufp as if it were returned as a string. This length will be the same as the length returned
+by :func:`TSUrlStringGet`.
+
+:func:`TSUrlPrint` formats a URL stored in an :type:`TSMBuffer` to an :type:`TSIOBuffer`. Capacity is
+added as needed to the :arg:`iobufp` to print the entire URL.
See Also
========