[e52906b] | 1 | .. SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
[8b64335] | 2 | |
---|
[4886d60] | 3 | .. Copyright (C) 2012, 2016 Chris Johns <chrisj@rtems.org> |
---|
[8b64335] | 4 | |
---|
| 5 | Project Sets |
---|
[9742e45] | 6 | ============ |
---|
[8b64335] | 7 | |
---|
| 8 | The RTEMS Source Builder supports project configurations. Project |
---|
| 9 | configurations can be public or private and can be contained in the RTEMS |
---|
| 10 | Source Builder project if suitable, other projects they use the RTEMS Source |
---|
| 11 | Builder or privately on your local file system. |
---|
| 12 | |
---|
| 13 | The configuration file loader searches the macro ``_configdir`` and by default |
---|
| 14 | this is set to ``%{_topdir}/config:%{_sbdir}/config`` where ``_topdir`` is the |
---|
| 15 | your current working direct, in other words the directory you invoke the RTEMS |
---|
| 16 | Source Builder command in, and ``_sbdir`` is the directory where the RTEMS |
---|
| 17 | Source Builder command resides. Therefore the ``config`` directory under each |
---|
| 18 | of these is searched so all you need to do is create a ``config`` in your |
---|
| 19 | project and add your configuration files. They do not need to be under the |
---|
| 20 | RTEMS Source Builder source tree. Public projects are included in the main |
---|
| 21 | RTEMS Source Builder such as RTEMS. |
---|
| 22 | |
---|
| 23 | You can also add your own ``patches`` directory next to your ``config`` |
---|
| 24 | directory as the ``%patch`` command searches the ``_patchdir`` macro variable |
---|
| 25 | and it is by default set to ``%{_topdir}/patches:%{_sbdir}/patches``. |
---|
| 26 | |
---|
| 27 | The ``source-builder/config`` directory provides generic scripts for building |
---|
| 28 | various tools. You can specialise these in your private configurations to make |
---|
| 29 | use of them. If you add new generic configurations please contribute them back |
---|
| 30 | to the project |
---|
| 31 | |
---|
[f95699b] | 32 | Build sets can be controlled via the command line to enable |
---|
| 33 | (``--with-<feature>``) and disable (``--without-<feature>``) various features. |
---|
| 34 | There is no definitive list of build options that can be listed because they |
---|
| 35 | are implemented with the configuration scripts. The best way to find what is |
---|
| 36 | available is to grep the configuration files for ``with`` and ``without``. |
---|
| 37 | |
---|
[8b64335] | 38 | Bare Metal |
---|
[9742e45] | 39 | ---------- |
---|
[8b64335] | 40 | |
---|
| 41 | The RSB contains a 'bare' configuration tree and you can use this to add |
---|
| 42 | packages you use on the hosts. For example 'qemu' is supported on a range of |
---|
| 43 | hosts. RTEMS tools live in the ``rtems/config`` directory tree. RTEMS packages |
---|
| 44 | include tools for use on your host computer as well as packages you can build |
---|
| 45 | and run on RTEMS. |
---|
| 46 | |
---|
| 47 | The **bare metal** support for GNU Tool chains. An example is the |
---|
| 48 | ``lang/gcc491`` build set. You need to provide a target via the command line |
---|
| 49 | ``--target`` option and this is in the standard 2 or 3 tuple form. For example |
---|
| 50 | for an ARM compiler you would use ``arm-eabi`` or ``arm-eabihf`, and for SPARC |
---|
| 51 | you would use `sparc-elf`:: |
---|
| 52 | |
---|
| 53 | $ cd rtems-source-builder/bare |
---|
| 54 | $ ../source-builder/sb-set-builder --log=log_arm_eabihf \ |
---|
| 55 | --prefix=$HOME/development/bare --target=arm-eabihf lang/gcc491 |
---|
| 56 | RTEMS Source Builder - Set Builder, v0.3.0 |
---|
| 57 | Build Set: lang/gcc491 |
---|
| 58 | config: devel/expat-2.1.0-1.cfg |
---|
| 59 | package: expat-2.1.0-x86_64-apple-darwin13.2.0-1 |
---|
| 60 | building: expat-2.1.0-x86_64-apple-darwin13.2.0-1 |
---|
| 61 | config: devel/binutils-2.24-1.cfg |
---|
| 62 | package: arm-eabihf-binutils-2.24-1 |
---|
| 63 | building: arm-eabihf-binutils-2.24-1 |
---|
| 64 | config: devel/gcc-4.9.1-newlib-2.1.0-1.cfg |
---|
| 65 | package: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1 |
---|
| 66 | building: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1 |
---|
| 67 | config: devel/gdb-7.7-1.cfg |
---|
| 68 | package: arm-eabihf-gdb-7.7-1 |
---|
| 69 | building: arm-eabihf-gdb-7.7-1 |
---|
| 70 | installing: expat-2.1.0-x86_64-apple-darwin13.2.0-1 -> /Users/chris/development/bare |
---|
| 71 | installing: arm-eabihf-binutils-2.24-1 -> /Users/chris/development/bare |
---|
| 72 | installing: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1 -> /Users/chris/development/bare |
---|
| 73 | installing: arm-eabihf-gdb-7.7-1 -> /Users/chris/development/bare |
---|
| 74 | cleaning: expat-2.1.0-x86_64-apple-darwin13.2.0-1 |
---|
| 75 | cleaning: arm-eabihf-binutils-2.24-1 |
---|
| 76 | cleaning: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1 |
---|
| 77 | cleaning: arm-eabihf-gdb-7.7-1 |
---|
| 78 | |
---|
| 79 | RTEMS |
---|
[9742e45] | 80 | ----- |
---|
[8b64335] | 81 | |
---|
| 82 | The RTEMS Configurations found in the ``rtems`` directory. The configurations |
---|
| 83 | are grouped by RTEMS version. In RTEMS the tools are specific to a specific |
---|
| 84 | version because of variations between Newlib and RTEMS. Restructuring in RTEMS |
---|
| 85 | and Newlib sometimes moves *libc* functionality between these two parts and |
---|
| 86 | this makes existing tools incompatible with RTEMS. |
---|
| 87 | |
---|
| 88 | RTEMS allows architectures to have different tool versions and patches. The |
---|
| 89 | large number of architectures RTEMS supports can make it difficult to get a |
---|
| 90 | common stable version of all the packages. An architecture may require a recent |
---|
| 91 | GCC because an existing bug has been fixed, however the more recent version may |
---|
| 92 | have a bug in other architecture. Architecture specific patches should be |
---|
| 93 | limited to the architecture it relates to. The patch may fix a problem on the |
---|
| 94 | effect architecture however it could introduce a problem in another |
---|
| 95 | architecture. Limit exposure limits any possible crosstalk between |
---|
| 96 | architectures. |
---|
| 97 | |
---|
| 98 | If you are building a released version of RTEMS the release RTEMS tar file will |
---|
| 99 | be downloaded and built as part of the build process. If you are building a |
---|
| 100 | tool set for use with the development branch of RTEMS, the development branch |
---|
| 101 | will be cloned directly from the RTEMS GIT repository and built. |
---|
| 102 | |
---|
| 103 | When building RTEMS within the RTEMS Source Builder it needs a suitable working |
---|
| 104 | ``autoconf`` and ``automake``. These packages need to built and installed in their |
---|
| 105 | prefix in order for them to work. The RTEMS Source Builder installs all |
---|
| 106 | packages only after they have been built so if you host does not have a |
---|
| 107 | recent enough version of ``autoconf`` and ``automake`` you first need to build them |
---|
| 108 | and install them then build your tool set. The commands are:: |
---|
| 109 | |
---|
| 110 | $ ../source-builder/sb-set-builder --log=l-4.11-at.txt \ |
---|
| 111 | --prefix=$HOME/development/rtems/4.11 4.11/rtems-autotools |
---|
| 112 | $ export PATH=~/development/rtems/4.11/bin:$PATH <1> |
---|
| 113 | $ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \ |
---|
| 114 | --prefix=$HOME/development/rtems/4.11 4.11/rtems-sparc |
---|
| 115 | |
---|
| 116 | .. topic:: Items: |
---|
| 117 | |
---|
| 118 | 1. Setting the path. |
---|
| 119 | |
---|
| 120 | If this is your first time building the tools and RTEMS it pays to add the |
---|
| 121 | ``--dry-run`` option. This will run through all the configuration files and if |
---|
| 122 | any checks fail you will see this quickly rather than waiting for until the |
---|
| 123 | build fails a check. |
---|
| 124 | |
---|
| 125 | To build snapshots for testing purposes you use the available macro maps |
---|
| 126 | passing them on the command line using the ``--macros`` option. For RTEMS these |
---|
| 127 | are held in ``config/snapshots`` directory. The following builds *newlib* from |
---|
| 128 | CVS:: |
---|
| 129 | |
---|
| 130 | $ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \ |
---|
| 131 | --prefix=$HOME/development/rtems/4.11 \ |
---|
| 132 | --macros=snapshots/newlib-head.mc \ |
---|
| 133 | 4.11/rtems-sparc |
---|
| 134 | |
---|
| 135 | and the following uses the version control heads for ``binutils``, ``gcc``, |
---|
| 136 | ``newlib``, ``gdb`` and *RTEMS*:: |
---|
| 137 | |
---|
| 138 | $ ../source-builder/sb-set-builder --log=l-heads-sparc.txt \ |
---|
| 139 | --prefix=$HOME/development/rtems/4.11-head \ |
---|
| 140 | --macros=snapshots/binutils-gcc-newlib-gdb-head.mc \ |
---|
| 141 | 4.11/rtems-sparc |
---|
| 142 | |
---|
[f95699b] | 143 | Following features can be enabled/disabled via the command line for the RTEMS |
---|
| 144 | build sets: |
---|
| 145 | |
---|
| 146 | ``--without-rtems`` |
---|
| 147 | Do not build RTEMS when building an RTEMS build set. |
---|
| 148 | |
---|
| 149 | ``--without-cxx`` |
---|
| 150 | Do not build a C++ compiler. |
---|
| 151 | |
---|
| 152 | ``--with-ada`` |
---|
| 153 | Attempt to build an Ada compiler. You need a native GNAT installed. |
---|
| 154 | |
---|
| 155 | ``--with-fortran`` |
---|
| 156 | Attempt to build a Fortran compiler. |
---|
| 157 | |
---|
| 158 | ``--with-objc`` |
---|
| 159 | Attempt to build a C++ compiler. |
---|
| 160 | |
---|
[8b64335] | 161 | Patches |
---|
[9742e45] | 162 | ------- |
---|
[8b64335] | 163 | |
---|
| 164 | Packages being built by the RSB need patches from time to time and the RSB |
---|
| 165 | supports patching upstream packages. The patches are held in a seperate |
---|
| 166 | directory called ``patches`` relative to the configuration directory you are |
---|
| 167 | building. For example ``%{_topdir}/patches:%{_sbdir}/patches``. Patches are |
---|
| 168 | declared in the configuration files in a similar manner to the package's source |
---|
| 169 | so please refer to the ``%source`` documentation. Patches, like the source, are |
---|
| 170 | to be made publically available for configurations that live in the RSB package |
---|
| 171 | and are downloaded on demand. |
---|
| 172 | |
---|
| 173 | If a package has a patch management tool it is recommended you reference the |
---|
| 174 | package's patch management tools directly. If the RSB does not support the |
---|
| 175 | specific patch manage tool please contact the mailing list to see if support |
---|
| 176 | can be added. |
---|
| 177 | |
---|
| 178 | Patches for packages developed by the RTEMS project can be placed in the RTEMS |
---|
| 179 | Tools Git repository. The ``tools`` directory in the repository has various |
---|
| 180 | places a patch can live. The tree is broken down in RTEMS releases and then |
---|
| 181 | tools within that release. If the package is not specific to any release the |
---|
| 182 | patch can be added closer to the top under the package's name. Patches to fix |
---|
| 183 | specific tool related issues for a specific architecture should be grouped |
---|
| 184 | under the specific architecture and only applied when building that |
---|
| 185 | architecture avoiding a patch breaking an uneffected architecture. |
---|
| 186 | |
---|
| 187 | Patches in the RTEMS Tools repository need to be submitted to the upstream |
---|
| 188 | project. It should not be a clearing house for patches that will not be |
---|
| 189 | accepted upstream. |
---|
| 190 | |
---|
| 191 | Patches are added to a component's name and in the ``%prep:`` section the |
---|
| 192 | patches can be set up, meaning they are applied to source. The patches |
---|
| 193 | are applied in the order they are added. If there is a dependency make |
---|
| 194 | sure you order the patches correctly when you add them. You can add any |
---|
| 195 | number of patches and the RSB will handle them efficently. |
---|
| 196 | |
---|
| 197 | Patches can have options. These are added before the patch URL. If no options |
---|
| 198 | are provided the patch's setup default options are used. |
---|
| 199 | |
---|
| 200 | Patches can be declared in build set up files. |
---|
| 201 | |
---|
| 202 | This examples shows how to declare a patch for gdb in the ``lm32`` architecture:: |
---|
| 203 | |
---|
| 204 | %patch add <1> gdb <2> %{rtems_gdb_patches}/lm32/gdb-sim-lm32uart.diff <3> |
---|
| 205 | |
---|
| 206 | .. topic:: Items: |
---|
| 207 | |
---|
| 208 | 1. The patch's ``add`` command. |
---|
| 209 | |
---|
| 210 | 2. The group of patches this patch belongs too. |
---|
| 211 | |
---|
| 212 | 3. The patch's URL. It is downloaded from here. |
---|
| 213 | |
---|
| 214 | Patches require a checksum to avoid a warning. The ``%hash`` directive can be |
---|
| 215 | used to add a checksum for a patch that is used to verify the patch:: |
---|
| 216 | |
---|
| 217 | %hash md5 <1> gdb-sim-lm32uart.diff <2> 77d070878112783292461bd6e7db17fb <3> |
---|
| 218 | |
---|
| 219 | .. topic:: Items: |
---|
| 220 | |
---|
| 221 | 1. The type of checksum, in the case an MD5 hash. |
---|
| 222 | |
---|
| 223 | 2. The patch file the checksum is for. |
---|
| 224 | |
---|
| 225 | 3. The MD5 hash. |
---|
| 226 | |
---|
| 227 | The patches are applied when a patch ``setup`` command is issued in the |
---|
| 228 | ``%prep:`` section. All patches in the group are applied. To apply the GDB |
---|
| 229 | patch above use:: |
---|
| 230 | |
---|
| 231 | %patch setup <1> gdb <2> -p1 <3> |
---|
| 232 | |
---|
| 233 | .. topic:: Items: |
---|
| 234 | |
---|
| 235 | 1. The patch's ``setup`` command. |
---|
| 236 | |
---|
| 237 | 2. The group of patches to apply. |
---|
| 238 | |
---|
| 239 | 3. The patch group's default options. If no option is given with the patch |
---|
| 240 | these options are used. |
---|
| 241 | |
---|
| 242 | Architecture specific patches live in the architecture build set file isolating |
---|
| 243 | the patch to that specific architecture. If a patch is common to a tool it |
---|
| 244 | resides in the RTEMS tools configuration file. Do not place patches for tools |
---|
| 245 | in the ``source-builder/config`` template configuration files. |
---|
| 246 | |
---|
| 247 | To test a patch simply copy it to your local ``patches`` directory. The RSB |
---|
| 248 | will see the patch is present and will not attempt to download it. Once you are |
---|
| 249 | happy with the patch submit it to the project and a core developer will review |
---|
| 250 | it and add it to the RTEMS Tools git repository. For example, to test a local |
---|
| 251 | patch for newlib, add the following two lines to the .cfg file in |
---|
| 252 | ``rtems/config/tools/`` that is included by the bset you use: |
---|
| 253 | |
---|
| 254 | .. code-block:: auto |
---|
| 255 | |
---|
| 256 | %patch add newlib file://0001-this-is-a-newlib-patch.patch <1> |
---|
| 257 | %hash md5 0001-this-is-a-newlib-patch.diff 77d070878112783292461bd6e7db17fb <2> |
---|
| 258 | |
---|
| 259 | .. topic:: Items: |
---|
| 260 | |
---|
| 261 | 1. The diff file prepended with ``file://`` to tell RSB this is a local file. |
---|
| 262 | |
---|
| 263 | 2. The output from md5sum on the diff file. |
---|