summaryrefslogtreecommitdiffstats
path: root/user
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2019-02-28 08:36:39 +1100
committerChris Johns <chrisj@rtems.org>2019-03-01 09:52:59 +1100
commitd5b631fa3bcd822815c7f875432b15e8b9875395 (patch)
tree153c5012fad2b329b10d11fbd248828fa8ef9928 /user
parent921037f12fdceaa8c09f797ccd14cf39a165b3c5 (diff)
downloadrtems-docs-d5b631fa3bcd822815c7f875432b15e8b9875395.tar.bz2
User: Change output block to type none.
Diffstat (limited to 'user')
-rw-r--r--user/bsps/bsps-powerpc.rst4
-rw-r--r--user/bsps/bsps-x86_64.rst10
-rw-r--r--user/bsps/index.rst2
-rw-r--r--user/exe/initialization.rst2
-rw-r--r--user/exe/loader.rst6
-rw-r--r--user/hardware/architectures.rst4
-rw-r--r--user/hosts/os.rst4
-rw-r--r--user/hosts/posix.rst20
-rw-r--r--user/hosts/windows.rst4
-rw-r--r--user/installation/developer.rst36
-rw-r--r--user/installation/kernel.rst30
-rw-r--r--user/installation/releases.rst12
-rw-r--r--user/rsb/bug-reporting.rst8
-rw-r--r--user/rsb/commands.rst8
-rw-r--r--user/rsb/configuration.rst8
-rw-r--r--user/rsb/cross-canadian-cross.rst6
-rw-r--r--user/rsb/deployment.rst8
-rw-r--r--user/rsb/project-sets.rst8
-rw-r--r--user/rsb/third-party-packages.rst2
-rw-r--r--user/testing/tftp.rst4
-rw-r--r--user/tools/bsp-builder.rst4
-rw-r--r--user/tools/exeinfo.rst4
-rw-r--r--user/tools/symbols.rst6
-rw-r--r--user/tools/tester.rst16
-rw-r--r--user/tracing/captureengine.rst4
-rw-r--r--user/tracing/examples.rst10
-rw-r--r--user/tracing/tracelinker.rst6
27 files changed, 119 insertions, 117 deletions
diff --git a/user/bsps/bsps-powerpc.rst b/user/bsps/bsps-powerpc.rst
index 365571f..623f23b 100644
--- a/user/bsps/bsps-powerpc.rst
+++ b/user/bsps/bsps-powerpc.rst
@@ -94,7 +94,7 @@ Boot via U-Boot
The application executable file (ELF file) must be converted to an U-Boot
image. Use the following commands:
-.. code-block:: shell
+.. code-block:: none
powerpc-rtems5-objcopy -O binary app.exe app.bin
gzip -9 -f -c app.bin > app.bin.gz
@@ -102,7 +102,7 @@ image. Use the following commands:
Use the following U-Boot commands to boot an application via TFTP download:
-.. code-block:: shell
+.. code-block:: none
tftpboot ${loadaddr} app.img && run loadfdt && bootm ${loadaddr} - ${fdt_addr} ; reset
diff --git a/user/bsps/bsps-x86_64.rst b/user/bsps/bsps-x86_64.rst
index c872734..eefffab 100644
--- a/user/bsps/bsps-x86_64.rst
+++ b/user/bsps/bsps-x86_64.rst
@@ -40,7 +40,7 @@ Complete detailed instructions are available at `TianoCore's Github's wiki
Quick instructions (which may fall out of date) are:
-.. code-block:: shell
+.. code-block:: none
$ git clone git://github.com/tianocore/edk2.git
$ cd edk2
@@ -63,7 +63,7 @@ shell.
You can find the ``OVMF.fd`` file like this as well in the edk2 directory:
-.. code-block:: shell
+.. code-block:: none
$ find . -name "*.fd"
./Build/OvmfX64/DEBUG_GCC5/FV/MEMFD.fd
@@ -82,7 +82,7 @@ it. `Download FreeBSD's installer "memstick" image for amd64
<https://www.freebsd.org/where.html>`_ and then run the following commands,
replacing paths as appropriate.
-.. code-block:: shell
+.. code-block:: none
$ qemu-img create freebsd.img 8G
$ OVMF_LOCATION=/path/to/ovmf/OVMF.fd
@@ -114,14 +114,14 @@ do something to the effect of the following.
On the host
-.. code-block:: shell
+.. code-block:: none
# Upload hello.exe anywhere accessible within the host
$ curl --upload-file hello.exe https://transfer.sh/rtems
Then on the guest (FreeBSD), login with ``root`` and
-.. code-block:: shell
+.. code-block:: none
# Back the FreeBSD kernel up
$ cp -r /boot/kernel/ /boot/kernel.old
diff --git a/user/bsps/index.rst b/user/bsps/index.rst
index a8035e1..0c3b2f6 100644
--- a/user/bsps/index.rst
+++ b/user/bsps/index.rst
@@ -18,7 +18,7 @@ target hardware.
You can see the current BSP list in the RTEMS sources by asking RTEMS with:
-.. code-block:: shell
+.. code-block:: none
$ ./rtems-bsps
diff --git a/user/exe/initialization.rst b/user/exe/initialization.rst
index eb96595..cfe39d6 100644
--- a/user/exe/initialization.rst
+++ b/user/exe/initialization.rst
@@ -85,7 +85,7 @@ 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::
-.. code-block:: shell
+.. code-block:: none
$ rtems-exeinfo --init arm-rtems5/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
RTEMS Executable Info 5.5416cfa39dd6
diff --git a/user/exe/loader.rst b/user/exe/loader.rst
index 485d691..c11f363 100644
--- a/user/exe/loader.rst
+++ b/user/exe/loader.rst
@@ -456,7 +456,7 @@ is made more complex as it needs to have extra steps to link a second time.
This example shows creating an embedded symbol table object file and linking it
into the base image.
-.. code-block:: shell
+.. code-block:: none
$ sparc-rtems5-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.pre
$ rtems-syms -e -C sparc-rtems5-gcc -c "-mcpu=cypress" -o foo-sym.o foo.pre
@@ -484,7 +484,7 @@ unpredictable. No checks are made.
The example shows creating and loading a symbol table executable object
file. First create the symbol table's executable object file:
-.. code-block:: shell
+.. code-block:: none
$ sparc-rtems5-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.exe
$ rtems-syms -C sparc-rtems5-gcc -c "-mcpu=cypress" -o foo-sym.o foo.exe
@@ -630,7 +630,7 @@ debug information and this should be stripped before loading on to the
target. The tool suite's command :program:`strip` can strip all the object files
in a library with a single command.
-.. code-block:: shell
+.. code-block:: none
$ sparc-rtems5-strip libc.a
diff --git a/user/hardware/architectures.rst b/user/hardware/architectures.rst
index 761258f..b604782 100644
--- a/user/hardware/architectures.rst
+++ b/user/hardware/architectures.rst
@@ -25,7 +25,7 @@ automatically by GCC via selecting a specific set of machine options.
You can query the multilibs of a specific RTEMS GCC compiler via the
``-print-multi-lib`` option:
-.. code-block:: shell
+.. code-block:: none
$ sparc-rtems5-gcc -print-multi-lib
.;
@@ -56,7 +56,7 @@ of machine options for this multilib follows separated by ``@`` characters.
You can figure out the multilib selected by GCC for a set of machine options
with the ``-print-multi-directory`` option:
-.. code-block:: shell
+.. code-block:: none
$ sparc-rtems5-gcc -print-multi-directory -mcpu=leon3
leon3
diff --git a/user/hosts/os.rst b/user/hosts/os.rst
index d1f0834..4bb873e 100644
--- a/user/hosts/os.rst
+++ b/user/hosts/os.rst
@@ -52,7 +52,7 @@ proven over the years to be difficult to manage in production systems.
using the ``--prefix`` option so the path you need to configure to build
applications can be set with the following in a BASH shell:
- .. code-block:: shell
+ .. code-block:: none
$ export PATH=$HOME/development/rtems/4.11/bin:$PATH
@@ -75,7 +75,7 @@ proven over the years to be difficult to manage in production systems.
example, if you want to build a toolchain for 4.11, then you should
checkout the 4.11 branch of the RSB:
- .. code-block:: shell
+ .. code-block:: none
$ git checkout -t origin/4.11
diff --git a/user/hosts/posix.rst b/user/hosts/posix.rst
index 24930e7..044b8bd 100644
--- a/user/hosts/posix.rst
+++ b/user/hosts/posix.rst
@@ -55,7 +55,7 @@ ArchLinux
The following packages are required on a fresh Archlinux 64bit installation:
-.. code-block:: shell
+.. code-block:: none
# pacman -S base-devel gdb xz unzip ncurses git zlib
@@ -63,7 +63,7 @@ Archlinux, by default installs ``texinfo-5`` which is incompatible for building
GCC 4.7 tree. You will have to obtain ``texinfo-legacy`` from ``AUR`` and
provide a manual override:
-.. code-block:: shell
+.. code-block:: none
# pacman -R texinfo
$ yaourt -S texinfo-legacy
@@ -76,7 +76,7 @@ CentOS
The following packages are required on a minimal CentOS 6.3 64bit installation:
-.. code-block:: shell
+.. code-block:: none
# yum install autoconf automake binutils gcc gcc-c++ gdb make patch \
bison flex xz unzip ncurses-devel texinfo zlib-devel python-devel git
@@ -93,7 +93,7 @@ Fedora
The RTEMS Source Builder has been tested on Fedora 19 64bit with the following
packages:
-.. code-block:: shell
+.. code-block:: none
# yum install ncurses-devel python-devel git bison gcc cvs gcc-c++ \
flex texinfo patch perl-Text-ParseWords zlib-devel
@@ -106,7 +106,7 @@ Raspbian
The is the Debian distribution for the Raspberry Pi. The following packages are
required:
-.. code-block:: shell
+.. code-block:: none
$ sudo apt-get install autoconf automake bison flex binutils gcc g++ gdb \
texinfo unzip ncurses-dev python-dev git
@@ -124,7 +124,7 @@ Ubuntu
The latest version is Ubuntu 18.04.1 LTS 64-bit. This section also includes
Xubuntu. A minimal installation was used and the following packages installed:
-.. code-block:: shell
+.. code-block:: none
$ sudu apt-get build-dep gcc-defaults g++ gdb git unzip pax bison \
flex libpython-dev git libncurses5-dev zlib1g-dev
@@ -147,7 +147,7 @@ Linux Mint
zlib package is required on Linux Mint. It has a different name (other
than the usual zlib-dev):
-.. code-block:: shell
+.. code-block:: none
# sudo apt-get install zlib1g-dev
@@ -167,7 +167,7 @@ FreeBSD
The RTEMS Source Builder has been tested on FreeBSD 9.1, 10.3 and 11 64bit
version. You need to install some ports. They are:
-.. code-block:: shell
+.. code-block:: none
# cd /usr/ports
# portinstall --batch lang/python27
@@ -175,7 +175,7 @@ version. You need to install some ports. They are:
If you wish to build Windows (mingw32) tools please install the following
ports:
-.. code-block:: shell
+.. code-block:: none
# cd /usr/ports
# portinstall --batch devel/mingw32-binutils devel/mingw32-gcc
@@ -195,7 +195,7 @@ NetBSD
The RTEMS Source Builder has been tested on NetBSD 6.1 i386. Packages to add
are:
-.. code-block:: shell
+.. code-block:: none
# pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/devel/gmake-3.82nb7.tgz
# pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/devel/bison-2.7.1.tgz
diff --git a/user/hosts/windows.rst b/user/hosts/windows.rst
index ffd70a0..7aaa9c3 100644
--- a/user/hosts/windows.rst
+++ b/user/hosts/windows.rst
@@ -157,7 +157,7 @@ The packages we require are:
Install the packages using ``pacman``:
-.. code-block:: shell
+.. code-block:: none
$ pacman -S python mingw-w64-x86_64-python2 mingw-w64-x86_64-gcc \
bison cvs diffutils git make patch tar texinfo unzip
@@ -225,7 +225,7 @@ cross-compiler is required to build the C runtime for the RTEMS target because
we are building under Cygiwn. The build output for an RTEMS 4.10 ARM tool set
is:
-.. code-block:: shell
+.. code-block:: none
chris@cygwin ~/development/rtems/src/rtems-source-builder/rtems
$ ../source-builder/sb-set-builder --log=l-arm.txt \
diff --git a/user/installation/developer.rst b/user/installation/developer.rst
index 90912cc..541e04b 100644
--- a/user/installation/developer.rst
+++ b/user/installation/developer.rst
@@ -62,7 +62,7 @@ This procedure will build a SPARC tool chain.
Clone the RTEMS Source Builder (RSB) repository:
-.. code-block:: shell
+.. code-block:: none
$ cd
$ mkdir -p development/rtems
@@ -80,7 +80,7 @@ Check all the host packages you need are present. Current libraries are not
checked and this includes checking for the python development libraries GDB
requires:
-.. code-block:: shell
+.. code-block:: none
$ cd rsb
$ ./source-builder/sb-check
@@ -90,7 +90,7 @@ requires:
If you are unsure how to specify the build set for the architecture you wish to
build, just ask the tool:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --list-bsets <1>
RTEMS Source Builder - Set Builder, v4.11.0
@@ -164,7 +164,7 @@ architecture because GDB has a good simulator that lets us run and test the
samples RTEMS builds by default. The current development version
is `5` and is on master:
-.. code-block:: shell
+.. code-block:: none
$ cd rtems
$ ../source-builder/sb-set-builder --prefix=/usr/home/chris/development/rtems/5 5/rtems-sparc
@@ -316,7 +316,7 @@ Create a workspace for RTEMS using the following shell command:
Add ``--bset-tar-file`` to the ``sb-set-builder`` command line to create
tar files of the built package set.
-.. code-block:: shell
+.. code-block:: none
~
$ mkdir -p /c/opt/rtems
@@ -328,7 +328,7 @@ another drive please subsitute ``/c`` with your drive letter.
We build and install all RTEMS packages under the `prefix` we just
created. Change to that directory and get a copy of the RSB:
-.. code-block:: shell
+.. code-block:: none
~
$ cd /c/opt/rtems
@@ -347,7 +347,7 @@ created. Change to that directory and get a copy of the RSB:
We are building RTEMS 4.11 tools so select the *4.11* branch:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/rsb
$ git checkout 4.11
@@ -358,7 +358,7 @@ We are building RTEMS 4.11 tools so select the *4.11* branch:
Check the RSB has a valid environment:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/rsb
$ cd rtems
@@ -375,7 +375,7 @@ long time so please be patient. The RSB creates a log file containing all the
build output and it will be changing size. The RSB command to build ``i386``
tools is:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/rsb/rtems
$ ../source-builder/sb-set-builder --prefix=/c/opt/rtems/4.11 \
@@ -495,7 +495,7 @@ Building the Kernel
We can now build the RTEMS kernel using the RTEMS tools we have just
built. First we need to set the path to the tools:
-.. code-block:: shell
+.. code-block:: none
/c
$ cd /c/opt/rtems
@@ -506,7 +506,7 @@ built. First we need to set the path to the tools:
We currently build RTEMS from the git release branch for 4.11:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems
$ mkdir kernel
@@ -538,7 +538,7 @@ clean away any files, then generate the pre-install header file lists and
finally we generate the ``autoconf`` and ``automake`` files using the RSB's
bootstrap tool. First we clean any generated files that exist:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/kernel/rtems
$ ./bootstrap -c
@@ -548,7 +548,7 @@ bootstrap tool. First we clean any generated files that exist:
Then we generate the pre-install header file automake make files:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/kernel/rtems
$ ./bootstrap -p
@@ -579,7 +579,7 @@ Then we generate the pre-install header file automake make files:
Finally we run the RSB's parallel ``bootstrap`` command:
-.. code-block:: shell
+.. code-block:: none
$ /c/opt/rtems/rsb/source-builder/sb-bootstrap
RTEMS Source Builder - RTEMS Bootstrap, 4.11 (76188ee494dd)
@@ -615,7 +615,7 @@ BSP. You can check the available BSPs by running the ``rtems-bsps`` command
found in the top directory of the RTEMS kernel source. We build the Board
Support Package (BSP) outside the kernel source tree:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/kernel/rtems
$ cd ..
@@ -629,7 +629,7 @@ Support Package (BSP) outside the kernel source tree:
Configure the RTEMS kernel to build ``pc686`` BSP for the ``i386`` target with
networking disabled, We will build the external libBSD stack later:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/kernel/pc686
$ /c/opt/rtems/kernel/rtems/configure --prefix=/c/opt/rtems/4.11 \
@@ -667,7 +667,7 @@ networking disabled, We will build the external libBSD stack later:
Build the kernel:
-.. code-block:: shell
+.. code-block:: none
/c/opt/rtems/kernel/pc686
$ make
@@ -706,7 +706,7 @@ Build the kernel:
Install the kernel to our prefix:
-.. code-block:: shell
+.. code-block:: none
$ make install
Making install in tools/build
diff --git a/user/installation/kernel.rst b/user/installation/kernel.rst
index 4978d41..f8c3c6f 100644
--- a/user/installation/kernel.rst
+++ b/user/installation/kernel.rst
@@ -16,7 +16,7 @@ Development Sources
Create a new location to build the RTEMS kernel:
-.. code-block:: shell
+.. code-block:: none
$ cd
$ cd development/rtems
@@ -25,7 +25,7 @@ Create a new location to build the RTEMS kernel:
Clone the RTEMS respository:
-.. code-block:: shell
+.. code-block:: none
$ git clone git://git.rtems.org/rtems.git rtems
Cloning into 'rtems'...
@@ -44,7 +44,7 @@ section. The RTEMS tools needs to be first in your path because RTEMS provides
specific versions of the ``autoconf`` and ``automake`` tools. We want to use
the RTEMS version and not your host's versions:
-.. code-block:: shell
+.. code-block:: none
$ export PATH=$HOME/development/rtems/5/bin:$PATH
@@ -61,7 +61,7 @@ to speed it up the RSB provides a command that can perform the bootstrap in
parallel using your available cores. We need to enter the cloned source
directory then run the bootstrap commands:
-.. code-block:: shell
+.. code-block:: none
$ cd rtems
$ ./bootstrap -c && $HOME/development/rtems/rsb/source-builder/sb-bootstrap
@@ -103,7 +103,7 @@ We build RTEMS in a directory outside of the source tree we have just cloned
and ``bootstrapped``. You cannot build RTEMS while in the source tree. Lets
create a suitable directory using the name of the BSP we are going to build:
-.. code-block:: shell
+.. code-block:: none
$ cd ..
$ mkdir erc32
@@ -115,7 +115,7 @@ files. If you are source level debugging you will be able to access the source
code to RTEMS from the debugger. We will build for the ``erc32`` BSP with POSIX
enabled and the networking stack disabled:
-.. code-block:: shell
+.. code-block:: none
$ $HOME/development/rtems/kernel/rtems/configure --prefix=$HOME/development/rtems/5 \
--target=sparc-rtems5 --enable-rtemsbsp=erc32 --enable-posix \
@@ -158,7 +158,7 @@ enabled and the networking stack disabled:
Build RTEMS using two cores:
-.. code-block:: shell
+.. code-block:: none
$ make -j 2
Making all in tools/build
@@ -250,7 +250,7 @@ the API headers and architecture specific libraries to a locaiton under the
RTEMS. Do not mix versions of RTEMS under the same `prefix`. Make installs
RTEMS with the following command:
-.. code-block:: shell
+.. code-block:: none
$ make install
Making install in tools/build
@@ -311,7 +311,7 @@ Changes to the source tree are tracked using git. If you have not made changes
and enter the source tree and enter a git status command you will see nothing
has changed:
-.. code-block:: shell
+.. code-block:: none
$ cd ../rtems
$ git status
@@ -323,7 +323,7 @@ We will make a change to the source code. In this example I change the help
message to the RTEMS shell's ``halt`` command. Running the same git status
command reports:
-.. code-block:: shell
+.. code-block:: none
$ git status
On branch master
@@ -339,14 +339,14 @@ command reports:
As an example I have a ticket open and the ticket number is 9876. I commit the
change with the follow git command:
-.. code-block:: shell
+.. code-block:: none
$ git commit cpukit/libmisc/shell/main_halt.c
An editor is opened and I enter my commit message. The first line is a title
and the following lines form a body. My message is:
-.. code-block:: shell
+.. code-block:: none
shell: Add more help detail to the halt command.
@@ -366,7 +366,7 @@ and the following lines form a body. My message is:
When you save and exit the editor git will report the commit's status:
-.. code-block:: shell
+.. code-block:: none
$ git commit cpukit/libmisc/shell/main_halt.c
[master 9f44dc9] shell: Add more help detail to the halt command.
@@ -375,14 +375,14 @@ When you save and exit the editor git will report the commit's status:
You can either email the patch to :r:list:`devel` with the following git
command, and it is `minus one` on the command line:
-.. code-block:: shell
+.. code-block:: none
$ git send-email --to=devel@rtems.org -1
<add output here>
Or you can ask git to create a patch file using:
-.. code-block:: shell
+.. code-block:: none
$ git format-patch -1
0001-shell-Add-more-help-detail-to-the-halt-command.patch
diff --git a/user/installation/releases.rst b/user/installation/releases.rst
index 10ef30e..a20f948 100644
--- a/user/installation/releases.rst
+++ b/user/installation/releases.rst
@@ -66,7 +66,7 @@ RTEMS Tools and Kernel
This procedure will build a SPARC tool chain. Set up a suitable workspace to
build the release in. On Unix:
-.. code-block:: shell
+.. code-block:: none
$ cd
$ mkdir -p development/rtems/releases
@@ -74,7 +74,7 @@ build the release in. On Unix:
If building on Windows:
-.. code-block:: shell
+.. code-block:: none
$ cd /c
$ mkdir -p opt/rtems
@@ -84,7 +84,7 @@ If building on Windows:
Download the RTEMS Source Builder (RSB) from the RTEMS FTP server:
-.. code-block:: shell
+.. code-block:: none
$ wget https://ftp.rtems.org/pub/rtems/releases/4.11/4.11.0/rtems-source-builder-4.11.0.tar.xz
--2016-03-21 10:50:04-- https://ftp.rtems.org/pub/rtems/releases/4.11/4.11.0/rtems-source-builder-4.11.0.tar.xz
@@ -100,7 +100,7 @@ Download the RTEMS Source Builder (RSB) from the RTEMS FTP server:
On Unix unpack the RSB release tar file using:
-.. code-block:: shell
+.. code-block:: none
$ tar Jxf rtems-source-builder-4.11.0.tar.xz
$ cd rtems-source-builder-4.11.0/rtems/
@@ -108,7 +108,7 @@ On Unix unpack the RSB release tar file using:
On Windows you need to shorten the path (See :ref:`windows-path-length`) after
you have unpacked the tar file:
-.. code-block:: shell
+.. code-block:: none
$ tar Jxf rtems-source-builder-4.11.0.tar.xz
$ mv rtems-source-builder-4.11.0 4.110
@@ -121,7 +121,7 @@ and test the samples RTEMS builds by default
If building on Windows add ``--jobs=none`` to avoid GNU make issues on Windows
discussed in :ref:`msys2_parallel_builds`.
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder \
--prefix=/opt/rtems/4.11 4.11/rtems-sparc
diff --git a/user/rsb/bug-reporting.rst b/user/rsb/bug-reporting.rst
index 2adf90a..304da17 100644
--- a/user/rsb/bug-reporting.rst
+++ b/user/rsb/bug-reporting.rst
@@ -13,10 +13,12 @@ find a bug please report it via the :r:url:`devel` or email on the RTEMS Users
list.
Please include the generated RSB report. If you see the following a report has
-been generated::
+been generated:
- ...
- ...
+.. code-block:: none
+
+ ...
+ ...
Build FAILED <1>
See error report: rsb-report-4.11-rtems-lm32.txt <2>
diff --git a/user/rsb/commands.rst b/user/rsb/commands.rst
index 80d74a5..b85692d 100644
--- a/user/rsb/commands.rst
+++ b/user/rsb/commands.rst
@@ -10,7 +10,7 @@ Checker (sb-check)
This commands checks your system is set up correctly. Most options are ignored:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-check --help
sb-check: [options] [args]
@@ -54,7 +54,7 @@ Defaults (sb-defaults)
This commands outputs and the default macros for your when given no
arguments. Most options are ignored:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-defaults --help
sb-defaults: [options] [args]
@@ -94,7 +94,7 @@ Set Builder (sb-set-builder)
This command builds a set:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --help
RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns
@@ -302,7 +302,7 @@ Set Builder (sb-builder)
This command builds a configuration as described in a configuration
file. Configuration files have the extension of ``.cfg``:
-.. code-block:: shell
+.. code-block:: none
$ ./source-builder/sb-builder --help
sb-builder: [options] [args]
diff --git a/user/rsb/configuration.rst b/user/rsb/configuration.rst
index 85e3626..e9a6ad4 100644
--- a/user/rsb/configuration.rst
+++ b/user/rsb/configuration.rst
@@ -238,7 +238,7 @@ with:
The ``sb-defaults`` command lists the defaults for your host. I will not include
the output of this command because of its size:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-defaults
@@ -518,7 +518,7 @@ provides.
To create a private configuration change to a suitable directory:
-.. code-block:: shell
+.. code-block:: none
$ cd ~/work
$ mkdir test
@@ -749,7 +749,7 @@ Once we have the configuration files we can execute the build using the
``sb-builder`` command. The command will perform the build and create a tar file
in the ``tar`` directory:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-builder --prefix=/usr/local \
--log=log_dtc devel/dtc-1.2.0
@@ -782,7 +782,7 @@ The DTC build set file is called ``dtc.bset`` and contains:
To build this you can use something similar to:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --prefix=/usr/local --log=log_dtc \
--trace --bset-tar-file --no-install dtc
diff --git a/user/rsb/cross-canadian-cross.rst b/user/rsb/cross-canadian-cross.rst
index fc903e4..d78952f 100644
--- a/user/rsb/cross-canadian-cross.rst
+++ b/user/rsb/cross-canadian-cross.rst
@@ -22,7 +22,7 @@ development machine.
To build the NTP package for RTEMS you enter the RSB command:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder \
--log=log_ntp_arm.txt \
@@ -85,7 +85,7 @@ To perform a cross build add ``--host=`` to the command line. For example
to build a MinGW tool set on FreeBSD for Windows add ``--host=mingw32``
if the cross compiler is ``mingw32-gcc``:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --host=mingw32 \
--log=l-mingw32-4.11-sparc.txt \
@@ -95,7 +95,7 @@ if the cross compiler is ``mingw32-gcc``:
If you are on a Linux Fedora build host with the MinGW packages installed the
command line is:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --host=i686-w64-mingw32 \
--log=l-mingw32-4.11-sparc.txt \
diff --git a/user/rsb/deployment.rst b/user/rsb/deployment.rst
index c0cd1ce..ad5dd57 100644
--- a/user/rsb/deployment.rst
+++ b/user/rsb/deployment.rst
@@ -32,7 +32,7 @@ directory to the root (``/``) and untar the file because the ``/home`` is root
access only. To install a tar file you have downloaded into your new machine's
``Downloads`` directory in your home directoty you would enter:
-.. code-block:: shell
+.. code-block:: none
$ cd /somewhere
$ tar --strip-components=3 -xjf \
@@ -41,7 +41,7 @@ access only. To install a tar file you have downloaded into your new machine's
A build set tar file is created by adding ``--bset-tar-file`` option to the
``sb-set-builder`` command:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --log=l-sparc.txt \
--prefix=$HOME/development/rtems/4.11 \
@@ -84,7 +84,7 @@ You can also suppress installing the files using the ``--no-install``
option. This is useful if your prefix is not accessiable, for example when
building Canadian cross compiled tool sets:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --log=l-sparc.txt \
--prefix=$HOME/development/rtems/4.11 \
@@ -124,7 +124,7 @@ A package tar file can be created by adding the ``--pkg-tar-files`` to the
``sb-set-builder`` command. This creates a tar file per package built in the
build set:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --log=l-sparc.txt \
--prefix=$HOME/development/rtems/4.11 \
diff --git a/user/rsb/project-sets.rst b/user/rsb/project-sets.rst
index 64a23d4..5ffce26 100644
--- a/user/rsb/project-sets.rst
+++ b/user/rsb/project-sets.rst
@@ -50,7 +50,7 @@ The **bare metal** support for GNU Tool chains. An example is the
for an ARM compiler you would use ``arm-eabi`` or ``arm-eabihf``, and for SPARC
you would use ``sparc-elf``:
-.. code-block:: shell
+.. code-block:: none
$ cd rtems-source-builder/bare
$ ../source-builder/sb-set-builder --log=log_arm_eabihf \
@@ -109,7 +109,7 @@ packages only after they have been built so if you host does not have a
recent enough version of ``autoconf`` and ``automake`` you first need to build them
and install them then build your tool set. The commands are:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --log=l-4.11-at.txt \
--prefix=$HOME/development/rtems/4.11 4.11/rtems-autotools
@@ -131,7 +131,7 @@ passing them on the command line using the ``--macros`` option. For RTEMS these
are held in ``config/snapshots`` directory. The following builds *newlib* from
CVS:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \
--prefix=$HOME/development/rtems/4.11 \
@@ -141,7 +141,7 @@ CVS:
and the following uses the version control heads for ``binutils``, ``gcc``,
``newlib``, ``gdb`` and *RTEMS*:
-.. code-block:: shell
+.. code-block:: none
$ ../source-builder/sb-set-builder --log=l-heads-sparc.txt \
--prefix=$HOME/development/rtems/4.11-head \
diff --git a/user/rsb/third-party-packages.rst b/user/rsb/third-party-packages.rst
index c02153b..b8ca15a 100644
--- a/user/rsb/third-party-packages.rst
+++ b/user/rsb/third-party-packages.rst
@@ -39,7 +39,7 @@ needs to be the same as the prefix used to build RTEMS.
To build Net-SNMP the command is:
-.. code-block:: shell
+.. code-block:: none
$ cd rtems-source-builder/rtems
$ ../source-builder/sb-set-builder --log=log_sis_net_snmp \
diff --git a/user/testing/tftp.rst b/user/testing/tftp.rst
index 54b744a..1abf469 100644
--- a/user/testing/tftp.rst
+++ b/user/testing/tftp.rst
@@ -61,7 +61,7 @@ you follow the instructions for you target.
Configure U-Boot to network boot using the TFTP protocol. This is U-Boot script
for a Zedboard:
-.. code-block:: shell
+.. code-block:: none
loadaddr=0x02000000
uenvcmd=echo Booting RTEMS Zed from net; set autoload no; dhcp; set serverip 10.10.5.2; tftpboot zed/rtems.img; bootm; reset;
@@ -166,7 +166,7 @@ substituted
Some of these field are normally provided by a user's configuration. To do this
use:
-.. code-block:: shell
+.. code-block:: ini
requires = bsp_tty_dev, target_on_command, target_off_command, target_reset_command
diff --git a/user/tools/bsp-builder.rst b/user/tools/bsp-builder.rst
index 0c1d330..7e79462 100644
--- a/user/tools/bsp-builder.rst
+++ b/user/tools/bsp-builder.rst
@@ -344,7 +344,7 @@ spinning disk mounted under `build`. The build uses a development source tree
that is bootstrapped and ready to build. The source can have local patches that
need to be regression tested:
-.. code-block:: shell
+.. code-block:: none
$ /opt/rtems/5/bin/rtems-bsp-builder --build-path=/build/rtems \
--rtems-tools=/opt/work/rtems/5 \
@@ -393,7 +393,7 @@ need to be regression tested:
To build a couple of BSPs you are interested in with tests:
-.. code-block:: shell
+.. code-block:: none
$ /opt/rtems/5/bin/rtems-bsp-builder --build-path=/build/rtems \
--rtems-tools=/opt/work/rtems/5 \
diff --git a/user/tools/exeinfo.rst b/user/tools/exeinfo.rst
index 1913986..279129c 100644
--- a/user/tools/exeinfo.rst
+++ b/user/tools/exeinfo.rst
@@ -94,7 +94,7 @@ Examples
Prints all reports for the ``hello.exe`` for the ``i386/pc686`` BSP:
-.. code-block:: shell
+.. code-block:: none
$ rtems-exeinfo -a i386-rtems5/c/pc686/testsuites/samples/hello/hello.exe
RTEMS Executable Info 5.6f5cfada964c
@@ -168,7 +168,7 @@ drivers.
Print the ``Init`` section data for the ``cdtest.exe`` for the ``i386/pc686`` BSP:
-.. code-block:: shell
+.. code-block:: none
$ rtems-exeinfo -I i386-rtems5/c/pc686/testsuites/samples/cdtest/cdtest.exe
RTEMS Executable Info 5.6f5cfada964c
diff --git a/user/tools/symbols.rst b/user/tools/symbols.rst
index 16e04ee..d1188f8 100644
--- a/user/tools/symbols.rst
+++ b/user/tools/symbols.rst
@@ -135,7 +135,7 @@ Examples
Create a dynamlically loaded symbol table for the ``minimum.exe`` sample
program for the ``i386/pc686`` BSP:
-.. code-block:: shell
+.. code-block:: none
$ rtems-syms -o ms.o i386-rtems5/c/pc686/testsuites/samples/minimum/minimum.exe
$ file ms.o
@@ -143,7 +143,7 @@ program for the ``i386/pc686`` BSP:
Run the same command, this time create a map file:
-.. code-block:: shell
+.. code-block:: none
$ rtems-syms -o ms.o -m ms.map i386-rtems5/c/pc686/testsuites/samples/minimum/minimum.exe
$ head -10 ms.map
@@ -161,7 +161,7 @@ Run the same command, this time create a map file:
Run the same command with a raise verbose level to observe the stages the
command performs:
-.. code-block:: shell
+.. code-block:: none
$ rtems-syms -vvv -o ms.o i386-rtems5/c/pc686/testsuites/samples/minimum/minimum.exe
RTEMS Kernel Symbols 5.a72a462adc18
diff --git a/user/tools/tester.rst b/user/tools/tester.rst
index 967016e..9fb50c7 100644
--- a/user/tools/tester.rst
+++ b/user/tools/tester.rst
@@ -36,7 +36,7 @@ Available BSP testers
You can list the available BSP testers with:
-.. code-block:: shell
+.. code-block:: none
$ rtems-test --list-bsps
arm920
@@ -78,7 +78,7 @@ running the ``bootstrap`` procedure, building and finally installing the
kernel. Be sure to enable tests by using ``--enable-tests`` option with
configure after running ``bootstrap``.
-.. code-block:: shell
+.. code-block:: none
$ ../../rtems.git/configure --target=sparc-rtems5 \
--enable-tests --enable-rtemsbsp=erc32
@@ -99,7 +99,7 @@ Before running all the tests it is a good idea to run the ``hello`` test. The
running it shows you have a working tool chain and build of RTEMS ready to run
the tests. Using the run with the ERC32 BSP the command is:
-.. code-block:: shell
+.. code-block:: none
$ sparc-rtems5-run sparc-rtems5/c/erc32/testsuites/samples/hello/hello.exe
@@ -111,7 +111,7 @@ The run command is the GDB simulator without the GDB part.
Running the example using GDB:
-.. code-block:: shell
+.. code-block:: none
$ sparc-rtems5-gdb sparc-rtems5/c/erc32/testsuites/samples/hello/hello.exe
GNU gdb (GDB) 7.12
@@ -162,7 +162,7 @@ extension for RTEMS executables built within RTEMS.
To run the erc32 tests enter the following command from the top of the erc32
BSP build tree:
-.. code-block:: shell
+.. code-block:: none
$ ~/development/rtems/test/rtems-tools.git/tester/rtems-test \
--log=log_erc32_run \
@@ -234,7 +234,7 @@ invalid count changing means a test running before this test started failed,
not the starting test. The status here has 7 tests passed, no failures, 5
timeouts and 1 invalid test.
-.. code-block:: shell
+.. code-block:: none
[ 5/13] p:2 f:0 u:0 e:0 I:0 B:0 t:0 i:0 | sparc/erc32: hello.exe
@@ -345,7 +345,7 @@ The output is tagged so you can determine where it comes from. The following is
the complete output for the In Memory File System test ``imfs_fslink.exe``
running on a Coldfire MCF5235 using GDB and a BDM pod:
-.. code-block:: shell
+.. code-block:: none
[ 11/472] p:9 f:0 t:0 i:1 | m68k/mcf5235: imfs_fslink.exe
> gdb: ..../bin/m68k-rtems4.11-gdb -i=mi --nx --quiet ..../imfs_fslink.exe
@@ -429,7 +429,7 @@ Command Line Help
The :program:`rtems-test` command line accepts a range of options. You can
review the available option by the ``--help`` option:
-.. code-block:: shell
+.. code-block:: none
RTEMS Tools Project (c) 2012-2014 Chris Johns
Options and arguments:
diff --git a/user/tracing/captureengine.rst b/user/tracing/captureengine.rst
index d04b8a4..a8bca53 100644
--- a/user/tracing/captureengine.rst
+++ b/user/tracing/captureengine.rst
@@ -19,7 +19,7 @@ file: `sparc-rtems5/c/erc32/testsuites/samples`. In order to access the capture
testcase perform the following set of operations inside the RTEMS build
directory.
-.. code-block:: shell
+.. code-block:: none
$ cd /sparc-rtems5/c/erc32/testsuites/samples
$ sparc-rtems5-run ./capture.exe
@@ -98,7 +98,7 @@ traces the context switches between these tasks. ``cwceil`` and ``cwfloor`` are
set to a narrow range of task priorities to avoid creating noise from a large
number of context switches between tasks we are not interested in.
-.. code-block:: shell
+.. code-block:: none
*** BEGIN OF TEST CAPTURE ENGINE ***
*** TEST VERSION: 5.0.0.de9b7d712bf5da6593386fd4fbca0d5f8b8431d8
diff --git a/user/tracing/examples.rst b/user/tracing/examples.rst
index c44daff..d0bef0b 100644
--- a/user/tracing/examples.rst
+++ b/user/tracing/examples.rst
@@ -46,7 +46,7 @@ has been stored) run the following commands to generate traces:
BSP is configured with the following command -
-.. code-block:: shell
+.. code-block:: none
../rtems/configure --target=sparc-rtems5 --prefix=/development/rtems/5 \
--enable-networking --enable-tests --enable-rtemsbsp=erc32 --enable-cxx
@@ -58,7 +58,7 @@ following commands according to your installation. Also confirm the path of the
fileio's executable and object files in the last line of the command according
to your installation.
-.. code-block:: shell
+.. code-block:: none
sparc-rtems5-gcc -Bsparc-rtems5/erc32/lib/ \
-specs bsp_specs -qrtems -mcpu=cypress -O2 -g -ffunction-sections \
@@ -72,7 +72,7 @@ the application. The link command follows the escape sequence "--". "-C" option
denotes the name of the user configuration file and "-W" specifies the name of
the wrapper c file.
-.. code-block:: shell
+.. code-block:: none
rtems-tld -C fileio-trace.ini -W fileio-wrapper -- -Bsparc-rtems5/erc32/lib/ \
-specs bsp_specs -qrtems -mcpu=cypress -O2 -g -ffunction-sections \
@@ -88,13 +88,13 @@ display the contents of the trace buffer and save the buffer to disk in the form
of binary files. Use `rtrace -l` to list the availalble options for commands
with `rtrace`.
-.. code-block:: shell
+.. code-block:: none
sparc-rtems5-run sparc-rtems5/c/erc32/testsuites/samples/fileio.exe
The output from the above commands will be as follows:
-.. code-block:: shell
+.. code-block:: none
*** BEGIN OF TEST FILE I/O ***
*** TEST VERSION: 5.0.0.de9b7d712bf5da6593386fd4fbca0d5f8b8431d8
diff --git a/user/tracing/tracelinker.rst b/user/tracing/tracelinker.rst
index b1e60fd..d32e52b 100644
--- a/user/tracing/tracelinker.rst
+++ b/user/tracing/tracelinker.rst
@@ -25,7 +25,7 @@ options it needs and the second part is a standard linker command line you would
use to link an RTEMS application. The current command line for trace linker
consists of:
-.. code-block:: shell
+.. code-block:: none
$ rtems-tld -h
rtems-trace-ld [options] objects
@@ -482,12 +482,12 @@ commands in the topmost build directory to build the tools project:
First we configure using:
-.. code-block:: shell
+.. code-block:: none
$./waf configure --prefix=$HOME/development/rtems/5
Then we build and install using:
-.. code-block:: shell
+.. code-block:: none
$./waf build install