Add an upgrade page to the documentation that can be used to determine the changes...
authormarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Sat, 25 Jun 2011 17:47:46 +0000 (17:47 +0000)
committermarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Sat, 25 Jun 2011 17:47:46 +0000 (17:47 +0000)
git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1139576 13f79535-47bb-0310-9956-ffa450edef68

webapps/docs/changelog.xml
webapps/docs/project.xml
webapps/docs/upgrading.xml [new file with mode: 0644]

index c22fada..996179d 100644 (file)
         Add <code>session="false"</code> directive to the index page of the
         ROOT web application. (kkolinko)
       </fix>
+      <add>
+        Add an upgrade page to the documentation that can be used to determine
+        the changes in any of the configuration files between two given
+        versions. (markt)
+      </add>
     </changelog>
   </subsection>
   <subsection name="Other">
index 42ad12b..bc6fe41 100644 (file)
@@ -70,6 +70,7 @@
         <item name="29) Windows Service"    href="windows-service-howto.html"/>
         <item name="30) Windows Authentication"   
               href="windows-auth-howto.html"/>
+        <item name="31) Upgrading"          href="upgrading.html"/>
     </menu>
 
     <menu name="Reference">
diff --git a/webapps/docs/upgrading.xml b/webapps/docs/upgrading.xml
new file mode 100644 (file)
index 0000000..7e96819
--- /dev/null
@@ -0,0 +1,125 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document [
+  <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="upgrading.html">
+
+    &project;
+
+    <properties>
+      <title>Upgrading</title>
+    </properties>
+
+<body>
+
+<section name="Table of Contents">
+<toc/>
+</section>
+
+<section name="Overview">
+<p>When upgrading instances of Apache Tomcat from one version of Tomcat 7 to
+another, particularly when using separate locations for $CATALINA_HOME and
+$CATALINA_BASE, it is necessary to ensure that any changes in the configuration
+files such as new attributes and changes to defaults are applied as part of the
+upgrade. To assist with the identification of these changes, the form below may
+be used to view the differences between the configuration files in different
+versions of Tomcat 7.</p>
+</section>
+
+<section name="Configuration file differences">
+
+<p>Select a configuration file, old version and new version from the boxes
+below and then click &quot;View differences&quot; to see the differences. The
+differences will be shown in a new tab/window.</p>
+
+<script type="text/javascript" language="JavaScript">
+function updateActionUrl() {
+  document.versions.action = document.file.file.value;
+  return true;
+}
+</script>
+
+<form name="file" action="not-used">
+<p>Configuration file:
+<select name="file">
+<option
+  value="http://svn.apache.org/viewvc/tomcat/trunk/conf/catalina.policy">
+  catalina.policy</option>
+<option
+  value="http://svn.apache.org/viewvc/tomcat/trunk/conf/catalina.properties">
+  catalina.properties</option>
+<option
+  value="http://svn.apache.org/viewvc/tomcat/trunk/conf/context.xml">
+  context.xml</option>
+<option
+  value="http://svn.apache.org/viewvc/tomcat/trunk/conf/logging.properties">
+  logging.properties</option>
+<option
+  value="http://svn.apache.org/viewvc/tomcat/trunk/conf/server.xml">
+  server.xml</option>
+<option
+  value="http://svn.apache.org/viewvc/tomcat/trunk/conf/tomcat-users.xml">
+  tomcat-users.xml</option>
+<option
+  value="http://svn.apache.org/viewvc/tomcat/trunk/conf/web.xml">
+  web.xml</option>
+</select>
+</p>
+</form>
+<form name="versions" action="to-be-replaced" method="get" target="_blank">
+<p>Old version:
+<input type="hidden" name="diff_format" value="h"/>
+<select name="r1">
+<option value="954232">7.0.0</option>
+<option value="982035">7.0.2</option>
+<option value="1022637">7.0.4</option>
+<option value="1038717">7.0.5</option>
+<option value="1057288">7.0.6</option>
+<option value="1067169">7.0.8</option>
+<option value="1078282">7.0.10</option>
+<option value="1080182">7.0.11</option>
+<option value="1087797">7.0.12</option>
+<option value="1101230">7.0.14</option>
+<option value="1134562">7.0.16</option>
+</select>
+</p>
+<p>New version:
+<select name="r2">
+<option value="954232">7.0.0</option>
+<option value="982035">7.0.2</option>
+<option value="1022637">7.0.4</option>
+<option value="1038717">7.0.5</option>
+<option value="1057288">7.0.6</option>
+<option value="1067169">7.0.8</option>
+<option value="1078282">7.0.10</option>
+<option value="1080182">7.0.11</option>
+<option value="1087797">7.0.12</option>
+<option value="1101230">7.0.14</option>
+<option value="1134562">7.0.16</option>
+</select>
+</p>
+<p>
+<input type="submit" value="View Differences"
+       onClick="return updateActionUrl();"/>
+</p>
+</form>
+</section>
+
+</body>
+</document>