[PATCH rtems-docs] user: Update @rtems-ver-major@ to use sphinx substitution extention
Muhammad Sulthan Mazaya
msulthanmazaya at gmail.com
Tue Jul 18 08:16:07 UTC 2023
Using sphinx-substitution-extensions to manage the variable @rtems-ver-major at .
Originally Utkarsh's idea:
https://discord.com/channels/820452222382112799/820452222848335924/1118416996606943302
I have tested and built the docs to see if it works and it does
subtitute the variable. The changes are: the variable @rtems-ver-major@
is now |rtems-ver-major|. For inline code block we use
:substitution-code:`{content}` and for multiline code block we use:
.. code-block:: {language}
:substitutions:
{content}
---
user/bsps/aarch64/raspberrypi4.rst | 3 +-
user/bsps/aarch64/xilinx-zynqmp.rst | 3 +-
user/bsps/arm/altera-cyclone-v.rst | 3 +-
user/bsps/arm/beagle.rst | 3 +-
user/bsps/arm/imx.rst | 3 +-
user/bsps/arm/imxrt.rst | 9 ++--
user/bsps/arm/raspberrypi.rst | 6 ++-
user/bsps/arm/xen.rst | 6 ++-
user/bsps/bsps-microblaze.rst | 6 ++-
user/bsps/bsps-powerpc.rst | 10 ++--
user/bsps/bsps-riscv.rst | 12 +++--
user/conf.py | 6 +++
user/deployment/index.rst | 71 ++++++++++++++------------
user/exe/initialization.rst | 13 ++---
user/exe/loader.rst | 15 +++---
user/installation/developer.rst | 9 ++--
user/installation/releases.rst | 6 ++-
user/start/app.rst | 60 ++++++++++++----------
user/start/bsp-build.rst | 79 ++++++++++++++++-------------
19 files changed, 185 insertions(+), 138 deletions(-)
diff --git a/user/bsps/aarch64/raspberrypi4.rst b/user/bsps/aarch64/raspberrypi4.rst
index efb09b6..616cc3f 100644
--- a/user/bsps/aarch64/raspberrypi4.rst
+++ b/user/bsps/aarch64/raspberrypi4.rst
@@ -79,8 +79,9 @@ can be processed in a similar way.
To create the kernel image:
.. code-block:: shell
+ :substitutions:
- $ aarch64-rtems at rtems-ver-major@-objcopy -Obinary hello.exe kernel8.img
+ $ aarch64-rtems|rtems-ver-major|-objcopy -Obinary hello.exe kernel8.img
Copy the kernel image to the SD card.
diff --git a/user/bsps/aarch64/xilinx-zynqmp.rst b/user/bsps/aarch64/xilinx-zynqmp.rst
index 4de0115..255628a 100644
--- a/user/bsps/aarch64/xilinx-zynqmp.rst
+++ b/user/bsps/aarch64/xilinx-zynqmp.rst
@@ -143,8 +143,9 @@ Prepare the RTEMS image
Prepare your RTEMS image to boot from u-boot with the following commands:
.. code-block:: shell
+ :substitutions:
- $ aarch64-rtems at rtems-ver-major@-objcopy -Obinary ticker.exe ticker.bin
+ $ aarch64-rtems|rtems-ver-major|-objcopy -Obinary ticker.exe ticker.bin
$ gzip -9 ticker.bin
$ mkimage -A arm64 -O rtems -T kernel -a 0x10000000 -e 0x10000000 -n RTEMS -d ticker.bin.gz rtems.img
diff --git a/user/bsps/arm/altera-cyclone-v.rst b/user/bsps/arm/altera-cyclone-v.rst
index 12e563e..5aaa841 100644
--- a/user/bsps/arm/altera-cyclone-v.rst
+++ b/user/bsps/arm/altera-cyclone-v.rst
@@ -26,8 +26,9 @@ The application executable file (ELF file) must be converted to an U-Boot
image. Use the following commands:
.. code-block:: none
+ :substitutions:
- arm-rtems at rtems-ver-major@-objcopy -O binary app.exe app.bin
+ arm-rtems|rtems-ver-major|-objcopy -O binary app.exe app.bin
gzip -9 -f -c app.bin > app.bin.gz
mkimage -A arm -O linux -T kernel -a 0x00300000 -e 0x00300000 -n RTEMS -d app.bin.gz app.img
diff --git a/user/bsps/arm/beagle.rst b/user/bsps/arm/beagle.rst
index 55f75c0..9da18e8 100644
--- a/user/bsps/arm/beagle.rst
+++ b/user/bsps/arm/beagle.rst
@@ -31,8 +31,9 @@ Boot via U-Boot
To boot via uboot, the ELF must be converted to a U-Boot image like below:
.. code-block:: none
+ :substitutions:
- arm-rtems at rtems-ver-major@-objcopy hello.exe -O binary app.bin
+ arm-rtems|rtems-ver-major|-objcopy hello.exe -O binary app.bin
gzip -9 app.bin
mkimage -A arm -O linux -T kernel -a 0x80000000 -e 0x80000000 -n RTEMS -d app.bin.gz rtems-app.img
diff --git a/user/bsps/arm/imx.rst b/user/bsps/arm/imx.rst
index 47ad503..6c8cf49 100644
--- a/user/bsps/arm/imx.rst
+++ b/user/bsps/arm/imx.rst
@@ -74,8 +74,9 @@ The application executable file (ELF file) must be converted to an U-Boot
image. Use the following commands:
.. code-block:: none
+ :substitutions:
- arm-rtems at rtems-ver-major@-objcopy -O binary app.exe app.bin
+ arm-rtems|rtems-ver-major|-objcopy -O binary app.exe app.bin
gzip -9 -f -c app.bin > app.bin.gz
mkimage -A arm -O linux -T kernel -a 0x80200000 -e 0x80200000 -n RTEMS -d app.bin.gz app.img
diff --git a/user/bsps/arm/imxrt.rst b/user/bsps/arm/imxrt.rst
index 3df233f..4af603b 100644
--- a/user/bsps/arm/imxrt.rst
+++ b/user/bsps/arm/imxrt.rst
@@ -39,7 +39,7 @@ For programming the HyperFlash in case 1, you can use the on board debugger
integrated into the IMXRT1050-EVKB. You can generate a flash image out of a
compiled RTEMS application with for example::
- arm-rtems at rtems-ver-major@-objcopy -O binary build/arm/imxrt1052/testsuites/samples/hello.exe hello.bin
+ arm-rtems|rtems-ver-major|-objcopy -O binary build/arm/imxrt1052/testsuites/samples/hello.exe hello.bin
Then just copy the generated binary to the mass storage provided by the
debugger. Wait a bit till the mass storage vanishes and re-appears. After that,
@@ -91,7 +91,7 @@ The BSP uses a FDT based initialization. The FDT is linked into the application.
You can find the default FDT used in the BSP in
`bsps/arm/imxrt/dts/imxrt1050-evkb.dts`. The FDT is split up into two parts. The
core part is put into an `dtsi` file and is installed together with normal
-headers into `${PREFIX}/arm-rtems at rtems-ver-major@/imxrt1052/lib/include`. You
+headers into `${PREFIX}/arm-rtems|rtems-ver-major|/imxrt1052/lib/include`. You
can use that to create your own device tree based on that. Basically use
something like::
@@ -126,9 +126,10 @@ You can then convert your FDT into a C file with (replace `YOUR.dts` and similar
with your FDT source names):
.. code-block:: none
+ :substitutions:
- sh> arm-rtems at rtems-ver-major@-cpp -P -x assembler-with-cpp \
- -I ${PREFIX}/arm-rtems at rtems-ver-major@/imxrt1052/lib/include \
+ sh> arm-rtems|rtems-ver-major|-cpp -P -x assembler-with-cpp \
+ -I ${PREFIX}/arm-rtems|rtems-ver-major|/imxrt1052/lib/include \
-include "YOUR.dts" /dev/null | \
dtc -O dtb -o "YOUR.dtb" -b 0 -p 64
sh> rtems-bin2c -A 8 -C -N imxrt_dtb "YOUR.dtb" "YOUR.c"
diff --git a/user/bsps/arm/raspberrypi.rst b/user/bsps/arm/raspberrypi.rst
index 8f40e92..40da041 100644
--- a/user/bsps/arm/raspberrypi.rst
+++ b/user/bsps/arm/raspberrypi.rst
@@ -40,8 +40,9 @@ Other executables can be processed in a similar way.
To create the kernel image:
.. code-block:: none
+ :substitutions:
- $ xsarm-rtems at rtems-ver-major@-objcopy -Obinary hello.exe kernel.img
+ $ xsarm-rtems|rtems-ver-major|-objcopy -Obinary hello.exe kernel.img
Copy the kernel image to the SD card.
@@ -131,8 +132,9 @@ We need to pass in the DTB file to GDB before running the example.
In a new terminal, run GDB using
.. code-block:: none
+ :substitutions:
- $ arm-rtems at rtems-ver-major@-gdb hello.exe
+ $ arm-rtems|rtems-ver-major|-gdb hello.exe
This will open GDB and will load the symbol table from hello.exe. Issue the
following commands in the GDB prompt.
diff --git a/user/bsps/arm/xen.rst b/user/bsps/arm/xen.rst
index d7538f0..07c503a 100644
--- a/user/bsps/arm/xen.rst
+++ b/user/bsps/arm/xen.rst
@@ -41,14 +41,16 @@ already be built with the BSP.
The ``ticker.exe`` file can be found in the BSP build tree at:
.. code-block:: none
+ :substitutions:
- arm-rtems at rtems-ver-major@/c/xen_virtual/testsuites/samples/ticker.exe
+ arm-rtems|rtems-ver-major|/c/xen_virtual/testsuites/samples/ticker.exe
The ``ticker.exe`` elf file must be translated to a binary format.
.. code-block:: none
+ :substitutions:
- arm-rtems at rtems-ver-major@-objcopy -O binary ticker.exe ticker.bin
+ arm-rtems|rtems-ver-major|-objcopy -O binary ticker.exe ticker.bin
Then place the ``ticker.bin`` file on the dom0 filesystem.
diff --git a/user/bsps/bsps-microblaze.rst b/user/bsps/bsps-microblaze.rst
index 6fe4891..f53c9cc 100644
--- a/user/bsps/bsps-microblaze.rst
+++ b/user/bsps/bsps-microblaze.rst
@@ -113,8 +113,9 @@ For example, to debug the hello sample and break at ``Init``, first start QEMU.
Then start GDB and connect to QEMU.
.. code-block:: none
+ :substitutions:
- $ microblaze-rtems at rtems-ver-major@-gdb build/microblaze/kcu105_qemu/testsuites/samples/hello.exe
+ $ microblaze-rtems|rtems-ver-major|-gdb build/microblaze/kcu105_qemu/testsuites/samples/hello.exe
(gdb) target remote localhost:1234
(gdb) break Init
(gdb) continue
@@ -174,8 +175,9 @@ With the debug server running, connect to the debug server with GDB, load the
application, and debug as usual. By default the GDB server listens on port 3002.
.. code-block:: none
+ :substitutions:
- $ microblaze-rtems at rtems-ver-major@-gdb example.exe
+ $ microblaze-rtems|rtems-ver-major|-gdb example.exe
(gdb) target extended-remote localhost:3002
(gdb) load
(gdb) break Init
diff --git a/user/bsps/bsps-powerpc.rst b/user/bsps/bsps-powerpc.rst
index 6b63936..217aa63 100644
--- a/user/bsps/bsps-powerpc.rst
+++ b/user/bsps/bsps-powerpc.rst
@@ -35,11 +35,12 @@ The application executable file (ELF file) must be converted to a boot
image. Use the following commands:
.. code-block:: none
+ :substitutions:
- powerpc-rtems at rtems-ver-major@-objcopy -O binary -R .comment -S ticker.exe rtems
+ powerpc-rtems|rtems-ver-major|-objcopy -O binary -R .comment -S ticker.exe rtems
gzip -9 -f rtems
- powerpc-rtems at rtems-ver-major@-ld -o ticker.boot bootloader.o --just-symbols=ticker.exe -b binary rtems.gz -T ppcboot.lds -no-warn-mismatch
- powerpc-rtems at rtems-ver-major@-objcopy -O binary ticker.boot ticker.bin
+ powerpc-rtems|rtems-ver-major|-ld -o ticker.boot bootloader.o --just-symbols=ticker.exe -b binary rtems.gz -T ppcboot.lds -no-warn-mismatch
+ powerpc-rtems|rtems-ver-major|-objcopy -O binary ticker.boot ticker.bin
mpc55xxevb
==========
@@ -106,8 +107,9 @@ The application executable file (ELF file) must be converted to an U-Boot
image. Use the following commands:
.. code-block:: none
+ :substitutions:
- powerpc-rtems at rtems-ver-major@-objcopy -O binary app.exe app.bin
+ powerpc-rtems|rtems-ver-major|-objcopy -O binary app.exe app.bin
gzip -9 -f -c app.bin > app.bin.gz
mkimage -A ppc -O linux -T kernel -a 0x4000 -e 0x4000 -n RTEMS -d app.bin.gz app.img
diff --git a/user/bsps/bsps-riscv.rst b/user/bsps/bsps-riscv.rst
index 263796e..678d5c4 100644
--- a/user/bsps/bsps-riscv.rst
+++ b/user/bsps/bsps-riscv.rst
@@ -220,15 +220,17 @@ The "config.ini" file.
Build RTEMS.
.. code-block:: shell
+ :substitutions:
- $ ./waf configure --prefix=$HOME/rtems-start/rtems/@rtems-ver-major@
+ $ ./waf configure --prefix=$HOME/rtems-start/rtems/|rtems-ver-major|
$ ./waf
Convert .exe to .elf file.
.. code-block:: shell
+ :substitutions:
- $ riscv-rtems at rtems-ver-major@-objcopy build/riscv/mpfs64imafdc/testsuites/smptests/smp01.exe build/riscv/mpfs64imafdc/testsuites/smptests/smp01.elf
+ $ riscv-rtems|rtems-ver-major|-objcopy build/riscv/mpfs64imafdc/testsuites/smptests/smp01.exe build/riscv/mpfs64imafdc/testsuites/smptests/smp01.elf
Generate a payload for the `smp01.elf` using the `hss-payload-generator <https://github.com/polarfire-soc/hart-software-services/blob/master/tools/hss-payload-generator>`_.
@@ -326,8 +328,9 @@ Configuration file ``config.ini``:
Build RTEMS:
.. code-block:: shell
+ :substitutions:
- $ ./waf configure --prefix=$HOME/rtems-start/rtems/@rtems-ver-major@
+ $ ./waf configure --prefix=$HOME/rtems-start/rtems/|rtems-ver-major|
$ ./waf
**Flash an executable to a supported K210 board**
@@ -336,8 +339,9 @@ Binary images can be flashed to the Sipeed boards through the USB port using
the ``kflash.py`` utility available from the python pip utility.
.. code-block:: shell
+ :substitutions:
- $ riscv-rtems at rtems-ver-major@-objcopy -Obinary ticker.exe ticker.bin
+ $ riscv-rtems|rtems-ver-major|-objcopy -Obinary ticker.exe ticker.bin
$ kflash.py --uart /dev/ttyUSB0 ticker.bin
After the image is flashed, the RTEMS image will automatically boot. It will
diff --git a/user/conf.py b/user/conf.py
index 134ec61..3b88520 100644
--- a/user/conf.py
+++ b/user/conf.py
@@ -12,3 +12,9 @@ latex_documents = [
u'RTEMS Documentation Project',
'manual'),
]
+
+extensions += ['sphinx_substitution_extensions']
+
+rst_prolog = """
+.. |rtems-ver-major| replace:: 6
+"""
diff --git a/user/deployment/index.rst b/user/deployment/index.rst
index d1315af..9fccc57 100644
--- a/user/deployment/index.rst
+++ b/user/deployment/index.rst
@@ -94,11 +94,12 @@ Create a configuration file for the ``project``:
Add the following to the buildset configuration file:
.. code-block:: none
+ :substitutions:
#
# Project Tools
#
- @rtems-ver-major@/rtems-aarch64
+ |rtems-ver-major|/rtems-aarch64
Commit the changes to the repository:
@@ -128,22 +129,23 @@ Inspect the tarfile to check the path matches the prefix used to build
the tools (sizes may vary):
.. code-block:: none
+ :substitutions:
$ tar Jtvf tar/project-tools.tar.bz2 | less
drwxr-xr-x 0 chris eng 0 Sep 6 14:27 opt/project/bin/
- -rwxr-xr-x 0 chris eng 1320888 Sep 6 14:20 opt/project/bin/aarch64-rtems at rtems-ver-major@-addr2line
- -rwxr-xr-x 0 chris eng 1358688 Sep 6 14:20 opt/project/bin/aarch64-rtems at rtems-ver-major@-ar
- -rwxr-xr-x 0 chris eng 2381976 Sep 6 14:20 opt/project/bin/aarch64-rtems at rtems-ver-major@-as
- -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-c++
- -rwxr-xr-x 0 chris eng 1316240 Sep 6 14:20 opt/project/bin/aarch64-rtems at rtems-ver-major@-c++filt
- -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-cpp
- -rwxr-xr-x 0 chris eng 60792 Sep 6 14:20 opt/project/bin/aarch64-rtems at rtems-ver-major@-elfedit
- -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-g++
- -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-gcc
- -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-gcc-12.1.1
- -rwxr-xr-x 0 chris eng 48568 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-gcc-ar
- -rwxr-xr-x 0 chris eng 48568 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-gcc-nm
- -rwxr-xr-x 0 chris eng 48576 Sep 6 14:27 opt/project/bin/aarch64-rtems at rtems-ver-major@-gcc-ranlib
+ -rwxr-xr-x 0 chris eng 1320888 Sep 6 14:20 opt/project/bin/aarch64-rtems|rtems-ver-major|-addr2line
+ -rwxr-xr-x 0 chris eng 1358688 Sep 6 14:20 opt/project/bin/aarch64-rtems|rtems-ver-major|-ar
+ -rwxr-xr-x 0 chris eng 2381976 Sep 6 14:20 opt/project/bin/aarch64-rtems|rtems-ver-major|-as
+ -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-c++
+ -rwxr-xr-x 0 chris eng 1316240 Sep 6 14:20 opt/project/bin/aarch64-rtems|rtems-ver-major|-c++filt
+ -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-cpp
+ -rwxr-xr-x 0 chris eng 60792 Sep 6 14:20 opt/project/bin/aarch64-rtems|rtems-ver-major|-elfedit
+ -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-g++
+ -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-gcc
+ -rwxr-xr-x 0 chris eng 1328440 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-gcc-12.1.1
+ -rwxr-xr-x 0 chris eng 48568 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-gcc-ar
+ -rwxr-xr-x 0 chris eng 48568 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-gcc-nm
+ -rwxr-xr-x 0 chris eng 48576 Sep 6 14:27 opt/project/bin/aarch64-rtems|rtems-ver-major|-gcc-ranlib
.....
Tools and Kernel
@@ -163,6 +165,7 @@ and a BSP:
Add the following to the buildset configuration file and save:
.. code-block:: none
+ :substitutions:
#
# Project Tools and BSP
@@ -170,8 +173,8 @@ Add the following to the buildset configuration file and save:
%define with_rtems_bsp aarch64/xilinx_versal_aiedge
%define with_rtems_bspopts BSP_XILINX_VERSAL_NOCACHE_LENGTH=0x4000000 \
BSP_XILINX_VERSAL_RAM_LENGTH=0x200000000
- @rtems-ver-major@/rtems-aarch64
- @rtems-ver-major@/rtems-kernel
+ |rtems-ver-major|/rtems-aarch64
+ |rtems-ver-major|/rtems-kernel
The configuration provides BSP options. Commit the changes to the
repository:
@@ -231,14 +234,15 @@ tools and BSPs:
Add the following to the buildset configuration file and save:
.. code-block:: none
+ :substitutions:
#
# Project Tools and BSPs
#
%define with_rtems_bsp_config config/project-bsps.ini
- @rtems-ver-major@/rtems-aarch64
- @rtems-ver-major@/rtems-arm
- @rtems-ver-major@/rtems-kernel
+ |rtems-ver-major|/rtems-aarch64
+ |rtems-ver-major|/rtems-arm
+ |rtems-ver-major|/rtems-kernel
Add a kernel configuration INI file:
@@ -336,23 +340,24 @@ submodule:
The tarfile can be reviewed to see the BSP libraries built (sizes may vary):
.. code-block:: none
+ :substitutions:
$ tar jtvf tar/project-aarch64-tools-bsp-libbsd.tar.bz2 | \
grep -e '\.a$' | grep -e 'xilinx_versal_aiedge'
- -rw-r--r-- 0 chris eng 138936312 Sep 7 14:58 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libbsd.a
- -rw-r--r-- 0 chris eng 686190 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libdebugger.a
- -rw-r--r-- 0 chris eng 164086 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libftpd.a
- -rw-r--r-- 0 chris eng 107560 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libftpfs.a
- -rw-r--r-- 0 chris eng 978812 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libjffs2.a
- -rw-r--r-- 0 chris eng 412354 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libmghttpd.a
- -rw-r--r-- 0 chris eng 2099962 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/librtemsbsp.a
- -rw-r--r-- 0 chris eng 29693496 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/librtemscpu.a
- -rw-r--r-- 0 chris eng 435236 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/librtemscxx.a
- -rw-r--r-- 0 chris eng 141234 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/librtemsdefaultconfig.a
- -rw-r--r-- 0 chris eng 856514 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/librtemstest.a
- -rw-r--r-- 0 chris eng 159004 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libtelnetd.a
- -rw-r--r-- 0 chris eng 137386 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libtftpfs.a
- -rw-r--r-- 0 chris eng 476692 Sep 7 14:56 opt/project/aarch64-rtems at rtems-ver-major@/xilinx_versal_aiedge/lib/libz.a
+ -rw-r--r-- 0 chris eng 138936312 Sep 7 14:58 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libbsd.a
+ -rw-r--r-- 0 chris eng 686190 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libdebugger.a
+ -rw-r--r-- 0 chris eng 164086 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libftpd.a
+ -rw-r--r-- 0 chris eng 107560 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libftpfs.a
+ -rw-r--r-- 0 chris eng 978812 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libjffs2.a
+ -rw-r--r-- 0 chris eng 412354 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libmghttpd.a
+ -rw-r--r-- 0 chris eng 2099962 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/librtemsbsp.a
+ -rw-r--r-- 0 chris eng 29693496 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/librtemscpu.a
+ -rw-r--r-- 0 chris eng 435236 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/librtemscxx.a
+ -rw-r--r-- 0 chris eng 141234 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/librtemsdefaultconfig.a
+ -rw-r--r-- 0 chris eng 856514 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/librtemstest.a
+ -rw-r--r-- 0 chris eng 159004 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libtelnetd.a
+ -rw-r--r-- 0 chris eng 137386 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libtftpfs.a
+ -rw-r--r-- 0 chris eng 476692 Sep 7 14:56 opt/project/aarch64-rtems|rtems-ver-major|/xilinx_versal_aiedge/lib/libz.a
Tools, Kernel with Config and Packages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/user/exe/initialization.rst b/user/exe/initialization.rst
index f4b5d7e..fd192af 100644
--- a/user/exe/initialization.rst
+++ b/user/exe/initialization.rst
@@ -83,19 +83,20 @@ initialization is performed before multitasking is started.
The RTEMS Tool ``rtems-exeinfo`` can provide some detail about the registered
handlers. The following shows the initialization handlers for the Hello World
-sample application in the RTEMS kernel's testsuite::
+sample application in the RTEMS kernel's testsuite:
.. code-block:: none
+ :substitutions:
- $ rtems-exeinfo --init arm-rtems at rtems-ver-major@/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
- RTEMS Executable Info @rtems-ver-major at .5416cfa39dd6
- $ rtems-exeinfo --init arm-rtems at rtems-ver-major@/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
- exe: arm-rtems at rtems-ver-major@/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
+ $ rtems-exeinfo --init arm-rtems|rtems-ver-major|/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
+ RTEMS Executable Info |rtems-ver-major|.5416cfa39dd6
+ $ rtems-exeinfo --init arm-rtems|rtems-ver-major|/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
+ exe: arm-rtems|rtems-ver-major|/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
Compilation:
Producers: 2
| GNU AS 2.31.1: 14 objects
- | GNU C11 7.3.0 20180125 (RTEMS @rtems-ver-major@, RSB e55769c64cf1a201588565a5662deafe3f1ccdcc, Newlib 103b055035fea328f8bc7826801760fb1c055683): 284 objects
+ | GNU C11 7.3.0 20180125 (RTEMS |rtems-ver-major|, RSB e55769c64cf1a201588565a5662deafe3f1ccdcc, Newlib 103b055035fea328f8bc7826801760fb1c055683): 284 objects
Common flags: 4
| -march=armv7-a -mthumb -mfpu=neon -mfloat-abi=hard
diff --git a/user/exe/loader.rst b/user/exe/loader.rst
index be2e78e..cb174e7 100644
--- a/user/exe/loader.rst
+++ b/user/exe/loader.rst
@@ -457,10 +457,11 @@ This example shows creating an embedded symbol table object file and linking it
into the base image.
.. code-block:: none
+ :substitutions:
- $ sparc-rtems at rtems-ver-major@-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.pre
- $ rtems-syms -e -C sparc-rtems at rtems-ver-major@-gcc -c "-mcpu=cypress" -o foo-sym.o foo.pre
- $ sparc-rtems at rtems-ver-major@-gcc -mcpu=cypress foo.o foo-sym.o -lrtemsbsp -lrtemscpu -o foo.exe
+ $ sparc-rtems|rtems-ver-major|-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.pre
+ $ rtems-syms -e -C sparc-rtems|rtems-ver-major|-gcc -c "-mcpu=cypress" -o foo-sym.o foo.pre
+ $ sparc-rtems|rtems-ver-major|-gcc -mcpu=cypress foo.o foo-sym.o -lrtemsbsp -lrtemscpu -o foo.exe
The link command line steps in this example are not complete.
@@ -485,9 +486,10 @@ The example shows creating and loading a symbol table executable object
file. First create the symbol table's executable object file:
.. code-block:: none
+ :substitutions:
- $ sparc-rtems at rtems-ver-major@-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.exe
- $ rtems-syms -C sparc-rtems at rtems-ver-major@-gcc -c "-mcpu=cypress" -o foo-sym.o foo.exe
+ $ sparc-rtems|rtems-ver-major|-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.exe
+ $ rtems-syms -C sparc-rtems|rtems-ver-major|-gcc -c "-mcpu=cypress" -o foo-sym.o foo.exe
The link command line steps in this example are not complete.
@@ -631,8 +633,9 @@ target. The tool suite's command :program:`strip` can strip all the object files
in a library with a single command.
.. code-block:: none
+ :substitutions:
- $ sparc-rtems at rtems-ver-major@-strip libc.a
+ $ sparc-rtems|rtems-ver-major|-strip libc.a
Large Memory
------------
diff --git a/user/installation/developer.rst b/user/installation/developer.rst
index 8acd68c..b2b414f 100644
--- a/user/installation/developer.rst
+++ b/user/installation/developer.rst
@@ -81,10 +81,11 @@ checked and this includes checking for the python development libraries GDB
requires:
.. code-block:: none
+ :substitutions:
$ cd rsb
$ ./source-builder/sb-check
- RTEMS Source Builder - Check, @rtems-ver-major@ (089327b5dcf9)
+ RTEMS Source Builder - Check, |rtems-ver-major| (089327b5dcf9)
Environment is ok
If you are unsure how to specify the build set for the architecture you wish to
@@ -196,14 +197,14 @@ build, just ask the tool:
2. The paths inspected. See :ref:`Configuration`.
- 3. A build set to build all RTEMS @rtems-ver-major@ supported architectures.
+ 3. A build set to build all RTEMS |rtems-ver-major| supported architectures.
- 4. The build set for the ARM architecture on RTEMS @rtems-ver-major at .
+ 4. The build set for the ARM architecture on RTEMS |rtems-ver-major|.
Build a tool chain for the SPARC architecture. We are using the SPARC
architecture because GDB has a good simulator that lets us run and
test the samples RTEMS builds by default. The development version is
-one more than ``@rtems-ver-major@` and is on the ``master`` branch:
+one more than :substitution-code:``|rtems-ver-major|` and is on the ``master`` branch:
.. _windows-tool-chain:
diff --git a/user/installation/releases.rst b/user/installation/releases.rst
index 6694806..1aef73d 100644
--- a/user/installation/releases.rst
+++ b/user/installation/releases.rst
@@ -84,8 +84,9 @@ If building on Windows:
Download the RTEMS Source Builder (RSB) from the RTEMS FTP server:
.. code-block:: none
+ :substitutions:
- $ wget https://ftp.rtems.org/pub/rtems/releases/@rtems-ver-major@/@rtems-ver-majminrev@/rtems-source-builder-@rtems-ver-majminrev@.tar.xz
+ $ wget https://ftp.rtems.org/pub/rtems/releases/|rtems-ver-major|/@rtems-ver-majminrev@/rtems-source-builder-@rtems-ver-majminrev@.tar.xz
--2016-03-21 10:50:04-- https://ftp.rtems.org/pub/rtems/releases/@rtems-ver-major/@rtems-ver-majminrev@/rtems-source-builder-@rtems-ver-majminrev@.tar.xz
Resolving ftp.rtems.org (ftp.rtems.org)... 140.211.10.151
Connecting to ftp.rtems.org (ftp.rtems.org)|140.211.10.151|:443... connected.
@@ -121,8 +122,9 @@ If building on Windows add ``--jobs=none`` to avoid GNU make issues on Windows
discussed in :ref:`msys2_parallel_builds`.
.. code-block:: none
+ :substitutions:
$ ../source-builder/sb-set-builder \
- --prefix=/opt/rtems/@rtems-ver-major@ @rtems-ver-major@/rtems-sparc
+ --prefix=/opt/rtems/|rtems-ver-major| |rtems-ver-major|/rtems-sparc
You can now build a third-party library or an application as defaulted in TBD.
diff --git a/user/start/app.rst b/user/start/app.rst
index 0599305..91659f8 100644
--- a/user/start/app.rst
+++ b/user/start/app.rst
@@ -8,7 +8,7 @@ Build Your Application
======================
You tested a BSP in the previous section. We built the ``erc32`` BSP
-and it is installed under :file:`$HOME/quick-start/rtems/@rtems-ver-major@`.
+and it is installed under :substitution-code:`$HOME/quick-start/rtems/|rtems-ver-major|`.
We will now create a simple Hello World application with a Git
repository and using the `Waf <https://waf.io>`_ build system.
@@ -147,29 +147,30 @@ Configure the application using Waf's ``configure`` command:
The output will be something close to:
.. code-block:: none
+ :substitutions:
Setting top to : $BASE/app/hello
Setting out to : $BASE/app/hello/build
- RTEMS Version : @rtems-ver-major@
- Architectures : sparc-rtems at rtems-ver-major@
- Board Support Package (BSP) : sparc-rtems at rtems-ver-major@-erc32
+ RTEMS Version : |rtems-ver-major|
+ Architectures : sparc-rtems|rtems-ver-major|
+ Board Support Package (BSP) : sparc-rtems|rtems-ver-major|-erc32
Show commands : no
Long commands : no
- Checking for program 'sparc-rtems at rtems-ver-major@-gcc' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-gcc
- Checking for program 'sparc-rtems at rtems-ver-major@-g++' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-g++
- Checking for program 'sparc-rtems at rtems-ver-major@-gcc' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-gcc
- Checking for program 'sparc-rtems at rtems-ver-major@-ld' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ld
- Checking for program 'sparc-rtems at rtems-ver-major@-ar' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ar
- Checking for program 'sparc-rtems at rtems-ver-major@-nm' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-nm
- Checking for program 'sparc-rtems at rtems-ver-major@-objdump' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-objdump
- Checking for program 'sparc-rtems at rtems-ver-major@-objcopy' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-objcopy
- Checking for program 'sparc-rtems at rtems-ver-major@-readelf' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-readelf
- Checking for program 'sparc-rtems6-strip' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-strip
- Checking for program 'sparc-rtems6-ranlib' : $BASE/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ranlib
- Checking for program 'rtems-ld' : $BASE/rtems/@rtems-ver-major@/bin/rtems-ld
- Checking for program 'rtems-tld' : $BASE/rtems/@rtems-ver-major@/bin/rtems-tld
- Checking for program 'rtems-syms' : $BASE/rtems/@rtems-ver-major@/bin/rtems-syms
- Checking for program 'rtems-bin2c' : $BASE/rtems/@rtems-ver-major@/bin/rtems-bin2c
+ Checking for program 'sparc-rtems|rtems-ver-major|-gcc' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-gcc
+ Checking for program 'sparc-rtems|rtems-ver-major|-g++' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-g++
+ Checking for program 'sparc-rtems|rtems-ver-major|-gcc' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-gcc
+ Checking for program 'sparc-rtems|rtems-ver-major|-ld' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ld
+ Checking for program 'sparc-rtems|rtems-ver-major|-ar' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ar
+ Checking for program 'sparc-rtems|rtems-ver-major|-nm' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-nm
+ Checking for program 'sparc-rtems|rtems-ver-major|-objdump' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-objdump
+ Checking for program 'sparc-rtems|rtems-ver-major|-objcopy' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-objcopy
+ Checking for program 'sparc-rtems|rtems-ver-major|-readelf' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-readelf
+ Checking for program 'sparc-rtems6-strip' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-strip
+ Checking for program 'sparc-rtems6-ranlib' : $BASE/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ranlib
+ Checking for program 'rtems-ld' : $BASE/rtems/|rtems-ver-major|/bin/rtems-ld
+ Checking for program 'rtems-tld' : $BASE/rtems/|rtems-ver-major|/bin/rtems-tld
+ Checking for program 'rtems-syms' : $BASE/rtems/|rtems-ver-major|/bin/rtems-syms
+ Checking for program 'rtems-bin2c' : $BASE/rtems/|rtems-ver-major|/bin/rtems-bin2c
Checking for program 'tar' : /usr/bin/tar
Checking for program 'gcc, cc' : $BASE/rtems/6/bin/sparc-rtems6-gcc
Checking for program 'ar' : $BASE/rtems/6/bin/sparc-rtems6-ar
@@ -179,7 +180,7 @@ The output will be something close to:
Checking for program 'ar' : $BASE/rtems/6/bin/sparc-rtems6-ar
Checking for c flags '-MMD' : yes
Checking for cxx flags '-MMD' : yes
- Compiler version (sparc-rtems at rtems-ver-major@-gcc) : 10.2.1 20210309 (RTEMS @rtems-ver-major@, RSB 5e449fb5c2cb6812a238f9f9764fd339cbbf05c2, Newlib d10d0d9)
+ Compiler version (sparc-rtems|rtems-ver-major|-gcc) : 10.2.1 20210309 (RTEMS |rtems-ver-major|, RSB 5e449fb5c2cb6812a238f9f9764fd339cbbf05c2, Newlib d10d0d9)
Checking for a valid RTEMS BSP installation : yes
Checking for RTEMS_DEBUG : no
Checking for RTEMS_MULTIPROCESSING : no
@@ -197,26 +198,29 @@ Build the application:
The output will be something close to:
.. code-block:: none
+ :substitutions:
- Waf: Entering directory `$BASE/app/hello/build/sparc-rtems at rtems-ver-major@-erc32'
+ Waf: Entering directory `$BASE/app/hello/build/sparc-rtems|rtems-ver-major|-erc32'
[1/3] Compiling init.c
[2/3] Compiling hello.c
- [3/3] Linking build/sparc-rtems at rtems-ver-major@-erc32/hello.exe
- Waf: Leaving directory `$BASE/app/hello/build/sparc-rtems at rtems-ver-major@-erc32'
- 'build-sparc-rtems at rtems-ver-major@-erc32' finished successfully (0.183s)
+ [3/3] Linking build/sparc-rtems|rtems-ver-major|-erc32/hello.exe
+ Waf: Leaving directory `$BASE/app/hello/build/sparc-rtems|rtems-ver-major|-erc32'
+ 'build-sparc-rtems|rtems-ver-major|-erc32' finished successfully (0.183s)
Run the executable:
.. code-block:: none
+ :substitutions:
- rtems-run --rtems-bsps=erc32-sis build/sparc-rtems at rtems-ver-major@-erc32/hello.exe
+ rtems-run --rtems-bsps=erc32-sis build/sparc-rtems|rtems-ver-major|-erc32/hello.exe
The output will be something close to:
.. code-block:: none
+ :substitutions:
RTEMS Testing - Run, @rtems-ver-mjminrev@
- Command Line: $BASE/quick-start/rtems/@rtems-ver-major@/bin/rtems-run --rtems-bsps=erc32-sis build/sparc-rtems at rtems-ver-major@-erc32/hello.exe
+ Command Line: $BASE/quick-start/rtems/|rtems-ver-major|/bin/rtems-run --rtems-bsps=erc32-sis build/sparc-rtems|rtems-ver-major|-erc32/hello.exe
Host: Linux 5.8.0-44-generic #50~20.04.1-Ubuntu SMP Wed Feb 10 21:07:30 UTC 2021 x86_64
Python: 3.8.5 (default, Jan 27 2021, 15:41:15) [GCC 9.3.0]
Host: Linux-5.8.0-44-generic-x86_64-with-glibc2.29 (Linux 5.8.0-44-generic #50~20.04.1-Ubuntu SMP Wed Feb 10 21:07:30 UTC 2021 x86_64 x86_64)
@@ -226,7 +230,7 @@ The output will be something close to:
ERC32 emulation enabled
- Loaded build/sparc-rtems at rtems-ver-major@-erc32/hello.exe, entry 0x02000000
+ Loaded build/sparc-rtems|rtems-ver-major|-erc32/hello.exe, entry 0x02000000
Hello World
@@ -234,7 +238,7 @@ The output will be something close to:
fatal source: 5 (RTEMS_FATAL_SOURCE_EXIT)
fatal code: 0 (0x00000000)
RTEMS version: 6.0.0.586e06ec6222f1cd1f005aa8f4a34a8b33f5d862
- RTEMS tools: 10.2.1 20210309 (RTEMS @rtems-ver-major@, RSB 5e449fb5c2cb6812a238f9f9764fd339cbbf05c2, Newlib d10d0d9)
+ RTEMS tools: 10.2.1 20210309 (RTEMS |rtems-ver-major|, RSB 5e449fb5c2cb6812a238f9f9764fd339cbbf05c2, Newlib d10d0d9)
executing thread ID: 0x08a010001
executing thread name: UI1
cpu 0 in error mode (tt = 0x101)
diff --git a/user/start/bsp-build.rst b/user/start/bsp-build.rst
index c62b6ba..e53225e 100644
--- a/user/start/bsp-build.rst
+++ b/user/start/bsp-build.rst
@@ -42,26 +42,28 @@ Git clone of the RSB the BSP will be version referenced in the RSB clone.
To build the BSP with all the tests run this command:
.. code-block:: none
+ :substitutions:
cd $HOME/quick-start/src/rsb/rtems
../source-builder/sb-set-builder --prefix=$HOME/quick-start/rtems/5 \
- --target=sparc-rtems at rtems-ver-major@ --with-rtems-bsp=erc32 --with-rtems-tests=yes @rtems-ver-major@/rtems-kernel
+ --target=sparc-rtems|rtems-ver-major| --with-rtems-bsp=erc32 --with-rtems-tests=yes |rtems-ver-major|/rtems-kernel
This command should output something like:
.. code-block:: none
+ :substitutions:
RTEMS Source Builder - Set Builder, @rtems-ver-majminver@
- Build Set: @rtems-ver-major@/rtems-kernel
- config: tools/rtems-kernel- at rtems-ver-major@.cfg
- package: sparc-rtems at rtems-ver-major@-kernel-erc32-1
- building: sparc-rtems at rtems-ver-major@-kernel-erc32-1
- sizes: sparc-rtems at rtems-ver-major@-kernel-erc32-1: 2.279GB (installed: 44.612MB)
- cleaning: sparc-rtems at rtems-ver-major@-kernel-erc32-1
- reporting: tools/rtems-kernel- at rtems-ver-major@.cfg -> sparc-rtems at rtems-ver-major@-kernel-erc32-1.txt
- reporting: tools/rtems-kernel- at rtems-ver-major@.cfg -> sparc-rtems at rtems-ver-major@-kernel-erc32-1.xml
- installing: sparc-rtems at rtems-ver-major@-kernel-erc32-1 -> $BASE/
- cleaning: sparc-rtems at rtems-ver-major@-kernel-erc32-1
+ Build Set: |rtems-ver-major|/rtems-kernel
+ config: tools/rtems-kernel-|rtems-ver-major|.cfg
+ package: sparc-rtems|rtems-ver-major|-kernel-erc32-1
+ building: sparc-rtems|rtems-ver-major|-kernel-erc32-1
+ sizes: sparc-rtems|rtems-ver-major|-kernel-erc32-1: 2.279GB (installed: 44.612MB)
+ cleaning: sparc-rtems|rtems-ver-major|-kernel-erc32-1
+ reporting: tools/rtems-kernel-|rtems-ver-major|.cfg -> sparc-rtems|rtems-ver-major|-kernel-erc32-1.txt
+ reporting: tools/rtems-kernel-|rtems-ver-major|.cfg -> sparc-rtems|rtems-ver-major|-kernel-erc32-1.xml
+ installing: sparc-rtems|rtems-ver-major|-kernel-erc32-1 -> $BASE/
+ cleaning: sparc-rtems|rtems-ver-major|-kernel-erc32-1
Build Set: Time 0:03:09.896961
The RSB BSP build can be customised with following RSB command line options:
@@ -104,14 +106,16 @@ Prepend the RTEMS tool suite binary directory to your ``$PATH`` throughout the
remaining steps. Run the command:
.. code-block:: none
+ :substitutions:
- export PATH=$HOME/quick-start/rtems/@rtems-ver-major@/bin:"$PATH"
+ export PATH=$HOME/quick-start/rtems/|rtems-ver-major|/bin:"$PATH"
Check your installed tools can be found by running:
.. code-block:: none
+ :substitutions:
- command -v sparc-rtems at rtems-ver-major@-gcc && echo "found" || echo "not found"
+ command -v sparc-rtems|rtems-ver-major|-gcc && echo "found" || echo "not found"
The output should be:
@@ -121,8 +125,8 @@ The output should be:
If ``not found`` is printed the tools are not correctly installed or the path
has not been correctly set. Check the contents of the path
-:file:`$HOME/quick-start/rtems/@rtems-ver-major@/bin` manually and if
-:file:`sparc-rtems at rtems-ver-major@-gcc` is present the path is wrong. If the
+:substitution-code:`$HOME/quick-start/rtems/|rtems-ver-major|/bin` manually and if
+:substitution-code:`sparc-rtems|rtems-ver-major|-gcc` is present the path is wrong. If the
file cannot be found return to :ref:`QuickStartTools` and install the tools
again.
@@ -135,11 +139,12 @@ everything else. For detailed information about the BSP build system, see
:ref:`BSPBuildSystem`.
.. code-block:: none
+ :substitutions:
cd $HOME/quick-start/src/rtems
echo "[sparc/erc32]" > config.ini
echo "BUILD_TESTS = True" >> config.ini
- ./waf configure --prefix=$HOME/quick-start/rtems/@rtems-ver-major@
+ ./waf configure --prefix=$HOME/quick-start/rtems/|rtems-ver-major|
The first invocation of ``./waf`` needs a bit of time (e.g. 10 seconds) since an
internal cache file is populated. This command should output something like
@@ -147,28 +152,29 @@ this. In this output the base directory :file:`$HOME/quick-start` was replaced
by ``$BASE``.
.. code-block:: none
+ :substitutions:
Setting top to : $BASE/quick-start/src/rtems
Setting out to : $BASE/quick-start/src/rtems/build
Configure board support package (BSP) : sparc/erc32
- Checking for program 'sparc-rtems at rtems-ver-major@-gcc' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-gcc
- Checking for program 'sparc-rtems at rtems-ver-major@-g++' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-g++
- Checking for program 'sparc-rtems at rtems-ver-major@-ar' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ar
- Checking for program 'sparc-rtems at rtems-ver-major@-ld' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ld
- Checking for program 'ar' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ar
- Checking for program 'g++, c++' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-g++
- Checking for program 'ar' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ar
- Checking for program 'gas, gcc' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-gcc
- Checking for program 'ar' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ar
- Checking for program 'gcc, cc' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-gcc
- Checking for program 'ar' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/sparc-rtems at rtems-ver-major@-ar
+ Checking for program 'sparc-rtems|rtems-ver-major|-gcc' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-gcc
+ Checking for program 'sparc-rtems|rtems-ver-major|-g++' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-g++
+ Checking for program 'sparc-rtems|rtems-ver-major|-ar' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ar
+ Checking for program 'sparc-rtems|rtems-ver-major|-ld' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ld
+ Checking for program 'ar' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ar
+ Checking for program 'g++, c++' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-g++
+ Checking for program 'ar' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ar
+ Checking for program 'gas, gcc' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-gcc
+ Checking for program 'ar' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ar
+ Checking for program 'gcc, cc' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-gcc
+ Checking for program 'ar' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/sparc-rtems|rtems-ver-major|-ar
Checking for asm flags '-MMD' : yes
Checking for c flags '-MMD' : yes
Checking for cxx flags '-MMD' : yes
- Checking for program 'rtems-bin2c' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/rtems-bin2c
+ Checking for program 'rtems-bin2c' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/rtems-bin2c
Checking for program 'gzip' : /usr/bin/gzip
- Checking for program 'rtems-ld' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/rtems-ld
- Checking for program 'rtems-syms' : $BASE/quick-start/rtems/@rtems-ver-major@/bin/rtems-syms
+ Checking for program 'rtems-ld' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/rtems-ld
+ Checking for program 'rtems-syms' : $BASE/quick-start/rtems/|rtems-ver-major|/bin/rtems-syms
Checking for program 'xz' : $BASE/anaconda3/bin/xz
'configure' finished successfully (0.414s)
@@ -208,17 +214,18 @@ This command should output something like this (omitted lines are denoted by
by ``$BASE``.
.. code-block:: none
+ :substitutions:
Waf: Entering directory `$BASE/quick-start/src/rtems/build'
Waf: Leaving directory `$BASE/quick-start/src/rtems/build'
'install' finished successfully (0.081s)
Waf: Entering directory `$BASE/quick-start/src/rtems/build/sparc/erc32'
- + install $BASE/quick-start/rtems/@rtems-ver-major@/sparc-rtems at rtems-ver-major@/erc32/lib/include/libchip/am29lv16.h (from bsps/include/libchip/am29lv1.h)
- + install $BASE/quick-start/rtems/@rtems-ver-major@/sparc-rtems at rtems-ver-major@/erc32/lib/include/libchip/mc146818a.h (from bsps/include/libchip/mc146818a.h)
- + install $BASE/quick-start/rtems/@rtems-ver-major@/sparc-rtems at rtems-ver-major@/erc32/lib/include/libchip/mc68681.h (from bsps/include/libchip/mc68681.h))
+ + install $BASE/quick-start/rtems/|rtems-ver-major|/sparc-rtems|rtems-ver-major|/erc32/lib/include/libchip/am29lv16.h (from bsps/include/libchip/am29lv1.h)
+ + install $BASE/quick-start/rtems/|rtems-ver-major|/sparc-rtems|rtems-ver-major|/erc32/lib/include/libchip/mc146818a.h (from bsps/include/libchip/mc146818a.h)
+ + install $BASE/quick-start/rtems/|rtems-ver-major|/sparc-rtems|rtems-ver-major|/erc32/lib/include/libchip/mc68681.h (from bsps/include/libchip/mc68681.h))
...
- + install $BASE/quick-start/rtems/@rtems-ver-major@/sparc-rtems at rtems-ver-major@/erc32/lib/include/rtems/score/watchdogticks.h (from cpukit/include/rtems/score/watchdogticks.h)
- + install $BASE/quick-start/rtems/@rtems-ver-major@/sparc-rtems at rtems-ver-major@/erc32/lib/include/rtems/score/wkspace.h (from cpukit/include/rtems/score/wkspace.h)
- + install $BASE/quick-start/rtems/@rtems-ver-major@/sparc-rtems at rtems-ver-major@/erc32/lib/include/rtems/score/wkspacedata.h (from cpukit/include/rtems/score/wkspacedata.h)
+ + install $BASE/quick-start/rtems/|rtems-ver-major|/sparc-rtems|rtems-ver-major|/erc32/lib/include/rtems/score/watchdogticks.h (from cpukit/include/rtems/score/watchdogticks.h)
+ + install $BASE/quick-start/rtems/|rtems-ver-major|/sparc-rtems|rtems-ver-major|/erc32/lib/include/rtems/score/wkspace.h (from cpukit/include/rtems/score/wkspace.h)
+ + install $BASE/quick-start/rtems/|rtems-ver-major|/sparc-rtems|rtems-ver-major|/erc32/lib/include/rtems/score/wkspacedata.h (from cpukit/include/rtems/score/wkspacedata.h)
Waf: Leaving directory `$BASE/quick-start/src/rtems/build/sparc/erc32'
'install_sparc/erc32' finished successfully (1.834s))
--
2.34.1
More information about the devel
mailing list