Changes between Version 16 and Version 17 of Developer/Bug_Reporting


Ignore:
Timestamp:
Nov 15, 2018, 8:25:06 PM (5 months ago)
Author:
Denth
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Bug_Reporting

    v16 v17  
    1616 *  A description of the actual undesired behaviour
    1717
    18 Only when your bug report requires multiple source files to be reproduced should you use an archive otherwise the uploaded individual source file or diff should contain the minimal source code needed to reproduce the bug. In any case, make sure the above are included in the body of your bug report as plain text, even if needlessly duplicated as part of an archive. Please try and repeat on the current git master.
     18Only when your bug report requires multiple source files to be reproduced should you use an archive. Otherwise, the uploaded individual source file or diff should contain the minimal source code needed to reproduce the bug. In any case, make sure the above are included in the body of your bug report as plain text, even if needlessly duplicated as part of an archive. Please try and repeat on the current git master.
    1919
    2020If you fail to supply enough information for a bug report to be reproduced, someone will probably ask you to post additional information. In this case, please post the additional information and not just to the person who requested it, unless explicitly told so.
     
    3434 *  Questions about the correctness or the expected behaviour of programming language constructs or calls to library routines that are not part of RTEMS.
    3535
    36 Developing and debugging real-time embedded systems can be difficult. Exercise caution in reporting an error that occurs only some of the times a certain program is executed, such that retrying a sufficient number of times results in a successful compilation; this is often a symptom of a hardware problem or application issue, not of a RTEMS bug (sorry). We do recognise that sometimes a timing bug will exist in RTEMS but we want you to exercise due diligence before pointing fingers.
     36Developing and debugging real-time embedded systems can be difficult. Exercise caution in reporting an error that occurs only some of the times a certain program is executed, such that retrying a sufficient number of times results in a successful compilation; this is often a symptom of a hardware problem or application issue, not of a RTEMS bug (sorry). We do recognise that sometimes a timing bug will exist in RTEMS, but we want you to exercise due diligence before pointing fingers.
    3737
    3838== Not RTEMS Bugs ==
     
    4040RTEMS users sometimes encounter that may be considered bugs in RTEMS but are not.
    4141
    42  *  The POSIX standard does NOT specify the default set of thread attributes. Thus when passing a NULL for attributes to pthread_create, the application is not guaranteed any particular thread behavior.
    43  *  The defaults for all RTEMS Configuration Table parameters are intentionally small. Thus it is common for RTEMS tasking and file related calls to return errors indicating out of resources until the configuration parameters are properly tuned for the application. For example, there are only 3 file descriptors available by default: stdin, stdout, and stderr. Any attempt to open a socket or file will fail unless more file descriptors are configured.
     42 *  The POSIX standard does NOT specify the default set of thread attributes. Thus, when passing a NULL for attributes to pthread_create, the application is not guaranteed any particular thread behavior.
     43 *  The defaults for all RTEMS Configuration Table parameters are intentionally small. Thus, it is common for RTEMS tasking and file related calls to return errors indicating out of resources until the configuration parameters are properly tuned for the application. For example, there are only 3 file descriptors available by default: stdin, stdout, and stderr. Any attempt to open a socket or file will fail unless more file descriptors are configured.
    4444 *  When first developing a BSP, many users encounter an unexpected interrupt or exception immediately upon completion of RTEMS initialization. This occurs because interrupts are disabled during RTEMS initialization and are automatically initialized as part of switching to the first task. The interrupted user code will be in either _CPU_Context_switch or _Thread_Handler. This indicates that an interrupt source has not been properly initialized or masked.
    4545 *  Some users encounter a random reset during BSP initialization. This usually indicates that the board has a watchdog timer that is not being properly serviced during the BSP initialization.
     
    4747== Reporting a Bug ==
    4848
    49 To submit a bug report please follow the instructions:
     49To submit a bug report, please follow these instructions:
    5050 
    51511. Sign in to the RTEMS Trac website using the [https://devel.rtems.org/login Trac Login].
     
    5858  a. Set the `Component` field and leave as `General` if you are not sure.
    5959  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.
    60   a. Click `Create Ticket` when you are happy you have all the details you can provide.
     60  a. Click `Create Ticket` when you have included all the details you can provide.
    6161
    6262The [wiki:TracWorkflow Trac Ticket Workflow] details the workflow for RTEMS Tickets.
     
    104104  '''worksforme''':: The bug could not be repeated and there is not more the maintainer can do.
    105105
    106 If a bug has been closed and you think there has been a mistake please reopen the ticket and add suitable comments to explain the reason for reopening the ticket.
     106If a bug has been closed and you think there has been a mistake, please reopen the ticket and add suitable comments to explain the reason for reopening the ticket.
    107107
    108108The high priority is reserved to maintainers in RTEMS, indicating that a certain problem must be solved before the next version of RTEMS is released.
     
    110110== Ticket Updates with Git Commits ==
    111111
    112 Tickets can be automatically updated using a git commit message. If the commit contains `fixes #12345` the ticket ''12345'' will be closed and the commit message used a comment in the ticket. The valid keywords are:
     112Tickets can be automatically updated using a git commit message. If the commit contains `fixes #12345`, the ticket ''12345'' will be closed and the commit message used a comment in the ticket. The valid keywords are:
    113113
    114114  '''Close a ticket''':: `close` `closed` `closes` `fix` `fixed` `fixes` `Close` `Closes` `Closed` `Fix` `Fixed` `Fixes`