trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From zw...@apache.org
Subject [trafficserver] branch 9.0.x updated: Cleaned up indentation etc.
Date Mon, 23 Dec 2019 23:43:08 GMT
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


The following commit(s) were added to refs/heads/9.0.x by this push:
     new ddb5956  Cleaned up indentation etc.
ddb5956 is described below

commit ddb59564a3393ec22d0ca964b99f2b8fa34a4eb0
Author: Leif Hedstrom <leif@ogre.com>
AuthorDate: Mon Dec 23 16:42:54 2019 -0700

    Cleaned up indentation etc.
---
 doc/release-notes/upgrading.en.rst | 76 ++++++++++++++++++--------------------
 doc/release-notes/whats-new.en.rst | 41 ++++++++++----------
 2 files changed, 56 insertions(+), 61 deletions(-)

diff --git a/doc/release-notes/upgrading.en.rst b/doc/release-notes/upgrading.en.rst
index 6ad85ab..a46bef5 100644
--- a/doc/release-notes/upgrading.en.rst
+++ b/doc/release-notes/upgrading.en.rst
@@ -28,16 +28,15 @@ Upgrading to ATS v9.x
 Remapping
 ---------
 
-One of the biggest changes in ATS v9.0.0 is that URL rewrites, as specified in a :file:`remap.config`
-rule, now always happens **before** all plugins are executed. This can have significant impact
on
-behavior, since plugins might now see a different URL than they did in prior versions. In
particular,
-plugins modifying the cache key could have serious problems (see the  section below for details).
+One of the biggest changes in ATS v9.0.0 is that URL rewrites, as specified in a :file:`remap.config`
rule, now always happens
+**before** all plugins are executed. This can have significant impact on behavior, since
plugins might now see a different URL than
+they did in prior versions. In particular, plugins modifying the cache key could have serious
problems (see the section below for
+details).
 
 YAML
 ----
 
-We are moving configurations over to YAML, and thus far, the following configurations are
now fully
-migrated over to YAML:
+We are moving configurations over to YAML, and thus far, the following configurations are
now fully migrated over to YAML:
 
 * :file:`logging.yaml` (*was* `logging.config` or `logging.lua`)
 * :file:`ip_allow.yaml` (*was* `ip_allow.config`)
@@ -49,11 +48,12 @@ In addition, a new file for TLS handhsake negotiation configuration is
added:
 New 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:
 
 * `proxy.config.http.origin_max_connections`
@@ -79,9 +79,9 @@ The following settings are simply gone, and have no purpose:
 
 Deprecated records.config settings
 ----------------------------------
-The following configurations still exist, and functions, but are considered
-deprecated and will be removed in a future release. We **strongly** encourage
-you to avoid using any of these:
+
+The following configurations still exist, and functions, but are considered deprecated and
will be removed in a future release. We
+**strongly** encourage you to avoid using any of these:
 
   * :ts:cv:`proxy.config.socks.socks_config_file`
   * :ts:cv:`proxy.config.log.config.filename`
@@ -97,23 +97,24 @@ 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()``
 
 Renamed or modified APIs
 ~~~~~~~~~~~~~~~~~~~~~~~~
+
 * ``TSVConnSSLConnectionGet()`` is renamed to be :c:func:`TSVConnSslConnectionGet`
 
 * ``TSHttpTxnServerPush()`` now returns a :c:type:`TSReturnCode`
@@ -121,37 +122,32 @@ Renamed or modified APIs
 
 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.
+
+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.
 
 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 7fa7ec9..d556dfa 100644
--- a/doc/release-notes/whats-new.en.rst
+++ b/doc/release-notes/whats-new.en.rst
@@ -21,49 +21,49 @@
 
 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
 
 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.
 
 Developer features
 ~~~~~~~~~~~~~~~~~~
-* Add support for dtrace style markers (SDT) and include a few markers at
-  locations of interest to users of SystemTap, dtrace, and gdb.
-  See :ref:`developer-debug-builds`.
+
+* Add support for dtrace style markers (SDT) and include a few markers at locations of interest
to users of SystemTap, dtrace, and
+  gdb. See :ref:`developer-debug-builds`.
 
 Command line tools
 ~~~~~~~~~~~~~~~~~~
-* The :program:`traffic_server` program now has two new maintenance
-  commands: ``verify_global_plugin`` and ``verify_remap_plugin``.
-  These commands load a  plugin's shared object file and verify it meets
-  minimal global or remap plugin API requirements.
+
+* The :program:`traffic_server` program now has two new maintenance commands: ``verify_global_plugin``
and ``verify_remap_plugin``.
+  These commands load a plugin's shared object file and verify it meets minimal global or
remap plugin API requirements.
 
 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.
 
 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`
@@ -87,14 +87,13 @@ 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:
+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
 


Mime
View raw message