Clarify difference between CATALINA_OPTS and

JAVA_OPTS in the scripts.

Feel free to improve wording and examples.

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

diff --git a/bin/catalina.bat b/bin/catalina.bat
index 9fa8088..be8b3f2 100755 (executable)
--- a/bin/catalina.bat
+++ b/bin/catalina.bat
@@ -28,6 +28,10 @@ rem                   the same directory that CATALINA_HOME points to.
 rem
 rem   CATALINA_OPTS   (Optional) Java runtime options used when the "start",
 rem                   or "run" command is executed.
+rem                   Include here and not in JAVA_OPTS all options, that should
+rem                   only be used by Tomcat itself, not by the stop process,
+rem                   the version command etc.
+rem                   Examples are heap size, GC logging, JMX ports etc.
 rem
 rem   CATALINA_TMPDIR (Optional) Directory path location of temporary directory
 rem                   the JVM should use (java.io.tmpdir).  Defaults to
@@ -42,6 +46,10 @@ rem                   are both set, JRE_HOME is used.
 rem
 rem   JAVA_OPTS       (Optional) Java runtime options used when the "start",
 rem                   "stop", or "run" command is executed.
+rem                   Include here and not in CATALINA_OPTS all options, thatr
+rem                   should be used by Tomcat and also by the stop process,
+rem                   the version command etc.
+rem                   Most options should go into CATALINA_OPTS.
 rem
 rem   JAVA_ENDORSED_DIRS (Optional) Lists of of semi-colon separated directories
 rem                   containing some jars in order to allow replacement of APIs 

diff --git a/bin/catalina.sh b/bin/catalina.sh
index f3a3801..cc9383d 100755 (executable)
--- a/bin/catalina.sh
+++ b/bin/catalina.sh
@@ -32,6 +32,10 @@
 #
 #   CATALINA_OPTS   (Optional) Java runtime options used when the "start",
 #                   or "run" command is executed.
+#                   Include here and not in JAVA_OPTS all options, that should
+#                   only be used by Tomcat itself, not by the stop process,
+#                   the version command etc.
+#                   Examples are heap size, GC logging, JMX ports etc.
 #
 #   CATALINA_TMPDIR (Optional) Directory path location of temporary directory
 #                   the JVM should use (java.io.tmpdir).  Defaults to
@@ -46,6 +50,10 @@
 #
 #   JAVA_OPTS       (Optional) Java runtime options used when the "start",
 #                   "stop", or "run" command is executed.
+#                   Include here and not in CATALINA_OPTS all options, thatr
+#                   should be used by Tomcat and also by the stop process,
+#                   the version command etc.
+#                   Most options should go into CATALINA_OPTS.
 #
 #   JAVA_ENDORSED_DIRS (Optional) Lists of of colon separated directories
 #                   containing some jars in order to allow replacement of APIs