Author: markt Date: Mon Jul 5 08:43:47 2021 New Revision: 1891274 URL: http://svn.apache.org/viewvc?rev=1891274&view=rev Log: Add a migration guide for 10.1.x
Added: tomcat/site/trunk/docs/migration-10.1.html (with props) tomcat/site/trunk/xdocs/migration-10.1.xml (with props) Modified: tomcat/site/trunk/docs/migration.html tomcat/site/trunk/xdocs/migration.xml Added: tomcat/site/trunk/docs/migration-10.1.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/migration-10.1.html?rev=1891274&view=auto ============================================================================== --- tomcat/site/trunk/docs/migration-10.1.html (added) +++ tomcat/site/trunk/docs/migration-10.1.html Mon Jul 5 08:43:47 2021 @@ -0,0 +1,155 @@ +<!DOCTYPE html SYSTEM "about:legacy-compat"> +<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><link href="res/css/tomcat.css" rel="stylesheet" type="text/css"><link href="res/css/fonts/fonts.css" rel="stylesheet" type="text/css"><title>Apache Tomcat® - Migration Guide - Tomcat 10.0.x</title><meta name="author" content="Apache Tomcat Project"></head><body><div id="wrapper"><header id="header"><div class="clearfix"><div class="menu-toggler pull-left" tabindex="1"><div class="hamburger"></div></div><a href="http://tomcat.apache.org/"><img class="tomcat-logo pull-left noPrint" alt="Tomcat Home" src="res/images/tomcat.png"></a><h1 class="pull-left">Apache Tomcat<sup>®</sup></h1><div class="asf-logos pull-right"><a href="https://www.apache.org/foundation/contributing.html" target="_blank" class="pull-left"><img src="https://www.apache.org/images/SupportApache-small.png" class="support-asf" alt="Support Apache"></a><a h ref="http://www.apache.org/" target="_blank" class="pull-left"><img src="res/images/asf_logo.svg" class="asf-logo" alt="The Apache Software Foundation"></a></div></div></header><main id="middle"><div><div id="mainLeft"><div id="nav-wrapper"><form action="https://www.google.com/search" method="get"><div class="searchbox"><input value="tomcat.apache.org" name="sitesearch" type="hidden"><input aria-label="Search text" placeholder="Search…" required="required" name="q" id="query" type="search"><button>GO</button></div></form><div class="asfevents"><a href="https://www.apache.org/events/current-event.html"><img src="https://www.apache.org/events/current-event-234x60.png" alt="Next ASF event"><br> + Save the date! + </a></div><nav><div><h2>Apache Tomcat</h2><ul><li><a href="./index.html">Home</a></li><li><a href="./taglibs.html">Taglibs</a></li><li><a href="./maven-plugin.html">Maven Plugin</a></li></ul></div><div><h2>Download</h2><ul><li><a href="./whichversion.html">Which version?</a></li><li><a href="https://tomcat.apache.org/download-10.cgi">Tomcat 10</a></li><li><a href="https://tomcat.apache.org/download-90.cgi">Tomcat 9</a></li><li><a href="https://tomcat.apache.org/download-80.cgi">Tomcat 8</a></li><li><a href="https://tomcat.apache.org/download-migration.cgi">Tomcat Migration Tool for Jakarta EE</a></li><li><a href="https://tomcat.apache.org/download-connectors.cgi">Tomcat Connectors</a></li><li><a href="https://tomcat.apache.org/download-native.cgi">Tomcat Native</a></li><li><a href="https://tomcat.apache.org/download-taglibs.cgi">Taglibs</a></li><li><a href="https://archive.apache.org/dist/tomcat/">Archives</a></li></ul></div><div><h2>Documentation</h2><ul><li><a href="./ tomcat-10.1-doc/index.html">Tomcat 10.1 (alpha)</a></li><li><a href="./tomcat-10.0-doc/index.html">Tomcat 10.0</a></li><li><a href="./tomcat-9.0-doc/index.html">Tomcat 9.0</a></li><li><a href="./tomcat-8.5-doc/index.html">Tomcat 8.5</a></li><li><a href="./connectors-doc/">Tomcat Connectors</a></li><li><a href="./native-doc/">Tomcat Native</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT">Wiki</a></li><li><a href="./migration.html">Migration Guide</a></li><li><a href="./presentations.html">Presentations</a></li><li><a href="https://cwiki.apache.org/confluence/x/Bi8lBg">Specifications</a></li></ul></div><div><h2>Problems?</h2><ul><li><a href="./security.html">Security Reports</a></li><li><a href="./findhelp.html">Find help</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT/FAQ">FAQ</a></li><li><a href="./lists.html">Mailing Lists</a></li><li><a href="./bugreport.html">Bug Database</a></li><li><a href="./irc.html">IRC</a></li></ul></div><div> <h2>Get Involved</h2><ul><li><a href="./getinvolved.html">Overview</a></li><li><a href="./source.html">Source code</a></li><li><a href="./ci.html">Buildbot</a></li><li><a href="https://cwiki.apache.org/confluence/x/vIPzBQ">Translations</a></li><li><a href="./tools.html">Tools</a></li></ul></div><div><h2>Media</h2><ul><li><a href="https://twitter.com/theapachetomcat">Twitter</a></li><li><a href="https://www.youtube.com/c/ApacheTomcatOfficial">YouTube</a></li><li><a href="https://blogs.apache.org/tomcat/">Blog</a></li></ul></div><div><h2>Misc</h2><ul><li><a href="./whoweare.html">Who We Are</a></li><li><a href="https://www.redbubble.com/people/comdev/works/30885254-apache-tomcat">Swag</a></li><li><a href="./heritage.html">Heritage</a></li><li><a href="http://www.apache.org">Apache Home</a></li><li><a href="./resources.html">Resources</a></li><li><a href="./contact.html">Contact</a></li><li><a href="./legal.html">Legal</a></li><li><a href="https://www.apache.org/foundation/contributing .html">Support Apache</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2 style="display: none;">Content</h2><h3 id="Table_of_Contents">Table of Contents</h3><div class="text"> +<ul><li><a href="#General">General</a></li><li><a href="#Migrating_from_10.0.x_to_10.1.x">Migrating from 10.0.x to 10.1.x</a><ol><li><a href="#Java_8_required">Java 8 required</a></li><li><a href="#Specification_APIs">Specification APIs</a></li><li><a href="#Servlet_TBD_API">Servlet TBD API</a></li><li><a href="#Server_Pages_TBD">Server Pages TBD</a></li><li><a href="#Expression_Language_TBD">Expression Language TBD</a></li><li><a href="#WebSocket_TBD">WebSocket TBD</a></li><li><a href="#Authentication_TBD">Authentication TBD</a></li><li><a href="#Internal_APIs">Internal APIs</a></li></ol></li><li><a href="#Upgrading_10.1.x">Upgrading 10.1.x</a><ol><li><a href="#Tomcat_10.1.x_noteable_changes">Tomcat 10.1.x noteable changes</a></li><li><a href="#Tomcat_10.1.x_configuration_file_differences">Tomcat 10.1.x configuration file differences</a></li></ol></li></ul> +</div><h3 id="General">General</h3><div class="text"> + +<p>Please read general <a href="migration.html">Migration Guide page</a> first, +for common considerations that apply to migration or upgrade between versions +of Apache Tomcat.</p> + +</div><h3 id="Migrating_from_10.0.x_to_10.1.x">Migrating from 10.0.x to 10.1.x</h3><div class="text"> + + <p>This section lists all the known changes between 10.0.x and 10.1.x + which may cause backwards compatibility problems when upgrading.</p> + + <div class="subsection"><h4 id="Java_8_required">Java 8 required</h4><div class="text"> + + <p>Apache Tomcat 10.1.x requires Java 8 or later. This is unchanged from + Tomcat 10.0.x.</p> + + </div></div> + + <div class="subsection"><h4 id="Specification_APIs">Specification APIs</h4><div class="text"> + + <p>Apache Tomcat 10.1 supports the Jakarta Servlet TBD, + Jakarta Server Pages TBD, Jakarta Expression Language TBD, + JakartaWebSocket TBD and Jakarta Authentication TBD + <a href="https://cwiki.apache.org/confluence/display/TOMCAT/Specifications">specifications</a>. + </p> + + </div></div> + + <div class="subsection"><h4 id="Servlet_TBD_API">Servlet TBD API</h4><div class="text"> + + <p>A new method, <code>Cookie.setAttribute(String name, String value)</code> + has been added.</p> + + </div></div> + + <div class="subsection"><h4 id="Server_Pages_TBD">Server Pages TBD</h4><div class="text"> + + <p>No changes.</p> + + </div></div> + + <div class="subsection"><h4 id="Expression_Language_TBD">Expression Language TBD</h4><div class="text"> + + <p>The EL API now uses generics where appropriate.</p> + + <p>The deprecated <code>MethodExpression.isParmetersProvided()</code> method + has been removed from the API.</p> + + </div></div> + + <div class="subsection"><h4 id="WebSocket_TBD">WebSocket TBD</h4><div class="text"> + + <p>No changes.</p> + + </div></div> + + <div class="subsection"><h4 id="Authentication_TBD">Authentication TBD</h4><div class="text"> + + <p>No changes.</p> + + </div></div> + + <div class="subsection"><h4 id="Internal_APIs">Internal APIs</h4><div class="text"> + + <p>Whilst the Tomcat 10.1 internal API is broadly compatible with Tomcat 10.0 + there have been many changes at the detail level and they are not binary + compatible. Developers of custom components that interact with Tomcat's + internals should review the JavaDoc for the relevant API.</p> + + <p>Of particular note are:</p> + <ul> + <li>All code marked as deprecated in 10.0.x has been removed.</li> + </ul> + + </div></div> + +</div><h3 id="Upgrading_10.1.x">Upgrading 10.1.x</h3><div class="text"> + + <p>When upgrading instances of Apache Tomcat from one version of Tomcat 10.1 + 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 10.1.</p> + + <div class="subsection"><h4 id="Tomcat_10.1.x_noteable_changes">Tomcat 10.1.x noteable changes</h4><div class="text"> + <p>The Tomcat developers aim for each stable patch release to be fully + backwards compatible with the previous release. Occasionally, it is + necessary to break backwards compatibility in order to fix a bug. In most + cases, these changes will go unnoticed. This section lists changes that + are not fully backwards compatible and might cause breakage when + upgrading.</p> + <ul> + <li>None</li> + </ul> + </div></div> + + <div class="subsection"><h4 id="Tomcat_10.1.x_configuration_file_differences">Tomcat 10.1.x configuration file differences</h4><div class="text"> + + <p>Select a configuration file, old version and new version from the boxes + below and then click "View differences" to see the differences. + The differences will be shown in a new tab/window.</p> + + <p><b>Note:</b> If there are no differences you will see an error page.</p> + + <form action="https://gitbox.apache.org/repos/asf" method="get" target="_blank"> + + <input type="hidden" name="p" value="tomcat.git"> + <input type="hidden" name="a" value="blobdiff"> + + <p><label>Configuration file: + <select name="f"> + <option value="conf/catalina.policy">catalina.policy</option> + <option value="conf/catalina.properties">catalina.properties</option> + <option value="conf/context.xml">context.xml</option> + <option value="conf/logging.properties">logging.properties</option> + <option value="conf/server.xml">server.xml</option> + <option value="conf/tomcat-users.xml">tomcat-users.xml</option> + <option value="conf/web.xml">web.xml</option> + </select></label> + </p> + <p><label>Old version: + <select name="hpb"> + <option value="10.1.0-M1" selected>10.1.0-M1</option> + <option value="10.1.0-M2">10.1.0-M2</option> + </select>,</label> <label>new version: + <select name="hb"> + <option value="10.1.0-M1">10.1.0-M1</option> + <option value="10.1.0-M2" selected>10.1.0-M2</option> + <option value="HEAD">trunk (unreleased)</option> + </select></label> + </p> + + <p> + <button>View Differences</button> + </p> + </form> + <p>You can also use a Git command similar to the following from within a + working copy:</p> + <div class="codeBox"><pre><code>git diff 10.1.0-M1 10.1.0-M2 -- conf/</code></pre></div> + </div></div> + +</div></div></div></div></main><footer id="footer"> + Copyright © 1999-2021, The Apache Software Foundation + <br> + Apache Tomcat, Tomcat, Apache, the Apache feather, and the Apache Tomcat + project logo are either registered trademarks or trademarks of the Apache + Software Foundation. + </footer></div><script src="res/js/tomcat.js"></script></body></html> \ No newline at end of file Propchange: tomcat/site/trunk/docs/migration-10.1.html ------------------------------------------------------------------------------ svn:eol-style = native Modified: tomcat/site/trunk/docs/migration.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/migration.html?rev=1891274&r1=1891273&r2=1891274&view=diff ============================================================================== --- tomcat/site/trunk/docs/migration.html (original) +++ tomcat/site/trunk/docs/migration.html Mon Jul 5 08:43:47 2021 @@ -24,6 +24,13 @@ and/or if any new elements have been add accordingly.</p> </div><h3 id="Migration_Guides">Migration Guides</h3><div class="text"> +<p>For upgrading between 10.1.x versions, see the +<a href="migration-10.1.html#Upgrading_10.1.x">upgrading</a> section of the Tomcat +10.1.x Migration Guide.</p> + +<p>For migration from 10.0.x to 10.1.x, see the +<a href="migration-10.1.html">Tomcat 10.1.x Migration Guide</a>.</p> + <p>For upgrading between 10.0.x versions, see the <a href="migration-10.html#Upgrading_10.0.x">upgrading</a> section of the Tomcat 10.0.x Migration Guide.</p> Added: tomcat/site/trunk/xdocs/migration-10.1.xml URL: http://svn.apache.org/viewvc/tomcat/site/trunk/xdocs/migration-10.1.xml?rev=1891274&view=auto ============================================================================== --- tomcat/site/trunk/xdocs/migration-10.1.xml (added) +++ tomcat/site/trunk/xdocs/migration-10.1.xml Mon Jul 5 08:43:47 2021 @@ -0,0 +1,167 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document> + + <properties> + <author>Apache Tomcat Project</author> + <title>Migration Guide - Tomcat 10.0.x</title> + </properties> + +<body> + +<section name="Table of Contents"> +<toc/> +</section> + +<section name="General"> + +<p>Please read general <a href="migration.html">Migration Guide page</a> first, +for common considerations that apply to migration or upgrade between versions +of Apache Tomcat.</p> + +</section> + +<section name="Migrating from 10.0.x to 10.1.x"> + + <p>This section lists all the known changes between 10.0.x and 10.1.x + which may cause backwards compatibility problems when upgrading.</p> + + <subsection name="Java 8 required"> + + <p>Apache Tomcat 10.1.x requires Java 8 or later. This is unchanged from + Tomcat 10.0.x.</p> + + </subsection> + + <subsection name="Specification APIs"> + + <p>Apache Tomcat 10.1 supports the Jakarta Servlet TBD, + Jakarta Server Pages TBD, Jakarta Expression Language TBD, + JakartaWebSocket TBD and Jakarta Authentication TBD + <a href="https://cwiki.apache.org/confluence/display/TOMCAT/Specifications">specifications</a>. + </p> + + </subsection> + + <subsection name="Servlet TBD API"> + + <p>A new method, <code>Cookie.setAttribute(String name, String value)</code> + has been added.</p> + + </subsection> + + <subsection name="Server Pages TBD"> + + <p>No changes.</p> + + </subsection> + + <subsection name="Expression Language TBD"> + + <p>The EL API now uses generics where appropriate.</p> + + <p>The deprecated <code>MethodExpression.isParmetersProvided()</code> method + has been removed from the API.</p> + + </subsection> + + <subsection name="WebSocket TBD"> + + <p>No changes.</p> + + </subsection> + + <subsection name="Authentication TBD"> + + <p>No changes.</p> + + </subsection> + + <subsection name="Internal APIs"> + + <p>Whilst the Tomcat 10.1 internal API is broadly compatible with Tomcat 10.0 + there have been many changes at the detail level and they are not binary + compatible. Developers of custom components that interact with Tomcat's + internals should review the JavaDoc for the relevant API.</p> + + <p>Of particular note are:</p> + <ul> + <li>All code marked as deprecated in 10.0.x has been removed.</li> + </ul> + + </subsection> + +</section> + +<section name="Upgrading 10.1.x"> + + <p>When upgrading instances of Apache Tomcat from one version of Tomcat 10.1 + 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 10.1.</p> + + <subsection name="Tomcat 10.1.x noteable changes"> + <p>The Tomcat developers aim for each stable patch release to be fully + backwards compatible with the previous release. Occasionally, it is + necessary to break backwards compatibility in order to fix a bug. In most + cases, these changes will go unnoticed. This section lists changes that + are not fully backwards compatible and might cause breakage when + upgrading.</p> + <ul> + <li>None</li> + </ul> + </subsection> + + <subsection name="Tomcat 10.1.x configuration file differences"> + + <p>Select a configuration file, old version and new version from the boxes + below and then click "View differences" to see the differences. + The differences will be shown in a new tab/window.</p> + + <p><b>Note:</b> If there are no differences you will see an error page.</p> + + <form action="https://gitbox.apache.org/repos/asf" + method="get" + target="_blank"> + + <input type="hidden" name="p" value="tomcat.git"/> + <input type="hidden" name="a" value="blobdiff"/> + + <p><label>Configuration file: + <select name="f"> + <option value="conf/catalina.policy">catalina.policy</option> + <option value="conf/catalina.properties">catalina.properties</option> + <option value="conf/context.xml">context.xml</option> + <option value="conf/logging.properties">logging.properties</option> + <option value="conf/server.xml">server.xml</option> + <option value="conf/tomcat-users.xml">tomcat-users.xml</option> + <option value="conf/web.xml">web.xml</option> + </select></label> + </p> + <p><label>Old version: + <select name="hpb"> + <option value="10.1.0-M1" selected="selected">10.1.0-M1</option> + <option value="10.1.0-M2">10.1.0-M2</option> + </select>,</label> <label>new version: + <select name="hb"> + <option value="10.1.0-M1">10.1.0-M1</option> + <option value="10.1.0-M2" selected="selected">10.1.0-M2</option> + <option value="HEAD">trunk (unreleased)</option> + </select></label> + </p> + + <p> + <button>View Differences</button> + </p> + </form> + <p>You can also use a Git command similar to the following from within a + working copy:</p> + <source>git diff 10.1.0-M1 10.1.0-M2 -- conf/</source> + </subsection> + +</section> + +</body> +</document> Propchange: tomcat/site/trunk/xdocs/migration-10.1.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: tomcat/site/trunk/xdocs/migration.xml URL: http://svn.apache.org/viewvc/tomcat/site/trunk/xdocs/migration.xml?rev=1891274&r1=1891273&r2=1891274&view=diff ============================================================================== --- tomcat/site/trunk/xdocs/migration.xml (original) +++ tomcat/site/trunk/xdocs/migration.xml Mon Jul 5 08:43:47 2021 @@ -33,6 +33,13 @@ accordingly.</p> <section name="Migration Guides"> +<p>For upgrading between 10.1.x versions, see the +<a href="migration-10.1.html#Upgrading_10.1.x">upgrading</a> section of the Tomcat +10.1.x Migration Guide.</p> + +<p>For migration from 10.0.x to 10.1.x, see the +<a href="migration-10.1.html">Tomcat 10.1.x Migration Guide</a>.</p> + <p>For upgrading between 10.0.x versions, see the <a href="migration-10.html#Upgrading_10.0.x">upgrading</a> section of the Tomcat 10.0.x Migration Guide.</p> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org