summaryrefslogtreecommitdiffstats
path: root/user/installation
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/installation
parentAdd commands and output to the README. (diff)
downloadrtems-docs-d5b631fa3bcd822815c7f875432b15e8b9875395.tar.bz2
User: Change output block to type none.
Diffstat (limited to 'user/installation')
-rw-r--r--user/installation/developer.rst36
-rw-r--r--user/installation/kernel.rst30
-rw-r--r--user/installation/releases.rst12
3 files changed, 39 insertions, 39 deletions
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