ceki 2004/11/23 03:01:23
Modified: docs/site bugreport.html mailing-lists.html
src/xdocs/site bugreport.xml mailing-lists.xml
Log:
Slight rewording and doc improvements.
PR:
Obtained from:
Submitted by:
Reviewed by:
Revision Changes Path
1.19 +83 -82 logging-site/docs/site/bugreport.html
Index: bugreport.html
===================================================================
RCS file: /home/cvs/logging-site/docs/site/bugreport.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- bugreport.html 22 Nov 2004 18:18:12 -0000 1.18
+++ bugreport.html 23 Nov 2004 11:01:23 -0000 1.19
@@ -48,40 +48,54 @@
<hr noshade="" size="1"/>
<h1>Before you report a
bug</strong></h1>
- <p>The Logging community consists of
those who use Logging components, help answer
-questions on discussions lists, contribute documentation and patches,
-and those who develop and maintain the code for Logging components. Almost
all those
-who assist on a day to day basis resolving bug reports do this for a
-wide variety of reasons, and almost all of them do this on their own
time.</p>
+ <p>The Logging community consists of
those who use Logging
+ components, help answer questions on discussions lists, contribute
+ documentation and patches, and those who develop and maintain the
+ code for Logging components. Almost all those who assist on a day
+ to day basis resolving bug reports do this for a wide variety of
+ reasons, and almost all of them do this on their own time.
+ </p>
<p>Many bugs reported end up
not being a bug in the Logging component's code, but are
-due to misconfiguration, problems caused by installed applications, the
-operating system, etc.
-<ul>
-<b>Before reporting a bug please make every effort to resolve the problem
-yourself.</b>
-</ul>
-The remainder of this document points you toward resources you can use to
-resolve the problem you are having.
-</p>
+ due to misconfiguration, problems caused by installed applications, the
+ operating system, etc.
+ </p>
+ <p>Before reporting a bug
please make every effort to resolve the
+ problem yourself. Just reporting a bug will not fix it. A good bug
+ report includes a detailed description of the problem and a
+ succinct test case which can reproduce the problem.
+ </p>
+ <p>The remainder of this
document points you toward resources you can use to
+ resolve the problem you are having.
+ </p>
<h1>Resources to help resolve Logging problems</strong></h1>
<p>Here are some resources you can use
to help you resolve the
-problem you are having before reporting a bug.</p>
- <h3>Problem trouble
shooting</strong></h3>
- <p>
- <li><b>Documentation</b> - Review the documentation for the version
- of the Logging component you are using. The problem you are having
may already
- be addressed in the docs.</li>
- <li><b>Logs</b> - If the logging component supports this feature, enable
- internal debugging of the logging component. This frequently yields
- enough information to solve the problem.</li>
- <li><b>FAQ's</b> - Search Frequently Asked Question documents. Available
- FAQ's include:
- <ul>
- <li><a
href="http://nagoya.apache.org/wiki/apachewiki.cgi?Log4JProjectPages";>Log4j
Wiki</a></li>
- </ul>
- </li>
+ problem you are having before reporting a bug.</p>
+ <h3>Start by
consulting the available documentation</strong></h3>
+ <ul>
+
+ <li><b>Documentation</b> - Review the documentation for the
+ version of the Logging component you are using. The problem
+ you are having may already be addressed in the docs.</li>
+
+
+ <li><b>Logs</b> - If the logging component supports this feature,
enable
+ internal debugging of the logging component. This frequently yields
+ enough information to solve the problem.</li>
+ <li><b>FAQ's</b> - Search Frequently Asked Question documents.
Available
+ FAQ's include:
+
+ The <a href="http://logging.apache.org/log4j/docs/faq.html";>log4j
FAQ</a>
+ </li>
+ </ul>
+
<h3>Then, consult the mailing lists</strong></h3>
+ <p>It is very likely you are not the
first to run into a problem.
+ Others may have already found a solution. Our various mailing
+ lists will likely have discussed this problem before.
+ </p>
+ <p>Before reporting a bug,
you are advised to discuss it on the
+ relevant mailing list first.
</p>
-
<h3>Bug Database</strong></h3>
+
<h3>Consult the Bug Database</strong></h3>
<p>Please search the bug database to see
if the bug you are
seeing has already been reported.
<ul>
@@ -101,63 +115,50 @@
here</a>.
<br />
</p>
-
<h3>Logging discussion lists</strong></h3>
- <p>It is very likely you are not the
first to run into a problem.
- Others may have already found a solution. The various
- <a href="mailing-lists.html">Mailing Lists</a> will likely
- have discussed this problem already.
- </p>
- <p>You can search the log4j
mailing list archives
- in one of the following locations:
- <a
href="http://marc.theaimsgroup.com/?l=log4j-user&r=1&w=2";>Log4j-User
Mailing list ARChives</a>,
- <a href="http://nagoya.apache.org/eyebrowse/[EMAIL
PROTECTED]">Log4j-User Eyebrowse</a>,
- <a
href="http://www.mail-archive.com/[email protected]";>Mail
Archive</a>.
- </p>
- <p>You can search the
log4cxx mailing list archives
- in one of the following locations:
- <a
href="http://marc.theaimsgroup.com/?l=log4cxx-user&r=1&w=2";>Log4cxx-User
Mailing list ARChives</a>,
- <a
href="http://nagoya.apache.org/eyebrowse/SummarizeList?listId=219";>Log4cxx-User
Eyebrowse</a>
- </p>
<h1>Reporting a Logging bug</strong></h1>
<p>If after you have exhausted all other
resources to resolve a problem
-with your Logging component you may want to file a bug report. Please make
sure the
-problem is a bug in Logging and not a bug in your application.</p>
+ with your Logging component you may want to file a bug report. Please
make sure the
+ problem is a bug in Logging and not a bug in your application.</p>
<p>Please make sure you
provide as much information as possible. Its
-very hard to fix a bug if the person looking into the problem can't
-reproduce it. Here is a listing of information which should be included:
-<ul>
- <li><b>Logging component</b> - Logging component which has the bug.</li>
- <li><b>Version</b> - Logging component version, if from a nightly build,
version
- and date of build.</li>
- <li><b>Platform</b> - Hardward platform in use.</li>
- <li><b>OS</b> - Computer operating system and version.</li>
- <li><b>JVM</b> - JVM Version, if a java component or program.</li>
- <li><b>Configuration</b> - Attach configuration files if they would help
track
- down the bug.</li>
- <li><b>Log file excerpts</b> - Review your logs files, reproduce the bug
with
- debugging enabled in your Logging component 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, if
any.</li>
- <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> which
- fixes the bug.
- (If you have found a bug fix which can be applied to the Logging
component's code)</li>
- <li><b>Miscellaneous</b> - Any other information you feel will help track
- down the problem.</li>
-</ul>
-</p>
+ very hard to fix a bug if the person looking into the problem can't
+ reproduce it. Here is a listing of information which should be included:
+ <ul>
+ <li><b>Logging component</b> - Logging component which has the
bug.</li>
+ <li><b>Version</b> - Logging component version, if from a nightly
build, version
+ and date of build.</li>
+ <li><b>Platform</b> - Hardward platform in use.</li>
+ <li><b>OS</b> - Computer operating system and version.</li>
+ <li><b>JVM</b> - JVM Version, if a java component or program.</li>
+ <li><b>Configuration</b> - Attach configuration files if they would
help track
+ down the bug.</li>
+ <li><b>Log file excerpts</b> - Review your logs files, reproduce the
bug with
+ debugging enabled in your Logging component 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, if
any.</li>
+ <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>
which
+ fixes the bug.
+ (If you have found a bug fix which can be applied to the Logging
component's code)</li>
+ <li><b>Miscellaneous</b> - Any other information you feel will help
track
+ down the problem.</li>
+ </ul>
+ </p>
+ <p><b>Just reporting a bug
will not fix it. A good bug report
+ includes a detailed description of the problem and a succinct test
+ case which can reproduce the problem.</b>
+ </p>
<p>
-Report a log4j bug
-<a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Log4j";>
-here</a>.
-</p>
+ Report a log4j bug
+ <a
href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Log4j";>
+ here</a>.
+ </p>
<p>
-Report a log4cxx bug
-<a href="http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10550";>
-here</a>
-</p>
+ Report a log4cxx bug
+ <a
href="http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10550";>
+ here</a>
+ </p>
1.21 +12 -7 logging-site/docs/site/mailing-lists.html
Index: mailing-lists.html
===================================================================
RCS file: /home/cvs/logging-site/docs/site/mailing-lists.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- mailing-lists.html 22 Nov 2004 18:18:12 -0000 1.20
+++ mailing-lists.html 23 Nov 2004 11:01:23 -0000 1.21
@@ -51,16 +51,21 @@
Jakarta Project</a> before subscribing and posting to any of the
lists below. They apply to Logging Services' lists as well.
</p>
- <p>All lists are
subscriber only lists, this means you have to
- subscribe before you can post to them. Please note that any HTML
- parts sent to the lists will be removed by our mailing list software
- - you shouldn't be sending HTML mails anyway.
+ <p><em>All lists are
subscriber only lists, this means you have to
+ subscribe before you can post to them.</em>
+ </p>
+ <p>Please do your best
to ensure that you are not sending HTML or
+ "Stylelized" email to the list. If you are using Outlook or Outlook
+ Express or Eudora, chances are that you are sending HTML email by
+ default. There is usually a setting that will allow you to send
+ "Plain Text" email.
</p>
<p>These lists are
archived at
<ul>
<li><a href="http://logging.apache.org/mail/";>Full mbox archives of all
lists</a></li>
- <li><a href="http://marc.theaimsgroup.com/";>Mailing list
Archives</a></li>
+ <li> <a href="http://nagoya.apache.org/eyebrowse/";>Eyebrowse
Archives</a></li>
+ <li>The Aims Group <a
href="http://marc.theaimsgroup.com/";>Archives</a></li>
</ul>
</p>
<h2>The Logging
Services <b>General</b> list</h2>
@@ -185,10 +190,10 @@
-
<hr/>
+
<hr/>
-
+
<!-- FOOTER -->
1.9 +105 -100 logging-site/src/xdocs/site/bugreport.xml
Index: bugreport.xml
===================================================================
RCS file: /home/cvs/logging-site/src/xdocs/site/bugreport.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- bugreport.xml 27 Jul 2004 20:03:26 -0000 1.8
+++ bugreport.xml 23 Nov 2004 11:01:23 -0000 1.9
@@ -9,47 +9,68 @@
<body>
-<section name="Before you report a bug">
-<p>The Logging community consists of those who use Logging components, help
answer
-questions on discussions lists, contribute documentation and patches,
-and those who develop and maintain the code for Logging components. Almost
all those
-who assist on a day to day basis resolving bug reports do this for a
-wide variety of reasons, and almost all of them do this on their own
time.</p>
-
-<p>Many bugs reported end up not being a bug in the Logging component's
code, but are
-due to misconfiguration, problems caused by installed applications, the
-operating system, etc.
-<ul>
-<b>Before reporting a bug please make every effort to resolve the problem
-yourself.</b>
-</ul>
-The remainder of this document points you toward resources you can use to
-resolve the problem you are having.
-</p>
-</section>
-
-<section name="Resources to help resolve Logging problems">
-<p>Here are some resources you can use to help you resolve the
-problem you are having before reporting a bug.</p>
+ <section name="Before you report a bug">
- <subsection name="Problem trouble shooting">
- <p>
- <li><b>Documentation</b> - Review the documentation for the version
- of the Logging component you are using. The problem you are having
may already
- be addressed in the docs.</li>
- <li><b>Logs</b> - If the logging component supports this feature, enable
- internal debugging of the logging component. This frequently yields
- enough information to solve the problem.</li>
- <li><b>FAQ's</b> - Search Frequently Asked Question documents. Available
- FAQ's include:
- <ul>
- <li><a
href="http://nagoya.apache.org/wiki/apachewiki.cgi?Log4JProjectPages";>Log4j
Wiki</a></li>
- </ul>
- </li>
+ <p>The Logging community consists of those who use Logging
+ components, help answer questions on discussions lists, contribute
+ documentation and patches, and those who develop and maintain the
+ code for Logging components. Almost all those who assist on a day
+ to day basis resolving bug reports do this for a wide variety of
+ reasons, and almost all of them do this on their own time.
+ </p>
+
+ <p>Many bugs reported end up not being a bug in the Logging component's
code, but are
+ due to misconfiguration, problems caused by installed applications, the
+ operating system, etc.
+ </p>
+
+ <p>Before reporting a bug please make every effort to resolve the
+ problem yourself. Just reporting a bug will not fix it. A good bug
+ report includes a detailed description of the problem and a
+ succinct test case which can reproduce the problem.
+ </p>
+
+ <p>The remainder of this document points you toward resources you can
use to
+ resolve the problem you are having.
+ </p>
+
+ </section>
+
+ <section name="Resources to help resolve Logging problems">
+ <p>Here are some resources you can use to help you resolve the
+ problem you are having before reporting a bug.</p>
+
+ <subsection name="Start by consulting the available documentation">
+ <ul>
+
+ <li><b>Documentation</b> - Review the documentation for the
+ version of the Logging component you are using. The problem
+ you are having may already be addressed in the docs.</li>
+
+
+ <li><b>Logs</b> - If the logging component supports this feature,
enable
+ internal debugging of the logging component. This frequently yields
+ enough information to solve the problem.</li>
+ <li><b>FAQ's</b> - Search Frequently Asked Question documents.
Available
+ FAQ's include:
+
+ The <a href="http://logging.apache.org/log4j/docs/faq.html";>log4j
FAQ</a>
+ </li>
+ </ul>
+ </subsection>
+
+ <subsection name="Then, consult the mailing lists">
+ <p>It is very likely you are not the first to run into a problem.
+ Others may have already found a solution. Our various mailing
+ lists will likely have discussed this problem before.
+ </p>
+
+ <p>Before reporting a bug, you are advised to discuss it on the
+ relevant mailing list first.
</p>
</subsection>
- <subsection name="Bug Database">
+ <subsection name="Consult the Bug Database">
<p>Please search the bug database to see if the bug you are
seeing has already been reported.
<ul>
@@ -71,72 +92,56 @@
</p>
</subsection>
- <subsection name="Logging discussion lists">
- <p>It is very likely you are not the first to run into a problem.
- Others may have already found a solution. The various
- <a href="mailing-lists.html">Mailing Lists</a> will likely
- have discussed this problem already.
- </p>
-
- <p>You can search the log4j mailing list archives
- in one of the following locations:
- <a
href="http://marc.theaimsgroup.com/?l=log4j-user&r=1&w=2";>Log4j-User
Mailing list ARChives</a>,
- <a href="http://nagoya.apache.org/eyebrowse/[EMAIL
PROTECTED]">Log4j-User Eyebrowse</a>,
- <a
href="http://www.mail-archive.com/[email protected]";>Mail
Archive</a>.
- </p>
-
- <p>You can search the log4cxx mailing list archives
- in one of the following locations:
- <a
href="http://marc.theaimsgroup.com/?l=log4cxx-user&r=1&w=2";>Log4cxx-User
Mailing list ARChives</a>,
- <a
href="http://nagoya.apache.org/eyebrowse/SummarizeList?listId=219";>Log4cxx-User
Eyebrowse</a>
+ </section>
+
+ <section name="Reporting a Logging bug">
+ <p>If after you have exhausted all other resources to resolve a problem
+ with your Logging component you may want to file a bug report. Please
make sure the
+ problem is a bug in Logging and not a bug in your application.</p>
+
+ <p>Please make sure you provide as much information as possible. Its
+ very hard to fix a bug if the person looking into the problem can't
+ reproduce it. Here is a listing of information which should be included:
+ <ul>
+ <li><b>Logging component</b> - Logging component which has the
bug.</li>
+ <li><b>Version</b> - Logging component version, if from a nightly
build, version
+ and date of build.</li>
+ <li><b>Platform</b> - Hardward platform in use.</li>
+ <li><b>OS</b> - Computer operating system and version.</li>
+ <li><b>JVM</b> - JVM Version, if a java component or program.</li>
+ <li><b>Configuration</b> - Attach configuration files if they would
help track
+ down the bug.</li>
+ <li><b>Log file excerpts</b> - Review your logs files, reproduce the
bug with
+ debugging enabled in your Logging component 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, if
any.</li>
+ <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>
which
+ fixes the bug.
+ (If you have found a bug fix which can be applied to the Logging
component's code)</li>
+ <li><b>Miscellaneous</b> - Any other information you feel will help
track
+ down the problem.</li>
+ </ul>
+ </p>
+
+ <p><b>Just reporting a bug will not fix it. A good bug report
+ includes a detailed description of the problem and a succinct test
+ case which can reproduce the problem.</b>
</p>
- </subsection>
-</section>
+ <p>
+ Report a log4j bug
+ <a
href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Log4j";>
+ here</a>.
+ </p>
-<section name="Reporting a Logging bug">
-<p>If after you have exhausted all other resources to resolve a problem
-with your Logging component you may want to file a bug report. Please make
sure the
-problem is a bug in Logging and not a bug in your application.</p>
-
-<p>Please make sure you provide as much information as possible. Its
-very hard to fix a bug if the person looking into the problem can't
-reproduce it. Here is a listing of information which should be included:
-<ul>
- <li><b>Logging component</b> - Logging component which has the bug.</li>
- <li><b>Version</b> - Logging component version, if from a nightly build,
version
- and date of build.</li>
- <li><b>Platform</b> - Hardward platform in use.</li>
- <li><b>OS</b> - Computer operating system and version.</li>
- <li><b>JVM</b> - JVM Version, if a java component or program.</li>
- <li><b>Configuration</b> - Attach configuration files if they would help
track
- down the bug.</li>
- <li><b>Log file excerpts</b> - Review your logs files, reproduce the bug
with
- debugging enabled in your Logging component 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, if
any.</li>
- <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> which
- fixes the bug.
- (If you have found a bug fix which can be applied to the Logging
component's code)</li>
- <li><b>Miscellaneous</b> - Any other information you feel will help track
- down the problem.</li>
-</ul>
-</p>
-
-<p>
-Report a log4j bug
-<a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Log4j";>
-here</a>.
-</p>
-
-<p>
-Report a log4cxx bug
-<a href="http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10550";>
-here</a>
-</p>
+ <p>
+ Report a log4cxx bug
+ <a
href="http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10550";>
+ here</a>
+ </p>
</section>
1.6 +11 -5 logging-site/src/xdocs/site/mailing-lists.xml
Index: mailing-lists.xml
===================================================================
RCS file: /home/cvs/logging-site/src/xdocs/site/mailing-lists.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- mailing-lists.xml 28 Jan 2004 21:12:20 -0000 1.5
+++ mailing-lists.xml 23 Nov 2004 11:01:23 -0000 1.6
@@ -19,17 +19,23 @@
lists below. They apply to Logging Services' lists as well.
</p>
- <p>All lists are subscriber only lists, this means you have to
- subscribe before you can post to them. Please note that any HTML
- parts sent to the lists will be removed by our mailing list software
- - you shouldn't be sending HTML mails anyway.
+ <p><em>All lists are subscriber only lists, this means you have to
+ subscribe before you can post to them.</em>
+ </p>
+
+ <p>Please do your best to ensure that you are not sending HTML or
+ "Stylelized" email to the list. If you are using Outlook or Outlook
+ Express or Eudora, chances are that you are sending HTML email by
+ default. There is usually a setting that will allow you to send
+ "Plain Text" email.
</p>
<p>These lists are archived at
<ul>
<li><a href="http://logging.apache.org/mail/";>Full mbox archives of all
lists</a></li>
- <li><a href="http://marc.theaimsgroup.com/";>Mailing list
Archives</a></li>
+ <li> <a href="http://nagoya.apache.org/eyebrowse/";>Eyebrowse
Archives</a></li>
+ <li>The Aims Group <a
href="http://marc.theaimsgroup.com/";>Archives</a></li>
</ul>
</p>
