Configuration variables
=======================

Variables from the environment
------------------------------

It is recommended that you set the environment variable
`RTEMS_SITE_CROSSTOOLS`. This is then used to find the cross compiler tools,
see also TOOL_BIN_PATH below.

CONFIG.COMMON
-------------

+-------------------------------+------------------------------------------------------+------------------------------------------+
| Variable                      | default value                                        | explanation                              |
+===============================+======================================================+==========================================+
| TOP                           | \`pwd\`                                              | The top directory of the project         |
+-------------------------------+------------------------------------------------------+------------------------------------------+
| INSTALL                       | ${TOP}/$RTEMS_RFS_VERSION                            | The directory where files are installed  |
+-------------------------------+------------------------------------------------------+------------------------------------------+
| RTEMS_TARGET                  | powerpc-rtems${RTEMS_VERSION}                        | Target architecture                      |
+-------------------------------+------------------------------------------------------+------------------------------------------+
| RTEMS_TESTS                   | "no"                                                 | Change to "yes" in order to build        |
|                               |                                                      | RTEMS test programs                      |
+-------------------------------+------------------------------------------------------+------------------------------------------+
| SRCDIR                        | ${TOP}/src/$RTEMS_RFS_VERSION                        | Source directory                         |
+-------------------------------+------------------------------------------------------+------------------------------------------+
| TOOL_BIN_PATH                 | $RTEMS_SITE_CROSSTOOLS/$RTEMS_RFS_VERSION/bin        | Directory where RTEMS cross tools are    |
|                               |                                                      | installed                                |
+-------------------------------+------------------------------------------------------+------------------------------------------+
| RTEMS_GIT_REPO                | "https://github.com/goetzpf/rtems-HZB-kernel.git"    | Source directory of RTEMS kernel         | 
+-------------------------------+------------------------------------------------------+------------------------------------------+
| CEXP_GIT_REPO                 | "https://github.com/goetzpf/rtems-HZB-cexpsh.git"    | Source directory of cexp shell           | 
+-------------------------------+------------------------------------------------------+------------------------------------------+
| BOOTLIB_GIT_REPO              | "https://github.com/goetzpf/rtems-HZB-bootlib.git"   | Source directory of bootlib              | 
+-------------------------------+------------------------------------------------------+------------------------------------------+
| BSPEXT_GIT_REPO               | "https://github.com/goetzpf/rtems-HZB-libbspext.git" | Source directory of bspext               | 
+-------------------------------+------------------------------------------------------+------------------------------------------+
| GESYS_GIT_REPO                | "https://github.com/goetzpf/rtems-HZB-gesys.git"     | Source directory of GeSys                | 
+-------------------------------+------------------------------------------------------+------------------------------------------+

CONFIG-RTEMS-NN
---------------

.. note::
   You usually don't have to change the variables in the CONFIG-RTEMS-NN files.

Common variables
++++++++++++++++

+-------------------------------+------------------------------------------+
| Variable                      | explanation                              |
+===============================+==========================================+
| RTEMS_VERSION                 | The RTEMS version. For RTEMS 5 and newer |
|                               | this is only the *major* version number. |
+-------------------------------+------------------------------------------+
| RTEMS_RFS_VERSION             | The RTEMS version used in the file path  |
|                               | for cross compiler tools. Usually in the |
|                               | form "n.m" with major and minor version. |
+-------------------------------+------------------------------------------+
| BSPS                          | List of board support packages for which |
|                               | RTEMS is built. Note that the naming     |
|                               | convention for RTEMS 6 has the form      |
|                               | "arch/boardsupport" instead of           |
|                               | "boardsupport" alone.                    |
+-------------------------------+------------------------------------------+

Variables for packages
++++++++++++++++++++++

These are the packages that may be used to create a boot image. Note that
package "RTEMS" is always used:

- RTEMS
- CEXP
- BOOTLIB
- BSPEXT
- GESYS

A package is only used (built) when variable [PACKAGE]_GIT_REV is defined.

Here are the package variables:

+-------------------------------+------------------------------------------+
| Variable                      | explanation                              |
+===============================+==========================================+
| [PACKAGE]_GIT_BRANCH          | Git branch that is used to check out     |
|                               | from git repository                      |
+-------------------------------+------------------------------------------+
| [PACKAGE]_GIT_REV             | Git revision that is used to check out   |
|                               | from git repository                      |
+-------------------------------+------------------------------------------+
| [PACKAGE]_PATCHES             | Patch files that are applied to the      |
|                               | source. These files are in directory     |
|                               | "patches"                                |
+-------------------------------+------------------------------------------+