Author: kkolinko
Date: Sun Oct 2 19:53:25 2011
New Revision: 1178242
URL: http://svn.apache.org/viewvc?rev=1178242&view=rev
Log:
CTR: documentation
Merged revisions r1177850, r1177862, r1178228, r1178233 from tomcat/trunk:
Removed wrong duplicate lines from aio.xml.
Javadoc for CometEvent: Added <br> tags to make it more readable.
Corrected markup.
Modified:
tomcat/tc6.0.x/trunk/ (props changed)
tomcat/tc6.0.x/trunk/java/org/apache/catalina/CometEvent.java
tomcat/tc6.0.x/trunk/webapps/docs/aio.xml
tomcat/tc6.0.x/trunk/webapps/docs/index.xml
tomcat/tc6.0.x/trunk/webapps/docs/manager-howto.xml
Propchange: tomcat/tc6.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Sun Oct 2 19:53:25 2011
@@ -1 +1 @@
-/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77
0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901
39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935105,935983,939491,939551,940064,941356,941463,943112,944409,944416,945231,945808,945835,945841
,946686,948057,950164,950596,950614,950851,950905,951615,953434,954435,955648,955655,956832,957130,957830,958192,960701,961948,962865,962872,962881,962900,963106,963865,963868,964614,966177-966178,966292,966692,966863,981815,988448,991837,993042,1001955,1002185,1002263,1002274,1002349,1002359,1002362,1002481,1002514,1003461,1003481,1003488,1003556,1003572,1003581,1003861,1004393,1004409,1004415,1004868-1004869,1004912,1005452,1005467,1005647,1005802,1022120,1022134,1022323,1022415,1022606,1022623,1024224,1024251,1026042,1026784,1026912,1026920,1029767,1033415,1033448,1033842,1033897,1037715,1037794,1037887,1037924,1038041,1042022,1042029,1042447,1042452,1042494,1044944,1044987,1050249,1055055,1055236,1055458,1055975,1056264,1056828,1056889,1059881,1061412,1061442,1061446,1062398,1064652,1066244,1066772,1067039,1067139,1069824,1070139,1070420,1070609,1072042,1073393,1075458,1076212,1078409,1078412,1079801,1081334,1088179,1088460,1090022,1094069,1094089,1095138,1097899,1099575
,1099586,1099772,1099789,1100145,1100822,1101094,1101144,1124680,1130774,1133014,1137862,1137996,1138950,1138953,1140693,1141104,1141441,1142043,1142904,1143134,1143150,1148216,1148471,1152601,1156519,1164567,1167394,1172233-1172234,1172236,1173614,1175158,1175190
+/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77
0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901
39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935105,935983,939491,939551,940064,941356,941463,943112,944409,944416,945231,945808,945835,945841
,946686,948057,950164,950596,950614,950851,950905,951615,953434,954435,955648,955655,956832,957130,957830,958192,960701,961948,962865,962872,962881,962900,963106,963865,963868,964614,966177-966178,966292,966692,966863,981815,988448,991837,993042,1001955,1002185,1002263,1002274,1002349,1002359,1002362,1002481,1002514,1003461,1003481,1003488,1003556,1003572,1003581,1003861,1004393,1004409,1004415,1004868-1004869,1004912,1005452,1005467,1005647,1005802,1022120,1022134,1022323,1022415,1022606,1022623,1024224,1024251,1026042,1026784,1026912,1026920,1029767,1033415,1033448,1033842,1033897,1037715,1037794,1037887,1037924,1038041,1042022,1042029,1042447,1042452,1042494,1044944,1044987,1050249,1055055,1055236,1055458,1055975,1056264,1056828,1056889,1059881,1061412,1061442,1061446,1062398,1064652,1066244,1066772,1067039,1067139,1069824,1070139,1070420,1070609,1072042,1073393,1075458,1076212,1078409,1078412,1079801,1081334,1088179,1088460,1090022,1094069,1094089,1095138,1097899,1099575
,1099586,1099772,1099789,1100145,1100822,1101094,1101144,1124680,1130774,1133014,1137862,1137996,1138950,1138953,1140693,1141104,1141441,1142043,1142904,1143134,1143150,1148216,1148471,1152601,1156519,1164567,1167394,1172233-1172234,1172236,1173614,1175158,1175190,1177850,1177862,1178228,1178233
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/CometEvent.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/CometEvent.java?rev=1178242&r1=1178241&r2=1178242&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/CometEvent.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/CometEvent.java Sun Oct 2
19:53:25 2011
@@ -34,16 +34,16 @@ public interface CometEvent {
/**
* Enumeration describing the major events that the container can invoke
- * the CometProcessors event() method with
+ * the CometProcessors event() method with.<br>
* BEGIN - will be called at the beginning
* of the processing of the connection. It can be used to initialize any
relevant
* fields using the request and response objects. Between the end of the
processing
* of this event, and the beginning of the processing of the end or error
events,
* it is possible to use the response object to write data on the open
connection.
- * Note that the response object and depedent OutputStream and Writer are
still
+ * Note that the response object and dependent OutputStream and Writer
are still
* not synchronized, so when they are accessed by multiple threads,
* synchronization is mandatory. After processing the initial event, the
request
- * is considered to be committed.
+ * is considered to be committed.<br>
* READ - This indicates that input data is available, and that one read
can be made
* without blocking. The available and ready methods of the InputStream or
* Reader may be used to determine if there is a risk of blocking: the
servlet
@@ -54,13 +54,13 @@ public interface CometEvent {
* Alternately, it is also possible to catch any exception, perform clean
up
* on any data structure the servlet may be using, and using the close
method
* of the event. It is not allowed to attempt reading data from the
request
- * object outside of the execution of this method.
+ * object outside of the execution of this method.<br>
* END - End may be called to end the processing of the request. Fields
that have
* been initialized in the begin method should be reset. After this event
has
* been processed, the request and response objects, as well as all their
dependent
* objects will be recycled and used to process other requests. End will
also be
* called when data is available and the end of file is reached on the
request input
- * (this usually indicates the client has pipelined a request).
+ * (this usually indicates the client has pipelined a request).<br>
* ERROR - Error will be called by the container in the case where an IO
exception
* or a similar unrecoverable error occurs on the connection. Fields that
have
* been initialized in the begin method should be reset. After this event
has
@@ -71,13 +71,13 @@ public interface CometEvent {
/**
- * Event details
+ * Event details.<br>
* TIMEOUT - the connection timed out (sub type of ERROR); note that this
ERROR type is not fatal, and
- * the connection will not be closed unless the servlet uses the close
method of the event
- * CLIENT_DISCONNECT - the client connection was closed (sub type of ERROR)
- * IOEXCEPTION - an IO exception occurred, such as invalid content, for
example, an invalid chunk block (sub type of ERROR)
- * WEBAPP_RELOAD - the webapplication is being reloaded (sub type of END)
- * SERVER_SHUTDOWN - the server is shutting down (sub type of END)
+ * the connection will not be closed unless the servlet uses the close
method of the event<br>
+ * CLIENT_DISCONNECT - the client connection was closed (sub type of
ERROR)<br>
+ * IOEXCEPTION - an IO exception occurred, such as invalid content, for
example, an invalid chunk block (sub type of ERROR)<br>
+ * WEBAPP_RELOAD - the webapplication is being reloaded (sub type of
END)<br>
+ * SERVER_SHUTDOWN - the server is shutting down (sub type of END)<br>
* SESSION_END - the servlet ended the session (sub type of END)
*/
public enum EventSubType { TIMEOUT, CLIENT_DISCONNECT, IOEXCEPTION,
WEBAPP_RELOAD, SERVER_SHUTDOWN, SESSION_END }
Modified: tomcat/tc6.0.x/trunk/webapps/docs/aio.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/aio.xml?rev=1178242&r1=1178241&r2=1178242&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/aio.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/aio.xml Sun Oct 2 19:53:25 2011
@@ -85,7 +85,6 @@
<li>EventType.READ: This indicates that input data is available, and that
one read can be made
without blocking. The available and ready methods of the InputStream or
Reader may be used to determine if there is a risk of blocking: the
servlet
- should read while data is reported available, and can make one
additional read
should read while data is reported available. When encountering a read
error,
the servlet should report it by propagating the exception properly.
Throwing
an exception will cause the error event to be invoked, and the
connection
@@ -124,7 +123,6 @@
method of the event.
</li>
<li>EventSubType.CLIENT_DISCONNECT: The client connection was closed (sub
type of ERROR).
- method of the event.
</li>
<li>EventSubType.IOEXCEPTION: An IO exception occurred, such as invalid
content, for example,
an invalid chunk block (sub type of ERROR).
@@ -307,7 +305,7 @@ public class ChatServlet
<source>CometEvent event.... event.setTimeout(30*1000);</source> or
<source>event.getHttpServletRequest().setAttribute("org.apache.tomcat.comet.timeout",
new Integer(30 * 1000));</source>
This sets the timeout to 30 seconds.
- Important note, in order to set this timeout, it has to be done on the
<code>BEGIN</code> event.
+ Important note: in order to set this timeout, it has to be done on the
<code>BEGIN</code> event.
The default value is <code>soTimeout</code>
</p>
<p>If you are using the APR connector, all Comet connections will have the
same timeout value. It is <code>soTimeout*50</code>
@@ -340,10 +338,10 @@ public class ChatServlet
</p>
<ul>
- <li>org.apache.tomcat.sendfile.filename: Canonical filename of the file
which will be sent as
+ <li><code>org.apache.tomcat.sendfile.filename</code>: Canonical filename of
the file which will be sent as
a String</li>
- <li>org.apache.tomcat.sendfile.start: Start offset as a Long</li>
- <li>org.apache.tomcat.sendfile.end: End offset as a Long</li>
+ <li><code>org.apache.tomcat.sendfile.start</code>: Start offset as a
Long</li>
+ <li><code>org.apache.tomcat.sendfile.end</code>: End offset as a Long</li>
</ul>
</section>
Modified: tomcat/tc6.0.x/trunk/webapps/docs/index.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/index.xml?rev=1178242&r1=1178241&r2=1178242&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/index.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/index.xml Sun Oct 2 19:53:25 2011
@@ -69,7 +69,7 @@ Apache Tomcat 6, and using many of the A
Operating the Apache Tomcat Deployer to deploy, precompile, and validate
web
applications.</li>
<li><a href="manager-howto.html"><strong>Manager</strong></a> -
- Operating the <code>Manager</code> web app to deploy, undeploy, and
+ Operating the <strong>Manager</strong> web app to deploy, undeploy, and
redeploy applications while Apache Tomcat is running.</li>
<li><a href="realm-howto.html"><strong>Realms and Access Control</strong></a>
- Description of how to configure <em>Realms</em> (databases of users,
Modified: tomcat/tc6.0.x/trunk/webapps/docs/manager-howto.xml
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/manager-howto.xml?rev=1178242&r1=1178241&r2=1178242&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/manager-howto.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/manager-howto.xml Sun Oct 2 19:53:25 2011
@@ -80,7 +80,7 @@ example:</p>
<p>If you have Tomcat configured to support multiple virtual hosts
(websites) you would need to configure a Manager for each.</p>
-<p>There are three ways to use the <code>Manager</code> web application.</p>
+<p>There are three ways to use the <strong>Manager</strong> web
application.</p>
<ul>
<li>As an application with a user interface you use in your browser.
Here is an example URL where you can replace <code>localhost</code> with
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
