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/01/15 20:35:39 UTC

[trafficserver] branch master updated: Doc: Repair build errors, primarily with some new events and configurations.

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 b8ddcb3  Doc: Repair build errors, primarily with some new events and configurations.
b8ddcb3 is described below

commit b8ddcb3a3ac54212cc69a0ee454b26d6b277bbd1
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Thu Jan 10 11:04:36 2019 -0600

    Doc: Repair build errors, primarily with some new events and configurations.
---
 doc/admin-guide/files/records.config.en.rst        | 11 ++++-
 .../api/functions/TSHttpOverridableConfig.en.rst   |  4 +-
 .../api/functions/TSLifecycleHookAdd.en.rst        | 25 ++++++-----
 doc/developer-guide/api/types/TSEvent.en.rst       | 50 ++++++++++++++++++++--
 .../api/types/TSOverridableConfigKey.en.rst        | 10 ++++-
 5 files changed, 80 insertions(+), 20 deletions(-)

diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index c4c02a8..b7d85c9 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -1097,6 +1097,15 @@ mptcp
 
 .. ts:cv:: CONFIG proxy.config.http.default_buffer_water_mark INT 32768
 
+.. ts:cv:: CONFIG proxy.config.http.request_buffer_enabled INT 0
+   :overridable:
+
+   This is a configuration value that is overridable but not configurable. This is most likely an
+   implementation error.
+
+   This enables buffering the content for incoming ``POST`` requests. If enabled no outbound
+   connection is made until the entire ``POST`` request has been buffered.
+
 .. ts:cv:: CONFIG proxy.config.http.request_header_max_size INT 131072
 
    Controls the maximum size, in bytes, of an HTTP header in requests. Headers
@@ -3580,7 +3589,7 @@ Client-Related Configuration
 .. ts:cv:: CONFIG proxy.config.ssl.client.sni_policy STRING NULL
    :overridable:
 
-   Indicate how the SNI value for the TLS connection to the origin is selected.  By default it is 
+   Indicate how the SNI value for the TLS connection to the origin is selected.  By default it is
    `host` which means the host header field value is used for the SNI.  If `remap` is specified, the
    remapped origin name is used for the SNI value.
 
diff --git a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
index a38fd56..a30b5c2 100644
--- a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
@@ -173,10 +173,10 @@ TSOverridableConfigKey Value                                        Configuratio
 :c:macro:`TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT`                  :ts:cv:`proxy.config.net.sock_send_buffer_size_out`
 :c:macro:`TS_CONFIG_PARENT_FAILURES_UPDATE_HOSTDB`                  :ts:cv:`proxy.config.http.parent_proxy.mark_down_hostdb`
 :c:macro:`TS_CONFIG_SRV_ENABLED`                                    :ts:cv:`proxy.config.srv_enabled`
