Author: kkolinko
Date: Sun Apr 27 19:17:31 2014
New Revision: 1590461
URL: http://svn.apache.org/r1590461
Log:
Improving valves documentation.
Wrap Access Logging valves into a distinct section.
Modified:
tomcat/trunk/webapps/docs/changelog.xml
tomcat/trunk/webapps/docs/config/context.xml
tomcat/trunk/webapps/docs/config/engine.xml
tomcat/trunk/webapps/docs/config/host.xml
tomcat/trunk/webapps/docs/config/valve.xml
tomcat/trunk/webapps/docs/logging.xml
Modified: tomcat/trunk/webapps/docs/changelog.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/changelog.xml?rev=1590461&r1=1590460&r2=1590461&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/trunk/webapps/docs/changelog.xml Sun Apr 27 19:17:31 2014
@@ -299,6 +299,9 @@
<bug>56418</bug>: Ensure that the Manager web application does not
report success for a web application deployment that fails. (slaurent)
</fix>
+ <update>
+ Improve valves documentation. Split valves into groups. (kkolinko)
+ </update>
</changelog>
</subsection>
<subsection name="Other">
Modified: tomcat/trunk/webapps/docs/config/context.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/context.xml?rev=1590461&r1=1590460&r2=1590461&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/context.xml (original)
+++ tomcat/trunk/webapps/docs/config/context.xml Sun Apr 27 19:17:31 2014
@@ -814,7 +814,7 @@
...
</Context>]]></source>
- <p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
+ <p>See <a href="valve.html#Access_Logging">Access Logging Valves</a>
for more information on the configuration attributes that are
supported.</p>
Modified: tomcat/trunk/webapps/docs/config/engine.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/engine.xml?rev=1590461&r1=1590460&r2=1590461&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/engine.xml (original)
+++ tomcat/trunk/webapps/docs/config/engine.xml Sun Apr 27 19:17:31 2014
@@ -194,7 +194,7 @@
...
</Engine>]]></source>
- <p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
+ <p>See <a href="valve.html#Access_Logging">Access Logging Valves</a>
for more information on the configuration attributes that are
supported.</p>
Modified: tomcat/trunk/webapps/docs/config/host.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/host.xml?rev=1590461&r1=1590460&r2=1590461&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/host.xml (original)
+++ tomcat/trunk/webapps/docs/config/host.xml Sun Apr 27 19:17:31 2014
@@ -348,7 +348,7 @@
...
</Host>]]></source>
- <p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
+ <p>See <a href="valve.html#Access_Logging">Access Logging Valves</a>
for more information on the configuration attributes that are
supported.</p>
Modified: tomcat/trunk/webapps/docs/config/valve.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/valve.xml?rev=1590461&r1=1590460&r2=1590461&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/valve.xml (original)
+++ tomcat/trunk/webapps/docs/config/valve.xml Sun Apr 27 19:17:31 2014
@@ -51,7 +51,12 @@
</section>
-<section name="Access Log Valve">
+<section name="Access Logging">
+
+<p>Access logging is performed by valves that implement
+<strong>org.apache.catalina.AccessLog</strong> interface.</p>
+
+<subsection name="Access Log Valve">
<subsection name="Introduction">
@@ -336,10 +341,10 @@
</subsection>
-</section>
+</subsection>
-<section name="Extended Access Log Valve">
+<subsection name="Extended Access Log Valve">
<subsection name="Introduction">
@@ -442,6 +447,8 @@
</subsection>
+</subsection>
+
</section>
Modified: tomcat/trunk/webapps/docs/logging.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/logging.xml?rev=1590461&r1=1590460&r2=1590461&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/logging.xml (original)
+++ tomcat/trunk/webapps/docs/logging.xml Sun Apr 27 19:17:31 2014
@@ -200,7 +200,7 @@
with low overhead, so it only uses Apache Commons Logging for
its own debug messages. This implementation approach avoids
additional overhead and potentially complex configuration.
- Please refer to the <a href="config/valve.html">Valves</a>
+ Please refer to the <a href="config/valve.html#Access_Logging">Valves</a>
documentation for more details on its configuration, including
the various report formats.
</p>
@@ -395,8 +395,8 @@ java.util.logging.ConsoleHandler.formatt
<li><p>The handlers by default use the system default encoding to write
the log files. It can be configured with <code>encoding</code>
property.
See Javadoc for details.</p></li>
- <li><p>Consider configuring an <a href="config/valve.html">Access
- log</a>.</p></li>
+ <li><p>Consider configuring an
+ <a href="config/valve.html#Access_Logging">Access log</a>.</p></li>
</ul>
</subsection>
@@ -597,7 +597,7 @@ log4j.logger.org.apache.catalina.session
<strong>ExtendedAccessLogValve</strong> use their own self-contained
logging implementation, so they
<strong><i>cannot be configured to use log4j</i></strong>.
- Refer to <a href="config/valve.html#Access_Log_Valve">Valves</a>
+ Refer to <a href="config/valve.html#Access_Logging">Valves</a>
for specific configuration details.</p></li>
</ul>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
