yoavs 2003/12/23 09:31:03
Added: docs/site bugreport.html Log: Added bugreport page. Revision Changes Path 1.1 logging-site/docs/site/bugreport.html Index: bugreport.html =================================================================== <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- Content Stylesheet for Site --> <!-- start the processing --> <!-- ====================================================================== --> <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! --> <!-- Main Page Section --> <!-- ====================================================================== --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> <meta name="author" value="Glenn L. Nielsen"> <meta name="email" value="$au.getAttributeValue("email")"> <meta name="author" value="Yoav Shapira"> <meta name="email" value="$au.getAttributeValue("email")"> <link href="../css/site.css" rel="stylesheet" type="text/css"/> <title>Logging Services - Bug Report Guidelines</title> </head> <body bgcolor="#ffffff" text="#000000" link="#525D76"> <table border="0" width="100%" cellspacing="0"> <!-- TOP IMAGE --> <tr> <td colspan="2"> <a href="http://logging.apache.org";> <img src="http://logging.apache.org/images/ls-logo.jpg"; align="left" border="0"/> </a> </td> </tr> </table> <table border="0" width="100%" cellspacing="4" cellpadding="0"> <tr><td colspan="2"> <hr noshade="" size="1"/> </td></tr> <tr> <!-- LEFT SIDE NAVIGATION --> <td width="20%" valign="top" nowrap="true"> <!-- ============================================================ --> <table class="menu" width="160" border="0" cellspacing="2" cellpadding="1"> <tr > <td><strong>About Logging Services</strong></td> </tr> <tr><td><small> <a href="../index.html">Welcome</a> </small></td></tr> <tr><td><small> <a href="../site/news.html">News</a> </small></td></tr> <tr bgcolor="#999999"> <td><html:img page="/images/space2.gif" height="1"></html:img></td> </tr> <tr > <td><strong>Projects</strong></td> </tr> <tr><td><small> <a href="..">log4cxx (in incubation)</a> </small></td></tr> <tr><td><small> <a href="..">log4cplus (in incubation)</a> </small></td></tr> <tr><td><small> <a href="../log4j/docs">log4j</a> </small></td></tr> <tr><td><small> <a href="..">log4net (in incubation)</a> </small></td></tr> <tr><td><small> <a href="..">log4php (in incubation)</a> </small></td></tr> <tr><td><small> <a href="..">log4jplsql (in process)</a> </small></td></tr> <tr bgcolor="#999999"> <td><html:img page="/images/space2.gif" height="1"></html:img></td> </tr> <tr > <td><strong>Information</strong></td> </tr> <tr><td><small> <a href="../site/mission-statement.html">Mission statement</a> </small></td></tr> <tr><td><small> <a href="../site/bylaws.html">Bylaws</a> </small></td></tr> <tr><td><small> <a href="..">License</a> </small></td></tr> <tr><td><small> <a href="../site/who-we-are.html">Who we are</a> </small></td></tr> <tr bgcolor="#999999"> <td><html:img page="/images/space2.gif" height="1"></html:img></td> </tr> <tr > <td><strong>Support</strong></td> </tr> <tr><td><small> <a href="../site/cvs-repositories.html">CVS repositories</a> </small></td></tr> <tr><td><small> <a href="../site/mailing-lists.html">Mailing lists</a> </small></td></tr> <tr><td><small> <a href="../site/bugreport.html">Bug database</a> </small></td></tr> <tr bgcolor="#999999"> <td><html:img page="/images/space2.gif" height="1"></html:img></td> </tr> </table> </td> <td width="80%" align="left" valign="top"> <div style="position: relative; left: 8px;"> <table border="0" cellspacing="0" cellpadding="2" width="100%"> <tr><td bgcolor="#FFFFFF"> <font color="#2222AA" face="arial,helvetica,sanserif" size="+1"> <a name="Before you report a bug"> <strong>Before you report a bug</strong></a> </font> </td></tr> <tr><td> </td></r> <tr><td> <blockquote> <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>If you have a verified security bug to report please do not post it to email lists or submit a bug report. Security bugs should be reported privately by email to <a href="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]</a>. </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> </blockquote> </p> </td></tr> <tr><td><br/></td></tr> </table> <table border="0" cellspacing="0" cellpadding="2" width="100%"> <tr><td bgcolor="#FFFFFF"> <font color="#2222AA" face="arial,helvetica,sanserif" size="+1"> <a name="Resources to help resolve Logging problems"> <strong>Resources to help resolve Logging problems</strong></a> </font> </td></tr> <tr><td> </td></r> <tr><td> <blockquote> <p>Here are some resources you can use to help you resolve the problem you are having before reporting a bug.</p> <table border="0" cellspacing="0" cellpadding="2" width="100%"> <tr><td bgcolor="#828DA6"> <font color="#ffffff" face="arial,helvetica,sanserif"> <a name="Problem trouble shooting"><strong>Problem trouble shooting</strong></a> </font> </td></tr> <tr><td> <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. FAQ's for all Jakarta projects can be found <a href="http://jakarta.apache.org/site/faqs.html";>here</a>.</li> </p> </td></tr> <tr><td><br/></td></tr> </table> <table border="0" cellspacing="0" cellpadding="2" width="100%"> <tr><td bgcolor="#828DA6"> <font color="#ffffff" face="arial,helvetica,sanserif"> <a name="Bug Database"><strong>Bug Database</strong></a> </font> </td></tr> <tr><td> <p>Please search the bug database to see if the bug you are seeing has already been reported. <ul> <li>The bug may have already been fixed and is available in a later version or nightly build.</li> <li>Someone else may have reported the bug, you could add supporting information to help reproduce and resolve the bug.</li> </ul> Search the log4j bug database <a href="http://nagoya.apache.prg/bugzilla/query.cgi?product=Log4j";> here</a>.<br /> </p> </td></tr> <tr><td><br/></td></tr> </table> <table border="0" cellspacing="0" cellpadding="2" width="100%"> <tr><td bgcolor="#828DA6"> <font color="#ffffff" face="arial,helvetica,sanserif"> <a name="Logging discussion lists"><strong>Logging discussion lists</strong></a> </font> </td></tr> <tr><td> <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. Search their 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> </td></tr> <tr><td><br/></td></tr> </table> </blockquote> </p> </td></tr> <tr><td><br/></td></tr> </table> <table border="0" cellspacing="0" cellpadding="2" width="100%"> <tr><td bgcolor="#FFFFFF"> <font color="#2222AA" face="arial,helvetica,sanserif" size="+1"> <a name="Reporting a Logging bug"> <strong>Reporting a Logging bug</strong></a> </font> </td></tr> <tr><td> </td></r> <tr><td> <blockquote> <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> Report a log4j bug <a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Log4j";> here</a>.<br /> </p> </blockquote> </p> </td></tr> <tr><td><br/></td></tr> </table> </div> </td> </tr> <!-- FOOTER --> <tr><td colspan="2"> <hr noshade="" size="1"/> </td></tr> <tr><td colspan="2"> <div align="center"><font color="#525D76" size="-1"><em> Copyright © 1999-2004, Apache Software Foundation </em></font></div> </td></tr> </table> </body> </html> <!-- end the processing -->
![http://logging.apache.org/images/ls-logo.jpg"](http://logging.apache.org/images/ls-logo.jpg"){kind=link}