diff options
-rw-r--r-- | doc/ChangeLog | 9 | ||||
-rw-r--r-- | doc/new_chapters/Makefile.am | 9 | ||||
-rw-r--r-- | doc/new_chapters/gen_section | 10 | ||||
-rw-r--r-- | doc/new_chapters/new_chapters.texi | 4 | ||||
-rw-r--r-- | doc/user/Makefile.am | 13 | ||||
-rw-r--r-- | doc/user/c_user.texi | 2 | ||||
-rw-r--r-- | doc/user/cpuuse.t (renamed from doc/new_chapters/cpuuse.t) | 19 | ||||
-rw-r--r-- | doc/user/dirstat.texi | 2 |
8 files changed, 33 insertions, 35 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index fabcd9a311..57fda49597 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +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. + 2006-09-13 Joel Sherrill <joel@OARcorp.com> * new_chapters/Makefile.am, user/Makefile.am, user/c_user.texi, diff --git a/doc/new_chapters/Makefile.am b/doc/new_chapters/Makefile.am index 017bbd6d93..db25ec8f22 100644 --- a/doc/new_chapters/Makefile.am +++ b/doc/new_chapters/Makefile.am @@ -13,7 +13,7 @@ include $(top_srcdir)/project.am include $(top_srcdir)/main.am GENERATED_FILES = \ - rtmonuse.texi cpuuse.texi error.texi monitor.texi + rtmonuse.texi error.texi monitor.texi COMMON_FILES += $(top_srcdir)/common/cpright.texi @@ -27,11 +27,6 @@ rtmonuse.texi: rtmonuse.t -u "Top" \ -n "" < $< > $@ -cpuuse.texi: cpuuse.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - error.texi: error.t $(BMENU2) -p "" \ -u "Top" \ @@ -44,7 +39,7 @@ monitor.texi: monitor.t noinst_SCRIPTS = gen_section -EXTRA_DIST = cpuuse.t error.t monitor.t rtmonuse.t STATUS TODO \ +EXTRA_DIST = error.t monitor.t rtmonuse.t STATUS TODO \ $(noinst_SCRIPTS) CLEANFILES += new_chapters.info new_chapters.info-? diff --git a/doc/new_chapters/gen_section b/doc/new_chapters/gen_section index d1b472ec3f..5950a2e303 100644 --- a/doc/new_chapters/gen_section +++ b/doc/new_chapters/gen_section @@ -129,22 +129,12 @@ case ${chapter} in ROUTINES="strcpy strncpy strcat strncat strcmp strncmp strchr strcspn \ strpbrk strrchr strspn strstr strtok stlen" ;; - misc_stackchk) - CHAPTER_CAPS="Stack Bounds Checker" - CHAPTER_LOWER="stack bounds checker" - ROUTINES="Stack_check_Initialize Stack_check_Dump_usage" - ;; misc_rtmonuse) CHAPTER_CAPS="Rate Monotonic Period Statistics" CHAPTER_LOWER="rate monotonic period statistics" ROUTINES="Period_usage_Initialize Period_usage_Reset \ Period_usage_Update Period_usage_Dump" ;; - misc_cpuuse) - CHAPTER_CAPS="CPU Usage Statistics" - CHAPTER_LOWER="CPU usage statistics" - ROUTINES="CPU_usage_Dump CPU_usage_Reset" - ;; misc_error) CHAPTER_CAPS="Error Reporting Support" CHAPTER_LOWER="error reporting support" diff --git a/doc/new_chapters/new_chapters.texi b/doc/new_chapters/new_chapters.texi index 3552421c8e..aaa11ba334 100644 --- a/doc/new_chapters/new_chapters.texi +++ b/doc/new_chapters/new_chapters.texi @@ -78,9 +78,7 @@ @c This prevents a black box from being printed on "overflow" lines. @c The alternative is to rework a sentence to avoid this problem. -@include stackchk.texi @include rtmonuse.texi -@include cpuuse.texi @include error.texi @include monitor.texi @ifinfo @@ -90,9 +88,7 @@ This is the online version of the RTEMS POSIX API User's Guide @menu -* Stack Bounds Checker:: * Rate Monotonic Period Statistics:: -* CPU Usage Statistics:: * Error Reporting Support:: * Monitor Task:: * Command and Variable Index:: diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am index 8aaf34c041..ec51b764c8 100644 --- a/doc/user/Makefile.am +++ b/doc/user/Makefile.am @@ -18,7 +18,7 @@ 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 \ - stackchk.texi + stackchk.texi cpuuse.texi COMMON_FILES += $(top_srcdir)/common/cpright.texi @@ -162,11 +162,16 @@ mp.texi: mp.t stackchk.texi: stackchk.t $(BMENU2) -p "Multiprocessing Manager MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet" \ -u "Top" \ + -n "CPU Usage Statistics" < $< > $@ + +cpuuse.texi: cpuuse.t + $(BMENU2) -p "Stack Bounds Checker stack_checker_dump_usage - Report Task Stack Usage" \ + -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 stackchk.t task.t timer.t userext.t \ +EXTRA_DIST = bsp.t clock.t concepts.t cpuuse.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 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 3336c1dae5..8a20a6dfc4 100644 --- a/doc/user/c_user.texi +++ b/doc/user/c_user.texi @@ -101,6 +101,7 @@ @include conf.texi @include mp.texi @include stackchk.texi +@include cpuuse.texi @include dirstat.texi @include example.texi @include glossary.texi @@ -136,6 +137,7 @@ This is the online version of the RTEMS C User's Guide. * Configuring a System:: * Multiprocessing Manager:: * Stack Bounds Checker:: +* CPU Usage Statistics:: * Directive Status Codes:: * Example Application:: * Glossary:: 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 diff --git a/doc/user/dirstat.texi b/doc/user/dirstat.texi index e7576e40e6..b1ac891d22 100644 --- a/doc/user/dirstat.texi +++ b/doc/user/dirstat.texi @@ -7,7 +7,7 @@ @c @ifinfo -@node Directive Status Codes, Example Application, Stack Bounds Checker stack_checker_dump_usage - Report Task Stack Usage, Top +@node Directive Status Codes, Example Application, CPU Usage Statistics cpu_usage_reset - Reset CPU Usage Statistics, Top @end ifinfo @chapter Directive Status Codes @table @b |