You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by "sujaykarmakar (via GitHub)" <gi...@apache.org> on 2026/08/06 23:12:56 UTC
[PR] Added high-level README files [tomcat]
sujaykarmakar opened a new pull request, #1037:
URL: https://github.com/apache/tomcat/pull/1037
## Summary
This PR adds package-level `README.md` files for the following core Tomcat packages:
* `java/org/apache/catalina/README.md`
* `java/org/apache/coyote/README.md`
* `java/org/apache/tomcat/util/README.md`
## What’s included
Each README provides a high-level overview of the package, including:
* The package's purpose and responsibilities
* Major components and commonly used classes/interfaces
* How the package fits into Tomcat's overall architecture
* Relationships with other core packages
## Motivation
While Tomcat has comprehensive Javadocs and architecture documentation, it can take some time for new contributors to understand the role of each package when navigating the source tree. These READMEs are intended to serve as quick entry points and improve codebase discoverability without duplicating existing documentation.
## Impact
* Documentation-only change
* No code, API, or behavioral changes
* No impact on build, tests, or runtime
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: [PR] Added high-level README files [tomcat]
Posted by "markt-asf (via GitHub)" <gi...@apache.org>.
markt-asf closed pull request #1037: Added high-level README files
URL: https://github.com/apache/tomcat/pull/1037
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: [PR] Added high-level README files [tomcat]
Posted by "markt-asf (via GitHub)" <gi...@apache.org>.
markt-asf commented on PR #1037:
URL: https://github.com/apache/tomcat/pull/1037#issuecomment-5215043981
That is what package level Javadoc is for.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: [PR] Added high-level README files [tomcat]
Posted by "markt-asf (via GitHub)" <gi...@apache.org>.
markt-asf commented on PR #1037:
URL: https://github.com/apache/tomcat/pull/1037#issuecomment-5958757418
No update to move this to Javadoc in almost 2 months.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org