mirror of
https://git.rtems.org/rtems-docs/
synced 2025-06-06 15:57:58 +08:00
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.
This commit is contained in:
Chris Johns
parent
6c5640131f
commit
ac0eaff941
31
user/conf.py
31
user/conf.py
@ -5,37 +5,6 @@ from conf import *
|
||||
|
||||
project = "RTEMS User Manual"
|
||||
|
||||
exclude_patterns = ['config/build.rst',
|
||||
'config/runtime.rst',
|
||||
|
||||
'start/quick.rst',
|
||||
|
||||
'hosts/os.rst',
|
||||
'hosts/prefixes.rst',
|
||||
'hosts/macos.rst',
|
||||
'hosts/posix.rst',
|
||||
'hosts/windows.rst',
|
||||
|
||||
'installation/prefixes-sandboxing.rst',
|
||||
'installation/releases.rst',
|
||||
'installation/developer.rst',
|
||||
'installation/kernel.rst',
|
||||
|
||||
'hardware/targets.rst',
|
||||
'hardware/architectures.rst',
|
||||
'hardware/bsps.rst',
|
||||
'hardware/tiers.rst',
|
||||
|
||||
'tools/build.rst',
|
||||
'tools/simulation.rst',
|
||||
|
||||
'test/create.rst',
|
||||
'test/running.rst',
|
||||
'start/installation.rst',
|
||||
'start/transition.rst',
|
||||
|
||||
'waf/index.rst']
|
||||
|
||||
latex_documents = [
|
||||
('index',
|
||||
'user.tex',
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
Build Configuration
|
||||
===================
|
||||
.. index:: Build Configuration
|
||||
|
||||
XXX: build configuration
|
||||
@ -1,10 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
|
||||
Config
|
||||
******
|
||||
|
||||
XXX: All about rtems config
|
||||
|
||||
.. include:: build.rst
|
||||
.. include:: runtime.rst
|
||||
@ -1,7 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
Runtime
|
||||
=======
|
||||
.. index:: Runtime Configuration
|
||||
|
||||
XXX: runtime config
|
||||
@ -12,7 +12,9 @@ Hardware
|
||||
This section discusses supported Hardware, Architectures, Board Support
|
||||
Packages, and running RTEMS on real hardware and simulators.
|
||||
|
||||
.. include:: targets.rst
|
||||
.. include:: architectures.rst
|
||||
.. include:: bsps.rst
|
||||
.. include:: tiers.rst
|
||||
.. toctree::
|
||||
|
||||
targets
|
||||
architectures
|
||||
bsps
|
||||
tiers
|
||||
|
||||
@ -44,7 +44,9 @@ building tools is something you do once. Once the tools and RTEMS is built all
|
||||
your time can be spent writing and developing your application. Over an hour
|
||||
can happen and for the ARM architecture and with all BSPs it can be many hours.
|
||||
|
||||
.. include:: os.rst
|
||||
.. include:: posix.rst
|
||||
.. include:: macos.rst
|
||||
.. include:: windows.rst
|
||||
.. toctree::
|
||||
|
||||
os
|
||||
posix
|
||||
macos
|
||||
windows
|
||||
|
||||
@ -53,7 +53,7 @@ to the Community Project hosted at http://www.rtems.org/.
|
||||
tools/index
|
||||
|
||||
support/index
|
||||
additional/index
|
||||
|
||||
glossary/index
|
||||
|
||||
genindex
|
||||
|
||||
@ -3,11 +3,11 @@
|
||||
.. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
|
||||
.. comment: All rights reserved.
|
||||
|
||||
.. index:: Installation
|
||||
.. _installation:
|
||||
|
||||
Installation
|
||||
************
|
||||
.. index:: Installation
|
||||
|
||||
This section details how to set up and install the RTEMS Ecosystem. You will
|
||||
create a set of tools and an RTEMS kernel for your selected Board Support
|
||||
@ -42,9 +42,11 @@ pass ready for you to use. The tools and kernel are stable and only bug fixes
|
||||
are added creating new dot point releases. The developer set up tracks the Git
|
||||
repositories for the tools and kernel.
|
||||
|
||||
.. include:: prefixes-sandboxing.rst
|
||||
.. include:: releases.rst
|
||||
.. include:: developer.rst
|
||||
.. include:: kernel.rst
|
||||
|
||||
.. comment: code block warning is in kernel.rst
|
||||
|
||||
.. toctree::
|
||||
|
||||
prefixes-sandboxing
|
||||
releases
|
||||
developer
|
||||
kernel
|
||||
|
||||
@ -4,12 +4,11 @@
|
||||
.. comment: All rights reserved.
|
||||
|
||||
.. _prefixes:
|
||||
.. index:: Prefixes
|
||||
|
||||
Prefixes
|
||||
========
|
||||
|
||||
.. index:: Prefixes
|
||||
|
||||
You will see the term :ref:term:`prefix` referred to thoughout this
|
||||
documentation and in a wide number of software packages you can download from
|
||||
the internet. A **prefix** is the path on your computer a software package is
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
.. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
|
||||
.. 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`.
|
||||
@ -1,68 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
.. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
|
||||
.. 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.
|
||||
@ -1,7 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
Transition
|
||||
===========
|
||||
.. index:: Transition, Autotools
|
||||
|
||||
XXX: Transition from auto* to waf.
|
||||
@ -14,9 +14,11 @@ of avaliable host computers users wish to develop on. This section details the
|
||||
tools available on the host computers to help support RTEMS users and
|
||||
developers.
|
||||
|
||||
.. include:: linker.rst
|
||||
.. include:: symbols.rst
|
||||
.. include:: exeinfo.rst
|
||||
.. include:: trace-linker.rst
|
||||
.. include:: bsp-builder.rst
|
||||
.. include:: tester.rst
|
||||
.. toctree::
|
||||
|
||||
linker
|
||||
symbols
|
||||
exeinfo
|
||||
trace-linker
|
||||
bsp-builder
|
||||
tester
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
:orphan:
|
||||
|
||||
Building
|
||||
========
|
||||
.. index:: Building
|
||||
|
||||
XXX: How to build.
|
||||
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
:orphan:
|
||||
|
||||
Config
|
||||
=======
|
||||
.. index:: Config
|
||||
|
||||
XXX: waf config
|
||||
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
.. _waf:
|
||||
|
||||
===
|
||||
Waf
|
||||
===
|
||||
|
||||
XXX: All about waf.
|
||||
|
||||
|
||||
.. include:: config.rst
|
||||
.. include:: build.rst
|
||||
.. include:: install.rst
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
:orphan:
|
||||
|
||||
Installing RTEMS
|
||||
================
|
||||
.. index:: Installing RTEMS
|
||||
|
||||
XXX: How to install.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user