| 1 | .. SPDX-License-Identifier: CC-BY-SA-4.0 |
|---|
| 2 | |
|---|
| 3 | .. Copyright (C) 2012, 2016 Chris Johns <chrisj@rtems.org> |
|---|
| 4 | |
|---|
| 5 | .. _Bugs, Crashes, and Build Failures: |
|---|
| 6 | |
|---|
| 7 | Bugs, Crashes, and Build Failures |
|---|
| 8 | --------------------------------- |
|---|
| 9 | |
|---|
| 10 | The RTEMS Source Builder is a Python program and every care is taken to test |
|---|
| 11 | the code however bugs, crashes, and build failures can and do happen. If you |
|---|
| 12 | find a bug please report it via the :r:url:`devel` or email on the RTEMS Users |
|---|
| 13 | list. |
|---|
| 14 | |
|---|
| 15 | Please include the generated RSB report. If you see the following a report has |
|---|
| 16 | been generated: |
|---|
| 17 | |
|---|
| 18 | .. code-block:: none |
|---|
| 19 | |
|---|
| 20 | ... |
|---|
| 21 | ... |
|---|
| 22 | Build FAILED <1> |
|---|
| 23 | See error report: rsb-report-4.11-rtems-lm32.txt <2> |
|---|
| 24 | |
|---|
| 25 | .. topic:: Items: |
|---|
| 26 | |
|---|
| 27 | 1. The build has failed. |
|---|
| 28 | |
|---|
| 29 | 2. The report's file name. |
|---|
| 30 | |
|---|
| 31 | The generated report contains the command line, version of the RSB, your host's |
|---|
| 32 | ``uname`` details, the version of Python and the last 200 lines of the log. |
|---|
| 33 | |
|---|
| 34 | If for some reason there is no report please send please report the following: |
|---|
| 35 | |
|---|
| 36 | - Command line, |
|---|
| 37 | |
|---|
| 38 | - The git hash, |
|---|
| 39 | |
|---|
| 40 | - Host details with the output of the ``uname -a`` command, |
|---|
| 41 | |
|---|
| 42 | - If you have made any modifications. |
|---|
| 43 | |
|---|
| 44 | If there is a Python crash please cut and paste the Python backtrace into the |
|---|
| 45 | bug report. If the tools fail to build please locate the first error in the log |
|---|
| 46 | file. This can be difficult to find on hosts with many cores so it sometimes |
|---|
| 47 | pays to re-run the command with the ``--jobs=none`` option to get a log that is |
|---|
| 48 | correctly sequenced. If searching the log file seach for ``error:`` and the |
|---|
| 49 | error should be just above it. |
|---|
| 50 | |
|---|
| 51 | .. _Contributing: |
|---|
| 52 | |
|---|
| 53 | Contributing |
|---|
| 54 | ============ |
|---|
| 55 | |
|---|
| 56 | We welcome all users adding, fixing, updating and upgrading packages and their |
|---|
| 57 | configurations. The RSB is open source and open to contributions. These can be |
|---|
| 58 | bug fixes, new features or new configurations. Please break patches down into |
|---|
| 59 | changes to the core Python code, configuration changes or new configurations. |
|---|
| 60 | |
|---|
| 61 | Please email patches generated using git so your commit messages and you are |
|---|
| 62 | acknowledged as the contributor. |
|---|
![[RTEMS Logo]](/images/logo.png){kind=logo}
