diff options
| author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2007-03-08 21:44:28 +0000 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2007-03-08 21:44:28 +0000 |
| commit | d4b29afe5c7cd00000ee2921861846049a8e6f83 (patch) | |
| tree | bf0294befcf9f8877098eab4522ff02a623a16f2 /doc | |
| parent | 2007-03-08 Joel Sherrill <joel@OARcorp.com> (diff) | |
| download | rtems-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')
| -rw-r--r-- | doc/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/user/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/user/stackchk.t | 8 |
3 files changed, 9 insertions, 5 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 97e4a8f27d..d141648f9b 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2007-03-08 Joel Sherrill <joel@OARcorp.com> + + * user/Makefile.am, user/stackchk.t: Change dump usage to report usage. + 2007-03-06 Joel Sherrill <joel@OARcorp.com> * ada_user/Makefile.am, ada_user/ada_user.texi: Ada API manual now diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am index ec33b13cc6..72c097efb1 100644 --- a/doc/user/Makefile.am +++ b/doc/user/Makefile.am @@ -170,7 +170,7 @@ stackchk.texi: stackchk.t -n "CPU Usage Statistics" < $< > $@ cpuuse.texi: cpuuse.t - $(BMENU2) -p "Stack Bounds Checker stack_checker_dump_usage - Report Task Stack Usage" \ + $(BMENU2) -p "Stack Bounds Checker stack_checker_report_usage - Report Task Stack Usage" \ -u "Top" \ -n "Directive Status Codes" < $< > $@ 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 |