[rtems commit] PR 1912: Add Scheduler Documentation

[gedare at rtems.org]

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

Author:    Petr Benes <petben at petben.net>
Date:      Sun Apr 15 13:50:11 2012 -0400

PR 1912: Add Scheduler Documentation

Adds documentation on the scheduler options and scheduler selection
to the User's Manual to reflect changes made in the development of
pluggable scheduling with EDF and CBS schedulers.

---

 doc/ada_user/Makefile.am   |    2 +-
 doc/ada_user/ada_user.texi |    2 ++
 doc/user/Makefile.am       |    9 +++++++--
 doc/user/c_user.texi       |    2 ++
 doc/user/dirstat.texi      |    2 +-
 5 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/doc/ada_user/Makefile.am b/doc/ada_user/Makefile.am
index 9ba4fee..d4b8bac 100644
--- a/doc/ada_user/Makefile.am
+++ b/doc/ada_user/Makefile.am
@@ -27,7 +27,7 @@ COMMON_FILES += \
     $(top_builddir)/user/task.texi $(top_builddir)/user/timer.texi \
     $(top_builddir)/user/userext.texi $(top_builddir)/user/stackchk.texi \
     $(top_builddir)/user/cpuuse.texi $(top_srcdir)/common/cpright.texi \
-    $(top_builddir)/user/object.texi
+    $(top_builddir)/user/object.texi $(top_builddir)/user/cbs.texi
 
 FILES = example.texi
 
diff --git a/doc/ada_user/ada_user.texi b/doc/ada_user/ada_user.texi
index 279f219..c7073fc 100644
--- a/doc/ada_user/ada_user.texi
+++ b/doc/ada_user/ada_user.texi
@@ -112,6 +112,7 @@
 @include user/cpuuse.texi
 @include user/object.texi
 @include user/chains.texi
+ at include user/cbs.texi
 @include user/dirstat.texi
 @include example.texi
 @include user/glossary.texi
@@ -149,6 +150,7 @@
 * CPU Usage Statistics::
 * Object Services::
 * Chains::
+* Constant Bandwidth Server Scheduler API::
 * Directive Status Codes::
 * Example Application::
 * Glossary::
diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am
index af2b24d..de950b1 100644
--- a/doc/user/Makefile.am
+++ b/doc/user/Makefile.am
@@ -17,7 +17,7 @@ GENERATED_FILES = overview.texi concepts.texi datatypes.texi init.texi \
     task.texi intr.texi clock.texi timer.texi sem.texi msg.texi event.texi \
     signal.texi part.texi region.texi dpmem.texi io.texi fatal.texi \
     schedule.texi rtmon.texi barrier.texi bsp.texi userext.texi conf.texi \
-    mp.texi stackchk.texi cpuuse.texi object.texi chains.texi
+    mp.texi stackchk.texi cpuuse.texi object.texi chains.texi cbs.texi
 
 COMMON_FILES += $(top_srcdir)/common/cpright.texi
 
@@ -183,9 +183,14 @@ object.texi: object.t
 chains.texi: chains.t
 	$(BMENU2) -p "Object Services OBJECT_GET_CLASS_INFORMATION - Obtain Class Information" \
 	    -u "Top" \
+	    -n "Constant Bandwidth Server Scheduler API" < $< > $@
+
+cbs.texi: cbs.t
+	$(BMENU2) -p "Chains Prepend a Node" \
+	    -u "Top" \
 	    -n "Directive Status Codes" < $< > $@
 
-EXTRA_DIST = bsp.t clock.t chains.t concepts.t cpuuse.t datatypes.t conf.t \
+EXTRA_DIST = bsp.t cbs.t clock.t chains.t concepts.t cpuuse.t datatypes.t conf.t \
     dpmem.t event.t fatal.t init.t intr.t io.t mp.t msg.t overview.t \
     part.t region.t rtmon.t sem.t schedule.t signal.t stackchk.t \
     task.t timer.t userext.t $(TXT_FILES) $(PNG_FILES) $(EPS_IMAGES) \
diff --git a/doc/user/c_user.texi b/doc/user/c_user.texi
index b1bc087..27c49b1 100644
--- a/doc/user/c_user.texi
+++ b/doc/user/c_user.texi
@@ -111,6 +111,7 @@
 @include cpuuse.texi
 @include object.texi
 @include chains.texi
+ at include cbs.texi
 @include dirstat.texi
 @include example.texi
 @include glossary.texi
@@ -148,6 +149,7 @@
 * CPU Usage Statistics::
 * Object Services::
 * Chains::
+* Constant Bandwidth Server Scheduler API::
 * Directive Status Codes::
 * Example Application::
 * Glossary::
diff --git a/doc/user/dirstat.texi b/doc/user/dirstat.texi
index 25c4ece..9ad866c 100644
--- a/doc/user/dirstat.texi
+++ b/doc/user/dirstat.texi
@@ -6,7 +6,7 @@
 @c  $Id$
 @c
 
- at node Directive Status Codes, Example Application, Chains Prepend a Node, Top
+ at node Directive Status Codes, Example Application, Constant Bandwidth Server Scheduler API CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time, Top
 @chapter Directive Status Codes
 @table @b
 @item @code{@value{RPREFIX}SUCCESSFUL} - successful completion