summaryrefslogtreecommitdiffstats
path: root/doc/user/cpuuse.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2006-09-14 15:06:38 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2006-09-14 15:06:38 +0000
commite694c94bf7221d94232743eb162c227975cd91e8 (patch)
tree411e519fbe72912bfbc601269a3591e5bcfb6fd9 /doc/user/cpuuse.t
parent2006-09-13 Joel Sherrill <joel@OARcorp.com> (diff)
downloadrtems-e694c94bf7221d94232743eb162c227975cd91e8.tar.bz2
2006-09-14 Joel Sherrill <joel@OARcorp.com>
* new_chapters/Makefile.am, new_chapters/gen_section, new_chapters/new_chapters.texi, user/Makefile.am, user/c_user.texi, user/dirstat.texi: Promote CPU Usage to first class citizen. Rename to start with rtems_ and include documentation in user guide. * user/cpuuse.t: New file. * new_chapters/cpuuse.t: Removed.
Diffstat (limited to '')
-rw-r--r--doc/user/cpuuse.t (renamed from doc/new_chapters/cpuuse.t)19
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/new_chapters/cpuuse.t b/doc/user/cpuuse.t
index a83ead2be9..161df741cd 100644
--- a/doc/new_chapters/cpuuse.t
+++ b/doc/user/cpuuse.t
@@ -16,8 +16,8 @@ the CPU usage information associated with each task
The routines provided by the CPU usage statistics manager are:
@itemize @bullet
-@item @code{CPU_usage_Dump} - Report CPU Usage Statistics
-@item @code{CPU_usage_Reset} - Reset CPU Usage Statistics
+@item @code{@value{DIRPREFIX}cpu_usage_report} - Report CPU Usage Statistics
+@item @code{@value{DIRPREFIX}cpu_usage_reset} - Reset CPU Usage Statistics
@end itemize
@section Background
@@ -29,7 +29,8 @@ The routines provided by the CPU usage statistics manager are:
@subsection Reporting Period Statistics
The application may dynamically report the CPU usage for every
-task in the system by calling the @code{CPU_usage_Dump} routine.
+task in the system by calling the
+@code{@value{DIRPREFIX}cpu_usage_report} routine.
This routine prints a table with the following information per task:
@itemize @bullet
@@ -73,8 +74,8 @@ task that will not be included in a production build of an application.
@section Reset CPU Usage Statistics
-Invoking the @code{CPU_usage_Reset} routine resets the CPU usage
-statistics for all tasks in the system.
+Invoking the @code{@value{DIRPREFIX}cpu_usage_reset} routine resets
+the CPU usage statistics for all tasks in the system.
@section Directives
@@ -84,13 +85,13 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
-@subsection CPU_usage_Dump - Report CPU Usage Statistics
+@subsection cpu_usage_report - Report CPU Usage Statistics
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-void CPU_usage_Dump( void );
+void rtems_cpu_usage_report( void );
@end example
@end ifset
@@ -112,13 +113,13 @@ all tasks in the system.
NONE
@page
-@subsection CPU_usage_Reset - Reset CPU Usage Statistics
+@subsection cpu_usage_reset - Reset CPU Usage Statistics
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-void CPU_usage_Reset( void );
+void rtems_cpu_usage_reset( void );
@end example
@end ifset