Add note that antiJARLocking and antiResourceLocking should not be used together.
authormarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Mon, 18 Apr 2011 11:19:16 +0000 (11:19 +0000)
committermarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Mon, 18 Apr 2011 11:19:16 +0000 (11:19 +0000)
Line length

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1094490 13f79535-47bb-0310-9956-ffa450edef68

webapps/docs/config/context.xml

index c4ccae2..da2c7b2 100644 (file)
       <attribute name="antiJARLocking" required="false">
         <p>If true, the Tomcat classloader will take extra measures to avoid
         JAR file locking when resources are accessed inside JARs through URLs.
-        This will impact startup time of applications, but could prove to be useful
-        on platforms or configurations where file locking can occur.
+        This will impact startup time of applications, but could prove to be
+        useful on platforms or configurations where file locking can occur.
         If not specified, the default value is <code>false</code>.</p>
+
+        <p><code>antiJARLocking</code> is a subset of
+        <code>antiResourceLocking</code> and therefore, to prevent duplicate
+        work and possible issues, only one of these attributes should be set
+        to <code>true</code> at any one time.</p>
       </attribute>
 
       <attribute name="antiResourceLocking" required="false">
         or configurations where file locking can occur.
         If not specified, the default value is <code>false</code>.</p>
    
-        <p>Please note that setting this to <code>true</code> has some side effects,
-        including the disabling of JSP reloading in a running server: see
-        <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=37668">Bugzilla 37668</a>.
-        </p>
+        <p><code>antiJARLocking</code> is a subset of
+        <code>antiResourceLocking</code> and therefore, to prevent duplicate
+        work and possible issues, only one of these attributes should be set
+        to <code>true</code> at any one time.</p>
 
-        <p>
-        Please note that setting this flag to true in applications that are
+        <p>Please note that setting this to <code>true</code> has some side
+        effects, including the disabling of JSP reloading in a running server:
+        see <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=37668">
+        Bugzilla 37668</a>.</p>
+
+        <p>Please note that setting this flag to true in applications that are
         outside the appBase for the Host (the <code>webapps</code> directory
-        by default) will cause the application to be
-        <strong>deleted</strong> on Tomcat shutdown.  You probably don't want to
-        do this, so think twice before setting antiResourceLocking=true on a webapp
-        that's outside the appBase for its Host.
-        </p>
+        by default) will cause the application to be <strong>deleted</strong> on
+        Tomcat shutdown.  You probably don't want to do this, so think twice
+        before setting antiResourceLocking=true on a webapp that's outside the
+        appBase for its Host.</p>
       </attribute>
 
       <attribute name="cacheMaxSize" required="false">