diff options
author | Chris Johns <chrisj@rtems.org> | 2016-11-08 15:26:50 +1100 |
---|---|---|
committer | Chris Johns <chrisj@rtems.org> | 2016-11-08 15:28:32 +1100 |
commit | 53bb72e99669750ecbd7a418047711a21e32ac40 (patch) | |
tree | b0cd10cb72041c45696ae9540c406b83ed1e62cb /c-user/cpu_usage_statistics.rst | |
parent | pdf: Format lists for directives to sit on the next line. (diff) | |
download | rtems-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/cpu_usage_statistics.rst | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/c-user/cpu_usage_statistics.rst b/c-user/cpu_usage_statistics.rst index 2fbe754..4705ca9 100644 --- a/c-user/cpu_usage_statistics.rst +++ b/c-user/cpu_usage_statistics.rst @@ -104,52 +104,52 @@ This section details the CPU usage statistics 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_cpu_usage_report: cpu_usage_report - Report CPU Usage Statistics ---------------------------------------------- -**CALLING SEQUENCE:** - -.. code-block:: c - - void rtems_cpu_usage_report( void ); +CALLING SEQUENCE: + .. code-block:: c -**STATUS CODES:** + void rtems_cpu_usage_report( void ); -NONE +STATUS CODES: + NONE -**DESCRIPTION:** +DESCRIPTION: + This routine prints out a table detailing the CPU usage statistics for all + tasks in the system. -This routine prints out a table detailing the CPU usage statistics for all -tasks in the system. +NOTES: + The table is printed using the ``printk`` routine. -**NOTES:** +.. raw:: latex -The table is printed using the ``printk`` routine. + \clearpage .. _rtems_cpu_usage_reset: cpu_usage_reset - Reset CPU Usage Statistics -------------------------------------------- -**CALLING SEQUENCE:** - -.. code-block:: c - - void rtems_cpu_usage_reset( void ); - -**STATUS CODES:** - -NONE +CALLING SEQUENCE: + .. code-block:: c -**DESCRIPTION:** + void rtems_cpu_usage_reset( void ); -This routine re-initializes the CPU usage statistics for all tasks in the -system to their initial state. The initial state is that a task has not -executed and thus has consumed no CPU time. default state which is when zero -period executions have occurred. +STATUS CODES: + NONE -**NOTES:** +DESCRIPTION: + This routine re-initializes the CPU usage statistics for all tasks in the + system to their initial state. The initial state is that a task has not + executed and thus has consumed no CPU time. default state which is when + zero period executions have occurred. -NONE +NOTES: + NONE |