Changes between Version 8 and Version 9 of Developer/Bug_Reporting


Ignore:
Timestamp:
Mar 22, 2015, 2:18:18 AM (5 years ago)
Author:
Chris Johns
Comment:

Trac updates.

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Bug_Reporting

    v8 v9  
    11= RTEMS Bug Reporting =
    22
     3[[TOC(Developer/Bug_Reporting, depth=2)]]
    34
    4 
    5 [[TOC(TBR/Review/RTEMS_Bugzilla, depth=2)]]
    6 
    7 
    8 Our preferred way of receiving bug reports is via the [http://devel.rtems.org RTEMS Trac] bug reporting system. For posting patches not specifically related to bugs, we prefer to use the [wiki:TBR/Website/RTEMSMailingLists Developer's Mailing List].
     5Our preferred way of receiving bug reports is via the [http://devel.rtems.org RTEMS Trac] ticket system. If you have patches not specifically related to bugs or existing tickets, we prefer to use the [wiki:TBR/Website/RTEMSMailingLists Developer's Mailing List].
    96
    107In general, if you have a bug to submit follow the instructions:
    11   1. Sign in Trac website
    12   2. Click in View Tickets (upper right corner of the screen)
    13   3. Search for a similar bug (to avoid duplicates)
    14   4. If you haven't found a similar bug, create a New Ticket, describe it, attach evidences, add detailed instructions in order to reproduce the bug and save it.
     8 
     91. Sign in to the RTEMS Trac website using the [https://devel.rtems.org/login Trac Login].
     101. Click in [https://devel.rtems.org/query View Tickets] (upper right corner of the screen).
     111. Search for a similar ticket about the bug (to avoid duplicates).
     121. If you haven't found a similar ticket, create a [https://devel.rtems.org/newticket New Ticket] and:
     13  a. Add a useful single line summary.
     14  a. Set the `Type` field to `defect` for a bug. Note `infra` is used to report issues with the RTEMS servers at OSUOSL.
     15  a. Set the `Version` field. If it is with the current git master branch use the next version
     16  a. Set the `Component` field and leave as `General` if you are not sure.
     17  a. Describe the bug or issue in the `Description` field with any details useful to the RTEMS maintainers such as host machine, build of tools, output traces, plus if you have any local modification and detailed instructions in order to reproduce the bug. The `WikiFormatting` is useful in formatting the information you provide and it does help the readability of the information you provide.
     18  a. Click `Create Ticket` when you are happy you have all the details you can provide.
    1519
    1620= Managing Bugs =
    17 
    1821
    1922This section contains information mostly intended for RTEMS contributors.  But if you submit a bug report, it is very important for you to submit a reproducible test case.  These submitted test cases end up being added to the test suite to prevent future regressions.
    2023
    2124If you find a bug, but you are not fixing it (yet):
    22 
    23   * Create a (minimal) test-case.
    24   * Add the test-case to our test-suite, documenting it as a current failure unless the bug is a regression.
    25   * Add a bug report referencing the test-case to Trac.
     25* Create a (minimal) test-case.
     26* Add the test-case to our test-suite, documenting it as a current failure unless the bug is a regression.
     27* Add a bug report referencing the test-case to Trac.
    2628
    2729If you want to provide additional information in the bug tracking system about a reported bug:
    2830
    29   * If the bug has been tracked down to a specific area or routine in RTEMS, please provide information about its location.
    30   * Minimize the test case.
    31   * Try the test case with earlier and later versions of RTEMS to determine which versions it affects and whether it is a regression. If it is a regression, identify the patch that introduced it.
     31* If the bug has been tracked down to a specific area or routine in RTEMS, please provide information about its location.
     32* Minimize the test case.
     33* Try the test case with earlier and later versions of RTEMS to determine which versions it affects and whether it is a regression. If it is a regression, identify the patch that introduced it.
    3234
    33 If you fix a bug for which there is already a Trac entry:
     35If you fix a bug for which there is already a Trac ticket:
    3436
    35   * Remove the failure notation on the test-case.
    36   * Attach your fix and test case to the Trac bug report.
    37   * Close the bug report in Trac.
     37* Remove the failure notation on the test-case.
     38* Attach your fix and test case to the Trac ticket.
     39* Close the ticket by adding `fixes #<ticket numer>` to the commit message.
    3840
    3941If you find a bug, and you are fixing it right then:
    4042
    41   * Create a (minimal) test-case.
    42   * Add the test-case to our test-suite, documenting it as known to work.
    43   * Check in your fixes.
     43* Create a (minimal) test-case.
     44* Add the test-case to our test-suite, documenting it as known to work.
     45* Check in your fixes.
    4446
    4547= Maintainer's View of Fields =
    46 
    4748
    4849As a RTEMS-specific convention, we will attach a special meaning to some fields. The State field should be used in the following way: