Author: kkolinko
Date: Thu Apr 22 17:17:27 2010
New Revision: 936971
URL: http://svn.apache.org/viewvc?rev=936971&view=rev
Log:
Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=49028
Include a more explicit section on patch submission
Modified:
tomcat/site/trunk/docs/bugreport.html
tomcat/site/trunk/xdocs/bugreport.xml
Modified: tomcat/site/trunk/docs/bugreport.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/bugreport.html?rev=936971&r1=936970&r2=936971&view=diff
==============================================================================
--- tomcat/site/trunk/docs/bugreport.html (original)
+++ tomcat/site/trunk/docs/bugreport.html Thu Apr 22 17:17:27 2010
@@ -212,11 +212,11 @@
<li>
<a href="#Recent version">Recent version</a>
</li>
+</ol>
+</li>
<li>
<a href="#Recently fixed issues">Recently fixed issues</a>
</li>
-</ol>
-</li>
<li>
<a href="#Reporting Apache Tomcat bugs">Reporting Apache Tomcat bugs</a>
<ol>
@@ -336,16 +336,16 @@ problem you are having before reporting
<blockquote>
<p>
<li>
-<b>Documentation</b> - Review the documentation for the version
- of Apache Tomcat you are using. The problem you are having may already
- be addressed in the docs.</li>
+<b>Documentation</b> – Review the documentation for the version
+ of Apache Tomcat that you are using. The problem that you are
+ facing may already be addressed in the docs.</li>
<li>
-<b>Logs</b> - The logs which Apache Tomcat generates can be a valuable
+<b>Logs</b> – The logs which Apache Tomcat generates can be a valuable
resource when trying to diagnose a problem. Please review them.
You may want to enable debug output in your Apache Tomcat configuration
so that you have more information to help diagnose the problem.</li>
<li>
-<b>FAQ's</b> - Search the <a href="http://wiki.apache.org/tomcat/FAQ";>
+<b>FAQ's</b> – Search the <a href="http://wiki.apache.org/tomcat/FAQ";>
Tomcat Frequently Asked Questions</a>.</li>
</p>
</blockquote>
@@ -484,10 +484,19 @@ problem you are having before reporting
</td>
</tr>
</table>
-
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
+</blockquote>
+</p>
+</td>
+</tr>
<tr>
-<td bgcolor="#828DA6">
+<td>
+<br/>
+</td>
+</tr>
+</table>
+<table border="0" cellspacing="0" cellpadding="2" width="100%">
+<tr>
+<td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Recently fixed issues">
<strong>Recently fixed issues</strong>
@@ -497,6 +506,7 @@ problem you are having before reporting
</tr>
<tr>
<td>
+<p>
<blockquote>
<p>The <em>Changelog</em> pages list the problems fixed in released
@@ -537,16 +547,6 @@ problem you are having before reporting
<a
href="http://svn.apache.org/viewvc/tomcat/tc5.5.x/trunk/STATUS.txt?view=markup";>Tomcat
5.5</a>
</li>
</ul>
- </blockquote>
-</td>
-</tr>
-<tr>
-<td>
-<br/>
-</td>
-</tr>
-</table>
-
</blockquote>
</p>
</td>
@@ -576,59 +576,76 @@ bug in your web application.</p>
<p>Please provide as much information as possible. It is
very hard to fix a bug if the person looking into the problem cannot
-reproduce it. Here is a listing of information which should be included:
+reproduce it. Here is a listing of information which should be included:</p>
<ul>
<li>Environment details:
<ul>
<li>
-<b>Version</b> - Apache Tomcat version, if from a nightly build,
+<b>Version</b> – Apache Tomcat version, if from a nightly build,
version and date of build. Please not only select the version from a
list, but also repeat it in the text of your bug report.</li>
<li>
-<b>Platform</b> and <b>OS</b> - Hardware platform and operating system
+<b>Platform</b> and <b>OS</b> – Hardware platform and operating system
Tomcat is running on.</li>
<li>
-<b>Java version</b> - Vendor and version of your Java Runtime
+<b>Java version</b> – Vendor and version of your Java Runtime
Environment used to run Tomcat.</li>
</ul>
</li>
<li>Configuration:
<ul>
<li>
-<b>Component</b> - Apache Tomcat component which has the bug.
+<b>Component</b> – Apache Tomcat component which has the bug.
If you do not know, just guess.</li>
<li>
-<b>Web Server</b> - Web Server and version, Apache Tomcat Connector
+<b>Web Server</b> – Web Server and version, Apache Tomcat Connector
and version.</li>
<li>
-<b>Configuration</b> - Attach configuration files if they would
- help track down the bug.</li>
+<b>Configuration</b> – Attach configuration files if they would
+ help to track down the bug.</li>
</ul>
</li>
<li>Evidences:
<ul>
<li>
-<b>Log file excerpts</b> - Review your logs files, reproduce the bug
+<b>Log file excerpts</b> – Review your logs files, reproduce the bug
with debugging enabled in your Apache Tomcat configuration. Then submit
- any relevant sections of the log which help document the bug.</li>
+ any relevant sections of the log which help to document the bug.</li>
<li>
-<b>Stack Traces</b> - Any stack traces generated by the bug.</li>
+<b>Stack Traces</b> – Any stack traces generated by the bug.</li>
</ul>
</li>
<li>
-<b>Example</b> - Example configuration files or web applications which
+<b>Example</b> – Example configuration files or web applications which
demonstrate the bug. When submitting an example which reproduces the bug,
please try to make it as simple as possible.</li>
<li>
-<b>Bug Fix Patch</b> - A patch created using <code>diff -u</code> or
- <code>svn diff</code> which fixes the bug.
- (If you have found a bug fix which can be applied to the Apache Tomcat
code)</li>
+<b>Bug Fix Patch</b> – A patch that fixes the issue, if you know
+ how to fix it.</li>
<li>
-<b>Miscellaneous</b> - Any other information you feel will help track
- down the problem. For example other Java API's and versions being used
- with Apache Tomcat.</li>
+<b>Miscellaneous</b> – Any other information that you feel will help
+ to track down the problem. For example other Java API's and versions being
+ used with Apache Tomcat.</li>
</ul>
+<p>
+Enhancements for Tomcat are submitted using the same procedure, but in the
+<b>Severity</b> field you will select the value "<code>enhancement</code>".
+</p>
+
+<p>
+Any patches are welcome, but we prefer the ones that use the
+<a href="http://en.wikipedia.org/wiki/Diff#Unified_format";>Unified Diff</a>
+format. Those can be generated using <code>diff -u</code> command, or, if you
+have obtained the Tomcat sources from the <a href="svn.html">Subversion
+repository</a>, using the <code>svn diff</code> command.
+For more information on Subversion and how to use it, see
+<a href="http://svnbook.red-bean.com/";> the Subversion Book.</a>
+When providing a patch, please mention to which version of the sources it
+applies.
+</p>
+
+<p>
Report an Apache Tomcat 7 bug
<a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Tomcat%207";>
here</a>.<br/>
Modified: tomcat/site/trunk/xdocs/bugreport.xml
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/xdocs/bugreport.xml?rev=936971&r1=936970&r2=936971&view=diff
==============================================================================
--- tomcat/site/trunk/xdocs/bugreport.xml (original)
+++ tomcat/site/trunk/xdocs/bugreport.xml Thu Apr 22 17:17:27 2010
@@ -44,14 +44,14 @@ problem you are having before reporting
<subsection name="Problem trouble shooting">
<p>
- <li><b>Documentation</b> - Review the documentation for the version
- of Apache Tomcat you are using. The problem you are having may already
- be addressed in the docs.</li>
- <li><b>Logs</b> - The logs which Apache Tomcat generates can be a valuable
+ <li><b>Documentation</b> – Review the documentation for the version
+ of Apache Tomcat that you are using. The problem that you are
+ facing may already be addressed in the docs.</li>
+ <li><b>Logs</b> – The logs which Apache Tomcat generates can be a
valuable
resource when trying to diagnose a problem. Please review them.
You may want to enable debug output in your Apache Tomcat configuration
so that you have more information to help diagnose the problem.</li>
- <li><b>FAQ's</b> - Search the <a href="http://wiki.apache.org/tomcat/FAQ";>
+ <li><b>FAQ's</b> – Search the <a
href="http://wiki.apache.org/tomcat/FAQ";>
Tomcat Frequently Asked Questions</a>.</li>
</p>
</subsection>
@@ -97,8 +97,9 @@ problem you are having before reporting
Apache Tomcat.</p>
</subsection>
+</section>
- <subsection name="Recently fixed issues">
+<section name="Recently fixed issues">
<p>The <em>Changelog</em> pages list the problems fixed in released
versions of Tomcat. They can be found in Documentation:</p>
@@ -138,8 +139,6 @@ problem you are having before reporting
<a
href="http://svn.apache.org/viewvc/tomcat/tc5.5.x/trunk/STATUS.txt?view=markup";>Tomcat
5.5</a>
</li>
</ul>
- </subsection>
-
</section>
<section name="Reporting Apache Tomcat bugs">
@@ -148,48 +147,65 @@ bug in your web application.</p>
<p>Please provide as much information as possible. It is
very hard to fix a bug if the person looking into the problem cannot
-reproduce it. Here is a listing of information which should be included:
+reproduce it. Here is a listing of information which should be included:</p>
<ul>
<li>Environment details:
<ul>
- <li><b>Version</b> - Apache Tomcat version, if from a nightly build,
+ <li><b>Version</b> – Apache Tomcat version, if from a nightly build,
version and date of build. Please not only select the version from a
list, but also repeat it in the text of your bug report.</li>
- <li><b>Platform</b> and <b>OS</b> - Hardware platform and operating
system
+ <li><b>Platform</b> and <b>OS</b> – Hardware platform and operating
system
Tomcat is running on.</li>
- <li><b>Java version</b> - Vendor and version of your Java Runtime
+ <li><b>Java version</b> – Vendor and version of your Java Runtime
Environment used to run Tomcat.</li>
</ul>
</li>
<li>Configuration:
<ul>
- <li><b>Component</b> - Apache Tomcat component which has the bug.
+ <li><b>Component</b> – Apache Tomcat component which has the bug.
If you do not know, just guess.</li>
- <li><b>Web Server</b> - Web Server and version, Apache Tomcat Connector
+ <li><b>Web Server</b> – Web Server and version, Apache Tomcat
Connector
and version.</li>
- <li><b>Configuration</b> - Attach configuration files if they would
- help track down the bug.</li>
+ <li><b>Configuration</b> – Attach configuration files if they would
+ help to track down the bug.</li>
</ul>
</li>
<li>Evidences:
<ul>
- <li><b>Log file excerpts</b> - Review your logs files, reproduce the bug
+ <li><b>Log file excerpts</b> – Review your logs files, reproduce
the bug
with debugging enabled in your Apache Tomcat configuration. Then submit
- any relevant sections of the log which help document the bug.</li>
- <li><b>Stack Traces</b> - Any stack traces generated by the bug.</li>
+ any relevant sections of the log which help to document the bug.</li>
+ <li><b>Stack Traces</b> – Any stack traces generated by the
bug.</li>
</ul>
</li>
- <li><b>Example</b> - Example configuration files or web applications which
+ <li><b>Example</b> – Example configuration files or web applications
which
demonstrate the bug. When submitting an example which reproduces the bug,
please try to make it as simple as possible.</li>
- <li><b>Bug Fix Patch</b> - A patch created using <code>diff -u</code> or
- <code>svn diff</code> which fixes the bug.
- (If you have found a bug fix which can be applied to the Apache Tomcat
code)</li>
- <li><b>Miscellaneous</b> - Any other information you feel will help track
- down the problem. For example other Java API's and versions being used
- with Apache Tomcat.</li>
+ <li><b>Bug Fix Patch</b> – A patch that fixes the issue, if you know
+ how to fix it.</li>
+ <li><b>Miscellaneous</b> – Any other information that you feel will help
+ to track down the problem. For example other Java API's and versions being
+ used with Apache Tomcat.</li>
</ul>
+<p>
+Enhancements for Tomcat are submitted using the same procedure, but in the
+<b>Severity</b> field you will select the value "<code>enhancement</code>".
+</p>
+
+<p>
+Any patches are welcome, but we prefer the ones that use the
+<a href="http://en.wikipedia.org/wiki/Diff#Unified_format";>Unified Diff</a>
+format. Those can be generated using <code>diff -u</code> command, or, if you
+have obtained the Tomcat sources from the <a href="svn.html">Subversion
+repository</a>, using the <code>svn diff</code> command.
+For more information on Subversion and how to use it, see
+<a href="http://svnbook.red-bean.com/";> the Subversion Book.</a>
+When providing a patch, please mention to which version of the sources it
+applies.
+</p>
+
+<p>
Report an Apache Tomcat 7 bug
<a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Tomcat%207";>
here</a>.<br />
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
