summaryrefslogtreecommitdiffstats
path: root/c-user/constant_bandwidth_server.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
committerChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
commit33849946ff6022c26722ec71248fd76aa55de4ef (patch)
treef082f683008e92f0894d8ac36bc4c83d4860bd37 /c-user/constant_bandwidth_server.rst
parentUse '.. toctree::' and not '.. include::' in the User Manual. (diff)
downloadrtems-docs-33849946ff6022c26722ec71248fd76aa55de4ef.tar.bz2
Clean up sphinx warnings.
- Fix minor formatting issues. - Fix reference the gloassary TLS using ':term:'. - Make sure nothing is between an anchor and the heading where ':ref:' references the anchor. This meant moving all the recently added '.. index::' entries. Update #3232. Update #3229.
Diffstat (limited to 'c-user/constant_bandwidth_server.rst')
-rw-r--r--c-user/constant_bandwidth_server.rst44
1 files changed, 28 insertions, 16 deletions
diff --git a/c-user/constant_bandwidth_server.rst b/c-user/constant_bandwidth_server.rst
index 2a6ed40..2b03475 100644
--- a/c-user/constant_bandwidth_server.rst
+++ b/c-user/constant_bandwidth_server.rst
@@ -4,11 +4,11 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. index:: cbs
+
Constant Bandwidth Server Scheduler API
***************************************
-.. index:: cbs
-
Introduction
============
@@ -40,11 +40,12 @@ provided by the CBS API are:
- rtems_cbs_get_approved_budget_ - Get scheduler approved execution time
-Background
-==========
.. index:: CBS parameters
.. index:: rtems_cbs_parameters
+Background
+==========
+
Constant Bandwidth Server Definitions
-------------------------------------
@@ -232,9 +233,9 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_cbs_initialize:
.. index:: initialize the CBS library
.. index:: rtems_cbs_initialize
+.. _rtems_cbs_initialize:
CBS_INITIALIZE - Initialize the CBS library
-------------------------------------------
@@ -270,10 +271,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_cleanup:
.. index:: cleanup the CBS library
.. index:: rtems_cbs_cleanup
+.. _rtems_cbs_cleanup:
+
CBS_CLEANUP - Cleanup the CBS library
-------------------------------------
@@ -300,10 +302,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_create_server:
.. index:: create a new bandwidth server
.. index:: rtems_cbs_create_server
+.. _rtems_cbs_create_server:
+
CBS_CREATE_SERVER - Create a new bandwidth server
-------------------------------------------------
@@ -348,10 +351,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_attach_thread:
.. index:: attach a thread to server
.. index:: rtems_cbs_attach_thread
+.. _rtems_cbs_attach_thread:
+
CBS_ATTACH_THREAD - Attach a thread to server
---------------------------------------------
@@ -390,10 +394,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_detach_thread:
.. index:: detach a thread from server
.. index:: rtems_cbs_detach_thread
+.. _rtems_cbs_detach_thread:
+
CBS_DETACH_THREAD - Detach a thread from server
-----------------------------------------------
@@ -427,10 +432,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_destroy_server:
.. index:: destroy a bandwidth server
.. index:: rtems_cbs_destroy_server
+.. _rtems_cbs_destroy_server:
+
CBS_DESTROY_SERVER - Destroy a bandwidth server
-----------------------------------------------
@@ -464,10 +470,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_server_id:
.. index:: get an ID of a server
.. index:: rtems_cbs_get_server_id
+.. _rtems_cbs_get_server_id:
+
CBS_GET_SERVER_ID - Get an ID of a server
-----------------------------------------
@@ -495,10 +502,11 @@ DESCRIPTION:
\clearpage
-.. _rtems_cbs_get_parameters:
.. index:: get scheduling parameters of a server
.. index:: rtems_cbs_get_parameters
+.. _rtems_cbs_get_parameters:
+
CBS_GET_PARAMETERS - Get scheduling parameters of a server
----------------------------------------------------------
@@ -532,10 +540,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_set_parameters:
.. index:: set scheduling parameters
.. index:: rtems_cbs_set_parameters
+.. _rtems_cbs_set_parameters:
+
CBS_SET_PARAMETERS - Set scheduling parameters
----------------------------------------------
@@ -571,10 +580,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_execution_time:
.. index:: get elapsed execution time
.. index:: rtems_cbs_get_execution_time
+.. _rtems_cbs_get_execution_time:
+
CBS_GET_EXECUTION_TIME - Get elapsed execution time
---------------------------------------------------
@@ -609,10 +619,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_remaining_budget:
.. index:: get remaining execution time
.. index:: rtems_cbs_get_remaining_budget
+.. _rtems_cbs_get_remaining_budget:
+
CBS_GET_REMAINING_BUDGET - Get remaining execution time
-------------------------------------------------------
@@ -647,10 +658,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_approved_budget:
.. index:: get scheduler approved execution time
.. index:: rtems_cbs_get_approved_budget
+.. _rtems_cbs_get_approved_budget:
+
CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time
---------------------------------------------------------------