Changeset eae5454 in rtems-docs

Jan 11, 2019, 2:47:00 PM (5 months ago)
Sebastian Huber <sebastian.huber@…>
Sebastian Huber <sebastian.huber@…> (01/11/19 14:47:00)
Sebastian Huber <sebastian.huber@…> (02/18/19 12:50:31)

user: Rework Prefixes section

Rename it to "Choose an Installation Prefix".

Update #3675.

5 edited


  • user/hosts/posix.rst

    r2445655 reae5454  
    3636have restricted access rights to only those who manage and have configuration
    3737control of the machine. We call this project sandboxing and
    38 :ref:`project-sandboxing` explains this in more detail.
     38:ref:`ProjectSandboxing` explains this in more detail.
  • user/installation/project-sandboxing.rst

    r2445655 reae5454  
    33.. Copyright (C) 2016 Chris Johns <>
    5 .. _project-sandboxing:
     5.. _ProjectSandboxing:
    77Project Sandboxing
  • user/start/index.rst

    r2445655 reae5454  
    5858doing this. You can build and install the tools anywhere on the host's
    5959file system you, as a standard user, have read and write access too.
    60 :ref:`Prefixes` and :ref:`project-sandboxing` provide detailed examples
     60:ref:`Prefixes` and :ref:`ProjectSandboxing` provide detailed examples
    6161of possible locations and set ups.
  • user/start/prefixes.rst

    r2445655 reae5454  
    11.. SPDX-License-Identifier: CC-BY-SA-4.0
     3.. Copyright (C) 2019 embedded brains GmbH
     4.. Copyright (C) 2019 Sebastian Huber
    35.. Copyright (C) 2016 Chris Johns <>
    57.. _QuickStartPrefixes:
    7 Prefixes
    8 ========
     9Choose an Installation Prefix
    1012.. index:: prefix
    12 You will see the term :ref:term:`prefix` referred to thoughout this
     14You will see the term :ref:term:`prefix` referred to throughout this
    1315documentation and in a wide number of software packages you can download from
    14 the internet. A **prefix** is the path on your computer a software package is
    15 built and installed under. Packages that have a **prefix** will place all parts
    16 under the **prefix** path. On a host computer like Linux the packages you
    17 install from your distribution typically use a platform specific standard
    18 **prefix**. For example on Linux it is :file:`/usr` and on FreeBSD it is
    19 :file:`/usr/local`.
     16the internet.  It is also used in the
     17`GNU Coding Standard <>`_.
     18A *prefix* is the path on your host computer a software package is installed
     19under.  Packages that have a prefix will place all parts under the prefix
     20path.  Packages for your host computer typically use a default prefix of
     21:file:`/usr/local` on FreeBSD and Linux.
    21 We recommend you *DO NOT* use the standard **prefix** when installing the RTEMS
    22 Tools. The standard **prefix** is the default **prefix** each package built by
    23 the RSB contains. If you are building the tools when logged in as a *Standard
    24 User* and not as the *Super User* (``root``) or *Administrator* the RTEMS
    25 Source Builder (RSB) *will* fail and report an error if the default **prefix**
    26 is not writable. We recommend you leave the standand **prefix** for the
    27 packages your operating system installs or software you manually install such
    28 as applications.
     23You have to select a prefix for your RTEMS tool suite installation.  The RTEMS
     24tool suite consists of a cross tool chain (Binutils, GCC, GDB, Newlib, etc.)
     25for your target architecture and :ref:`other tools <HostTools>` provided by the
     26RTEMS Project.  You build and install the tool suite with the
     27:ref:`RTEMS Source Builder (RSB) <RSB>`.  By default, the RSB will start the
     28prefix path with a host operating system specific path plus :file:`rtems` plus
     29the RTEMS version, e.g.  :file:`/opt/rtems/5` on Linux and
     30:file:`/usr/local/rtems/5` on FreeBSD and macOS.
    30 A further reason not to use the standard **prefix** is to allow more than one
    31 version of RTEMS to exist on your host machine at a time. The ``autoconf`` and
    32 ``automake`` tools required by RTEMS are not versioned and vary between the
    33 various versions of RTEMS. If you use a single **prefix** such as the standard
    34 **prefix** there is a chance parts from a package of different versions may
    35 interact. This should not happen but it can.
     32It is strongly recommended to run the RSB as a *normal user* and not with
     33*root* privileges (also known as *super user* or *Administrator*).  You have to
     34make sure that your normal user has sufficient privileges to create files and
     35directories under the prefix.  For example, you can create a directory
     36:file:`/opt/rtems` and give it to a developer group with read, write and
     37execute permissions.  Alternatively, you can choose a prefix in your home
     38directory, e.g. :file:`$HOME/rtems/5` or with a project-specific component
     39:file:`$HOME/project-x/rtems/5`.  For more ideas, see the
     40:ref:`project sandboxing <ProjectSandboxing>` section.  In this quick start
     41chapter, we will choose :file:`$HOME/quick-start/rtems/5` for the RTEMS tool
     42suite prefix.
    37 For POSIX or Unix hosts, the RTEMS Project uses :file:`/opt/rtems` as it's
    38 standard **prefix**. We view this **prefix** as a production level path, and we
    39 prefer to place development versions under a different **prefix** away from the
    40 production versions. Under this top level **prefix** we place the various
    41 versions we need for development. For example the version 4.11.0 **prefix**
    42 would be :file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the
    43 **prefix** would be :file:`/opt/rtems/4.11.1`. These are recommendations and
    44 the choice of what you use is entirely yours. You may decide to have a single
    45 path for all RTEMS 4.11 releases of :file:`/opt/rtems/4.11`.
     44.. warning::
    47 For Windows a typical **prefix** is :file:`C:\\opt\\rtems` and as an MSYS2 path
    48 this is :file:`/c/opt/rtems`.
     46    The prefix must not contain space characters.
  • user/tools/index.rst

    r2445655 reae5454  
    33.. Copyright (C) 2017 Chris Johns <>
     5.. _HostTools:
    57Host Tools
Note: See TracChangeset for help on using the changeset viewer.