summaryrefslogtreecommitdiffstats
path: root/rsb/bug-reporting.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-11-02 12:09:54 +1100
committerChris Johns <chrisj@rtems.org>2016-11-02 12:09:54 +1100
commit8b643359868d044ef0f1f3432dd49594aae6c6a2 (patch)
treef8790fab70ef8bfcc123d5221b9605109f36144f /rsb/bug-reporting.rst
parent75e787d4a0c6ac405ee4442d1be46dafa8b368be (diff)
downloadrtems-docs-8b643359868d044ef0f1f3432dd49594aae6c6a2.tar.bz2
RSB: Finish reformatting after moving from asciidocs.
Diffstat (limited to 'rsb/bug-reporting.rst')
-rw-r--r--rsb/bug-reporting.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/rsb/bug-reporting.rst b/rsb/bug-reporting.rst
new file mode 100644
index 0000000..a2d4b70
--- /dev/null
+++ b/rsb/bug-reporting.rst
@@ -0,0 +1,61 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. comment COPYRIGHT (c) 2012 - 2016.
+.. comment Chris Johns <chrisj@rtems.org>
+
+.. _Bugs, Crashes, and Build Failures:
+
+Bugs, Crashes, and Build Failures
+#################################
+
+The RTEMS Source Builder is a Python program and every care is taken to test
+the code however bugs, crashes, and build failures can and do happen. If you
+find a bug please report it via the :r:url:`devel` or email on the RTEMS Users
+list.
+
+Please include the generated RSB report. If you see the following a report has
+been generated::
+
+ ...
+ ...
+ Build FAILED <1>
+ See error report: rsb-report-4.11-rtems-lm32.txt <2>
+
+.. topic:: Items:
+
+ 1. The build has failed.
+
+ 2. The report's file name.
+
+The generated report contains the command line, version of the RSB, your host's
+``uname`` details, the version of Python and the last 200 lines of the log.
+
+If for some reason there is no report please send please report the following:
+
+- Command line,
+
+- The git hash,
+
+- Host details with the output of the ``uname -a`` command,
+
+- If you have made any modifications.
+
+If there is a Python crash please cut and paste the Python backtrace into the
+bug report. If the tools fail to build please locate the first error in the log
+file. This can be difficult to find on hosts with many cores so it sometimes
+pays to re-run the command with the ``--jobs=none`` option to get a log that is
+correctly sequenced. If searching the log file seach for ``error:`` and the
+error should be just above it.
+
+.. _Contributing:
+
+Contributing
+############
+
+We welcome all users adding, fixing, updating and upgrading packages and their
+configurations. The RSB is open source and open to contributions. These can be
+bug fixes, new features or new configurations. Please break patches down into
+changes to the core Python code, configuration changes or new configurations.
+
+Please email patches generated using git so your commit messages and you are
+acknowledged as the contributor.