diff options
Diffstat (limited to '')
-rw-r--r-- | doc/ChangeLog | 16 | ||||
-rw-r--r-- | doc/new_chapters/Makefile.am | 11 | ||||
-rw-r--r-- | doc/user/Makefile.am | 12 | ||||
-rw-r--r-- | doc/user/c_user.texi | 4 | ||||
-rw-r--r-- | doc/user/dirstat.texi | 4 | ||||
-rw-r--r-- | doc/user/stackchk.t (renamed from doc/new_chapters/stackchk.t) | 18 | ||||
-rw-r--r-- | doc/user/task.t | 2 |
7 files changed, 42 insertions, 25 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 53b467c93c..fabcd9a311 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,19 @@ +2006-09-13 Joel Sherrill <joel@OARcorp.com> + + * new_chapters/Makefile.am, user/Makefile.am, user/c_user.texi, + user/dirstat.texi, user/task.t: Move stack to first class citizen + status. Include it in User Manual and rename to start with rtems_. + * user/stackchk.t: New file. + * new_chapters/stackchk.t: Removed. + +2006-09-13 Joel Sherrill <joel@OARcorp.com> + + * new_chapters/Makefile.am, user/Makefile.am, user/c_user.texi, + user/dirstat.texi, user/task.t: Move stack to first class citizen + status. Include it in User Manual and rename to start with rtems_. + * user/stackchk.t: New file. + * new_chapters/stackchk.t: Removed. + 2006-09-07 Ken Peters <ken.peters@jpl.nasa.gov> PR 1171/doc diff --git a/doc/new_chapters/Makefile.am b/doc/new_chapters/Makefile.am index 03bc2a8083..017bbd6d93 100644 --- a/doc/new_chapters/Makefile.am +++ b/doc/new_chapters/Makefile.am @@ -13,8 +13,7 @@ include $(top_srcdir)/project.am include $(top_srcdir)/main.am GENERATED_FILES = \ - stackchk.texi rtmonuse.texi cpuuse.texi error.texi \ - monitor.texi + rtmonuse.texi cpuuse.texi error.texi monitor.texi COMMON_FILES += $(top_srcdir)/common/cpright.texi @@ -23,11 +22,6 @@ FILES = info_TEXINFOS = new_chapters.texi new_chapters_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) -stackchk.texi: stackchk.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - rtmonuse.texi: rtmonuse.t $(BMENU2) -p "" \ -u "Top" \ @@ -50,8 +44,7 @@ monitor.texi: monitor.t noinst_SCRIPTS = gen_section -EXTRA_DIST = cpuuse.t error.t \ - monitor.t rtmonuse.t stackchk.t STATUS TODO \ +EXTRA_DIST = cpuuse.t error.t monitor.t rtmonuse.t STATUS TODO \ $(noinst_SCRIPTS) CLEANFILES += new_chapters.info new_chapters.info-? diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am index 90182f51b4..8aaf34c041 100644 --- a/doc/user/Makefile.am +++ b/doc/user/Makefile.am @@ -17,7 +17,8 @@ FILES = bsp.texi dirstat.texi example.texi glossary.texi preface.texi GENERATED_FILES = overview.texi concepts.texi datatypes.texi init.texi \ task.texi intr.texi clock.texi timer.texi sem.texi msg.texi event.texi \ signal.texi part.texi region.texi dpmem.texi io.texi fatal.texi \ - schedule.texi rtmon.texi bsp.texi userext.texi conf.texi mp.texi + schedule.texi rtmon.texi bsp.texi userext.texi conf.texi mp.texi \ + stackchk.texi COMMON_FILES += $(top_srcdir)/common/cpright.texi @@ -156,11 +157,16 @@ conf.texi: conf.t mp.texi: mp.t $(BMENU2) -p "Configuring a System Sizing the RTEMS RAM Workspace" \ -u "Top" \ + -n "Stack Bounds Checker" < $< > $@ + +stackchk.texi: stackchk.t + $(BMENU2) -p "Multiprocessing Manager MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet" \ + -u "Top" \ -n "Directive Status Codes" < $< > $@ EXTRA_DIST = bsp.t concepts.t clock.t datatypes.t conf.t dpmem.t event.t \ fatal.t init.t intr.t io.t mp.t msg.t overview.t part.t region.t rtmon.t \ - sem.t schedule.t signal.t task.t timer.t userext.t $(TXT_FILES) $(PNG_FILES) \ - $(EPS_IMAGES) $(noinst_DATA) + sem.t schedule.t signal.t stackchk.t task.t timer.t userext.t \ + $(TXT_FILES) $(PNG_FILES) $(EPS_IMAGES) $(noinst_DATA) CLEANFILES += c_user.info c_user.info-? c_user.info-?? diff --git a/doc/user/c_user.texi b/doc/user/c_user.texi index 4ade92d03d..3336c1dae5 100644 --- a/doc/user/c_user.texi +++ b/doc/user/c_user.texi @@ -7,7 +7,7 @@ @c %**end of header @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2006. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -100,6 +100,7 @@ @include userext.texi @include conf.texi @include mp.texi +@include stackchk.texi @include dirstat.texi @include example.texi @include glossary.texi @@ -134,6 +135,7 @@ This is the online version of the RTEMS C User's Guide. * User Extensions Manager:: * Configuring a System:: * Multiprocessing Manager:: +* Stack Bounds Checker:: * Directive Status Codes:: * Example Application:: * Glossary:: diff --git a/doc/user/dirstat.texi b/doc/user/dirstat.texi index 094bcf2b13..e7576e40e6 100644 --- a/doc/user/dirstat.texi +++ b/doc/user/dirstat.texi @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2006. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -7,7 +7,7 @@ @c @ifinfo -@node Directive Status Codes, Example Application, Multiprocessing Manager MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet, Top +@node Directive Status Codes, Example Application, Stack Bounds Checker stack_checker_dump_usage - Report Task Stack Usage, Top @end ifinfo @chapter Directive Status Codes @table @b diff --git a/doc/new_chapters/stackchk.t b/doc/user/stackchk.t index 1994ea5d49..00cde1b386 100644 --- a/doc/new_chapters/stackchk.t +++ b/doc/user/stackchk.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2006. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -15,8 +15,8 @@ if a task has overflowed its run-time stack. The routines provided by the stack bounds checker manager are: @itemize @bullet -@item @code{Stack_check_Initialize} - Initialize the Stack Bounds Checker -@item @code{Stack_check_Dump_usage} - Report Task Stack Usage +@item @code{@value{DIRPREFIX}stack_checker_initialize} - Initialize the Stack Bounds Checker +@item @code{@value{DIRPREFIX}stack_checker_dump_usage} - Report Task Stack Usage @end itemize @section Background @@ -68,7 +68,7 @@ provided by every RTEMS port to get for this information. The stack checker is initialized automatically when its task create extension runs for the first time. When this occurs, -the @code{Stack_check_Initialize} is invoked. +the @code{@value{DIRPREFIX}stack_checker_initialize} is invoked. The application must include the stack bounds checker extension set in its set of Initial Extensions. This set of extensions is @@ -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{Stack_check_Dump_usage} routine. +in the system by calling the @code{@value{DIRPREFIX}stack_checker_dump_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: @@ -136,13 +136,13 @@ and describes the calling sequence, related constants, usage, and status codes. @page -@subsection Stack_check_Initialize - Initialize the Stack Bounds Checker +@subsection stack_checker_initialize - Initialize the Stack Bounds Checker @subheading CALLING SEQUENCE: @ifset is-C @example -void Stack_check_Initialize( void ); +void rtems_stack_checker_initialize( void ); @end example @end ifset @@ -164,13 +164,13 @@ This is performed automatically the first time the stack bounds checker task create extension executes. @page -@subsection Stack_check_Dump_usage - Report Task Stack Usage +@subsection stack_checker_dump_usage - Report Task Stack Usage @subheading CALLING SEQUENCE: @ifset is-C @example -void Stack_check_Dump_usage( void ); +void rtems_stack_checker_dump_usage( void ); @end example @end ifset diff --git a/doc/user/task.t b/doc/user/task.t index 115536eb22..8ad87d0760 100644 --- a/doc/user/task.t +++ b/doc/user/task.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2002. +@c COPYRIGHT (c) 1988-2006. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c |