Bug 50294 - Mention obvious things about config format
Summary: Mention obvious things about config format
Alias: None
Product: Tomcat 7
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: All All
: P4 enhancement (vote)
Target Milestone: ---
Assignee: Tomcat Developers Mailing List
Depends on:
Reported: 2010-11-18 17:10 UTC by Luke Meyer
Modified: 2010-11-24 15:02 UTC (History)
0 users

diff against http://svn.apache.org/repos/asf/tomcat/trunk/webapps/docs (891 bytes, patch)
2010-11-18 17:10 UTC, Luke Meyer
Details | Diff
diff against http://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk/webapps/docs (891 bytes, patch)
2010-11-18 17:11 UTC, Luke Meyer
Details | Diff
diff against http://svn.apache.org/repos/asf/tomcat/tc5.5.x/trunk/container/webapps/docs (891 bytes, patch)
2010-11-18 17:12 UTC, Luke Meyer
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Luke Meyer 2010-11-18 17:10:14 UTC
Created attachment 26311 [details]
diff against http://svn.apache.org/repos/asf/tomcat/trunk/webapps/docs

It might be obvious to those who work on Tomcat, but sometimes things need to be spelled out for others. I suggest mentioning at the top of the config section that configs are schemaless XML and case-sensitive. Patches created against the docs webapps in 5.5, 6.0, and trunk that are basically like this:

--- config/index.xml    (revision 1036202)
+++ config/index.xml    (working copy)

-<p>The Tomcat configuration files support Apache Ant style variable
-substitution. A system property with the name <code>propname</code> may be
+<p>Tomcat configuration files are formatted as schemaless XML; elements and
+attributes are case-sensitive. Apache Ant-style variable substitution
+is supported; a system property with the name <code>propname</code> may be
 used in a configuration file using the syntax <code>${propname}</code>. All
Comment 3 Mark Thomas 2010-11-24 15:02:12 UTC
Many thanks for the patches. The updated docs will be included in 7.0.6, 6.0.30 and 5.5.32