[rtems-docs commit] User: Simplify the top level headings.

Chris Johns chrisj at rtems.org
Sat Nov 3 06:01:19 UTC 2018


Module:    rtems-docs
Branch:    master
Commit:    bb13624065da143fd02d2be1a4caaebce253751e
Changeset: http://git.rtems.org/rtems-docs/commit/?id=bb13624065da143fd02d2be1a4caaebce253751e

Author:    Chris Johns <chrisj at rtems.org>
Date:      Fri Nov  2 14:03:54 2018 +1100

User: Simplify the top level headings.

---

 user/bsps/index.rst    | 14 +++++++++++---
 user/ecosys/index.rst  |  6 ++----
 user/support/index.rst | 12 +++++++++++-
 user/tracing/index.rst |  4 ++--
 4 files changed, 26 insertions(+), 10 deletions(-)

diff --git a/user/bsps/index.rst b/user/bsps/index.rst
index c8f06d7..c1b4e4f 100644
--- a/user/bsps/index.rst
+++ b/user/bsps/index.rst
@@ -5,9 +5,17 @@
 
 .. _BoardSupportPackages:
 
-Board Support Packages (BSPs)
-*****************************
-.. index:: Board Support Packages (BSPs)
+Board Support Packages
+**********************
+.. index:: Board Support Packages
+.. index:: BSP
+
+A Board Support Package or BSP is the software that glues a specific target or
+board or piece of hardware to RTEMS so it's services are available to
+applications.
+
+RTEMS contains a large number of BSPs for commonly available simulators and
+target hardware.
 
 .. toctree::
 
diff --git a/user/ecosys/index.rst b/user/ecosys/index.rst
index 1ea97df..f41cbb3 100644
--- a/user/ecosys/index.rst
+++ b/user/ecosys/index.rst
@@ -5,8 +5,8 @@
 
 .. _ecosystem:
 
-RTEMS Ecosystem
-***************
+Ecosystem
+*********
 .. index:: Ecosystem
 
 The RTEMS Ecosystem is the collection of tools, packages, code, documentation
@@ -239,5 +239,3 @@ build set::
   2. The GDB package tar file.
 
   3. The build set tar file. All the others in a single tar file.
-
-
diff --git a/user/support/index.rst b/user/support/index.rst
index 3e6aeef..294b7e4 100644
--- a/user/support/index.rst
+++ b/user/support/index.rst
@@ -1,7 +1,8 @@
 .. comment SPDX-License-Identifier: CC-BY-SA-4.0
 
 Support
-=======
+*******
+.. index:: Support
 
 RTEMS offers a variety of support options.
 
@@ -11,12 +12,15 @@ developers mailing list is the default location to send the report.
 
 RTEMS Project Support
 =====================
+.. index:: RTEMS Project Support
 
 The following support channels are provided by the RTEMS Project and provide
 direct access to the RTEMS community.
 
 Bug Tracker
 -----------
+.. index:: Bugs
+.. index:: Reporting bugs
 
 The bug tracker can be found at the :r:url:`bugs`.
 
@@ -38,6 +42,8 @@ The latest user documentation can always be found at the :r:url:`docs`.
 
 Mailing Lists
 -------------
+.. index:: Community
+.. index:: Mailing lists
 
 We have several mailing lists for RTEMS users and developers.
 
@@ -63,6 +69,8 @@ We have several mailing lists for RTEMS users and developers.
 
 IRC
 ---
+.. index:: Community
+.. index:: IRC
 
 RTEMS IRC is available on the Freenode network. See the `Freenode
 <http://www.freenode.net/>`_ web site for details on connecting, selecting a
@@ -86,6 +94,8 @@ to your search terms.
 
 Developers
 ----------
+.. index:: Community
+.. index:: Developers
 
 Developers can find help and support on the mailing lists, see
 :ref:`support-mailing-lists`.
diff --git a/user/tracing/index.rst b/user/tracing/index.rst
index 0d714bc..ac988fc 100644
--- a/user/tracing/index.rst
+++ b/user/tracing/index.rst
@@ -5,8 +5,8 @@
 
 .. _tracing-framework:
 
-RTEMS Tracing Framework
-***********************
+Tracing
+*******
 .. index:: Tracing Framework
 
 RTEMS Tracing Framework is an on-target software based system which helps track




More information about the vc mailing list