Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=51294

Clarify docs for unpackWAR attribute of StandardContext

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

diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index e2f970e..15818a9 100644 (file)
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -128,6 +128,10 @@
         <bug>51229</bug>: Fix bugs in the Servlet 3.0 asynchronous examples.
         Patch provided by Eiji Takahashi. (markt)
       </fix>
+      <fix>
+        <bug>51294</bug>: Clarify behaviour of unpackWAR attribute of
+        StandardContext components. (markt)
+      </fix>
     </changelog>
   </subsection>
   <subsection name="Other">

diff --git a/webapps/docs/config/context.xml b/webapps/docs/config/context.xml
index 072915a..f877231 100644 (file)
--- a/webapps/docs/config/context.xml
+++ b/webapps/docs/config/context.xml
@@ -665,9 +665,14 @@
       </attribute>
 
       <attribute name="unpackWAR" required="false">
-        <p>If true, Tomcat will unpack all compressed web applications before
-        running them.
-        If not specified, the default value is <code>true</code>.</p>
+        <p>If <code>false</code>, the <strong>unpackWARs</strong> attribute of
+        the owning <a href="host.html">Host</a> will be overridden and the WAR
+        file will not be unpacked. If <code>true</code>, the value of the owning
+        <a href="host.html">Host</a>&apos;s <strong>unpackWARs</strong>
+        attribute will determine if the WAR is unpacked. If not specified, the
+        default value is <code>true</code>. Note that WAR files located outside
+        of a <a href="host.html">Host</a>&apos;s <strong>appBase</strong> are
+        never unpacked.</p>
       </attribute>
 
       <attribute name="useNaming" required="false">