[rtems commit] user/overview.t: Add missing chapters to overview

Joel Sherrill joel at rtems.org
Tue Feb 26 13:59:07 UTC 2013


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

Author:    Joel Sherrill <joel.sherrill at oarcorp.com>
Date:      Mon Feb 25 17:34:04 2013 -0600

user/overview.t: Add missing chapters to overview

---

 doc/user/overview.t |   97 ++++++++++++++++++++++++++++++++++-----------------
 1 files changed, 65 insertions(+), 32 deletions(-)

diff --git a/doc/user/overview.t b/doc/user/overview.t
index a8c9572..3e1904c 100644
--- a/doc/user/overview.t
+++ b/doc/user/overview.t
@@ -409,107 +409,140 @@ The following provides an overview of the remainder
 of this manual:
 
 @table @asis
- at item Chapter 2
-Key Concepts: presents an
-introduction to the ideas which are common across multiple RTEMS
-managers.
+ at item Chapter 2:
+Key Concepts: presents an introduction to the ideas which are common
+across multiple RTEMS managers.
 
 @item Chapter 3:
 RTEMS Data Types: describes the fundamental data types shared
 by the services in the RTEMS Classic API.
 
 @item Chapter 4:
+Scheduling Concepts: details the various RTEMS scheduling algorithms
+and task state transitions.
+
+ at item Chapter 5:
 Initialization Manager: describes the functionality and directives
 provided by the Initialization Manager.
 
- at item Chapter 5:
+ at item Chapter 6:
 Task Manager: describes the functionality and directives provided
 by the Task Manager.
 
- at item Chapter 6:
+ at item Chapter 7:
 Interrupt Manager: describes the functionality and directives
 provided by the Interrupt Manager.
 
- at item Chapter 7:
+ at item Chapter 8:
 Clock Manager: describes the functionality and directives
 provided by the Clock Manager.
 
- at item Chapter 8:
+ at item Chapter 9:
 Timer Manager: describes the functionality and directives provided
 by the Timer Manager.
 
- at item Chapter 9:
+ at item Chapter 10:
+Rate Monotonic Manager: describes the functionality and directives
+provided by the Rate Monotonic Manager.
+
+ at item Chapter 11:
 Semaphore Manager: describes the functionality and directives
 provided by the Semaphore Manager.
 
- at item Chapter 10:
+ at item Chapter 12:
+Barrier Manager: describes the functionality and directives
+provided by the Barrier Manager.
+
+ at item Chapter 13:
 Message Manager: describes the functionality and directives
 provided by the Message Manager.
 
- at item Chapter 11:
+ at item Chapter 14:
 Event Manager: describes the
 functionality and directives provided by the Event Manager.
 
- at item Chapter 12:
+ at item Chapter 15:
 Signal Manager: describes the
 functionality and directives provided by the Signal Manager.
 
- at item Chapter 13:
+ at item Chapter 16:
 Partition Manager: describes the
 functionality and directives provided by the Partition Manager.
 
- at item Chapter 14:
+ at item Chapter 17:
 Region Manager: describes the
 functionality and directives provided by the Region Manager.
 
- at item Chapter 15:
+ at item Chapter 18:
 Dual-Ported Memory Manager: describes
 the functionality and directives provided by the Dual-Ported
 Memory Manager.
 
- at item Chapter 16:
+ at item Chapter 19:
 I/O Manager: describes the
 functionality and directives provided by the I/O Manager.
 
- at item Chapter 17:
+ at item Chapter 20:
 Fatal Error Manager: describes the functionality and directives
 provided by the Fatal Error Manager.
 
- at item Chapter 18:
-Scheduling Concepts: details the RTEMS scheduling algorithm and
-task state transitions.
-
- at item Chapter 19:
-Rate Monotonic Manager: describes the functionality and directives
-provided by the Rate Monotonic Manager.
-
- at item Chapter 20:
+ at item Chapter 21:
 Board Support Packages: defines the
 functionality required of user-supplied board support packages.
 
- at item Chapter 21:
+ at item Chapter 22:
 User Extensions: shows the user how to
 extend RTEMS to incorporate custom features.
 
- at item Chapter 22:
+ at item Chapter 23:
 Configuring a System: details the process by which one tailors RTEMS
 for a particular single-processor or multiprocessor application.
 
- at item Chapter 23:
+ at item Chapter 24:
 Multiprocessing Manager: presents a
 conceptual overview of the multiprocessing capabilities provided
 by RTEMS as well as describing the Multiprocessing
 Communications Interface Layer and Multiprocessing Manager
 directives.
 
- at item Chapter 24:
+ at item Chapter 25:
+Stack Bounds Checker: presents the capabilities of the RTEMS
+task stack checker which can report stack usage as well as detect
+bounds violations.
+
+ at item Chapter 26:
+CPU Usage Statistics: presents the capabilities of the CPU Usage
+statistics gathered on a per task basis along with the mechanisms
+for reporting and resetting the statistics.
+
+ at item Chapter 27:
+Object Services: presents a collection of helper services useful
+when manipulating RTEMS objects. These include methods to assist
+in obtaining an object's name in printable form. Additional services
+are provided to decompose an object Id and determine which API
+and object class it belongs to.
+
+ at item Chapter 28:
+Chains: presents the methods provided to build, iterate and
+manipulate doubly-linked chains. This manager makes the
+chain implementation used internally by RTEMS to user space
+applications.
+
+ at item Chapter 29:
+Timespec Helpers: presents a set of helper services useful
+when manipulating POSIX @code{struct timespec} instances.
+
+ at item Chapter 30:
+Constant Bandwidth Server Scheduler API::
+
+ at item Chapter 31:
 Directive Status Codes: provides a definition of each of the
 directive status codes referenced in this manual.
 
- at item Chapter 25:
+ at item Chapter 32:
 Example Application: provides a template for simple RTEMS applications.
 
- at item Chapter 26:
+ at item Chapter 33:
 Glossary: defines terms used throughout this manual.
 
 @end table




More information about the vc mailing list