summaryrefslogtreecommitdiffstats
path: root/c-user/user_extensions.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-11-08 15:26:50 +1100
committerChris Johns <chrisj@rtems.org>2016-11-08 15:28:32 +1100
commit53bb72e99669750ecbd7a418047711a21e32ac40 (patch)
treeb0cd10cb72041c45696ae9540c406b83ed1e62cb /c-user/user_extensions.rst
parentdaea85e3b23a265dc58c1fdc8d123beff4d92205 (diff)
downloadrtems-docs-53bb72e99669750ecbd7a418047711a21e32ac40.tar.bz2
c-user: Format the directives as descriptions.
This change combined with the element list change in latex generates a much better looking PDF. Add a page break before each directive to like th previous versions of the manuals.
Diffstat (limited to '')
-rw-r--r--c-user/user_extensions.rst155
1 files changed, 76 insertions, 79 deletions
diff --git a/c-user/user_extensions.rst b/c-user/user_extensions.rst
index 664d70a..aba0d9b 100644
--- a/c-user/user_extensions.rst
+++ b/c-user/user_extensions.rst
@@ -436,47 +436,51 @@ This section details the user extension manager's directives. A subsection is
dedicated to each of this manager's directives and describes the calling
sequence, related constants, usage, and status codes.
+.. raw:: latex
+
+ \clearpage
+
.. _rtems_extension_create:
EXTENSION_CREATE - Create a extension set
-----------------------------------------
.. index:: create an extension set
-
-**CALLING SEQUENCE:**
-
.. index:: rtems_extension_create
-.. code-block:: c
+CALLING SEQUENCE:
+ .. code-block:: c
- rtems_status_code rtems_extension_create(
- rtems_name name,
- rtems_extensions_table *table,
- rtems_id *id
- );
+ rtems_status_code rtems_extension_create(
+ rtems_name name,
+ rtems_extensions_table *table,
+ rtems_id *id
+ );
-**DIRECTIVE STATUS CODES:**
+DIRECTIVE STATUS CODES:
+ .. list-table::
+ :class: rtems-table
-.. list-table::
- :class: rtems-table
+ * - ``RTEMS_SUCCESSFUL``
+ - extension set created successfully
+ * - ``RTEMS_INVALID_NAME``
+ - invalid extension set name
+ * - ``RTEMS_TOO_MANY``
+ - too many extension sets created
- * - ``RTEMS_SUCCESSFUL``
- - extension set created successfully
- * - ``RTEMS_INVALID_NAME``
- - invalid extension set name
- * - ``RTEMS_TOO_MANY``
- - too many extension sets created
+DESCRIPTION:
+ This directive creates a extension set. The assigned extension set id is
+ returned in id. This id is used to access the extension set with other
+ user extension manager directives. For control and maintenance of the
+ extension set, RTEMS allocates an ESCB from the local ESCB free pool and
+ initializes it.
-**DESCRIPTION:**
+NOTES:
-This directive creates a extension set. The assigned extension set id is
-returned in id. This id is used to access the extension set with other user
-extension manager directives. For control and maintenance of the extension
-set, RTEMS allocates an ESCB from the local ESCB free pool and initializes it.
+ This directive will not cause the calling task to be preempted.
-**NOTES:**
+.. raw:: latex
-This directive will not cause the calling task to be
-preempted.
+ \clearpage
.. _rtems_extension_ident:
@@ -484,80 +488,73 @@ EXTENSION_IDENT - Get ID of a extension set
-------------------------------------------
.. index:: get ID of an extension set
.. index:: obtain ID of an extension set
-
-**CALLING SEQUENCE:**
-
.. index:: rtems_extension_ident
-.. code-block:: c
+CALLING SEQUENCE:
+ .. code-block:: c
- rtems_status_code rtems_extension_ident(
- rtems_name name,
- rtems_id *id
- );
+ rtems_status_code rtems_extension_ident(
+ rtems_name name,
+ rtems_id *id
+ );
-**DIRECTIVE STATUS CODES:**
+DIRECTIVE STATUS CODES:
+ .. list-table::
+ :class: rtems-table
-.. list-table::
- :class: rtems-table
+ * - ``RTEMS_SUCCESSFUL``
+ - extension set identified successfully
+ * - ``RTEMS_INVALID_NAME``
+ - extension set name not found
- * - ``RTEMS_SUCCESSFUL``
- - extension set identified successfully
- * - ``RTEMS_INVALID_NAME``
- - extension set name not found
+DESCRIPTION:
+ This directive obtains the extension set id associated with the extension
+ set name to be acquired. If the extension set name is not unique, then the
+ extension set id will match one of the extension sets with that name.
+ However, this extension set id is not guaranteed to correspond to the
+ desired extension set. The extension set id is used to access this
+ extension set in other extension set related directives.
-**DESCRIPTION:**
+NOTES:
+ This directive will not cause the running task to be preempted.
-This directive obtains the extension set id associated with the extension set
-name to be acquired. If the extension set name is not unique, then the
-extension set id will match one of the extension sets with that name. However,
-this extension set id is not guaranteed to correspond to the desired extension
-set. The extension set id is used to access this extension set in other
-extension set related directives.
+.. raw:: latex
-**NOTES:**
-
-This directive will not cause the running task to be preempted.
+ \clearpage
.. _rtems_extension_delete:
EXTENSION_DELETE - Delete a extension set
-----------------------------------------
.. index:: delete an extension set
-
-**CALLING SEQUENCE:**
-
.. index:: rtems_extension_delete
-.. code-block:: c
-
- rtems_status_code rtems_extension_delete(
- rtems_id id
- );
-
-**DIRECTIVE STATUS CODES:**
-
-.. list-table::
- :class: rtems-table
-
- * - ``RTEMS_SUCCESSFUL``
- - extension set deleted successfully
- * - ``RTEMS_INVALID_ID``
- - invalid extension set id
+CALLING SEQUENCE:
+ .. code-block:: c
-**DESCRIPTION:**
+ rtems_status_code rtems_extension_delete(
+ rtems_id id
+ );
-This directive deletes the extension set specified by ``id``. If the extension
-set is running, it is automatically canceled. The ESCB for the deleted
-extension set is reclaimed by RTEMS.
+DIRECTIVE STATUS CODES:
+ .. list-table::
+ :class: rtems-table
-**NOTES:**
+ * - ``RTEMS_SUCCESSFUL``
+ - extension set deleted successfully
+ * - ``RTEMS_INVALID_ID``
+ - invalid extension set id
-This directive will not cause the running task to be preempted.
+DESCRIPTION:
+ This directive deletes the extension set specified by ``id``. If the
+ extension set is running, it is automatically canceled. The ESCB for the
+ deleted extension set is reclaimed by RTEMS.
-A extension set can be deleted by a task other than the task which created the
-extension set.
+NOTES:
+ This directive will not cause the running task to be preempted.
-**NOTES:**
+ A extension set can be deleted by a task other than the task which created
+ the extension set.
-This directive will not cause the running task to be preempted.
+NOTES:
+ This directive will not cause the running task to be preempted.