Document Tomcat 10/Micronaut 4 compatability (#574)

See https://github.com/micronaut-projects/micronaut-servlet/issues/276\#issuecomment-1728182009
micronaut-projects · Sep 22, 2023 · 51b4c4c · 51b4c4c
1 parent d4d5944
commit 51b4c4c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/main/docs/guide/toc.yml b/src/main/docs/guide/toc.yml
@@ -3,6 +3,7 @@ releaseHistory: Release History
 servletApi: Working with the Servlet API
 warDeployment:
   title: WAR Deployment
+  versioning: Container version considerations
   externalConfig: External Configuration
   warContext: WAR Context path
 jetty: Jetty Server

diff --git a/src/main/docs/guide/warDeployment/versioning.adoc b/src/main/docs/guide/warDeployment/versioning.adoc
@@ -0,0 +1,7 @@
+Micronaut 4.0.0 switched to using the new `jakarta.servlet` package for Servlet API classes.
+This means that Micronaut 4.0.0+ WAR files will not run on Servlet containers that do not support the `jakarta.servlet` package.
+
+For example, Tomcat 10 switched to the `jakarta.servlet` package, so Micronaut 4.0.0 is required to run as a WAR on Tomcat 10.
+And Micronaut 4.0.0 WAR files cannot be run on Tomcat 9 or earlier.
+
+If you have a Micronaut 3 based WAR file that you wish to deploy to Tomcat 10, you need to deploy it to the `$CATALINA_BASE/webapps-javaee` directory instead of the usual `$CATALINA_BASE/webapps`, and Tomcat will perform a conversion to jakarta.servlet.