From 8ffa38cbe64c7be971bc8d6a928126e82f653d3c Mon Sep 17 00:00:00 2001
From: pritishjain <pritishjain2001@gmail.com>
Date: Sun, 18 Nov 2018 19:39:32 +0530
Subject: [PATCH] version number notation: Ticket #2562 (GCI 2018)
---
rsb/configuration.rst | 12 ++++++------
rsb/cross-canadian-cross.rst | 23 ++++++++++++++---------
rsb/project-sets.rst | 34 ++++++++++++++++++++++++----------
rsb/third-party-packages.rst | 25 +++++++++++++++----------
user/start/index.rst | 22 ++++++++++++++++++----
5 files changed, 77 insertions(+), 39 deletions(-)
diff --git a/rsb/configuration.rst b/rsb/configuration.rst
index b2745a5..82505da 100644
a
|
b
|
configuration files. |
402 | 402 | |
403 | 403 | Defining macros is performed with the ``%define`` macro:: |
404 | 404 | |
405 | | %define _target m32r-rtems4.11 |
| 405 | %define _target m32r-rtems**urversion** |
406 | 406 | |
407 | 407 | Inline including another file with the ``%include`` macro continues processing |
408 | 408 | with the specified file returning to carry on from just after the include |
409 | 409 | point:: |
410 | 410 | |
411 | | %include rtems-4.11-base.bset |
| 411 | %include rtems-**urversion**-base.bset |
412 | 412 | |
413 | | This includes the RTEMS 4.11 base set of defines and checks. The configuration |
| 413 | This includes the RTEMS **urversion** base set of defines and checks. The configuration |
414 | 414 | paths as defined by ``_configdir`` are scanned. The file extension is optional. |
415 | 415 | |
416 | 416 | You reference build set or package configuration files by placing the file name |
… |
… |
The generic configuration may provide defaults in case options are not |
460 | 460 | specified. The patches this specific version of the package requires can be |
461 | 461 | included:: |
462 | 462 | |
463 | | Patch0: gcc-4.7.2-rtems4.11-20121026.diff |
| 463 | Patch0: gcc-4.7.2-rtems**urversion**-20121026.diff |
464 | 464 | |
465 | 465 | Finally including the GCC 4.7 configuration script:: |
466 | 466 | |
… |
… |
The ``__patchdir`` path is searched. |
1272 | 1272 | |
1273 | 1273 | To add a patch:: |
1274 | 1274 | |
1275 | | %patch add gcc <1> gcc-4.7.2-rtems4.11-20121026.diff |
1276 | | %patch add gcc -p0 <2> gcc-4.7.2-rtems4.11-20121101.diff |
| 1275 | %patch add gcc <1> gcc-4.7.2-rtems**urversion**-20121026.diff |
| 1276 | %patch add gcc -p0 <2> gcc-4.7.2-rtems**urversion**-20121101.diff |
1277 | 1277 | |
1278 | 1278 | .. topic:: Items: |
1279 | 1279 | |
diff --git a/rsb/cross-canadian-cross.rst b/rsb/cross-canadian-cross.rst
index d4fce9e..805c8f6 100644
a
|
b
|
To build the NTP package for RTEMS you enter the RSB command:: |
25 | 25 | |
26 | 26 | $ ../source-builder/sb-set-builder \ |
27 | 27 | --log=log_ntp_arm.txt \ |
28 | | --prefix=$HOME/development/rtems/4.11 \ <1> |
29 | | --host=arm-rtems4.11 \ <2> |
| 28 | --prefix=$HOME/development/rtems/**urversion** \ <1> |
| 29 | --host=arm-rtems**urversion** \ <2> |
30 | 30 | --with-rtems-bsp=xilinx_zynq_zc706 \ <3> |
31 | | 4.11/net/ntp |
| 31 | **urversion**/net/ntp |
| 32 | |
| 33 | .. topic:: Note : |
| 34 | In the above commands and all commands on this page, **urversion** gives the version |
| 35 | of RTEMS you are building or want to build. Replace it with reference to release version table on |
| 36 | *projects sets* page . |
32 | 37 | |
33 | 38 | .. topic:: Items: |
34 | 39 | |
… |
… |
to build a MinGW tool set on FreeBSD for Windows add ``--host=mingw32`` |
85 | 90 | if the cross compiler is ``mingw32-gcc``:: |
86 | 91 | |
87 | 92 | $ ../source-builder/sb-set-builder --host=mingw32 \ |
88 | | --log=l-mingw32-4.11-sparc.txt \ |
89 | | --prefix=$HOME/development/rtems/4.11 \ |
90 | | 4.11/rtems-sparc |
| 93 | --log=l-mingw32-**urversion**-sparc.txt \ |
| 94 | --prefix=$HOME/development/rtems/**urversion** \ |
| 95 | **urversion**/rtems-sparc |
91 | 96 | |
92 | 97 | If you are on a Linux Fedora build host with the MinGW packages installed the |
93 | 98 | command line is:: |
94 | 99 | |
95 | 100 | $ ../source-builder/sb-set-builder --host=i686-w64-mingw32 \ |
96 | | --log=l-mingw32-4.11-sparc.txt \ |
97 | | --prefix=$HOME/development/rtems/4.11 \ |
98 | | 4.11/rtems-sparc |
| 101 | --log=l-mingw32-**urversion**-sparc.txt \ |
| 102 | --prefix=$HOME/development/rtems/**urversion** \ |
| 103 | **urversion**/rtems-sparc |
diff --git a/rsb/project-sets.rst b/rsb/project-sets.rst
index 8abd080..01e1480 100644
a
|
b
|
If you are building a released version of RTEMS the release RTEMS tar file will |
94 | 94 | be downloaded and built as part of the build process. If you are building a |
95 | 95 | tool set for use with the development branch of RTEMS, the development branch |
96 | 96 | will be cloned directly from the RTEMS GIT repository and built. |
| 97 | +----------------+----------------+ |
| 98 | | Release(Notes) | Status | |
| 99 | +================+================+ |
| 100 | | 5 | development | |
| 101 | +----------------+----------------+ |
| 102 | | 4.11 |current release | |
| 103 | +----------------+----------------+ |
| 104 | | 4.10 |previous release| |
| 105 | +----------------+----------------+ |
| 106 | |
97 | 107 | |
98 | 108 | When building RTEMS within the RTEMS Source Builder it needs a suitable working |
99 | 109 | ``autoconf`` and ``automake``. These packages need to built and installed in their |
… |
… |
packages only after they have been built so if you host does not have a |
102 | 112 | recent enough version of ``autoconf`` and ``automake`` you first need to build them |
103 | 113 | and install them then build your tool set. The commands are:: |
104 | 114 | |
105 | | $ ../source-builder/sb-set-builder --log=l-4.11-at.txt \ |
106 | | --prefix=$HOME/development/rtems/4.11 4.11/rtems-autotools |
107 | | $ export PATH=~/development/rtems/4.11/bin:$PATH <1> |
108 | | $ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \ |
109 | | --prefix=$HOME/development/rtems/4.11 4.11/rtems-sparc |
| 115 | $ ../source-builder/sb-set-builder --log=l-**urversion**-at.txt \ |
| 116 | --prefix=$HOME/development/rtems/**urversion** **urversion**/rtems-autotools |
| 117 | $ export PATH=~/development/rtems/**urversion**/bin:$PATH <1> |
| 118 | $ ../source-builder/sb-set-builder --log=l-**urversion**-sparc.txt \ |
| 119 | --prefix=$HOME/development/rtems/**urversion** **urversion**/rtems-sparc |
| 120 | |
| 121 | .. topic:: Note : |
| 122 | In the above commands and all commands on this page, **urversion** gives the version |
| 123 | of RTEMS you want to build. |
110 | 124 | |
111 | 125 | .. topic:: Items: |
112 | 126 | |
… |
… |
passing them on the command line using the ``--macros`` option. For RTEMS these |
122 | 136 | are held in ``config/snapshots`` directory. The following builds *newlib* from |
123 | 137 | CVS:: |
124 | 138 | |
125 | | $ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \ |
126 | | --prefix=$HOME/development/rtems/4.11 \ |
| 139 | $ ../source-builder/sb-set-builder --log=l-**urversion**-sparc.txt \ |
| 140 | --prefix=$HOME/development/rtems/**urversion** \ |
127 | 141 | --macros=snapshots/newlib-head.mc \ |
128 | | 4.11/rtems-sparc |
| 142 | **urversion**/rtems-sparc |
129 | 143 | |
130 | 144 | and the following uses the version control heads for ``binutils``, ``gcc``, |
131 | 145 | ``newlib``, ``gdb`` and *RTEMS*:: |
132 | 146 | |
133 | 147 | $ ../source-builder/sb-set-builder --log=l-heads-sparc.txt \ |
134 | | --prefix=$HOME/development/rtems/4.11-head \ |
| 148 | --prefix=$HOME/development/rtems/**urversion**-head \ |
135 | 149 | --macros=snapshots/binutils-gcc-newlib-gdb-head.mc \ |
136 | | 4.11/rtems-sparc |
| 150 | **urversion**/rtems-sparc |
137 | 151 | |
138 | 152 | Patches |
139 | 153 | ------- |
diff --git a/rsb/third-party-packages.rst b/rsb/third-party-packages.rst
index 21d9887..1aaf739 100644
a
|
b
|
To build Net-SNMP the command is: |
44 | 44 | |
45 | 45 | $ cd rtems-source-builder/rtems |
46 | 46 | $ ../source-builder/sb-set-builder --log=log_sis_net_snmp \ |
47 | | --prefix=$HOME/development/rtems/bsps/4.11 \ |
48 | | --with-tools=$HOME/development/rtems/4.11 \ |
49 | | --host=sparc-rtems4.11 --with-rtems-bsp=erc32 4.11/net-mgmt/net-snmp |
| 47 | --prefix=$HOME/development/rtems/bsps/**urversion** \ |
| 48 | --with-tools=$HOME/development/rtems/**urversion** \ |
| 49 | --host=sparc-rtems**urversion** --with-rtems-bsp=erc32 **urversion**/net-mgmt/net-snmp |
50 | 50 | RTEMS Source Builder - Set Builder, v0.3.0 |
51 | | Build Set: 4.11/net-mgmt/net-snmp |
| 51 | Build Set: **urversion**/net-mgmt/net-snmp |
52 | 52 | config: net-mgmt/net-snmp-5.7.2.1-1.cfg |
53 | | package: net-snmp-5.7.2.1-sparc-rtems4.11-1 |
54 | | building: net-snmp-5.7.2.1-sparc-rtems4.11-1 |
55 | | installing: net-snmp-5.7.2.1-sparc-rtems4.11-1 -> /Users/chris/development/rtems/bsps/4.11 |
56 | | cleaning: net-snmp-5.7.2.1-sparc-rtems4.11-1 |
| 53 | package: net-snmp-5.7.2.1-sparc-rtems**urversion**-1 |
| 54 | building: net-snmp-5.7.2.1-sparc-rtems**urversion**-1 |
| 55 | installing: net-snmp-5.7.2.1-sparc-rtems**urversion**-1 -> /Users/chris/development/rtems/bsps/**urversion** |
| 56 | cleaning: net-snmp-5.7.2.1-sparc-rtems**urversion**-1 |
57 | 57 | Build Set: Time 0:01:10.651926 |
58 | 58 | |
| 59 | .. topic:: Note : |
| 60 | In the above commands and all commands on this page, **urversion** gives the version |
| 61 | of RTEMS you are building or want to build. Replace it with reference to release version table on |
| 62 | *projects sets* page . |
| 63 | |
59 | 64 | Adding |
60 | 65 | ------ |
61 | 66 | |
… |
… |
A package requires 3 files to be created: |
86 | 91 | |
87 | 92 | - The first file is the RTEMS build set file and it resides in the |
88 | 93 | ``rtems/config/%{rtems_version}`` path in a directory tree based on the |
89 | | FreeBSD ports collection. For the NTP package and RTEMS 4.11 this is |
90 | | ``rtems/config/4.11/net/ntp.bset``. If you do not know the FreeBSD port path |
| 94 | FreeBSD ports collection. For the NTP package and RTEMS **urversion** this is |
| 95 | ``rtems/config/**urversion**/net/ntp.bset``. If you do not know the FreeBSD port path |
91 | 96 | for the package you are adding please ask. The build set file references a |
92 | 97 | specific configuration file therefore linking the RTEMS version to a specific |
93 | 98 | version of the package you are adding. Updating the package to a new version |
diff --git a/user/start/index.rst b/user/start/index.rst
index 1016678..6a20886 100644
a
|
b
|
of possible locations and set ups. |
51 | 51 | |
52 | 52 | Simple Example |
53 | 53 | ============== |
| 54 | .. topic:: Note : |
| 55 | In all the commands on this page, **urversion** gives the version |
| 56 | of RTEMS you want to build. Here is a table about RTEMS release versions |
| 57 | |
| 58 | +----------------+----------------+ |
| 59 | | Release(Notes) | Status | |
| 60 | +================+================+ |
| 61 | | 5 | development | |
| 62 | +----------------+----------------+ |
| 63 | | 4.11 |current release | |
| 64 | +----------------+----------------+ |
| 65 | | 4.10 |previous release| |
| 66 | +----------------+----------------+ |
| 67 | |
54 | 68 | |
55 | 69 | .. code-block:: shell |
56 | 70 | |
… |
… |
Simple Example |
64 | 78 | ... |
65 | 79 | $ cd rtems |
66 | 80 | $ ../source-builder/sb-set-builder \ |
67 | | --prefix=/usr/home/chris/development/rtems/5 5/rtems-sparc |
| 81 | --prefix=/usr/home/chris/development/rtems/**urversion** **urversion**/rtems-sparc |
68 | 82 | ... |
69 | 83 | |
70 | 84 | Build the RTEMS Kernel (:ref:`rtems-kernel-install`) by cloning the repository, |
… |
… |
kernel: |
73 | 87 | |
74 | 88 | .. code-block:: shell |
75 | 89 | |
76 | | $ export PATH=$HOME/development/rtems/5/bin:$PATH |
| 90 | $ export PATH=$HOME/development/rtems/**urversion**/bin:$PATH |
77 | 91 | $ cd |
78 | 92 | $ cd development/rtems |
79 | 93 | $ mkdir kernel |
… |
… |
kernel: |
86 | 100 | $ cd .. |
87 | 101 | $ mkdir erc32 |
88 | 102 | $ cd erc32 |
89 | | $ $HOME/development/rtems/kernel/rtems/configure --prefix=$HOME/development/rtems/5 \ |
90 | | --target=sparc-rtems5 --enable-rtemsbsp=erc32 --enable-posix |
| 103 | $ $HOME/development/rtems/kernel/rtems/configure --prefix=$HOME/development/rtems/**urversion** \ |
| 104 | --target=sparc-rtems**urversion** --enable-rtemsbsp=erc32 --enable-posix |
91 | 105 | ... |
92 | 106 | $ make -j 8 |
93 | 107 | ... |