From ac0eaff94117757046867bc92797d6c2dae78cd4 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Mon, 13 Nov 2017 11:51:23 +1100 Subject: Use '.. toctree::' and not '.. include::' in the User Manual. - Change all suitable '.. include::' to TOC tree. - Remove unused and not needed sections. - Fix the conf.py to not exclude some files. Close #3232. --- user/start/installation.rst | 27 ------------------ user/start/quick.rst | 68 --------------------------------------------- user/start/transition.rst | 7 ----- 3 files changed, 102 deletions(-) delete mode 100644 user/start/installation.rst delete mode 100644 user/start/quick.rst delete mode 100644 user/start/transition.rst (limited to 'user/start') diff --git a/user/start/installation.rst b/user/start/installation.rst deleted file mode 100644 index 0513e4c..0000000 --- a/user/start/installation.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. comment SPDX-License-Identifier: CC-BY-SA-4.0 - -.. comment: Copyright (c) 2016 Chris Johns -.. comment: All rights reserved. - -Installation -============ - -.. index:: Installation - -RTEMS is built from source on your host machine. Releases are available from -our :r:url:`ftp` and each release contains a Quick Start build guide. If you -are wanting to track changes to RTEMS as they happen or you want to make -changes to RTEMS to send back to the project on our :r:list:`devel` then you -can use the developer's version available in our :r:url:`git`. - -RTEMS supports development on a wide vararity of hosts. There is no preferred -host operating system the project requires you use. This means you are able to -decide on a host operating system that is your passion, suites your needs, or -in some cases is decided for you by your employer. Our aim is to provide a -consistent user experience and on matching hardware the experience should feel -similar. - -The RTEMS core development team uses POSIX type operating systems, that is -Unix. The :ref:`released-version` and :ref:`development-version` sections -assume Unix. Microsoft Windows is documented in a separate section -:ref:`microsoft-windows-installation`. diff --git a/user/start/quick.rst b/user/start/quick.rst deleted file mode 100644 index 199ae2c..0000000 --- a/user/start/quick.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. comment SPDX-License-Identifier: CC-BY-SA-4.0 - -.. comment: Copyright (c) 2016 Chris Johns -.. comment: All rights reserved. - -Quick Start Guide -================= - -.. index:: Quick Start - -The following is a quick start guide that provides you with the basic commands -you need to build the RTEMS Tools and Kernel. - -You need to have your development host set up and ready, the -:ref:`development-host` covers what you need. - -This procedure does a development (unstable) build from Git for a POSIX -host. You can refer to the specific section that cover the specific part of the -process in detail if you have an issue. The output from the commands has been -removed and replaced with ``...``. - -Create a workspace, download the RTEMS Source Builder (RSB) and build a tool -chain (See :ref:`rtems-tools-chain`): - -.. code-block:: shell - - $ cd - $ mkdir -p development/rtems - $ cd development/rtems - $ git clone git://git.rtems.org/rtems-source-builder.git rsb - ... - $ cd rsb - $ ./source-builder/sb-check - ... - $ cd rtems - $ ../source-builder/sb-set-builder \ - --prefix=/usr/home/chris/development/rtems/5 5/rtems-sparc - ... - -Build the RTEMS Kernel (See :ref:`rtems-kernel`) by cloning the repository, -running the ``bootstrap`` procecure, building and finally installing the -kernel: - -.. code-block:: shell - - $ export PATH=$HOME/development/rtems/5/bin:$PATH - $ cd - $ cd development/rtems - $ mkdir kernel - $ cd kernel - $ git clone git://git.rtems.org/rtems.git rtems - ... - $ cd rtems - $ ./bootstrap -c && ./bootstrap -p && \ - $HOME/development/rtems/rsb/source-builder/sb-bootstrap - ... - $ cd .. - $ mkdir erc32 - $ cd erc32 - $ $HOME/development/rtems/kernel/rtems/configure --prefix=$HOME/development/rtems/5 \ - --target=sparc-rtems5 --enable-rtemsbsp=erc32 --enable-posix \ - --disable-networking - ... - $ make -j 8 - ... - $ make install - -You can now build a 3rd party library like LibBSD or an application. diff --git a/user/start/transition.rst b/user/start/transition.rst deleted file mode 100644 index ecdefe3..0000000 --- a/user/start/transition.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. comment SPDX-License-Identifier: CC-BY-SA-4.0 - -Transition -=========== -.. index:: Transition, Autotools - -XXX: Transition from auto* to waf. -- cgit v1.2.3