Author: kkolinko
Date: Sun Apr 27 21:32:19 2014
New Revision: 1590497
URL: http://svn.apache.org/r1590497
Log:
Improve documentation markup.
This is partial backport of r1519668 from trunk.
Modified:
tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-interceptor.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-membership.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/loader.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/manager.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/realm.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/systemprops.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/valve.xml
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-interceptor.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-interceptor.xml?rev=1590497&r1=1590496&r2=1590497&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-interceptor.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-interceptor.xml Sun Apr 27
21:32:19 2014
@@ -41,7 +41,6 @@
</section>
<section name="Available Interceptors">
- <p>
<ul>
<li><code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code></li>
<li><code>org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor</code></li>
@@ -57,7 +56,6 @@
<li><code>org.apache.catalina.tribes.group.interceptors.GzipInterceptor</code></li>
<li><code>org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor</code></li>
</ul>
- </p>
</section>
<section name="Static Membership">
@@ -67,19 +65,15 @@
underneath the
<code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code>
interceptor.
Inside the <code>StaticMembershipInterceptor</code> you can add the static
members you wish to have.
The <code>TcpFailureDetector</code> will do a health check on the static
members,and also monitor them for crashes
- so they will have the same level of notification mechanism as the members
that are automatically discovered.
- <source>
- <Interceptor
className="org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor">
- <Member
className="org.apache.catalina.tribes.membership.StaticMember"
- port="5678"
- securePort="-1"
- host="tomcat01.mydomain.com"
- domain="staging-cluster"
-
uniqueId="{0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}"/>
- </Interceptor>
-
- </source>
- </p>
+ so they will have the same level of notification mechanism as the members
that are automatically discovered.</p>
+ <source><![CDATA[ <Interceptor
className="org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor">
+ <Member className="org.apache.catalina.tribes.membership.StaticMember"
+ port="5678"
+ securePort="-1"
+ host="tomcat01.mydomain.com"
+ domain="staging-cluster"
+ uniqueId="{0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}"/>
+ </Interceptor>]]></source>
</section>
<section name="Attributes">
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-membership.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-membership.xml?rev=1590497&r1=1590496&r2=1590497&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-membership.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/cluster-membership.xml Sun Apr 27
21:32:19 2014
@@ -98,7 +98,7 @@
a give time. The default value is <code>3000</code> ms. This means, that
if a heartbeat is not received from a
member in that timeframe, the membership component will notify the
cluster of this.<br/>
On a high latency network you may wish to increase this value, to
protect against false positives.<br/>
- Apache Tribes also provides a <a
href="cluster-interceptor.html#tcpfailuredetector"><code>TcpFailureDetector</code></a>
that will
+ Apache Tribes also provides a <a
href="cluster-interceptor.html#org.apache.catalina.tribes.group.interceptors.TcpFailureDetector_Attributes"><code>TcpFailureDetector</code></a>
that will
verify a timeout using a TCP connection when a heartbeat timeout has
occurred. This protects against false positives.
</p>
</attribute>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/loader.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/loader.xml?rev=1590497&r1=1590496&r2=1590497&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/loader.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/loader.xml Sun Apr 27 21:32:19 2014
@@ -56,13 +56,11 @@
<p>For a more in-depth description of the class loader hierarchy
that is implemented by Catalina, see <a
href="../class-loader-howto.html">the ClassLoader HowTo</a>.</p>
- <blockquote><em>
- <p>The description below uses the variable name $CATALINA_BASE to refer the
+ <p><em>The description below uses the variable name $CATALINA_BASE to
refer the
base directory against which most relative paths are resolved. If you have
not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat.</p>
- </em></blockquote>
+ the directory into which you have installed Tomcat.</em></p>
</section>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/manager.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/manager.xml?rev=1590497&r1=1590496&r2=1590497&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/manager.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/manager.xml Sun Apr 27 21:32:19
2014
@@ -195,14 +195,14 @@
element - this is required for use of <code>PersistentManager</code>.</p>
<p>This implementation of Manager supports the following attributes in
- addition to the <a href="#Common Attributes">Common Attributes</a>
+ addition to the <a href="#Common_Attributes">Common Attributes</a>
described earlier.</p>
<attributes>
<attribute name="className" required="true">
<p>It has the same meaning as described in the
- <a href="#Common Attributes">Common Attributes</a> above.
+ <a href="#Common_Attributes">Common Attributes</a> above.
You <strong>must</strong> specify
<code>org.apache.catalina.session.PersistentManager</code> to use
this manager implementation.</p>
@@ -432,8 +432,7 @@
Detailed SQL commands vary depending on the database you are using, but
a script like this will generally be required:</p>
-<source>
-create table tomcat_sessions (
+<source>create table tomcat_sessions (
session_id varchar(100) not null primary key,
valid_session char(1) not null,
max_inactive int not null,
@@ -441,8 +440,7 @@ create table tomcat_sessions (
app_name varchar(255),
session_data mediumblob,
KEY kapp_name(app_name)
-);
-</source>
+);</source>
<p>In order for the JDBC Based Store to successfully connect to your
database, the JDBC driver you configure must be visible to Tomcat's
@@ -481,7 +479,7 @@ create table tomcat_sessions (
a <a href="context.html">Context</a> configuration file for your web
application and add the following element there:</p>
- <source><Manager pathname="" /></source>
+ <source><![CDATA[<Manager pathname="" />]]></source>
</subsection>
</section>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/realm.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/realm.xml?rev=1590497&r1=1590496&r2=1590497&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/realm.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/realm.xml Sun Apr 27 21:32:19 2014
@@ -58,13 +58,11 @@
<a href="../realm-howto.html">Container-Managed Security Guide</a>.
</p>
- <blockquote><em>
- <p>The description below uses the variable name $CATALINA_BASE to refer the
+ <p><em>The description below uses the variable name $CATALINA_BASE to
refer the
base directory against which most relative paths are resolved. If you have
not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat.</p>
- </em></blockquote>
+ the directory into which you have installed Tomcat.</em></p>
</section>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/systemprops.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/systemprops.xml?rev=1590497&r1=1590496&r2=1590497&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/systemprops.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/systemprops.xml Sun Apr 27
21:32:19 2014
@@ -274,7 +274,7 @@
<property name="org.apache.catalina. STRICT_SERVLET_COMPLIANCE">
<p>The default value of this system property is <code>false</code>.</p>
- <p>If this is <code>true</code> the default values will be changed for:
+ <p>If this is <code>true</code> the default values will be changed
for:</p>
<ul>
<li><code>org.apache.catalina.core.<br/>ApplicationContext.GET_RESOURCE_REQUIRE_SLASH</code></li>
<li><code>org.apache.catalina.core.<br/>ApplicationDispatcher.WRAP_SAME_OBJECT</code></li>
@@ -293,7 +293,7 @@
<li>The <code>xmlValidation</code> attribute of any
<a href="context.html">Context</a> element.</li>
</ul>
- </p>
+
<p>Note that changing a number of the above defaults is likely to break
the majority of systems as some browsers are unable to correctly handle
the cookie headers that result from a strict adherence to the
@@ -495,7 +495,7 @@
<code>org.apache.juli.logging.UserDataHelper.SUPPRESSION_TIME</code>.
</p>
<p>The default value is <code>INFO_THEN_DEBUG</code>.</p>
- <p>The errors currently logged using this system are:
+ <p>The errors currently logged using this system are:</p>
<ul>
<li>invalid cookies;</li>
<li>invalid parameters;</li>
@@ -503,7 +503,7 @@
<code>maxHeaderCount</code> or <code>maxParameterCount</code> limits
of a <a href="http.html">connector</a>).</li>
</ul>
- Other errors triggered by invalid input data may be added to this
+ <p>Other errors triggered by invalid input data may be added to this
system in later versions.</p>
</property>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/valve.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/valve.xml?rev=1590497&r1=1590496&r2=1590497&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/valve.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/valve.xml Sun Apr 27 21:32:19 2014
@@ -42,13 +42,11 @@
Individual Valves have distinct processing capabilities, and are
described individually below.</p>
- <blockquote><em>
- <p>The description below uses the variable name $CATALINA_BASE to refer the
+ <p><em>The description below uses the variable name $CATALINA_BASE to
refer the
base directory against which most relative paths are resolved. If you have
not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat.</p>
- </em></blockquote>
+ the directory into which you have installed Tomcat.</em></p>
</section>
@@ -284,6 +282,7 @@
It is modeled after the
<a href="http://httpd.apache.org/";>Apache HTTP Server</a> log configuration
syntax:
+ </p>
<ul>
<li><b><code>%{xxx}i</code></b> for incoming headers</li>
<li><b><code>%{xxx}o</code></b> for outgoing response headers</li>
@@ -292,7 +291,6 @@
<li><b><code>%{xxx}s</code></b> xxx is an attribute in the HttpSession</li>
<li><b><code>%{xxx}t</code></b> xxx is an enhanced SimpleDateFormat
pattern</li>
</ul>
- </p>
<p>All formats supported by SimpleDateFormat are allowed in
<code>%{xxx}t</code>.
In addition the following extensions have been added:</p>
@@ -502,10 +500,8 @@
<subsection name="Example">
<p>To allow access only for the clients connecting from localhost:</p>
-<pre>
- <Valve className="org.apache.catalina.valves.RemoteAddrValve"
- allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1"/>
-</pre>
+ <source><![CDATA[<Valve
className="org.apache.catalina.valves.RemoteAddrValve"
+ allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1"/>]]></source>
</subsection>
</section>
@@ -637,7 +633,7 @@
your virtual host, and then have their identity recognized by all other
web applications on the same virtual host.</p>
- <p>See the <a href="host.html#Single Sign On">Single Sign On</a> special
+ <p>See the <a href="host.html#Single_Sign_On">Single Sign On</a> special
feature on the <strong>Host</strong> element for more information.</p>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