-:c:macro:`TS_CONFIG_SSL_CERT_FILENAME`                              :ts:cv:`proxy.config.ssl.client.cert.filename`
+:c:macro:`TS_CONFIG_SSL_CLIENT_CERT_FILENAME`                       :ts:cv:`proxy.config.ssl.client.cert.filename`
 :c:macro:`TS_CONFIG_SSL_CERT_FILEPATH`                              :ts:cv:`proxy.config.ssl.client.cert.path`
 :c:macro:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER`                       :ts:cv:`proxy.config.ssl.client.verify.server`
-:c:macro:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES`            :ts:cv:`proxy.config.ssl.client.verify.server,properties`
+:c:macro:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES`            :ts:cv:`proxy.config.ssl.client.verify.server.properties`
 :c:macro:`TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY`                :ts:cv:`proxy.config.ssl.client.verify.server.policy`
 :c:macro:`TS_CONFIG_SSL_CLIENT_SNI_POLICY`                          :ts:cv:`proxy.config.ssl.client.sni_policy`
 :c:macro:`TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS`                    :ts:cv:`proxy.config.ssl.hsts_include_subdomains`
diff --git a/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst b/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst
index 82b22d4..ced169b 100644
--- a/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst
+++ b/doc/developer-guide/api/functions/TSLifecycleHookAdd.en.rst
@@ -1,19 +1,18 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
-   or more contributor license agreements.  See the NOTICE file
-   distributed with this work for additional information
-   regarding copyright ownership.  The ASF licenses this file
-   to you under the Apache License, Version 2.0 (the
-   "License"); you may not use this file except in compliance
-   with the License.  You may obtain a copy of the License at
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed
+   with this work for additional information regarding copyright
+   ownership.  The ASF licenses this file to you under the Apache
+   License, Version 2.0 (the "License"); you may not use this file
+   except in compliance with the License.  You may obtain a copy of
+   the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
-   Unless required by applicable law or agreed to in writing,
-   software distributed under the License is distributed on an
-   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-   KIND, either express or implied.  See the License for the
-   specific language governing permissions and limitations
-   under the License.
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied.  See the License for the specific language governing
+   permissions and limitations under the License.
 
 .. include:: ../../../common.defs
 
diff --git a/doc/developer-guide/api/types/TSEvent.en.rst b/doc/developer-guide/api/types/TSEvent.en.rst
index 3104c13..8261cfc 100644
--- a/doc/developer-guide/api/types/TSEvent.en.rst
+++ b/doc/developer-guide/api/types/TSEvent.en.rst
@@ -57,6 +57,22 @@ Enumeration Members
 
 .. c:macro:: TS_EVENT_VCONN_ACTIVE_TIMEOUT
 
+.. c:macro:: TS_EVENT_VCONN_START
+
+   An inbound connection has started.
+
+.. c:macro:: TS_EVENT_VCONN_CLOSE
+
+   An inbound connection has closed.
+
+.. c:macro:: TS_EVENT_OUTBOUND_START
+
+   An outbound connection has started.
+
+.. c:macro:: TS_EVENT_OUTBOUND_CLOSE
+
+   An outbound connection has closed.
+
 .. c:macro:: TS_EVENT_NET_CONNECT
 
 .. c:macro:: TS_EVENT_NET_CONNECT_FAILED
@@ -167,21 +183,31 @@ Enumeration Members
 
 .. c:macro:: TS_EVENT_LIFECYCLE_PORTS_INITIALIZED
 
+   The internal data structures for the proxy ports have been initialized.
+
 .. c:macro:: TS_EVENT_LIFECYCLE_PORTS_READY
 
+   The proxy ports are now open for inbound connections.
+
 .. c:macro:: TS_EVENT_LIFECYCLE_CACHE_READY
 
+   The cache is ready.
+
 .. c:macro:: TS_EVENT_LIFECYCLE_SERVER_SSL_CTX_INITIALIZED
 
 .. c:macro:: TS_EVENT_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED
 
 .. c:macro:: TS_EVENT_LIFECYCLE_MSG
 
-.. c:macro:: TS_EVENT_VCONN_START
+   A message from an external source has arrived.
 
-.. c:macro:: TS_EVENT_VCONN_CLOSE
+.. c:macro:: TS_EVENT_LIFECYCLE_TASK_THREADS_READY
 
-.. c:macro:: TS_EVENT_MGMT_UPDATE
+   The ``ET_TASK`` threads are running.
+
+.. c:macro:: TS_EVENT_LIFECYCLE_SHUTDOWN
+
+   The |TS| process has is shutting down.
 
 .. c:macro:: TS_EVENT_INTERNAL_60200
 
@@ -189,6 +215,24 @@ Enumeration Members
 
 .. c:macro:: TS_EVENT_INTERNAL_60202
 
+.. c:macro:: TS_EVENT_SSL_CERT
+
+   Preparing to present a server certificate to an inbound TLS connection.
+
+.. c:macro:: TS_EVENT_SSL_SERVERNAME
+
+   The SNI name for an Inbound TLS connection has become available.
+
+.. c:macro:: TS_EVENT_SSL_VERIFY_SERVER
+
+   Outbound TLS connection certificate verification (verifying the server certificate).
+
+.. c:macro:: TS_EVENT_SSL_VERIFY_CLIENT
+
+   Inbound TLS connection certificate verification (verifying the client certificate).
+
+.. c:macro:: TS_EVENT_MGMT_UPDATE
+
 Description
 ===========
 
diff --git a/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
index 55e2b4e..938254e 100644
--- a/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
+++ b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
@@ -119,6 +119,7 @@ Enumeration Members
    .. c:macro:: TS_CONFIG_HTTP_NUMBER_OF_REDIRECTIONS
    .. c:macro:: TS_CONFIG_HTTP_CACHE_MAX_OPEN_WRITE_RETRIES
    .. c:macro:: TS_CONFIG_HTTP_REDIRECT_USE_ORIG_CACHE_KEY
+   .. c:macro:: TS_CONFIG_HTTP_REQUEST_BUFFER_ENABLED
    .. c:macro:: TS_CONFIG_HTTP_ATTACH_SERVER_SESSION_TO_CLIENT
    .. c:macro:: TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS_QUEUE
    .. c:macro:: TS_CONFIG_WEBSOCKET_NO_ACTIVITY_TIMEOUT
@@ -128,7 +129,7 @@ Enumeration Members
    .. c:macro:: TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_IN
    .. c:macro:: TS_CONFIG_SRV_ENABLED
    .. c:macro:: TS_CONFIG_HTTP_FORWARD_CONNECT_METHOD
-   .. c:macro:: TS_CONFIG_SSL_CERT_FILENAME
+   .. c:macro:: TS_CONFIG_SSL_CLIENT_CERT_FILENAME
    .. c:macro:: TS_CONFIG_SSL_CERT_FILEPATH
    .. c:macro:: TS_CONFIG_PARENT_FAILURES_UPDATE_HOSTDB
    .. c:macro:: TS_CONFIG_HTTP_CACHE_ENABLE_DEFAULT_VARY_HEADER
@@ -149,6 +150,13 @@ Enumeration Members
    .. c:macro:: TS_CONFIG_HTTP_ALLOW_HALF_OPEN
    .. c:macro:: TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MAX
    .. c:macro:: TS_CONFIG_HTTP_PER_SERVER_CONNECTION_MATCH
+   .. c:macro:: TS_CONFIG_SSL_CLIENT_VERIFY_SERVER
+   .. c:macro:: TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_POLICY
+   .. c:macro:: TS_CONFIG_SSL_CLIENT_VERIFY_SERVER_PROPERTIES
+   .. c:macro:: TS_CONFIG_SSL_CLIENT_SNI_POLICY
+   .. c:macro:: TS_CONFIG_SSL_CLIENT_PRIVATE_KEY_FILENAME
+   .. c:macro:: TS_CONFIG_SSL_CLIENT_CA_CERT_FILENAME
+
 
 Description
 ===========