summaryrefslogtreecommitdiffstats
path: root/user/hosts
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2019-02-21 13:06:58 +1100
committerChris Johns <chrisj@rtems.org>2019-02-28 10:22:54 +1100
commit2674d6a949447e5874bf47d152bdca57d09a3864 (patch)
tree476dbe93b7bb6d4add2f74de57cc98d9d5d8dba4 /user/hosts
parentAdd a cheetsheet link to the README.txt (diff)
downloadrtems-docs-2674d6a949447e5874bf47d152bdca57d09a3864.tar.bz2
user: Remove nit-picky warnings.
Diffstat (limited to 'user/hosts')
-rw-r--r--user/hosts/macos.rst5
-rw-r--r--user/hosts/os.rst3
-rw-r--r--user/hosts/posix.rst87
-rw-r--r--user/hosts/windows.rst93
4 files changed, 102 insertions, 86 deletions
diff --git a/user/hosts/macos.rst b/user/hosts/macos.rst
index c68e627..d488f20 100644
--- a/user/hosts/macos.rst
+++ b/user/hosts/macos.rst
@@ -2,7 +2,7 @@
.. Copyright (C) 2016 Chris Johns <chrisj@rtems.org>
-.. _macos:
+.. _MacOS:
Apple MacOS
===========
@@ -19,7 +19,6 @@ suitable.
:ref:`QuickStartPrefixes` details using Prefixes to manage the installation.
-MacOS
.. _Mavericks:
Mavericks
@@ -43,5 +42,3 @@ Sierra
~~~~~~
The RSB works on Sierra with the latest Xcode.
-
-
diff --git a/user/hosts/os.rst b/user/hosts/os.rst
index 98fa6af..d1f0834 100644
--- a/user/hosts/os.rst
+++ b/user/hosts/os.rst
@@ -38,7 +38,7 @@ proven over the years to be difficult to manage in production systems.
The RSB assumes your host is set up and the needed packages are installed
and configured to work. If your host has not been set up please refer to
- :ref:`Hosts` and your host's section for packages you need to install.
+ section that covers your host's packages you need to install.
.. topic:: Path to use when building applications:
@@ -80,4 +80,3 @@ proven over the years to be difficult to manage in production systems.
$ git checkout -t origin/4.11
Branches are available for the 4.9, 4.10, and 4.11 versions of RTEMS.
-
diff --git a/user/hosts/posix.rst b/user/hosts/posix.rst
index 2a3e694..24930e7 100644
--- a/user/hosts/posix.rst
+++ b/user/hosts/posix.rst
@@ -53,27 +53,33 @@ been tested and report as working.
ArchLinux
~~~~~~~~~
-The following packages are required on a fresh Archlinux 64bit installation::
+The following packages are required on a fresh Archlinux 64bit installation:
- # pacman -S base-devel gdb xz unzip ncurses git zlib
+.. code-block:: shell
+
+ # pacman -S base-devel gdb xz unzip ncurses git zlib
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::
+provide a manual override:
+
+.. code-block:: shell
- # pacman -R texinfo
- $ yaourt -S texinfo-legacy
- # ln -s /usr/bin/makeinfo-4.13a /usr/bin/makeinfo
+ # pacman -R texinfo
+ $ yaourt -S texinfo-legacy
+ # ln -s /usr/bin/makeinfo-4.13a /usr/bin/makeinfo
.. _CentOS:
CentOS
~~~~~~
-The following packages are required on a minimal CentOS 6.3 64bit installation::
+The following packages are required on a minimal CentOS 6.3 64bit installation:
+
+.. code-block:: shell
- # yum install autoconf automake binutils gcc gcc-c++ gdb make patch \
- bison flex xz unzip ncurses-devel texinfo zlib-devel python-devel git
+ # yum install autoconf automake binutils gcc gcc-c++ gdb make patch \
+ bison flex xz unzip ncurses-devel texinfo zlib-devel python-devel git
The minimal CentOS distribution is a specific DVD that installs a minimal
system. If you use a full system some of these packages may have been
@@ -85,10 +91,12 @@ Fedora
~~~~~~
The RTEMS Source Builder has been tested on Fedora 19 64bit with the following
-packages::
+packages:
- # yum install ncurses-devel python-devel git bison gcc cvs gcc-c++ \
- flex texinfo patch perl-Text-ParseWords zlib-devel
+.. code-block:: shell
+
+ # yum install ncurses-devel python-devel git bison gcc cvs gcc-c++ \
+ flex texinfo patch perl-Text-ParseWords zlib-devel
.. _Raspbian:
@@ -96,10 +104,12 @@ Raspbian
~~~~~~~~
The is the Debian distribution for the Raspberry Pi. The following packages are
-required::
+required:
+
+.. code-block:: shell
- $ sudo apt-get install autoconf automake bison flex binutils gcc g++ gdb \
- texinfo unzip ncurses-dev python-dev git
+ $ sudo apt-get install autoconf automake bison flex binutils gcc g++ gdb \
+ texinfo unzip ncurses-dev python-dev git
It is recommended you get Model B of the Pi with 512M of memory and to mount a
remote disk over the network. The tools can be built on the network disk with a
@@ -112,11 +122,13 @@ 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::
+Xubuntu. A minimal installation was used and the following packages installed:
+
+.. code-block:: shell
+
+ $ sudu apt-get build-dep gcc-defaults g++ gdb git unzip pax bison \
+ flex libpython-dev git libncurses5-dev zlib1g-dev
- $ sudu apt-get build-dep gcc-defaults g++ gdb git unzip pax bison \
- flex libpython-dev git libncurses5-dev zlib1g-dev
-
Note that in previous versions of Ubuntu, the package libpython-dev was
python2.7-dev. The name of packages changes over time. You need the
package with Python development libraries for C/C++ programs.
@@ -124,7 +136,7 @@ package with Python development libraries for C/C++ programs.
It is likely necessary that you will have to enable the Ubuntu Source Repositories.
Users have suggested the following web pages which have instructions:
-* https://askubuntu.com/questions/158871/how-do-i-enable-the-source-code-repositories/158872
+* https://askubuntu.com/questions/158871/how-do-i-enable-the-source-code-repositories/158872
* https://askubuntu.com/questions/496549/error-you-must-put-some-source-uris-in-your-sources-list
.. _Linux Mint:
@@ -133,9 +145,11 @@ Linux Mint
~~~~~~~~~~
zlib package is required on Linux Mint. It has a different name (other
-than the usual zlib-dev)::
+than the usual zlib-dev):
+
+.. code-block:: shell
- # sudo apt-get install zlib1g-dev
+ # sudo apt-get install zlib1g-dev
.. _openSUSE:
@@ -151,17 +165,21 @@ 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::
+version. You need to install some ports. They are:
+
+.. code-block:: shell
- # cd /usr/ports
- # portinstall --batch lang/python27
+ # cd /usr/ports
+ # portinstall --batch lang/python27
If you wish to build Windows (mingw32) tools please install the following
-ports::
+ports:
- # cd /usr/ports
- # portinstall --batch devel/mingw32-binutils devel/mingw32-gcc
- # portinstall --batch devel/mingw32-zlib devel/mingw32-pthreads
+.. code-block:: shell
+
+ # cd /usr/ports
+ # portinstall --batch devel/mingw32-binutils devel/mingw32-gcc
+ # portinstall --batch devel/mingw32-zlib devel/mingw32-pthreads
The +zlip+ and +pthreads+ ports for MinGW32 are used for builiding a Windows
QEMU.
@@ -175,11 +193,10 @@ NetBSD
------
The RTEMS Source Builder has been tested on NetBSD 6.1 i386. Packages to add
-are::
-
- # 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
- # pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/archivers/xz-5.0.4.tgz
+are:
-.. _MacOS:
+.. code-block:: shell
+ # 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
+ # pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/archivers/xz-5.0.4.tgz
diff --git a/user/hosts/windows.rst b/user/hosts/windows.rst
index bd63fb5..ffd70a0 100644
--- a/user/hosts/windows.rst
+++ b/user/hosts/windows.rst
@@ -38,7 +38,8 @@ overhead is only during the building of the tools and the RTEMS kernel
and if you use a suitable build system that is native to Windows your
application development should be similar to other operating systems.
-Building is known to work on `Windows 7 64bit Professional` and `Windows 10`.
+Building is known to work on `Windows 7 64bit Professional` and
+`Windows 10 64bit`.
.. _windows-path-length:
@@ -222,49 +223,52 @@ result in Cygiwn binaries. With a Canadian cross-compile a Cygwin
cross-compiler is built as well as the MinGW RTEMS cross-compiler. The Cygwin
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::
-
- chris@cygthing ~/development/rtems/src/rtems-source-builder/rtems
- $ ../source-builder/sb-set-builder --log=l-arm.txt --prefix=$HOME/development/rtems/4.10 4.10/rtems-arm
- RTEMS Source Builder - Set Builder, v0.2
- Build Set: 4.10/rtems-arm
- config: expat-2.1.0-1.cfg
- package: expat-2.1.0-x86_64-w64-mingw32-1
- building: expat-2.1.0-x86_64-w64-mingw32-1
- reporting: expat-2.1.0-1.cfg -> expat-2.1.0-x86_64-w64-mingw32-1.html
- config: tools/rtems-binutils-2.20.1-1.cfg
- package: arm-rtems4.10-binutils-2.20.1-1 <1>
- building: arm-rtems4.10-binutils-2.20.1-1
- package: (Cxc) arm-rtems4.10-binutils-2.20.1-1 <2>
- building: (Cxc) arm-rtems4.10-binutils-2.20.1-1
- reporting: tools/rtems-binutils-2.20.1-1.cfg ->
- arm-rtems4.10-binutils-2.20.1-1.html
- config: tools/rtems-gcc-4.4.7-newlib-1.18.0-1.cfg
- package: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
- building: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
- package: (Cxc) arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
- building: (Cxc) arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
- reporting: tools/rtems-gcc-4.4.7-newlib-1.18.0-1.cfg ->
- arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1.html
- config: tools/rtems-gdb-7.3.1-1.cfg
- package: arm-rtems4.10-gdb-7.3.1-1
- building: arm-rtems4.10-gdb-7.3.1-1
- reporting: tools/rtems-gdb-7.3.1-1.cfg -> arm-rtems4.10-gdb-7.3.1-1.html
- config: tools/rtems-kernel-4.10.2.cfg
- package: arm-rtems4.10-kernel-4.10.2-1
- building: arm-rtems4.10-kernel-4.10.2-1
- reporting: tools/rtems-kernel-4.10.2.cfg -> arm-rtems4.10-kernel-4.10.2-1.html
- installing: expat-2.1.0-x86_64-w64-mingw32-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
- installing: arm-rtems4.10-binutils-2.20.1-1 -> /cygdrive/c/Users/chris/development/rtems/4.10 <3>
- installing: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
- installing: arm-rtems4.10-gdb-7.3.1-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
- installing: arm-rtems4.10-kernel-4.10.2-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
- cleaning: expat-2.1.0-x86_64-w64-mingw32-1
- cleaning: arm-rtems4.10-binutils-2.20.1-1
- cleaning: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
- cleaning: arm-rtems4.10-gdb-7.3.1-1
- cleaning: arm-rtems4.10-kernel-4.10.2-1
- Build Set: Time 10:09:42.810547 <4>
+is:
+
+.. code-block:: shell
+
+ chris@cygwin ~/development/rtems/src/rtems-source-builder/rtems
+ $ ../source-builder/sb-set-builder --log=l-arm.txt \
+ --prefix=$HOME/development/rtems/4.10 4.10/rtems-arm
+ RTEMS Source Builder - Set Builder, v0.2
+ Build Set: 4.10/rtems-arm
+ config: expat-2.1.0-1.cfg
+ package: expat-2.1.0-x86_64-w64-mingw32-1
+ building: expat-2.1.0-x86_64-w64-mingw32-1
+ reporting: expat-2.1.0-1.cfg -> expat-2.1.0-x86_64-w64-mingw32-1.html
+ config: tools/rtems-binutils-2.20.1-1.cfg
+ package: arm-rtems4.10-binutils-2.20.1-1 <1>
+ building: arm-rtems4.10-binutils-2.20.1-1
+ package: (Cxc) arm-rtems4.10-binutils-2.20.1-1 <2>
+ building: (Cxc) arm-rtems4.10-binutils-2.20.1-1
+ reporting: tools/rtems-binutils-2.20.1-1.cfg ->
+ arm-rtems4.10-binutils-2.20.1-1.html
+ config: tools/rtems-gcc-4.4.7-newlib-1.18.0-1.cfg
+ package: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
+ building: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
+ package: (Cxc) arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
+ building: (Cxc) arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
+ reporting: tools/rtems-gcc-4.4.7-newlib-1.18.0-1.cfg ->
+ arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1.html
+ config: tools/rtems-gdb-7.3.1-1.cfg
+ package: arm-rtems4.10-gdb-7.3.1-1
+ building: arm-rtems4.10-gdb-7.3.1-1
+ reporting: tools/rtems-gdb-7.3.1-1.cfg -> arm-rtems4.10-gdb-7.3.1-1.html
+ config: tools/rtems-kernel-4.10.2.cfg
+ package: arm-rtems4.10-kernel-4.10.2-1
+ building: arm-rtems4.10-kernel-4.10.2-1
+ reporting: tools/rtems-kernel-4.10.2.cfg -> arm-rtems4.10-kernel-4.10.2-1.html
+ installing: expat-2.1.0-x86_64-w64-mingw32-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
+ installing: arm-rtems4.10-binutils-2.20.1-1 -> /cygdrive/c/Users/chris/development/rtems/4.10 <3>
+ installing: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
+ installing: arm-rtems4.10-gdb-7.3.1-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
+ installing: arm-rtems4.10-kernel-4.10.2-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
+ cleaning: expat-2.1.0-x86_64-w64-mingw32-1
+ cleaning: arm-rtems4.10-binutils-2.20.1-1
+ cleaning: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
+ cleaning: arm-rtems4.10-gdb-7.3.1-1
+ cleaning: arm-rtems4.10-kernel-4.10.2-1
+ Build Set: Time 10:09:42.810547 <4>
.. topic:: Items:
@@ -289,4 +293,3 @@ is::
cannot be avoided in all cases. Cygwin and it's fork MSYS are fantastic
pieces of software in a difficult environment. I have found building a single
tool tends to work, building all at once is harder.
-