[PATCH] quick start variable version number

Robin Mueller robin.mueller.m at gmail.com
Wed Dec 2 13:54:11 UTC 2020


---
 user/start/sources.rst | 10 ++++++++--
 user/start/tools.rst   | 19 +++++++++++++------
 2 files changed, 21 insertions(+), 8 deletions(-)

diff --git a/user/start/sources.rst b/user/start/sources.rst
index 8c40aa0..836cab9 100644
--- a/user/start/sources.rst
+++ b/user/start/sources.rst
@@ -9,11 +9,14 @@
 Obtain the Sources
 ==================
 
+The chosen RTEMS version (5 for a released build, 6 for the git clone) will be 
+replaced by $RTEMS_VERSION for some parts of the Quick Start.
 You have considered and chosen a suitable installation prefix in the previous
-section.  We have chosen :file:`$HOME/quick-start/rtems/5` as the installation
+section.  We have chosen :file:`$HOME/quick-start/rtems/$RTEMS_VERSION` as the installation
 prefix. We will show how to use a released version of RTEMS and then as an
 alternative we will show you using the :ref:`RSB Git repository
-<QuickStartSources_Git>`. Consider using a Git clone if you wish to make
+<QuickStartSources_Git>` master which uses RTEMS version 6. 
+Consider using a Git clone if you wish to make
 contributions to the RTEMS Project.
 
 You need the RTEMS Source Builder (RSB) to work with RTEMS and we prefer you
@@ -86,6 +89,9 @@ You can clone the Git repository to get all versions of RTEMS including the
 development head.  Release branches in Git are kept stable however they may
 differ from a release's source archive.
 
+The master branch by default uses RTEMS version 6 and does not 
+contain the version 5 `rtems-sparc` build set.
+
 .. code-block:: none
 
     mkdir -p $HOME/quick-start/src
diff --git a/user/start/tools.rst b/user/start/tools.rst
index baa2387..7f4a122 100644
--- a/user/start/tools.rst
+++ b/user/start/tools.rst
@@ -12,20 +12,27 @@ Install the Tool Suite
 
 You have chosen an installation prefix, the BSP to build, the tool's
 architecure and prepared the source for the RSB in the previous sections.  We
-have chosen :file:`$HOME/quick-start/rtems/5` as the installation prefix, the
-``erc32`` BSP and the SPARC architecture name of ``sparc-rtems5``, and unpacked
-the RSB source in :file:`$HOME/quick-start/src`.
+have chosen :file:`$HOME/quick-start/rtems/$RTEMS_VERSION` as the installation prefix, the
+``erc32`` BSP and the SPARC architecture name of ``sparc-rtems5`` (``sparc-rtems6`` for the git clone), 
+and unpacked the RSB source in :file:`$HOME/quick-start/src`.
 
 The tool suite for RTEMS and the RTEMS sources are tightly coupled.  For
 example, do not use a RTEMS version 5 tool suite with RTEMS version 4.11
 sources and vice versa.
 
-Build and install the tool suite:
+The available build sets can be displayed with:
+
+.. code-block:: none
+    
+    cd $HOME/quick-start/src/rsb/rtems
+    ../source-builder/sb-set-builder --list-bsets
+	
+Build and install the tool suite for the SPARC architecture and RTEMS version:
 
 .. code-block:: none
 
     cd $HOME/quick-start/src/rsb/rtems
-    ../source-builder/sb-set-builder --prefix=$HOME/quick-start/rtems/5 5/rtems-sparc
+    ../source-builder/sb-set-builder --prefix=$HOME/quick-start/rtems/$RTEMS_VERSION $RTEMS_VERSION/rtems-sparc
 
 This command should output something like this (omitted lines are denoted by
 ...). The build host appears as part of the name of the package being
@@ -51,7 +58,7 @@ built. The name you see may vary depending on the host you are using:
     Build Set: Time 0:21:35.626294
 
 Once the build has successfully completed you can check if the cross C compiler
-works with the following command:
+works with the following command (replace 5 with 6 for RTEMS 6):
 
 .. code-block:: none
 
-- 
2.29.2



More information about the devel mailing list