1 | .. SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
2 | |
---|
3 | .. Copyright (C) 2016 Chris Johns <chrisj@rtems.org> |
---|
4 | |
---|
5 | .. index:: prefix |
---|
6 | .. _prefixes: |
---|
7 | |
---|
8 | Prefixes |
---|
9 | ======== |
---|
10 | |
---|
11 | You will see the term :ref:term:`prefix` referred to thoughout this |
---|
12 | documentation and in a wide number of software packages you can download from |
---|
13 | the internet. A **prefix** is the path on your computer a software package is |
---|
14 | built and installed under. Packages that have a **prefix** will place all parts |
---|
15 | under the **prefix** path. On a host computer like Linux the packages you |
---|
16 | install from your distribution typically use a platform specific standard |
---|
17 | **prefix**. For example on Linux it is :file:`/usr` and on FreeBSD it is |
---|
18 | :file:`/usr/local`. |
---|
19 | |
---|
20 | We recommend you *DO NOT* use the standard **prefix** when installing the RTEMS |
---|
21 | Tools. The standard **prefix** is the default **prefix** each package built by |
---|
22 | the RSB contains. If you are building the tools when logged in as a *Standard |
---|
23 | User* and not as the *Super User* (``root``) or *Administrator* the RTEMS |
---|
24 | Source Builder (RSB) *will* fail and report an error if the default **prefix** |
---|
25 | is not writable. We recommend you leave the standand **prefix** for the |
---|
26 | packages your operating system installs or software you manually install such |
---|
27 | as applications. |
---|
28 | |
---|
29 | A further reason not to use the standard **prefix** is to allow more than one |
---|
30 | version of RTEMS to exist on your host machine at a time. The ``autoconf`` and |
---|
31 | ``automake`` tools required by RTEMS are not versioned and vary between the |
---|
32 | various versions of RTEMS. If you use a single **prefix** such as the standard |
---|
33 | **prefix** there is a chance parts from a package of different versions may |
---|
34 | interact. This should not happen but it can. |
---|
35 | |
---|
36 | For POSIX or Unix hosts, the RTEMS Project uses :file:`/opt/rtems` as it's |
---|
37 | standard **prefix**. We view this **prefix** as a production level path, and we |
---|
38 | prefer to place development versions under a different **prefix** away from the |
---|
39 | production versions. Under this top level **prefix** we place the various |
---|
40 | versions we need for development. For example the version 4.11.0 **prefix** |
---|
41 | would be :file:`/opt/rtems/4.11.0`. If an update called 4.11.1 is released the |
---|
42 | **prefix** would be :file:`/opt/rtems/4.11.1`. These are recommendations and |
---|
43 | the choice of what you use is entirely yours. You may decide to have a single |
---|
44 | path for all RTEMS 4.11 releases of :file:`/opt/rtems/4.11`. |
---|
45 | |
---|
46 | For Windows a typical **prefix** is :file:`C:\\opt\\rtems` and as an MSYS2 path |
---|
47 | this is :file:`/c/opt/rtems`. |
---|