logging-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From yo...@apache.org
Subject cvs commit: logging-site/src/xdocs/site bugreport.xml
Date Tue, 23 Dec 2003 17:28:01 GMT
yoavs       2003/12/23 09:28:01

  Added:       src/xdocs/site bugreport.xml
  Log:
  Bug reporting instructions.  Copied from jakarta-tomcat-site
  and modified to fit logging project.
  
  Revision  Changes    Path
  1.1                  logging-site/src/xdocs/site/bugreport.xml
  
  Index: bugreport.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <author>Glenn L. Nielsen</author>
      <author>Yoav Shapira</author>
      <title>Bug Report Guidelines</title>
    </properties>
  
  <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>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:security@apache.org">security@apache.org</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>
  </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="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><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>
    </subsection>
  
    <subsection name="Bug Database">
      <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>
    </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.  Search their archives
        in one of the following locations:
         <a href="http://marc.theaimsgroup.com/?l=log4j-user&amp;r=1&amp;w=2">Log4j-User
Mailing list ARChives</a>,
         <a href="http://nagoya.apache.org/eyebrowse/SummarizeList?listName=log4j-user-user@jakarta.apache.org">Log4j-User
Eyebrowse</a>,
         <a href="http://www.mail-archive.com/log4j-user@jakarta.apache.org">Mail Archive</a>.
      </p>
    </subsection>
  
  </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>
  
  Report a log4j bug
  <a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Log4j">
  here</a>.<br />
  </p>
  </section>
  
  </body>
  </document>
  
  
  

Mime
View raw message