From aa1c010e313ed4067e4d477f048cc6f0350b5e97 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Wed, 9 Nov 2016 12:20:46 +1100 Subject: user: Fix header levels. --- user/additional/index.rst | 4 ++-- user/apps/index.rst | 25 +++++++++++++++++++++++++ user/bsp/index.rst | 4 +--- user/config/index.rst | 8 +++----- user/ecosys/index.rst | 8 ++++---- user/glossary/index.rst | 2 +- user/hardware/architectures.rst | 2 +- user/hardware/bsps.rst | 2 +- user/hardware/index.rst | 2 +- user/hardware/targets.rst | 2 +- user/hardware/tiers.rst | 2 +- user/hosts/index.rst | 2 +- user/hosts/macos.rst | 2 +- user/hosts/os.rst | 2 +- user/hosts/posix.rst | 4 ++-- user/hosts/windows.rst | 12 ++++++------ user/index.rst | 2 +- user/installation/developer.rst | 6 +++--- user/installation/index.rst | 2 +- user/installation/kernel.rst | 14 +++++++------- user/installation/prefixes-sandboxing.rst | 2 +- user/installation/releases.rst | 4 ++-- user/overview/index.rst | 6 +++--- user/start/index.rst | 2 +- user/support/index.rst | 24 +++++++++++++++--------- user/test/index.rst | 4 +--- user/tools/build.rst | 1 - user/tools/index.rst | 3 +-- 28 files changed, 88 insertions(+), 65 deletions(-) create mode 100644 user/apps/index.rst (limited to 'user') diff --git a/user/additional/index.rst b/user/additional/index.rst index 903e24e..c276f03 100644 --- a/user/additional/index.rst +++ b/user/additional/index.rst @@ -1,8 +1,8 @@ .. comment SPDX-License-Identifier: CC-BY-SA-4.0 -====================== + Additional Information -====================== +********************** Information and details that do not belong in other sections go here. diff --git a/user/apps/index.rst b/user/apps/index.rst new file mode 100644 index 0000000..f0b3881 --- /dev/null +++ b/user/apps/index.rst @@ -0,0 +1,25 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. comment: Copyright (c) 2016 Chris Johns +.. comment: All rights reserved. + +.. _applications: + +Applications +============ +.. index:: Applications + +this section discusses RTEMS Applications and guides you on how to create an +application. + +Executables +----------- + +The RTEMS applications are statically linked executable that run on bare target +hardware in a single address space. The application code, RTEMS kernel and any +libraries are linked to a fixed address. The applications are loaded into the +target's address space and run with full control of the processor and all +hardware connected. + +The RTEMS tools generate Extendable Loadable Format or ELF format files by +default and we recommend your build script alwas diff --git a/user/bsp/index.rst b/user/bsp/index.rst index 5391962..72c3f4e 100644 --- a/user/bsp/index.rst +++ b/user/bsp/index.rst @@ -1,12 +1,10 @@ .. comment SPDX-License-Identifier: CC-BY-SA-4.0 -=== BSP -=== +*** XXX: preamble BSPs Testing. :r:bsp:`sparc/sis` - diff --git a/user/config/index.rst b/user/config/index.rst index 0283150..ef19702 100644 --- a/user/config/index.rst +++ b/user/config/index.rst @@ -1,12 +1,10 @@ .. comment SPDX-License-Identifier: CC-BY-SA-4.0 -====== + Config -====== +****** + XXX: All about rtems config .. include:: build.rst .. include:: runtime.rst - - - diff --git a/user/ecosys/index.rst b/user/ecosys/index.rst index f2da24d..1e9ee12 100644 --- a/user/ecosys/index.rst +++ b/user/ecosys/index.rst @@ -6,7 +6,7 @@ .. _ecosystem: RTEMS Ecosystem -=============== +*************** .. index:: Ecosystem The RTEMS Ecosystem is the collection of tools, packages, code, documentation @@ -27,7 +27,7 @@ work-flow that best suites the demands of your project and what you are delivering. Rational --------- +======== RTEMS is complex and the focus of the RTEMS Ecosystem is to simplify the complexity for users by providing a stable documented way to build, configure @@ -63,7 +63,7 @@ an archive of the complete build process including all the source code for long term storage. This is important for projects with a long life cycle. Open Source ------------ +=========== RTEMS is an open source operating system and an open source project and this extends to the ecosystem. We encourage users to integrate the processes to @@ -78,7 +78,7 @@ the freedom this gives a user is as important as the freedom of having access to the source code for a package. Deployment ----------- +========== The RTEMS Project provides the ecosystem as source code that users can download to create personalised development environments. The RTEMS Project does not diff --git a/user/glossary/index.rst b/user/glossary/index.rst index ef7e4bb..852ed73 100644 --- a/user/glossary/index.rst +++ b/user/glossary/index.rst @@ -2,7 +2,7 @@ Glossary -======== +******** .. glossary:: diff --git a/user/hardware/architectures.rst b/user/hardware/architectures.rst index 1d6fd26..54245e6 100644 --- a/user/hardware/architectures.rst +++ b/user/hardware/architectures.rst @@ -4,7 +4,7 @@ .. comment: All rights reserved. Architectures -------------- +============= .. index:: Architectures An RTEMS architecture is a class or family of a processor that RTEMS diff --git a/user/hardware/bsps.rst b/user/hardware/bsps.rst index 907a161..e83dda0 100644 --- a/user/hardware/bsps.rst +++ b/user/hardware/bsps.rst @@ -6,7 +6,7 @@ .. _bsps: Board Support Packages (BSP) ----------------------------- +============================ .. index:: Board Support Package .. index:: BSP diff --git a/user/hardware/index.rst b/user/hardware/index.rst index df4eeef..d27ecb8 100644 --- a/user/hardware/index.rst +++ b/user/hardware/index.rst @@ -6,7 +6,7 @@ .. _Hardware: Hardware -======== +******** .. index:: Hardware This section discusses supported Hardware, Architectures, Board Support diff --git a/user/hardware/targets.rst b/user/hardware/targets.rst index 08917c6..fe1ce18 100644 --- a/user/hardware/targets.rst +++ b/user/hardware/targets.rst @@ -6,7 +6,7 @@ .. _targets: Targets -------- +======= .. index:: Targets Hardware that can run RTEMS is often referred to as a *target* because RTEMS is diff --git a/user/hardware/tiers.rst b/user/hardware/tiers.rst index 9ebdc7c..e81157f 100644 --- a/user/hardware/tiers.rst +++ b/user/hardware/tiers.rst @@ -6,7 +6,7 @@ .. _tiers: Tiers ------ +===== .. index Tiers RTEMS has a tiered structure for architecture and BSPs. It provides: diff --git a/user/hosts/index.rst b/user/hosts/index.rst index 5d562e8..71111f9 100644 --- a/user/hosts/index.rst +++ b/user/hosts/index.rst @@ -8,7 +8,7 @@ .. _development-host: Host Computer -------------- +************* .. index:: Host Computer RTEMS applications are developed using cross-development tools running on a diff --git a/user/hosts/macos.rst b/user/hosts/macos.rst index 426b303..057679b 100644 --- a/user/hosts/macos.rst +++ b/user/hosts/macos.rst @@ -6,7 +6,7 @@ .. _macos: Apple OS X -~~~~~~~~~~ +========== Apple's OS X is fully supported. You need to download and install a recent version of the Apple developer application Xcode. Xocde is available in the App diff --git a/user/hosts/os.rst b/user/hosts/os.rst index 9197144..a120ec2 100644 --- a/user/hosts/os.rst +++ b/user/hosts/os.rst @@ -6,7 +6,7 @@ .. _host-os: Host Operating Systems -~~~~~~~~~~~~~~~~~~~~~~ +====================== .. sidebar:: *GDB and Python* diff --git a/user/hosts/posix.rst b/user/hosts/posix.rst index fd4fb6c..5906428 100644 --- a/user/hosts/posix.rst +++ b/user/hosts/posix.rst @@ -6,7 +6,7 @@ .. _posix-hosts: POSIX Hosts -~~~~~~~~~~~ +=========== POSIX hosts are most Unix operating systems such as Linux, FreeBSD and NetBSD. RTEMS development works well on Unix and can scale from a single user @@ -14,7 +14,7 @@ and a desktop machine to a team with decentralised or centralised development infrastructure. Root Access -^^^^^^^^^^^ +----------- You either have ``root`` access to your host development machine or you do not. Some users are given hardware that is centrally managed. If you do not diff --git a/user/hosts/windows.rst b/user/hosts/windows.rst index 093fa31..6a76e7c 100644 --- a/user/hosts/windows.rst +++ b/user/hosts/windows.rst @@ -6,7 +6,7 @@ .. _microsoft-windows: Microsoft Windows -~~~~~~~~~~~~~~~~~ +================= RTEMS supports Windows as a development host and the tools for most architectures are available. The RTEMS Project relies on the GNU tools for @@ -44,7 +44,7 @@ Building is known to work on `Windows 7 64bit Professional` and `Windows 10`. .. _windows-path-length: Windows Path Length -^^^^^^^^^^^^^^^^^^^ +------------------- Windows path length is limited and can cause problems when building the tools. The standard Windows API has a ``MAX_PATH`` length of 260 @@ -61,7 +61,7 @@ smaller to build. This is indicated in :ref:`released-version`. .. _msys2_parallel_builds: Parallel Builds with Make -^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------- The MSYS2 GNU ``make`` has problems when using the `jobs` option. The RSB defaults to automatically using as many cores as the host machine has. To get a @@ -69,7 +69,7 @@ successful build on Windows it is recommended you add the ``--jobs=none`` option to all RSB build set commands. POSIX Support -^^^^^^^^^^^^^ +------------- Building the RTEMS compilers, debugger, the RTEMS kernel and a number of other 3rd party packages requires a POSIX environment. On Windows you can use Cygwin @@ -87,7 +87,7 @@ distribution and that is a welcome feature on Windows. You get a powerful tool to manage your development environment on Windows. Python -^^^^^^ +------ We need Python to build the tools as the RSB is written in Python and we need suitable Python libraries to link to GDB as RTEMS makes use of GDB's Python @@ -113,7 +113,7 @@ generate. .. _microsoft-windows-installation: Installing MSYS2 -^^^^^^^^^^^^^^^^ +---------------- MSYS2 is installed on a new machine using the MSYS2 installer found on https://msys2.github.io/. Please select the ``x86_64`` variant for 64bit diff --git a/user/index.rst b/user/index.rst index c3f9683..063bd4a 100644 --- a/user/index.rst +++ b/user/index.rst @@ -16,7 +16,7 @@ Table of Contents ----------------- .. toctree:: - :maxdepth: 3 + :maxdepth: 5 :numbered: overview/index diff --git a/user/installation/developer.rst b/user/installation/developer.rst index 0db4a51..db62dc4 100644 --- a/user/installation/developer.rst +++ b/user/installation/developer.rst @@ -8,7 +8,7 @@ .. _unstable: Developer (Unstable) --------------------- +==================== .. index:: Git RTEMS provides open access to it's development processes. We call this the @@ -57,7 +57,7 @@ versions available to test with. .. _macos-host-tools-chain: POSIX and OS X Host Tools Chain -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------- This procedure will build a SPARC tool chain. @@ -208,7 +208,7 @@ is `4.12` and is on master: .. _windows-tool-chain: Windows Host Tool Chain -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- .. index:: Microsoft Windows Installation This section details how you create an RTEMS development environment on diff --git a/user/installation/index.rst b/user/installation/index.rst index 2864114..6f3db6b 100644 --- a/user/installation/index.rst +++ b/user/installation/index.rst @@ -6,7 +6,7 @@ .. _installation: Installation -============ +************ .. index:: Installation This section details how to set up and install the RTEMS Ecosystem. You will diff --git a/user/installation/kernel.rst b/user/installation/kernel.rst index 676e2c2..907c918 100644 --- a/user/installation/kernel.rst +++ b/user/installation/kernel.rst @@ -6,14 +6,14 @@ .. _rtems-kernel: RTEMS Kernel ------------- +============ RTEMS is an open source real-time operating system. As a user you have access to all the source code. The ``RTEMS Kernel`` section will show you how you build the RTEMS kernel on your host. Development Sources -~~~~~~~~~~~~~~~~~~~ +------------------- Create a new location to build the RTEMS kernel: @@ -38,7 +38,7 @@ Clone the RTEMS respository: Checking connectivity... done. Tools Path Set Up -~~~~~~~~~~~~~~~~~ +----------------- We need to set our path to include the RTEMS tools we built in the previous section. The RTEMS tools needs to be first in your path because RTEMS provides @@ -52,7 +52,7 @@ the RTEMS version and not your host's versions: .. _bootstrapping: Bootstrapping -~~~~~~~~~~~~~ +------------- The developers version of the code from git requires we ``bootstrap`` the source code. This is an ``autoconf`` and ``automake`` bootstrap to create the @@ -140,7 +140,7 @@ directory then run the bootsrap commands: Bootstrap time: 0:02:47.398824 Building a BSP -~~~~~~~~~~~~~~ +-------------- 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 @@ -284,7 +284,7 @@ Build RTEMS using two cores: make[1]: Leaving directory '/home/chris/development/rtems/kernel/erc32' Installing A BSP -~~~~~~~~~~~~~~~~ +---------------- All that remains to be done is to install the kernel. Installing RTEMS copies the API headers and architecture specific libraries to a locaiton under the @@ -340,7 +340,7 @@ RTEMS with the following command: make[1]: Leaving directory '/home/chris/development/rtems/kernel/erc32' Contributing Patches -~~~~~~~~~~~~~~~~~~~~ +-------------------- RTEMS welcomes fixes to bugs and new features. The RTEMS Project likes to have bugs fixed against a ticket created on our :r:url:`devel`. Please raise a diff --git a/user/installation/prefixes-sandboxing.rst b/user/installation/prefixes-sandboxing.rst index c797a1f..f91def6 100644 --- a/user/installation/prefixes-sandboxing.rst +++ b/user/installation/prefixes-sandboxing.rst @@ -6,7 +6,7 @@ .. _prefixes: Prefixes --------- +======== .. index:: Prefixes diff --git a/user/installation/releases.rst b/user/installation/releases.rst index dec59d4..92fce78 100644 --- a/user/installation/releases.rst +++ b/user/installation/releases.rst @@ -6,7 +6,7 @@ .. _released-version: Releases --------- +======== .. index:: tarball .. index:: release @@ -61,7 +61,7 @@ Once you have built the tools and kernel you can move to the Packages section of the manual. RTEMS Tools and Kernel -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- This procedure will build a SPARC tool chain. Set up a suitable workspace to build the release in. On Unix: diff --git a/user/overview/index.rst b/user/overview/index.rst index a8cfc32..8064e21 100644 --- a/user/overview/index.rst +++ b/user/overview/index.rst @@ -1,7 +1,7 @@ .. comment SPDX-License-Identifier: CC-BY-SA-4.0 Overview -========= +******** Welcome to the :ref:term:`RTEMS` User Manual. @@ -54,7 +54,7 @@ RTEMS provides features found in modern operating systems: - parallel programming language support Real-time Application Systems ------------------------------ +============================= Real-time application systems are a special class of computer applications. They have a complex set of characteristics that distinguish them from other @@ -89,7 +89,7 @@ competing processors are introduced. The ramifications of multiple processors complicate each and every characteristic of a real-time system. Real-time Executive -------------------- +=================== Fortunately, real-time operating systems, or real-time executives, serve as a cornerstone on which to build the application system. A real-time multitasking diff --git a/user/start/index.rst b/user/start/index.rst index 98fcf7b..cf6b674 100644 --- a/user/start/index.rst +++ b/user/start/index.rst @@ -4,7 +4,7 @@ .. comment: All rights reserved. Quick Start -============ +*********** The following is a quick start guide that provides a basic set of commands to build the RTEMS Tools and Kernel. The quick start guide provides links to the diff --git a/user/support/index.rst b/user/support/index.rst index 03a95df..de75ae6 100644 --- a/user/support/index.rst +++ b/user/support/index.rst @@ -1,7 +1,7 @@ .. comment SPDX-License-Identifier: CC-BY-SA-4.0 Support -======= +******* RTEMS offers a variety of support options. @@ -9,6 +9,12 @@ This chapter covers all options available to both users and developers. If you believe this is a bug report please submit it to the bug tracker otherwise the developers mailing list is the default location to send the report. +RTEMS Project Support +===================== + +The following support channels are provided by the RTEMS Project and provide +direct access to the RTEMS community. + Bug Tracker ----------- @@ -28,7 +34,6 @@ Documentation The latest user documentation can always be found at the :r:url:`docs`. - .. _support-mailing-lists: Mailing Lists @@ -88,16 +93,17 @@ Developers can find help and support on the mailing lists, see Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be found on the :r:url:`devel`. -Support Services ----------------- +Commercial Support Services +=========================== The wider RTEMS community has developers and orgainizations who can provide commercial support services. These services range from training, implementing -new features in RTEMS, helping establish a new project environment for a team, -to application and system design. The RTEMS Project does not endorse or promote -any provider of these services and we recommend you use a search engine to -locate a suitable provider. If you are unsrue please contact a provider and see -what is available. +new features in RTEMS, deployment of RTEMS< helping establish a new project +environment for a team, to application and system design. + +The RTEMS Project does not endorse or promote any provider of these services +and we recommend you use a search engine to locate a suitable provider. If you +are unsrue please contact a provider and see what is available. If you develop a new feature or you have someone do this for you we recommend you have the work submitted to the project and merged. Once accepted into the diff --git a/user/test/index.rst b/user/test/index.rst index e9d7163..7ae43fe 100644 --- a/user/test/index.rst +++ b/user/test/index.rst @@ -1,12 +1,10 @@ .. comment SPDX-License-Identifier: CC-BY-SA-4.0 -========== Test Suite -========== +********** XXX: All about the test suite. .. include:: running.rst .. include:: create.rst - diff --git a/user/tools/build.rst b/user/tools/build.rst index 570fb41..3482cc2 100644 --- a/user/tools/build.rst +++ b/user/tools/build.rst @@ -5,7 +5,6 @@ Build Tools .. index:: Tools, rtems-config, rtems-cc - rtems-config ------------ diff --git a/user/tools/index.rst b/user/tools/index.rst index 3f32aa3..5441d76 100644 --- a/user/tools/index.rst +++ b/user/tools/index.rst @@ -3,9 +3,8 @@ .. comment: Copyright (c) 2016 Chris Johns .. comment: All rights reserved. -=========== RTEMS Tools -=========== +*********** The RTEMS kernel is cross-compiled on host computers and linked to 3rd party packages and application code and run on target hardware. This section details -- cgit v1.2.3