Changeset bb47f89 in rtems-docs for user/rsb/index.rst


Ignore:
Timestamp:
Oct 13, 2019, 8:51:25 AM (4 months ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
c576e9b
Parents:
6185f6e
git-author:
Chris Johns <chrisj@…> (10/13/19 08:51:25)
git-committer:
Chris Johns <chrisj@…> (10/13/19 09:21:17)
Message:

user/rsb: Update 3rd party package build and add packaging details.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • user/rsb/index.rst

    r6185f6e rbb47f89  
    77.. _RSB:
    88
    9 RTEMS Source Builder
    10 ********************
     9Source Builder
     10**************
    1111
    12 The RTEMS Source Builder or RSB is a tool to build packages from source. It is
    13 used by the RTEMS project to build it's compilers and OS. The RSB helps
    14 consolidate the details you need to build a package from source in a controlled
    15 and verifiable way. The tool is aimed at developers of software who use tool
    16 sets for embedded development. The RSB is not limited to building tools just
    17 for RTEMS, you can build bare metal development environments.
     12The RTEMS Source Builder or RSB is a tool to build packages from source. The
     13RTEMS project uses it to build it's compilers, tools, kernel and 3rd party
     14packages. The tool is aimed at developers of software for RTEMS who use tool
     15sets for embedded development.
     16
     17The RSB consolidates the details you need to build a package from source in a
     18controlled and verifiable way. The RSB is not limited to building tools for
     19RTEMS, you can build bare metal development environments.
     20
     21.. comment: TBD: The section "Installing and Tar Files" does not exist.
     22
     23The RSB section of this manual caters for a range of users from new to
     24experienced RTEMS developers who want to understand the RTEMS Source
     25Builder. New users who just want to build tools should follow :ref:`QuickStart`
     26in this manual. Users building a binary tool set for release can read the
     27"Installing and Tar Files". Users wanting to run and test bleeding edge tools
     28or packages, or wanting update or extend the RSB's configuration can read the
     29remaining sections.
    1830
    1931Embedded development typically uses cross-compiling tool chains, debuggers, and
     
    2234used outside of the RTEMS project and we welcome this.
    2335
    24 The RTEMS Source Builder is typically used to build a set of tools or a **build
    25 set**. A **build set** is a collection of packages and a package is a specific
    26 tool, for example GCC or GDB, or library. The RTEMS Source Builder attempts to
    27 support any host environment that runs Python and you can build the package
    28 on. The RSB is not some sort of magic that can take any piece of source code
    29 and make it build. Someone at some point in time has figured out how to build
    30 that package from source and taught this tool.
     36The RTEMS Source Builder is typically used to build a set of packages or a
     37**build set**. A **build set** is a collection of packages and a package is a
     38specific tool, for example GCC, GDB, or library of code and a single **build
     39set** can build them all in a single command. The RTEMS Source Builder
     40attempts to support any host environment that runs Python and you can build
     41the package on. The RSB is not some sort of magic that can take any piece of
     42source code and make it build. Someone at some point in time has figured out
     43how to build that package from source and taught this tool.
    3144
    32 The RTEMS Source Builder has been tested on:
     45.. sidebar:: Setting up your Host
     46
     47   See :ref:`QuickStartHost` for details on setting up hosts.
     48
     49The RTEMS Source Builder is known to work on:
    3350
    3451- ArchLinux
     
    4158- FreeBSD
    4259- NetBSD
     60- Solaris
    4361- MacOS
    4462- Windows
    45 
    46 .. topic:: Setting up your Host
    47 
    48    See :ref:`QuickStartHost` for details on setting up hosts.
    4963
    5064The RTEMS Source Builder has two types of configuration data. The first is the
     
    5367basic GNU tool set is Binutils, GCC, and GDB and is the typical base suite of
    5468tools you need for an embedded cross-development type project. The second type
    55 of configuration data is the configuration files and they define how a package
     69of configuration data are the configuration files and they define how a package
    5670is built. Configuration files are scripts loosely based on the RPM spec file
    5771format and they detail the steps needed to build a package. The steps are
     
    6781a problem please ask on our :r:list:`devel`.
    6882
    69 .. comment: TBD: The section "Installing and Tar Files" does not exist.
    70 
    71 This documentation caters for a range of users from new to experienced RTEMS
    72 developers who want to understand the RTEMS Source Builder. New users
    73 who just want to build tools should follow the Quick Start section in
    74 the User's Guide.  Users building a binary tool set for release can
    75 read the "Installing and Tar Files". Users wanting to run and test
    76 bleeding edge tools or packages, or wanting update or extend the RSB's
    77 configuration can read the remaining sections.
    78 
    7983.. topic:: Bug Reporting
    8084
     
    8488.. toctree::
    8589
    86     why-build-from-source.rst
    87     project-sets
    88     cross-canadian-cross
    89     third-party-packages
    90     configuration
    91     commands
    92     deployment
    93     bug-reporting
    94     history
     90   why-build-from-source.rst
     91   project-sets
     92   cross-canadian-cross
     93   third-party-packages
     94   configuration
     95   commands
     96   deployment
     97   bug-reporting
     98   history
Note: See TracChangeset for help on using the changeset viewer.