From 8b643359868d044ef0f1f3432dd49594aae6c6a2 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Wed, 2 Nov 2016 12:09:54 +1100 Subject: RSB: Finish reformatting after moving from asciidocs. --- rsb/bug-reporting.rst | 61 + rsb/commands.rst | 323 ++++ rsb/configuration.rst | 1515 ++++++++++++++++++ rsb/cross-canadian-cross.rst | 98 ++ rsb/history.rst | 24 + rsb/hosts.rst | 346 ++++ rsb/index.rst | 8 + rsb/project-sets.rst | 240 +++ rsb/quick-start.rst | 531 +++++++ rsb/source-builder.rst | 3578 +----------------------------------------- rsb/third-party-packages.rst | 314 ++++ 11 files changed, 3534 insertions(+), 3504 deletions(-) create mode 100644 rsb/bug-reporting.rst create mode 100644 rsb/commands.rst create mode 100644 rsb/configuration.rst create mode 100644 rsb/cross-canadian-cross.rst create mode 100644 rsb/history.rst create mode 100644 rsb/hosts.rst create mode 100644 rsb/project-sets.rst create mode 100644 rsb/quick-start.rst create mode 100644 rsb/third-party-packages.rst (limited to 'rsb') 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 + +.. _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. diff --git a/rsb/commands.rst b/rsb/commands.rst new file mode 100644 index 0000000..4c8160a --- /dev/null +++ b/rsb/commands.rst @@ -0,0 +1,323 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. comment COPYRIGHT (c) 2012 - 2016. +.. comment Chris Johns + +Commands +######## + +Checker (sb-check) +~~~~~~~~~~~~~~~~~~ + +This commands checks your system is set up correctly. Most options are ignored:: + + $ ../source-builder/sb-check --help + sb-check: [options] [args] + RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns + Options and arguments: + --force : Force the build to proceed + --quiet : Quiet output (not used) + --trace : Trace the execution + --dry-run : Do everything but actually run the build + --warn-all : Generate warnings + --no-clean : Do not clean up the build tree + --always-clean : Always clean the build tree, even with an error + --jobs : Run with specified number of jobs, default: num CPUs. + --host : Set the host triplet + --build : Set the build triplet + --target : Set the target triplet + --prefix path : Tools build prefix, ie where they are installed + --topdir path : Top of the build tree, default is $PWD + --configdir path : Path to the configuration directory, default: ./config + --builddir path : Path to the build directory, default: ./build + --sourcedir path : Path to the source directory, default: ./source + --tmppath path : Path to the temp directory, default: ./tmp + --macros file[,[file] : Macro format files to load after the defaults + --log file : Log file where all build out is written too + --url url[,url] : URL to look for source + --no-download : Disable the source downloader + --targetcflags flags : List of C flags for the target code + --targetcxxflags flags : List of C++ flags for the target code + --libstdcxxflags flags : List of C++ flags to build the target libstdc++ code + --with-