summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2019-01-11 12:45:30 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2019-01-14 07:15:27 +0100
commitc4da70595f19737640430bd1941439d2d8a8edf0 (patch)
tree1c75ae2b1210e197af33056a3e243d3a74e9b369
parentb5014fe0c875dbc9df7d78355a82727e42ec5a97 (diff)
downloadrtems-docs-c4da70595f19737640430bd1941439d2d8a8edf0.tar.bz2
user: Move "Support" to "Introduction"
New users may find it useful to get this information in the introduction.
-rw-r--r--user/index.rst2
-rw-r--r--user/overview/index.rst130
-rw-r--r--user/support/index.rst121
3 files changed, 125 insertions, 128 deletions
diff --git a/user/index.rst b/user/index.rst
index 7ec34bd..1eda925 100644
--- a/user/index.rst
+++ b/user/index.rst
@@ -42,8 +42,6 @@ RTEMS User Manual (|version|).
tools/index
rsb/index
- support/index
-
glossary/index
* :ref:`genindex`
diff --git a/user/overview/index.rst b/user/overview/index.rst
index 3a38bc5..a3718d2 100644
--- a/user/overview/index.rst
+++ b/user/overview/index.rst
@@ -1,10 +1,10 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
Introduction
-============
+************
Overview
---------
+========
You are someone looking for a real-time operating system. This document
@@ -17,7 +17,7 @@ You are someone looking for a real-time operating system. This document
- helps you to build an example application on top of RTEMS.
Features
---------
+========
The Real-Time Executive for Multiprocessor Systems (:ref:term:`RTEMS`) is a
multi-threaded, single address-space, real-time operating system with no
@@ -182,8 +182,128 @@ RTEMS provides the following basic feature set:
- Support to stay in synchronization with FreeBSD
+Support
+=======
+.. index:: Support
+
+RTEMS offers a variety of support options.
+
+This section 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
+---------------------
+.. 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`.
+
+See the `Submission Guidelines <http://devel.rtems.org/wiki/NewTicket/>`_ for
+details on submitting a ticket.
+
+Be sure to do a cursory search for any tickets that may be relevant to your
+problem.
+
+If you are unsure about your issue status submit a ticket and we will help you
+sort it out.
+
+Documentation
+~~~~~~~~~~~~~
+
+The latest user documentation can always be found at the :r:url:`docs`.
+
+.. _support-mailing-lists:
+
+Mailing Lists
+~~~~~~~~~~~~~
+.. index:: Community
+.. index:: Mailing lists
+
+We have several mailing lists for RTEMS users and developers.
+
+ * :r:list:`announce`
+ * Announcements for major and other project-related issues.
+
+ * :r:list:`bugs`
+ * Bugs email from :r:url:`bugs`.
+
+ * :r:list:`devel`
+ * Developers list, this is for developers of RTEMS itself.
+
+
+ * :r:list:`build`
+ * Results from the testing and building of RTEMS.
+
+ * :r:list:`users`
+ * Users of RTEMS.
+
+ * :r:list:`vc`
+ * Commits to the RTEMS master repository.
+
+
+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
+nickname, and general usage tips. If you are new to IRC it is recommended
+reading.
+
+These are the current IRC channels.
+
+ **#rtems**
+
+This is a general channel for all things RTEMS. You can just hang out with
+other RTEMS users and developers to talk about RTEMS, using RTEMS or to make
+contact with other RTEMS users.
+
+The ``#rtems`` channel is logged. You can find the logs at
+http://www.rtems.org/irclogs/. You can search the logs using Google by adding:
+
+ **site:rtems.org inurl:irclogs**
+
+to your search terms.
+
+Developers
+~~~~~~~~~~
+.. index:: Community
+.. index:: Developers
+
+Developers can find help and support on the mailing lists, see
+:ref:`support-mailing-lists`.
+
+Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be
+found on the :r:url:`devel`.
+
+Commercial Support Services
+---------------------------
+
+The wider RTEMS community has developers and organizations who can provide
+commercial support services. These services range from training, implementing
+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 unsure 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
+project the work will be maintained as part of the development process within
+the project and this is a benefit for.
+
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
@@ -218,7 +338,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/support/index.rst b/user/support/index.rst
deleted file mode 100644
index 3f90ee1..0000000
--- a/user/support/index.rst
+++ /dev/null
@@ -1,121 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-4.0
-
-Support
-*******
-.. index:: Support
-
-RTEMS offers a variety of support options.
-
-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
-=====================
-.. 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`.
-
-See the `Submission Guidelines <http://devel.rtems.org/wiki/NewTicket/>`_ for
-details on submitting a ticket.
-
-Be sure to do a cursory search for any tickets that may be relevant to your
-problem.
-
-If you are unsure about your issue status submit a ticket and we will help you
-sort it out.
-
-Documentation
--------------
-
-The latest user documentation can always be found at the :r:url:`docs`.
-
-.. _support-mailing-lists:
-
-Mailing Lists
--------------
-.. index:: Community
-.. index:: Mailing lists
-
-We have several mailing lists for RTEMS users and developers.
-
- * :r:list:`announce`
- * Announcements for major and other project-related issues.
-
- * :r:list:`bugs`
- * Bugs email from :r:url:`bugs`.
-
- * :r:list:`devel`
- * Developers list, this is for developers of RTEMS itself.
-
-
- * :r:list:`build`
- * Results from the testing and building of RTEMS.
-
- * :r:list:`users`
- * Users of RTEMS.
-
- * :r:list:`vc`
- * Commits to the RTEMS master repository.
-
-
-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
-nickname, and general usage tips. If you are new to IRC it is recommended
-reading.
-
-These are the current IRC channels.
-
- **#rtems**
-
-This is a general channel for all things RTEMS. You can just hang out with
-other RTEMS users and developers to talk about RTEMS, using RTEMS or to make
-contact with other RTEMS users.
-
-The ``#rtems`` channel is logged. You can find the logs at
-http://www.rtems.org/irclogs/. You can search the logs using Google by adding:
-
- **site:rtems.org inurl:irclogs**
-
-to your search terms.
-
-Developers
-----------
-.. index:: Community
-.. index:: Developers
-
-Developers can find help and support on the mailing lists, see
-:ref:`support-mailing-lists`.
-
-Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be
-found on the :r:url:`devel`.
-
-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, 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
-project the work will be maintained as part of the development process within
-the project and this is a benefit for.