From 5950919f7161bae7c79856689c9943a27e9da60f Mon Sep 17 00:00:00 2001
From: kkolinko <kkolinko@13f79535-47bb-0310-9956-ffa450edef68>
Date: Sat, 15 Jan 2011 19:53:47 +0000
Subject: [PATCH] Update documentation for restrictedUserAgents,
 noCompressionUserAgents attributes of HTTP connectors, because they now use a
 single regex.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1059404 13f79535-47bb-0310-9956-ffa450edef68
---
 java/org/apache/coyote/http11/AbstractHttp11Processor.java |  4 ++--
 java/org/apache/coyote/http11/AbstractHttp11Protocol.java  |  4 ++--
 webapps/docs/config/http.xml                               | 13 +++++++------
 3 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/java/org/apache/coyote/http11/AbstractHttp11Processor.java b/java/org/apache/coyote/http11/AbstractHttp11Processor.java
index 3805640fe..765c79b7b 100644
--- a/java/org/apache/coyote/http11/AbstractHttp11Processor.java
+++ b/java/org/apache/coyote/http11/AbstractHttp11Processor.java
@@ -122,7 +122,7 @@ public abstract class AbstractHttp11Processor implements ActionHook, Processor {
 
 
     /**
-     * List of restricted user agents.
+     * Regular expression that defines the restricted user agents.
      */
     protected Pattern restrictedUserAgents = null;
 
@@ -211,7 +211,7 @@ public abstract class AbstractHttp11Processor implements ActionHook, Processor {
 
 
     /**
-     * List of user agents to not use gzip with
+     * Regular expression that defines the user agents to not use gzip with
      */
     protected Pattern noCompressionUserAgents = null;
 
diff --git a/java/org/apache/coyote/http11/AbstractHttp11Protocol.java b/java/org/apache/coyote/http11/AbstractHttp11Protocol.java
index cb77d821b..a90a2794f 100644
--- a/java/org/apache/coyote/http11/AbstractHttp11Protocol.java
+++ b/java/org/apache/coyote/http11/AbstractHttp11Protocol.java
@@ -115,8 +115,8 @@ public abstract class AbstractHttp11Protocol extends AbstractProtocolHandler {
 
 
     /**
-     * User agents regular expressions which should be restricted to HTTP/1.0
-     * support.
+     * Regular expression that defines the User agents which should be
+     * restricted to HTTP/1.0 support.
      */
     private String restrictedUserAgents = null;
     public String getRestrictedUserAgents() { return restrictedUserAgents; }
diff --git a/webapps/docs/config/http.xml b/webapps/docs/config/http.xml
index b5c72e51c..4f819c5e0 100644
--- a/webapps/docs/config/http.xml
+++ b/webapps/docs/config/http.xml
@@ -383,8 +383,9 @@
     </attribute>
 
     <attribute name="noCompressionUserAgents" required="false">
-      <p>The value is a comma separated list of regular expressions matching
-      user-agents of HTTP clients for which compression should not be used,
+      <p>The value is a regular expression (using <code>java.util.regex</code>)
+      matching the <code>user-agent</code> header of HTTP clients for which
+      compression should not be used,
       because these clients, although they do advertise support for the
       feature, have a broken implementation.
       The default value is an empty String (regexp matching disabled).</p>
@@ -398,10 +399,10 @@
     </attribute>
       
     <attribute name="restrictedUserAgents" required="false">
-      <p>The value is a comma separated list of regular expressions matching
-      user-agents of HTTP clients for which HTTP/1.1 or HTTP/1.0 keep alive
-      should not be used, even if the clients advertise support for these
-      features.
+      <p>The value is a regular expression (using <code>java.util.regex</code>) matching
+      matching the <code>user-agent</code> header of HTTP clients for which
+      HTTP/1.1 or HTTP/1.0 keep alive should not be used, even if the clients
+      advertise support for these features.
       The default value is an empty String (regexp matching disabled).</p>
     </attribute>
 
-- 
2.11.0