Home | History | Annotate | Download | only in Documentation
      1 This document describes the process for reporting bugs found _by_ the
      2 POSIX Test Test Suites.
      3 
      4 A future document will cover how to report bugs found _within_ the
      5 POSIX Test Test Suites.
      6 
      7 This document describes the steps we'd like to take to ensure we are finding
      8 new, important issues and reporting them in a clear, consice, and effective
      9 manner.
     10 
     11 1.  Bug is found - i.e., Test case shows failure.
     12     Ensure you were testing using:
     13     - The latest version of the test case.
     14     - The latest version of the code under test.
     15     - Code under test that is targeted* for the POSIX Test Suite reporting.
     16 2.  Research.
     17     Research as many of the following areas as possible to ensure the bug
     18     is new:
     19     - Mailing list for the code under test.
     20     - Bug database for the code under test.
     21     - LKML - (one archive:  http://marc.theaimsgroup.com/?l=linux-kernel)
     22     - Kernel bug database - http://bugme.osdl.org
     23 3.  Debug as much as possible.
     24     Some steps include:
     25     - Create a test case which clearly shows the bug.
     26     - If possible, find the fault in the code under test causing the test case
     27       failure.
     28     - If possible, create a patch to fix the fault.
     29 4.  If the code under test is compatible with another POSIX version (e.g.,
     30     1993), then determine whether this test case is for functionality
     31     added by the 2001 spec.
     32     If yes, document this in the assertions.xml file**.
     33 5.  Create an email bug report containing:
     34     - description of the issue
     35     - kernel used
     36     - patches applied
     37     - relevant configuration information
     38     - hardware used
     39     - test case to reproduce the issue (can be included in the email)
     40 6.  Send email bug report to the mailing list for the code under test (or
     41     its bug database, if applicable).  Copy LKML, if applicable.  [If it
     42     is a bug in the Linux Kernel, submit directly to the Linux Kernel
     43     bug database.]
     44 
     45 *targeted implementation = an implementation which POSIX Test Suite will
     46 be run against; not yet formally defined
     47 **Process for tracing a test case to previous POSIX specifications not
     48 yet defined.
     49 
     50 Contributors:	geoffrey.r.gustafson REMOVE-THIS AT intel DOT com
     51 		julie.n.fleischer REMOVE-THIS AT intel DOT com
     52