source: rtems-docs/user/start/prefixes.rst @ cb4e4e2

Last change on this file since cb4e4e2 was eae5454, checked in by Sebastian Huber <sebastian.huber@…>, on Jan 11, 2019 at 2:47:00 PM

user: Rework Prefixes section

Rename it to "Choose an Installation Prefix".

Update #3675.

  • Property mode set to 100644
File size: 2.2 KB

Choose an Installation Prefix

.. index:: prefix

You will see the term :ref:term:`prefix` referred to throughout this documentation and in a wide number of software packages you can download from the internet. It is also used in the GNU Coding Standard. A prefix is the path on your host computer a software package is installed under. Packages that have a prefix will place all parts under the prefix 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 RTEMS tool suite installation. 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. 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.


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 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.



The prefix must not contain space characters.

Note: See TracBrowser for help on using the repository browser.