diff options
author | Chris Johns <chrisj@rtems.org> | 2020-03-12 15:13:39 +1100 |
---|---|---|
committer | Chris Johns <chrisj@rtems.org> | 2020-03-13 08:18:36 +1100 |
commit | f6720264ea8ebfdd3a6b7819650520a2d18e7c31 (patch) | |
tree | 77191c2d15ae58fc35b51d07c4c7e0b80ecd2c4d /user/start/prefixes.rst | |
parent | c-user: Move "Obsolete Configuration Options" (diff) | |
download | rtems-docs-f6720264ea8ebfdd3a6b7819650520a2d18e7c31.tar.bz2 |
user: Update Quick Start Guide
- Add support for release source archives
- Add building the BSP using the RSB
- Add building packages using the RSB
- Add an application
Closes #2998
Diffstat (limited to 'user/start/prefixes.rst')
-rw-r--r-- | user/start/prefixes.rst | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/user/start/prefixes.rst b/user/start/prefixes.rst index 9727503..67255d0 100644 --- a/user/start/prefixes.rst +++ b/user/start/prefixes.rst @@ -21,32 +21,39 @@ path. Packages for your host computer typically use a default prefix of :file:`/usr/local` on FreeBSD and Linux. You have to select a prefix for your installation. You will build and install -the RTEMS tool suite, an RTEMS kernel for a BSP and you may build and install -third party libraries. You can build them all as a stack with a single prefix -or you can +the RTEMS tool suite, an RTEMS kernel for a BSP, and you may build and install +third party libraries. You can build all the parts as a stack with a single +prefix or you can separate various parts by providing different prefixes to +each part as it is built. Using separate prefixes is for experienced RTEMS +users. -The RTEMS tool suite consists of a cross tool chain (Binutils, GCC, GDB, -Newlib, etc.) for your target architecture and :ref:`other tools <HostTools>` -provided by the RTEMS Project. The RTEMS +Do not select a prefix that is under the top of any of the source trees. The +prefix collects the install output of the various build steps you take in this +guide and need to be kept separate from the sources used. +The RTEMS tool suite consists of a cross tool chain (Binutils, GCC, GDB, +Newlib, etc.) for your target architecture and :ref:`RTEMS tools <HostTools>` +provided by the RTEMS Project. The RTEMS Tools are a toolkit that help create +the RTEMS ecosystem and help support the building of embedded real-time +applications and systems. You build and install the tool suite with the :ref:`RTEMS Source Builder (RSB) <RSB>`. By default, the RSB will start the prefix path with a host operating -system specific path plus :file:`rtems` plus the RTEMS version, e.g. -:file:`/opt/rtems/5` on Linux and :file:`/usr/local/rtems/5` on FreeBSD and -macOS. +system specific path plus :file:`rtems`, and the RTEMS version, e.g. +:file:`/opt/rtems/5` on Linux, and :file:`/usr/local/rtems/5` on FreeBSD and +macOS. Placing the RTEMS version number in the path lets you manage and +migrate RTEMS versions as they are released. It is strongly recommended to run the RSB as a *normal user* and not with *root* privileges (also known as *super user* or *Administrator*). You have to make sure that your normal user has sufficient privileges to create files and directories under the prefix. For example, you can create a directory -:file:`/opt/rtems` and give it to a developer group with read, write and +:file:`/opt/rtems` and give it to a developer group with read, write, and execute permissions. Alternatively, you can choose a prefix in your home directory, e.g. :file:`$HOME/rtems/5` or with a project-specific component -:file:`$HOME/project-x/rtems/5`. For more ideas, see the -:ref:`project sandboxing <ProjectSandboxing>` section. In this quick start -chapter, we will choose :file:`$HOME/quick-start/rtems/5` for the RTEMS tool -suite prefix. +:file:`$HOME/project-x/rtems/5`. For more ideas, see the :ref:`project +sandboxing <ProjectSandboxing>` section. In this quick start chapter, we will +choose :file:`$HOME/quick-start/rtems/5` for the RTEMS tool suite prefix. .. warning:: |