Changeset e694c94b in rtems


Ignore:
Timestamp:
Sep 14, 2006, 3:06:38 PM (14 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
bc11ec2
Parents:
5c1023a0
Message:

2006-09-14 Joel Sherrill <joel@…>

  • 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.
Location:
doc
Files:
7 edited
1 moved

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r5c1023a0 re694c94b  
     12006-09-14      Joel Sherrill <joel@OARcorp.com>
     2
     3        * new_chapters/Makefile.am, new_chapters/gen_section,
     4        new_chapters/new_chapters.texi, user/Makefile.am, user/c_user.texi,
     5        user/dirstat.texi: Promote CPU Usage to first class citizen. Rename
     6        to start with rtems_ and include documentation in user guide.
     7        * user/cpuuse.t: New file.
     8        * new_chapters/cpuuse.t: Removed.
     9
    1102006-09-13      Joel Sherrill <joel@OARcorp.com>
    211
  • doc/new_chapters/Makefile.am

    r5c1023a0 re694c94b  
    1414
    1515GENERATED_FILES = \
    16     rtmonuse.texi cpuuse.texi error.texi monitor.texi
     16    rtmonuse.texi error.texi monitor.texi
    1717
    1818COMMON_FILES += $(top_srcdir)/common/cpright.texi
     
    2424
    2525rtmonuse.texi: rtmonuse.t
    26         $(BMENU2) -p "" \
    27             -u "Top" \
    28             -n "" < $< > $@
    29 
    30 cpuuse.texi: cpuuse.t
    3126        $(BMENU2) -p "" \
    3227            -u "Top" \
     
    4540noinst_SCRIPTS = gen_section
    4641
    47 EXTRA_DIST = cpuuse.t error.t monitor.t rtmonuse.t STATUS TODO \
     42EXTRA_DIST = error.t monitor.t rtmonuse.t STATUS TODO \
    4843    $(noinst_SCRIPTS)
    4944
  • doc/new_chapters/gen_section

    r5c1023a0 re694c94b  
    130130       strpbrk strrchr strspn strstr strtok stlen"
    131131    ;;
    132   misc_stackchk)
    133     CHAPTER_CAPS="Stack Bounds Checker"
    134     CHAPTER_LOWER="stack bounds checker"
    135     ROUTINES="Stack_check_Initialize Stack_check_Dump_usage"
    136     ;;
    137132  misc_rtmonuse)
    138133    CHAPTER_CAPS="Rate Monotonic Period Statistics"
     
    140135    ROUTINES="Period_usage_Initialize Period_usage_Reset \
    141136        Period_usage_Update Period_usage_Dump"
    142     ;;
    143   misc_cpuuse)
    144     CHAPTER_CAPS="CPU Usage Statistics"
    145     CHAPTER_LOWER="CPU usage statistics"
    146     ROUTINES="CPU_usage_Dump CPU_usage_Reset"
    147137    ;;
    148138  misc_error)
  • doc/new_chapters/new_chapters.texi

    r5c1023a0 re694c94b  
    7979@c  The alternative is to rework a sentence to avoid this problem.
    8080
    81 @include stackchk.texi
    8281@include rtmonuse.texi
    83 @include cpuuse.texi
    8482@include error.texi
    8583@include monitor.texi
     
    9189
    9290@menu
    93 * Stack Bounds Checker::
    9491* Rate Monotonic Period Statistics::
    95 * CPU Usage Statistics::
    9692* Error Reporting Support::
    9793* Monitor Task::
  • doc/user/Makefile.am

    r5c1023a0 re694c94b  
    1919    signal.texi part.texi region.texi dpmem.texi io.texi fatal.texi \
    2020    schedule.texi rtmon.texi bsp.texi userext.texi conf.texi mp.texi \
    21     stackchk.texi
     21    stackchk.texi cpuuse.texi
    2222
    2323COMMON_FILES += $(top_srcdir)/common/cpright.texi
     
    163163        $(BMENU2) -p "Multiprocessing Manager MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet" \
    164164            -u "Top" \
     165            -n "CPU Usage Statistics" < $< > $@
     166
     167cpuuse.texi: cpuuse.t
     168        $(BMENU2) -p "Stack Bounds Checker stack_checker_dump_usage - Report Task Stack Usage" \
     169            -u "Top" \
    165170            -n "Directive Status Codes" < $< > $@
    166171
    167 EXTRA_DIST = bsp.t concepts.t clock.t datatypes.t conf.t dpmem.t event.t \
    168     fatal.t init.t intr.t io.t mp.t msg.t overview.t part.t region.t rtmon.t \
    169     sem.t schedule.t signal.t stackchk.t task.t timer.t userext.t \
     172EXTRA_DIST = bsp.t clock.t concepts.t cpuuse.t datatypes.t conf.t dpmem.t \
     173    event.t fatal.t init.t intr.t io.t mp.t msg.t overview.t part.t region.t \
     174    rtmon.t sem.t schedule.t signal.t stackchk.t task.t timer.t userext.t \
    170175    $(TXT_FILES) $(PNG_FILES) $(EPS_IMAGES) $(noinst_DATA)
    171176
  • doc/user/c_user.texi

    r5c1023a0 re694c94b  
    102102@include mp.texi
    103103@include stackchk.texi
     104@include cpuuse.texi
    104105@include dirstat.texi
    105106@include example.texi
     
    137138* Multiprocessing Manager::
    138139* Stack Bounds Checker::
     140* CPU Usage Statistics::
    139141* Directive Status Codes::
    140142* Example Application::
  • doc/user/cpuuse.t

    r5c1023a0 re694c94b  
    1717
    1818@itemize @bullet
    19 @item @code{CPU_usage_Dump} - Report CPU Usage Statistics
    20 @item @code{CPU_usage_Reset} - Reset CPU Usage Statistics
     19@item @code{@value{DIRPREFIX}cpu_usage_report} - Report CPU Usage Statistics
     20@item @code{@value{DIRPREFIX}cpu_usage_reset} - Reset CPU Usage Statistics
    2121@end itemize
    2222
     
    3030
    3131The application may dynamically report the CPU usage for every
    32 task in the system by calling the @code{CPU_usage_Dump} routine.
     32task in the system by calling the
     33@code{@value{DIRPREFIX}cpu_usage_report} routine.
    3334This routine prints a table with the following information per task:
    3435
     
    7475@section Reset CPU Usage Statistics
    7576
    76 Invoking the @code{CPU_usage_Reset} routine resets the CPU usage
    77 statistics for all tasks in the system.
     77Invoking the @code{@value{DIRPREFIX}cpu_usage_reset} routine resets
     78the CPU usage statistics for all tasks in the system.
    7879
    7980@section Directives
     
    8586
    8687@page
    87 @subsection CPU_usage_Dump - Report CPU Usage Statistics
     88@subsection cpu_usage_report - Report CPU Usage Statistics
    8889
    8990@subheading CALLING SEQUENCE:
     
    9192@ifset is-C
    9293@example
    93 void CPU_usage_Dump( void );
     94void rtems_cpu_usage_report( void );
    9495@end example
    9596@end ifset
     
    113114
    114115@page
    115 @subsection CPU_usage_Reset - Reset CPU Usage Statistics
     116@subsection cpu_usage_reset - Reset CPU Usage Statistics
    116117
    117118@subheading CALLING SEQUENCE:
     
    119120@ifset is-C
    120121@example
    121 void CPU_usage_Reset( void );
     122void rtems_cpu_usage_reset( void );
    122123@end example
    123124@end ifset
  • doc/user/dirstat.texi

    r5c1023a0 re694c94b  
    88
    99@ifinfo
    10 @node Directive Status Codes, Example Application, Stack Bounds Checker stack_checker_dump_usage - Report Task Stack Usage, Top
     10@node Directive Status Codes, Example Application, CPU Usage Statistics cpu_usage_reset - Reset CPU Usage Statistics, Top
    1111@end ifinfo
    1212@chapter Directive Status Codes
Note: See TracChangeset for help on using the changeset viewer.