[trafficserver] 02/02: Clarify settion when used with API

[ml...@apache.org]

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

mlibbey pushed a commit to branch master
in repository https://git-dual.apache.org/repos/asf/trafficserver.git

commit a918487fea6e024ccc73979bd5856b00cc670c40
Author: Miles Libbey <ml...@apache.org>
AuthorDate: Wed Jun 15 13:15:37 2016 -0700

    Clarify settion when used with API
    
    When using an API (or plugin like header_rewrite or conf_remap),
    proxy.config.http.server_session_sharing.match needs to be set to
    an INT.
---
 doc/admin-guide/files/records.config.en.rst | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index c805df1..2ddce00 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -874,13 +874,19 @@ Value Effect
    ======== ===================================================================
    Value    Description
    ======== ===================================================================
-   ``none`` Do not match and do not re-use server sessions.
+   ``none`` Do not match and do not re-use server sessions. If using this in
+            :ref:`ts-overridable-config` (like the :ref:`admin-plugins-conf-remap`),
+            use the integer ``0`` instead.
+   ``both`` Re-use server sessions, if *both* the IP address and fully qualified
+            domain name match. If using this in :ref:`ts-overridable-config` (like
+            the :ref:`admin-plugins-conf-remap`), use the integer ``1`` instead.
    ``ip``   Re-use server sessions, checking only that the IP address and port
-            of the origin server matches.
+            of the origin server matches. If using this in
+            :ref:`ts-overridable-config` (like the :ref:`admin-plugins-conf-remap`),
+            use the integer ``2`` instead.
    ``host`` Re-use server sessions, checking only that the fully qualified
-            domain name matches.
-   ``both`` Re-use server sessions, if *both* the IP address and fully qualified
-            domain name match.
+            domain name matches. If using this in :ref:`ts-overridable-config`
+            (like the :ref:`admin-plugins-conf-remap`), use the integer ``3`` instead.
    ======== ===================================================================
 
    It is strongly recommended to use either ``none`` or ``both`` for this value

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