Author: kkolinko
Date: Mon Nov 15 18:48:50 2010
New Revision: 1035401
URL: http://svn.apache.org/viewvc?rev=1035401&view=rev
Log:
Reformat the document.
Improve wording in several places. Print default values on separate lines, for
better readability.
Modified:
tomcat/tc6.0.x/trunk/webapps/docs/config/systemprops.xml
Modified: tomcat/tc6.0.x/trunk/webapps/docs/config/systemprops.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/config/systemprops.xml?rev=1035401&r1=1035400&r2=1035401&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/config/systemprops.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/config/systemprops.xml Mon Nov 15
18:48:50 2010
@@ -44,8 +44,8 @@
<property name="org.apache.catalina. tribes.dns_lookups">
<p>If <code>true</code>, the clustering module will attempt to use DNS to
- resolve any host names provided in the cluster configuration. If not
- specified, the default value of <code>false</code> will be used.</p>
+ resolve any host names provided in the cluster configuration.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
</properties>
@@ -55,30 +55,30 @@
<section name="Expression Language">
<properties>
- <property name="org.apache.el.parser.COERCE_TO_ZERO">
- <p>If <code>true</code>, when coercing expressions to numbers
- <code>""</code> and <code>null</code> will be coerced to zero as required
- by the specification. If not specified, the default value of
- <code>true</code> will be used.</p>
- </property>
-
- <property name="org.apache.el.BeanELResolver.CACHE_SIZE">
+ <property name="org.apache.el.BeanELResolver. CACHE_SIZE">
<p>The number of javax.el.BeanELResolver.BeanProperties objects that will
- be cached by the EL Parser. If not specified, the default of
- <code>1000</code> will be used.</p>
+ be cached by the EL Parser.</p>
+ <p>If not specified, the default of <code>1000</code> will be used.</p>
</property>
- <property name="org.apache.el.ExpressionBuilder.CACHE_SIZE">
+ <property name="org.apache.el.ExpressionBuilder. CACHE_SIZE">
<p>The number of parsed EL expressions that will be cached by the EL
- Parser. If not specified, the default of <code>5000</code> will be used.
- </p>
+ Parser.</p>
+ <p>If not specified, the default of <code>5000</code> will be used.</p>
+ </property>
+
+ <property name="org.apache.el.parser. COERCE_TO_ZERO">
+ <p>If <code>true</code>, when coercing EL expressions to numbers
+ <code>""</code> and <code>null</code> will be coerced to zero as required
+ by the specification.</p>
+ <p>If not specified, the default value of <code>true</code> will be
used.</p>
</property>
- <property name="org.apache.el.parser.SKIP_IDENTIFIER_CHECK">
- <p>If <code>true</code>, when parsing expressions, identifiers will not
be
+ <property name="org.apache.el.parser. SKIP_IDENTIFIER_CHECK">
+ <p>If <code>true</code>, when parsing EL expressions, identifiers will
not be
checked to ensure that they conform to the Java Language Specification
for
- Java identifiers. If not specified, the default value of
- <code>true</code> will be used.</p>
+ Java identifiers.</p>
+ <p>If not specified, the default value of <code>true</code> will be
used.</p>
</property>
</properties>
@@ -89,63 +89,68 @@
<property name="org.apache.jasper.compiler.
Generator.VAR_EXPRESSIONFACTORY">
<p>The name of the variable to use for the expression language expression
- factory. If not specified, the default value of
- <code>_el_expressionfactory</code> will be used.</p>
+ factory.</p>
+ <p>If not specified, the default value of
<code>_el_expressionfactory</code>
+ will be used.</p>
</property>
<property name="org.apache.jasper.compiler. Generator.VAR_INSTANCEMANAGER">
- <p>The name of the variable to use for the instance manager factory. If
- not specified, the default value of <code>_jsp_instancemanager</code>
will
- be used.</p>
+ <p>The name of the variable to use for the instance manager factory.</p>
+ <p>If not specified, the default value of
<code>_jsp_instancemanager</code>
+ will be used.</p>
</property>
<property name="org.apache.jasper.compiler. Generator.STRICT_GET_PROPERTY">
<p>If <code>true</code>, the requirement to have the object referenced in
<code>jsp:getProperty</code> action to be previously "introduced"
to the JSP processor, as specified in the chapter JSP.5.3 of JSP 2.0 and
- later specifications, is enforced. If not specified, the specification
- compliant default of <code>true</code> will be used.</p>
+ later specifications, is enforced.</p>
+ <p>If not specified, the specification compliant default of
<code>true</code>
+ will be used.</p>
</property>
<property name="org.apache.jasper.compiler. Parser.STRICT_QUOTE_ESCAPING">
<p>If <code>false</code> the requirements for escaping quotes in JSP
attributes will be relaxed so that an unescaped quote will not
- cause an error. If not specified, the specification compliant default of
+ cause an error.</p>
+ <p>If not specified, the specification compliant default of
<code>true</code> will be used.</p>
</property>
<property name="org.apache.jasper.runtime. BodyContentImpl.LIMIT_BUFFER">
<p>If <code>true</code>, any tag buffer that expands beyond
<code>org.apache.jasper.Constants.DEFAULT_TAG_BUFFER_SIZE</code> will be
- destroyed and a new buffer created of the default size. If not specified,
- the default value of <code>false</code> will be used.</p>
+ destroyed and a new buffer created of the default size.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
<property name="org.apache.jasper.runtime. JspFactoryImpl.USE_POOL">
<p>If <code>true</code>, a ThreadLocal <code>PageContext</code> pool will
- be used. If not specified, the default value of <code>true</code> will be
- used.</p>
+ be used.</p>
+ <p>If not specified, the default value of <code>true</code> will be
used.</p>
</property>
<property name="org.apache.jasper.runtime. JspFactoryImpl.POOL_SIZE">
- <p>The size of the ThreadLocal <code>PageContext</code>. If not
specified,
- the default value of <code>8</code> will be used.</p>
+ <p>The size of the ThreadLocal <code>PageContext</code>.</p>
+ <p>If not specified, the default value of <code>8</code> will be
used.</p>
</property>
<property name="org.apache.jasper.Constants. JSP_SERVLET_BASE">
- <p>The base class of the Servlets generated from the JSPs. If not
- specified, the default value of
+ <p>The base class of the Servlets generated from the JSPs.</p>
+ <p>If not specified, the default value of
<code>org.apache.jasper.runtime.HttpJspBase</code> will be used.</p>
</property>
<property name="org.apache.jasper.Constants. SERVICE_METHOD_NAME">
- <p>The name of the service method called by the base class. If not
- specified, the default value of <code>_jspService</code> will be
used.</p>
+ <p>The name of the service method called by the base class.</p>
+ <p>If not specified, the default value of <code>_jspService</code>
+ will be used.</p>
</property>
<property name="org.apache.jasper.Constants. SERVLET_CLASSPATH">
<p>The name of the ServletContext attribute that provides the classpath
- for the JSP. If not specified, the default value of
+ for the JSP.</p>
+ <p>If not specified, the default value of
<code>org.apache.catalina.jsp_classpath</code> will be used.</p>
</property>
@@ -153,42 +158,48 @@
<p>The name of the request attribute for <code><jsp-file></code>
element of a servlet definition. If present on a request, this overrides
the value returned by <code>request.getServletPath()</code> to select the
- JSP page to be executed. If not specified, the default value of
+ JSP page to be executed.</p>
+ <p>If not specified, the default value of
<code>org.apache.catalina.jsp_file</code> will be used.</p>
</property>
<property name="org.apache.jasper.Constants. PRECOMPILE">
<p>The name of the query parameter that causes the JSP engine to just
- pregenerate the servlet but not invoke it. If not specified, the default
- value of <code>org.apache.catalina.jsp_precompile</code> will be
used.</p>
+ pregenerate the servlet but not invoke it.</p>
+ <p>If not specified, the default value of
+ <code>org.apache.catalina.jsp_precompile</code> will be used.</p>
</property>
<property name="org.apache.jasper.Constants. JSP_PACKAGE_NAME">
- <p>The default package name for compiled jsp pages. If not specified, the
- default value of <code>org.apache.jsp</code> will be used.</p>
+ <p>The default package name for compiled jsp pages.</p>
+ <p>If not specified, the default value of <code>org.apache.jsp</code>
+ will be used.</p>
</property>
<property name="org.apache.jasper.Constants. TAG_FILE_PACKAGE_NAME">
- <p>The default package name for tag handlers generated from tag files. If
- not specified, the default value of <code>org.apache.jsp.tag</code> will
- be used.</p>
+ <p>The default package name for tag handlers generated from tag
files.</p>
+ <p>If not specified, the default value of <code>org.apache.jsp.tag</code>
+ will be used.</p>
</property>
<property name="org.apache.jasper.Constants. ALT_DD_ATTR">
<p>The servlet context attribute under which the alternate deployment
- descriptor for this web application is stored. If not specified, the
+ descriptor for this web application is stored.</p>
+ <p>If not specified, the
default value of <code>org.apache.catalina.deploy.alt_dd</code> will
be used.</p>
</property>
<property name="org.apache.jasper.Constants. TEMP_VARIABLE_NAME_PREFIX">
- <p>Prefix to use for generated temporary variable names. If not
specified,
+ <p>Prefix to use for generated temporary variable names.</p>
+ <p>If not specified,
the default value of <code>_jspx_temp</code> will be used.</p>
</property>
<property name="org.apache.jasper.Constants.
USE_INSTANCE_MANAGER_FOR_TAGS">
<p>If <code>true</code>, the instance manager is used to obtain tag
- handler instances. If not specified, <code>false</code> will be used.</p>
+ handler instances.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
</properties>
@@ -202,21 +213,24 @@
<property name="org.apache.catalina.connector. RECYCLE_FACADES">
<p>If this is <code>true</code> or if a security manager is in use a new
- facade object will be created for each request. If not specified, the
+ facade object will be created for each request.</p>
+ <p>If not specified, the
default value of <code>false</code> will be used.</p>
</property>
<property
name="org.apache.catalina.connector. CoyoteAdapter.ALLOW_BACKSLASH">
<p>If this is <code>true</code> the '\' character will be permitted as a
- path delimiter. If not specified, the default value of <code>false</code>
+ path delimiter.</p>
+ <p>If not specified, the default value of <code>false</code>
will be used.</p>
</property>
<property
name="org.apache.tomcat.util.buf. UDecoder.ALLOW_ENCODED_SLASH">
<p>If this is <code>true</code> '%2F' and '%5C' will be permitted as path
- delimiters. If not specified, the default value of <code>false</code>
will
+ delimiters.</p>
+ <p>If not specified, the default value of <code>false</code> will
be used.</p>
</property>
@@ -225,8 +239,8 @@
<code>true</code>, custom HTTP status messages will be used within HTTP
headers. If a custom message is specified that is not valid for use in an
HTTP header (as defined by RFC2616) then the custom message will be
- ignored and the default message used. If not specified, the default value
- of <code>false</code> will be used.</p>
+ ignored and the default message used.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
</properties>
@@ -257,22 +271,30 @@
</li>
<li>
cookies will be parsed strictly, by default v0 cookies will not work
with any invalid characters.
- <br/>If set to false, any v0 cookie with invalid character will be
switched to a v1 cookie and
- the value will be quoted.
+ <br/>If set to <code>false</code>, any v0 cookie with invalid character
+ will be switched to a v1 cookie and the value will be quoted.
</li>
<li>
- <code>ServletContext.getResource/getResourceAsStream</code> must start
with "/"<br/>
- if set to false, code like
<code>getResource("myfolder/myresource.txt")</code> will work
+ the path in <code>ServletContext.getResource</code> /
+ <code>getResourceAsStream</code> calls must start with a "/".<br/>
+ If set to <code>false</code>, code like
<code>getResource("myfolder/myresource.txt")</code> will work.
</li>
</ul>
</p>
+ <p>If this is <code>true</code> the default value will be changed for:
+ <ul>
+ <li><code>org.apache.catalina.connector.Request.
ALLOW_EMPTY_QUERY_STRING</code> property</li>
+ </ul>
+ </p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
<property
- name="org.apache.catalina. connector.Request.ALLOW_EMPTY_QUERY_STRING">
+ name="org.apache.catalina.connector. Request.ALLOW_EMPTY_QUERY_STRING">
<p>If this is <code>true</code> Tomcat will return an empty string rather
than <code>null</code> for empty query strings - i.e. query strings where
- only <code>?</code> is present. If not specified, the value of
+ only <code>?</code> is present.</p>
+ <p>If not specified, the value of
<code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> will be used
as
the default.</p>
</property>
@@ -283,17 +305,18 @@
<code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> is
<code>true</code> Tomcat will track the number of active requests for
each
session. When determining if a session is valid, any session with at
least
- one active request will always be considered valid. If not specified, the
- default value of <code>false</code> will be used.</p>
+ one active request will always be considered valid.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
-
+
<property
name="org.apache.tomcat.util.http. ServerCookie.ALLOW_EQUALS_IN_VALUE">
- <p>If this is <code>true</code> Tomcat will allow <code>=</code>
+ <p>If this is <code>true</code> Tomcat will allow '<code>=</code>'
characters when parsing unquoted cookie values. If <code>false</code>,
- cookie values containing <code>=</code> will be terminated when the
- <code>=</code> is encountered and the remainder of the cookie value will
- be dropped. If not specified, the default specification compliant value
of
+ cookie values containing '<code>=</code>' will be terminated when the
+ '<code>=</code>' is encountered and the remainder of the cookie value
will
+ be dropped.</p>
+ <p>If not specified, the default specification compliant value of
<code>false</code> will be used.</p>
</property>
@@ -302,8 +325,8 @@
<p>If this is <code>true</code> Tomcat will always add an expires
parameter to a SetCookie header even for cookies with version greater
than
zero. This is to work around a known IE6 and IE7 bug that causes IE to
- ignore the Max-Age parameter in a SetCookie header.If not specified, the
- default value of <code>true</code> will be used.</p>
+ ignore the Max-Age parameter in a SetCookie header.</p>
+ <p>If not specified, the default value of <code>true</code> will be
used.</p>
</property>
</properties>
@@ -375,47 +398,47 @@
<property name="tomcat.util.buf.StringCache.byte.enabled">
<p>If <code>true</code>, the String cache is enabled for
- <code>ByteChunk</code>. If not specified, the default value of
- <code>false</code> will be used.</p>
+ <code>ByteChunk</code>.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
<property name="tomcat.util.buf.StringCache.char.enabled">
<p>If <code>true</code>, the String cache is enabled for
- <code>CharChunk</code>. If not specified, the default value of
- <code>false</code> will be used.</p>
+ <code>CharChunk</code>.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
<property name="tomcat.util.buf.StringCache.trainThreshold">
<p>The number of times <code>toString()</code> must be called before the
- cache is activated. If not specified, the default value of
- <code>20000</code> will be used.</p>
+ cache is activated.</p>
+ <p>If not specified, the default value of <code>20000</code> will be
used.</p>
</property>
<property name="tomcat.util.buf.StringCache.cacheSize">
- <p>The size of the String cache. If not specified, the default value of
- <code>200</code> will be used.</p>
+ <p>The size of the String cache.</p>
+ <p>If not specified, the default value of <code>200</code> will be
used.</p>
</property>
<property name="tomcat.util.buf.StringCache.maxStringSize">
- <p>The maximum length of String that will be cached. If not specified,
the
- default value of <code>128</code> will be used.</p>
+ <p>The maximum length of String that will be cached.</p>
+ <p>If not specified, the default value of <code>128</code> will be
used.</p>
</property>
<property name="org.apache.tomcat.util.
http.FastHttpDateFormat.CACHE_SIZE">
- <p>The size of the cache to use parsed and formatted date value. If not
- specified, the default value of <code>1000</code> will be used.</p>
+ <p>The size of the cache to use parsed and formatted date value.</p>
+ <p>If not specified, the default value of <code>1000</code> will be
used.</p>
</property>
<property name="org.apache.tomcat.util. net.NioSelectorShared">
- <p>If <code>true</code>, use a shared selector for servlet write/read. If
- not specified, the default value of <code>true</code> will be used.</p>
+ <p>If <code>true</code>, use a shared selector for servlet
write/read.</p>
+ <p>If not specified, the default value of <code>true</code> will be
used.</p>
</property>
<property name="org.apache.catalina.startup. EXIT_ON_INIT_FAILURE">
<p>If <code>true</code>, the server will exit if an exception happens
- during the server initialization phase. The default is
<code>false</code>.</p>
+ during the server initialization phase.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</property>
-
</properties>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
