From 60ed99d2b0c01f46c3458f45c0d0cd9334b6c497 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Fri, 11 Jan 2019 10:20:08 +0100 Subject: user: Add RSB content as a chapter Remove the separate RSB manual. --- rsb/bug-reporting.rst | 60 -- rsb/commands.rst | 329 -------- rsb/conf.py | 14 - rsb/configuration.rst | 1514 ------------------------------------ rsb/cross-canadian-cross.rst | 97 --- rsb/history.rst | 26 - rsb/index.rst | 40 - rsb/project-sets.rst | 263 ------- rsb/source-builder.rst | 78 -- rsb/third-party-packages.rst | 313 -------- rsb/why-build-from-source.rst | 59 -- rsb/wscript | 11 - user/index.rst | 33 +- user/rsb/bug-reporting.rst | 60 ++ user/rsb/commands.rst | 329 ++++++++ user/rsb/configuration.rst | 1514 ++++++++++++++++++++++++++++++++++++ user/rsb/cross-canadian-cross.rst | 97 +++ user/rsb/history.rst | 26 + user/rsb/index.rst | 93 +++ user/rsb/project-sets.rst | 263 +++++++ user/rsb/third-party-packages.rst | 313 ++++++++ user/rsb/why-build-from-source.rst | 59 ++ wscript | 1 - 23 files changed, 2772 insertions(+), 2820 deletions(-) delete mode 100644 rsb/bug-reporting.rst delete mode 100644 rsb/commands.rst delete mode 100644 rsb/conf.py delete mode 100644 rsb/configuration.rst delete mode 100644 rsb/cross-canadian-cross.rst delete mode 100644 rsb/history.rst delete mode 100644 rsb/index.rst delete mode 100644 rsb/project-sets.rst delete mode 100644 rsb/source-builder.rst delete mode 100644 rsb/third-party-packages.rst delete mode 100644 rsb/why-build-from-source.rst delete mode 100644 rsb/wscript create mode 100644 user/rsb/bug-reporting.rst create mode 100644 user/rsb/commands.rst create mode 100644 user/rsb/configuration.rst create mode 100644 user/rsb/cross-canadian-cross.rst create mode 100644 user/rsb/history.rst create mode 100644 user/rsb/index.rst create mode 100644 user/rsb/project-sets.rst create mode 100644 user/rsb/third-party-packages.rst create mode 100644 user/rsb/why-build-from-source.rst diff --git a/rsb/bug-reporting.rst b/rsb/bug-reporting.rst deleted file mode 100644 index b8fcc71..0000000 --- a/rsb/bug-reporting.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-4.0 - -.. Copyright (C) 2012, 2016 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 deleted file mode 100644 index 214607c..0000000 --- a/rsb/commands.rst +++ /dev/null @@ -1,329 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-4.0 - -.. Copyright (C) 2012, 2016 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 - --patchdir path : Path to the patches directory, default: ./patches - --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-