Repository: trafficserver Updated Branches: refs/heads/master 731d35d38 -> ba1c77c26
docs: Minor edits This closes #89 Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/ba1c77c2 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/ba1c77c2 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/ba1c77c2 Branch: refs/heads/master Commit: ba1c77c26e485fc8307e9d7a869fa37adb5abcb2 Parents: 731d35d Author: Jack Bates <j...@nottheoilrig.com> Authored: Thu May 22 09:42:53 2014 -0700 Committer: James Peach <jpe...@apache.org> Committed: Fri Aug 22 12:26:41 2014 -0700 ---------------------------------------------------------------------- doc/reference/api/TSLifecycleHookAdd.en.rst | 17 ++++++++++------- .../configuration/ssl_multicert.config.en.rst | 10 +++++----- 2 files changed, 15 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ba1c77c2/doc/reference/api/TSLifecycleHookAdd.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSLifecycleHookAdd.en.rst b/doc/reference/api/TSLifecycleHookAdd.en.rst index 3f58f5c..ae18207 100644 --- a/doc/reference/api/TSLifecycleHookAdd.en.rst +++ b/doc/reference/api/TSLifecycleHookAdd.en.rst @@ -36,31 +36,34 @@ Description based on the Traffic Server process, not on any specific transaction or session. These will typically be called only once during the execution of the Traffic Server process and therefore should be added in :func:`TSPluginInit` (which could itself be considered a lifecyle hook). Unlike other hooks, lifecycle hooks may not have a well defined ordering and use of them should not assume that one of the hooks is always called before another unless specifically mentioned. -`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` +.. c:var:: TS_LIFECYCLE_PORTS_INITIALIZED_HOOK + Called after the :ts:cv:`proxy server port <proxy.config.http.server_ports>` data structures have been initialized but before connections are accepted on those ports. The sockets corresponding to the ports may or may not be open depending on how the :program:`traffic_server` process was invoked. Other API functions that depend on server ports should be called from this hook and not :func:`TSPluginInit`. - Invoked with the event `TS_EVENT_LIFECYCLE_PORTS_INITIALIZED` and `NULL` data. + Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_PORTS_INITIALIZED` and :c:data:`NULL` data. + +.. c:var:: TS_LIFECYCLE_PORTS_READY_HOOK -`TS_LIFECYCLE_PORTS_READY_HOOK` Called after enabling connections on the proxy server ports. Because Traffic Server is threaded this may or may not be called before any connections are accepted. The hook code may assume that any connection to Traffic Server started after this hook is called will be accepted by Traffic Server, making this a convenient place to signal external processes of that. - Invoked with the event `TS_EVENT_LIFECYCLE_PORTS_READY` and `NULL` data. + Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_PORTS_READY` and :c:data:`NULL` data. + +.. c:var:: TS_LIFECYCLE_CACHE_READY_HOOK -`TS_LIFECYCLE_CACHE_READY_HOOK` Called after Traffic Server cache initialization has finished. - Invoked with the event `TS_EVENT_LIFECYCLE_CACHE_READY` and `NULL` data. + Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_CACHE_READY` and :c:data:`NULL` data. Ordering ======== -`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` will always be called before `TS_LIFECYCLE_PORTS_READY_HOOK`. +:c:data:`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` will always be called before :c:data:`TS_LIFECYCLE_PORTS_READY_HOOK`. Examples ======== http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ba1c77c2/doc/reference/configuration/ssl_multicert.config.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/configuration/ssl_multicert.config.en.rst b/doc/reference/configuration/ssl_multicert.config.en.rst index f044868..8bdeeb8 100644 --- a/doc/reference/configuration/ssl_multicert.config.en.rst +++ b/doc/reference/configuration/ssl_multicert.config.en.rst @@ -47,7 +47,7 @@ Each :file:`ssl_multicert.config` line consists of a sequence of particular SSL certificate. ssl_cert_name=FILENAME[,FILENAME ...] - The name of the file containing the TLS certificate. `FILENAME` + The name of the file containing the TLS certificate. *FILENAME* is located relative to the directory specified by the :ts:cv:`proxy.config.ssl.server.cert.path` configuration variable. It may also include the intermediate CA certificates, sorted from @@ -70,7 +70,7 @@ ssl_cert_name=FILENAME[,FILENAME ...] dest_ip=ADDRESS (optional) The IP (v4 or v6) address that the certificate should be presented on. This is now only used as a fallback in the case that the TLS - SubjectNameIndication extension is not supported. If `ADDRESS` is + SubjectNameIndication extension is not supported. If *ADDRESS* is `*`, the corresponding certificate will be used as the global default fallback if no other match can be made. The address may contain a port specifier, in which case the corresponding certificate @@ -81,13 +81,13 @@ dest_ip=ADDRESS (optional) ssl_key_name=FILENAME (optional) The name of the file containing the private key for this certificate. If the key is contained in the certificate file, this field can - be omitted, otherwise `FILENAME` is resolved relative to the + be omitted, otherwise *FILENAME* is resolved relative to the :ts:cv:`proxy.config.ssl.server.private_key.path` configuration variable. ssl_ca_name=FILENAME (optional) If the certificate is issued by an authority that is not in the system CA bundle, additional certificates may be needed to validate - the certificate chain. `FILENAME` is resolved relative to the + the certificate chain. *FILENAME* is resolved relative to the :ts:cv:`proxy.config.ssl.CA.cert.path` configuration variable. ssl_ticket_enabled=1|0 (optional) @@ -97,7 +97,7 @@ ssl_ticket_enabled=1|0 (optional) ticket_key_name=FILENAME (optional) The name of session ticket key file which contains a secret for - encrypting and decrypting TLS session tickets. If `FILENAME` is + encrypting and decrypting TLS session tickets. If *FILENAME* is not an absolute path, it is resolved relative to the :ts:cv:`proxy.config.ssl.server.cert.path` configuration variable. This option has no effect if session tickets are disabled by the
