[trafficserver] branch master updated: Update the docs to be a bit more clear about config behavior

[zw...@apache.org]

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

zwoop 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 43cc156  Update the docs to be a bit more clear about config behavior
43cc156 is described below

commit 43cc1566b6134fa1708e98234e7d89cca8da8ea9
Author: Leif Hedstrom <zw...@apache.org>
AuthorDate: Mon Dec 18 16:18:44 2017 -0700

    Update the docs to be a bit more clear about config behavior
    
    Also fixes a typo or two in the markdown.
---
 doc/admin-guide/plugins/gzip.en.rst | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/doc/admin-guide/plugins/gzip.en.rst b/doc/admin-guide/plugins/gzip.en.rst
index 59b03dd..42750e2 100644
--- a/doc/admin-guide/plugins/gzip.en.rst
+++ b/doc/admin-guide/plugins/gzip.en.rst
@@ -155,11 +155,14 @@ will leave the header intact if the client provided it.
 supported-algorithms
 ----------------------
 
-Provides the compression algorithms that are supported. This will allow |TS| to selectively
-support gzip, deflate, and brotli compression. The default is gzip. Multiple algorthims can be selected using ',' delimiter,
-for instance, ``supported-algorithms deflate,gzip,br``. Note that if
-ts:cv:`proxy.config.http.normalize_ae` is ``1``, only gzip will be
-considered, and if it is ``2``, only br or gzip will be considered.
+Provides the compression algorithms that are supported, a comma separate list
+of values. This will allow |TS| to selectively support ``gzip``, ``deflate``,
+and brotli (``br``) compression. The default is ``gzip``. Multiple algorithms can
+be selected using ',' delimiter, for instance, ``supported-algorithms
+deflate,gzip,br``. Note that this list must **not** contain any white-spaces!
+
+Note that if :ts:cv:`proxy.config.http.normalize_ae` is ``1``, only gzip will
+be considered, and if it is ``2``, only br or gzip will be considered.
 
 Examples
 ========

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>'].