summaryrefslogtreecommitdiffstats
path: root/c-user/stack_bounds_checker.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/stack_bounds_checker.rst
parentpdf: Format lists for directives to sit on the next line. (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 'c-user/stack_bounds_checker.rst')
-rw-r--r--c-user/stack_bounds_checker.rst64
1 files changed, 28 insertions, 36 deletions
diff --git a/c-user/stack_bounds_checker.rst b/c-user/stack_bounds_checker.rst
index 0ce5a44..87c16f5 100644
--- a/c-user/stack_bounds_checker.rst
+++ b/c-user/stack_bounds_checker.rst
@@ -157,54 +157,46 @@ constants, usage, and status codes.
STACK_CHECKER_IS_BLOWN - Has Current Task Blown Its Stack
---------------------------------------------------------
-**CALLING SEQUENCE:**
+CALLING SEQUENCE:
+ .. code-block:: c
-.. code-block:: c
-
- bool rtems_stack_checker_is_blown( void );
-
-**STATUS CODES:**
-
-.. list-table::
- :class: rtems-table
-
- * - ``TRUE``
- - Stack is operating within its stack limits
- * - ``FALSE``
- - Current stack pointer is outside allocated area
+ bool rtems_stack_checker_is_blown( void );
-**DESCRIPTION:**
+STATUS CODES:
+ .. list-table::
+ :class: rtems-table
-This method is used to determine if the current stack pointer of the currently
-executing task is within bounds.
+ * - ``TRUE``
+ - Stack is operating within its stack limits
+ * - ``FALSE``
+ - Current stack pointer is outside allocated area
-**NOTES:**
+DESCRIPTION:
+ This method is used to determine if the current stack pointer of the
+ currently executing task is within bounds.
-This method checks the current stack pointer against the high and low addresses
-of the stack memory allocated when the task was created and it looks for damage
-to the high water mark pattern for the worst case usage of the task being
-called.
+NOTES:
+ This method checks the current stack pointer against the high and low
+ addresses of the stack memory allocated when the task was created and it
+ looks for damage to the high water mark pattern for the worst case usage of
+ the task being called.
.. _rtems_stack_checker_report_usage:
STACK_CHECKER_REPORT_USAGE - Report Task Stack Usage
----------------------------------------------------
-**CALLING SEQUENCE:**
-
-.. code-block:: c
-
- void rtems_stack_checker_report_usage( void );
-
-**STATUS CODES:**
-
-NONE
+CALLING SEQUENCE:
+ .. code-block:: c
-**DESCRIPTION:**
+ void rtems_stack_checker_report_usage( void );
-This routine prints a table with the peak stack usage and stack space
-allocation of every task in the system.
+STATUS CODES:
+ NONE
-**NOTES:**
+DESCRIPTION:
+ This routine prints a table with the peak stack usage and stack space
+ allocation of every task in the system.
-NONE
+NOTES:
+ NONE