Update RUNNING.txt #877
Open
Update RUNNING.txt #877
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Title: Add JVM memory configuration example for CATALINA_OPTS in RUNNING.txt Description: This PR adds a new subsection (3.5) to `RUNNING.txt` under "(3.4) Using the setenv script" to provide platform-specific examples for configuring JVM memory options using `CATALINA_OPTS`. The examples show how to set initial and maximum heap sizes (-Xms512m -Xmx2048m) for Windows and *nix systems, with a note about system resource considerations. This improves setup clarity for users, especially in production environments, aligning with Tomcat’s goal of supporting mission-critical applications. Changes: - Added subsection (3.5) to `webapps/docs/RUNNING.txt` with `CATALINA_OPTS` memory configuration examples. Testing: - Verified formatting in `RUNNING.txt` for consistency with existing style (plain text, no tabs). - Confirmed the new section renders correctly in the docs webapp at http://localhost:8080/docs/RUNNING.txt. - Tested the example `setenv` scripts to ensure Tomcat starts with the specified JVM options. Related Issues: - No specific Bugzilla issue, but addresses common user questions about memory configuration (seen in tomcat-users mailing list).
|
Is there evidence that downstream users don't know how to set their JVM settings, or that heap settings are particularly worthy of documentation? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR adds a new subsection (3.5) to
RUNNING.txtunder "(3.4) Using the setenv script" to provide platform-specific examples for configuring JVM memory options usingCATALINA_OPTS. The example shows how to set initial and maximum heap sizes (-Xms512m -Xmx2048m) for Windows and *nix systems, with a note about system resource considerations. This improves setup clarity for users, especially in production environments, aligning with Tomcat’s goal of supporting mission-critical applications.Changes:
webapps/docs/RUNNING.txtwithCATALINA_OPTSmemory configuration example.Testing:
RUNNING.txtfor consistency with existing style (plain text, no tabs).setenvscripts to ensure Tomcat starts with the specified JVM options.Related Issues: