summaryrefslogtreecommitdiffstats
path: root/doc/user/stackchk.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2007-03-08 21:44:28 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2007-03-08 21:44:28 +0000
commitd4b29afe5c7cd00000ee2921861846049a8e6f83 (patch)
treebf0294befcf9f8877098eab4522ff02a623a16f2 /doc/user/stackchk.t
parent2007-03-08 Joel Sherrill <joel@OARcorp.com> (diff)
downloadrtems-d4b29afe5c7cd00000ee2921861846049a8e6f83.tar.bz2
2007-03-08 Joel Sherrill <joel@OARcorp.com>
* user/Makefile.am, user/stackchk.t: Change dump usage to report usage.
Diffstat (limited to 'doc/user/stackchk.t')
-rw-r--r--doc/user/stackchk.t8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/user/stackchk.t b/doc/user/stackchk.t
index 00cde1b386..0d975265e6 100644
--- a/doc/user/stackchk.t
+++ b/doc/user/stackchk.t
@@ -16,7 +16,7 @@ by the stack bounds checker manager are:
@itemize @bullet
@item @code{@value{DIRPREFIX}stack_checker_initialize} - Initialize the Stack Bounds Checker
-@item @code{@value{DIRPREFIX}stack_checker_dump_usage} - Report Task Stack Usage
+@item @code{@value{DIRPREFIX}stack_checker_report_usage} - Report Task Stack Usage
@end itemize
@section Background
@@ -88,7 +88,7 @@ to define the macro @code{STACK_CHECKER_ON} before including
@subsection Reporting Task Stack Usage
The application may dynamically report the stack usage for every task
-in the system by calling the @code{@value{DIRPREFIX}stack_checker_dump_usage} routine.
+in the system by calling the @code{@value{DIRPREFIX}stack_checker_report_usage} routine.
This routine prints a table with the peak usage and stack size of
every task in the system. The following is an example of the
report generated:
@@ -164,13 +164,13 @@ This is performed automatically the first time the stack bounds checker
task create extension executes.
@page
-@subsection stack_checker_dump_usage - Report Task Stack Usage
+@subsection stack_checker_report_usage - Report Task Stack Usage
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-void rtems_stack_checker_dump_usage( void );
+void rtems_stack_checker_report_usage( void );
@end example
@end ifset