[trafficserver] 04/04: Cleanup, and added TSHttpTxnServerPush changes

[zw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zwoop pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git

commit 95fab5ca7f29013a1f4880cdd90d1919af2ea51e
Author: Leif Hedstrom <le...@ogre.com>
AuthorDate: Fri Nov 8 12:19:29 2019 -0700

    Cleanup, and added TSHttpTxnServerPush changes
---
 doc/release-notes/upgrading.en.rst | 61 ++++++++++++++++++++++----------------
 doc/release-notes/whats-new.en.rst | 34 ++++++++++++++-------
 2 files changed, 60 insertions(+), 35 deletions(-)

diff --git a/doc/release-notes/upgrading.en.rst b/doc/release-notes/upgrading.en.rst
index f7a46b8..4f6ab7f 100644
--- a/doc/release-notes/upgrading.en.rst
+++ b/doc/release-notes/upgrading.en.rst
@@ -97,50 +97,61 @@ you to avoid using any of these:
 
 Deprecated or Removed Features
 ------------------------------
-The following features, configurations and plugins are either removed or deprecated in this
-version of ATS. Deprecated features should be avoided, with the expectation that they will be
-removed in the next major release of ATS.
+The following features, configurations and plugins are either removed
+or deprecated in this version of ATS. Deprecated features should be
+avoided, with the expectation that they will be removed in the next major
+release of ATS.
 
 
 API Changes
 -----------
-Our APIs are guaranteed to be compatible within major versions, but we do make changes
-for each new major release.
+Our APIs are guaranteed to be compatible within major versions, but we do
+make changes for each new major release.
 
 Removed APIs
 ~~~~~~~~~~~~
-* `TSHttpTxnRedirectRequest()`
+* ``TSHttpTxnRedirectRequest()``
 
 Renamed or modified APIs
 ~~~~~~~~~~~~~~~~~~~~~~~~
-* `TSVConnSSLConnectionGet` is renamed to be :c:func:`TSVConnSslConnectionGet`.
+* ``TSVConnSSLConnectionGet()`` is renamed to be :c:func:`TSVConnSslConnectionGet`.
 
-Cache
------
-The cache in this releases of ATS is compatible with previous versions of ATS. You would not expect
-to lose your cache, or have to reinitialize the cache when upgrading.
+* ``TSHttpTxnServerPush()`` now returns a :type:`TSReturnCode`.
 
-However, due to changes in how remap plugins are processed, your cache key *might* change. In versions
-to v9.0.0, the first plugin in a remap rule would get the pristine URL, and subsequent plugins would
-get the remapped URL. As of v9.0.0, **all** plugins now receive the remapped URL. If you are using
-a plugin that modifies the cache key, e.g. :ref:`admin-plugins-cachekey`, if it was evaluated first
-in a remap rule, the behavior (input) changes, and therefore, cache keys can change!
 
-The old `v23` cache is no longer supported, which means caches created with ATS v2.x will no longer be
-possible to load with ATS v9.0.0 or later. We feel that this is an unlikely scenario, but if you do
-run into this, clearing the cache is required.
+Cache
+-----
+The cache in this releases of ATS is compatible with previous versions of ATS.
+You would not expect to lose your cache, or have to reinitialize the cache when
+upgrading.
+
+However, due to changes in how remap plugins are processed, your cache key
+*might* change. In versions to v9.0.0, the first plugin in a remap rule would
+get the pristine URL, and subsequent plugins would get the remapped URL. As of
+v9.0.0, **all** plugins now receive the remapped URL. If you are using a
+plugin that modifies the cache key, e.g. :ref:`admin-plugins-cachekey`, if it
+was evaluated first in a remap rule, the behavior (input) changes, and
+therefore, cache keys can change!
+
+The old ``v23`` cache is no longer supported, which means caches created with ATS
+v2.x will no longer be possible to load with ATS v9.0.0 or later. We feel that
+this is an unlikely scenario, but if you do run into this, clearing the cache
+is required.
 
 Plugins
 -------
-The following plugins have changes that might require you to change configurations.
+The following plugins have changes that might require you to change
+configurations.
 
 header_rewrite
 ~~~~~~~~~~~~~~
-* The `%{PATH}` directive is now removed, and instead you want to use `%{CLIENT-URL:PATH}`. This was
-  done to unify the behavior of these operators, rather than having this one-off directive.
+* The `%{PATH}` directive is now removed, and instead you want to use
+  `%{CLIENT-URL:PATH}`. This was  done to unify the behavior of these
+  operators, rather than having this one-off directive.
 
 Platform specific
 -----------------
-Solaris is no longer a supported platform, but the code is still there. However, it's unlikely to work,
-and unless someone takes on ownership of this Platform, it will be removed from the source in ATS v10.0.0.
-For more details, see issue #5553.
+Solaris is no longer a supported platform, but the code is still there.
+However, it's unlikely to work, and unless someone takes on ownership of this
+Platform, it will be removed from the source in ATS v10.0.0. For more details,
+see issue #5553.
diff --git a/doc/release-notes/whats-new.en.rst b/doc/release-notes/whats-new.en.rst
index 53e4841..a87b84c 100644
--- a/doc/release-notes/whats-new.en.rst
+++ b/doc/release-notes/whats-new.en.rst
@@ -21,8 +21,8 @@
 
 What's New in ATS v9.x
 =======================
-This version of ATS includes over <x> commits, from <y> pull requests. A total of <z> contributors
-have participated in this development cycle.
+This version of ATS includes over <x> commits, from <y> pull requests. A total
+of <z> contributors have participated in this development cycle.
 
 .. toctree::
    :maxdepth: 1
@@ -30,25 +30,28 @@ have participated in this development cycle.
 New Features
 ------------
 
-This version of ATS has a number of new features (details below), but we're particularly excited about
-the following features:
+This version of ATS has a number of new features (details below), but we're
+particularly excited about the following features:
 
 * Experimental QUIC support (draft 23).
 * TLS v1.3 0RTT support.
 
 PROXY protocol
 ~~~~~~~~~~~~~~
-ATS now supports the `PROXY <https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt>`_ protocol,
-on the inbound side. The incoming PROXY data gets transformed into the `Forwarded` header.
+ATS now supports the `PROXY
+<https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt>`_ protocol, on
+the inbound side. The incoming PROXY data gets transformed into the
+``Forwarded`` header.
 
 Incompatible records.config settings
 ------------------------------------
-These are the changes that are most likely to cause problems during an upgrade. Take special care
-making sure you have updated your configurations accordingly.
+These are the changes that are most likely to cause problems during an upgrade.
+Take special care making sure you have updated your configurations accordingly.
 
 Connection management
 ~~~~~~~~~~~~~~~~~~~~~
-The old settings for origin connection management included the following settings:
+The old settings for origin connection management included the following
+settings:
 
 * `proxy.config.http.origin_max_connections`
 * `proxy.config.http.origin_max_connections_queue`
@@ -72,4 +75,15 @@ Plugins
 xdebug
 ~~~~~~
 
-* A new directive, `fwd=<n>` to control the number of hops the header is forwarded for.
+* A new directive, `fwd=<n>` to control the number of hops the header is
+  forwarded for.
+
+Plugin APIs
+-----------
+
+The API for server push is promoted to stable, and modified to return an error
+code, to be consistent with other similar APIs. The new prototype is:
+
+.. code-block:: c
+
+    TSReturnCode TSHttpTxnServerPush(TSHttpTxn txnp, const char *url, int url_len);