Changeset d5671b1 in rtems


Ignore:
Timestamp:
Jan 29, 2008, 9:37:00 PM (12 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.9, master
Children:
9252e55e
Parents:
01618cc
Message:

2008-01-29 Joel Sherrill <joel.sherrill@…>

  • user/.cvsignore, user/Makefile.am, user/c_user.texi, user/concepts.t, user/conf.t, user/dirstat.texi, user/stackchk.t, user/task.t, user/userext.t: Add new Object Services collection. Tidy up some configuration documentation from earlier changes.
  • user/object.t: New file.
Location:
doc
Files:
1 added
10 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r01618cc rd5671b1  
     12008-01-29      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * user/.cvsignore, user/Makefile.am, user/c_user.texi, user/concepts.t,
     4        user/conf.t, user/dirstat.texi, user/stackchk.t, user/task.t,
     5        user/userext.t: Add new Object Services collection. Tidy up some
     6        configuration documentation from earlier changes.
     7        * user/object.t: New file.
     8
    192008-01-25      Joel Sherrill <joel.sherrill@oarcorp.com>
    210
  • doc/user/.cvsignore

    r01618cc rd5671b1  
    3939mp.texi
    4040msg.texi
     41object.texi
    4142overview.texi
    4243part.texi
  • doc/user/Makefile.am

    r01618cc rd5671b1  
    1919    signal.texi part.texi region.texi dpmem.texi io.texi fatal.texi \
    2020    schedule.texi rtmon.texi barrier.texi bsp.texi userext.texi conf.texi \
    21     mp.texi stackchk.texi cpuuse.texi
     21    mp.texi stackchk.texi cpuuse.texi object.texi
    2222
    2323COMMON_FILES += $(top_srcdir)/common/cpright.texi
     
    171171
    172172cpuuse.texi: cpuuse.t
    173         $(BMENU2) -p "Stack Bounds Checker stack_checker_report_usage - Report Task Stack Usage" \
     173        $(BMENU2) -p "Stack Bounds Checker STACK_CHECKER_REPORT_USAGE - Report Task Stack Usage" \
     174            -u "Top" \
     175            -n "Object Services" < $< > $@
     176
     177object.texi: object.t
     178        $(BMENU2) -p "CPU Usage Statistics cpu_usage_reset - Reset CPU Usage Statistics" \
    174179            -u "Top" \
    175180            -n "Directive Status Codes" < $< > $@
  • doc/user/c_user.texi

    r01618cc rd5671b1  
    88
    99@c
    10 @c  COPYRIGHT (c) 1988-2006.
     10@c  COPYRIGHT (c) 1988-2008.
    1111@c  On-Line Applications Research Corporation (OAR).
    1212@c  All rights reserved.
     
    106106@include stackchk.texi
    107107@include cpuuse.texi
     108@include object.texi
    108109@include dirstat.texi
    109110@include example.texi
     
    143144* Stack Bounds Checker::
    144145* CPU Usage Statistics::
     146* Object Services::
    145147* Directive Status Codes::
    146148* Example Application::
  • doc/user/concepts.t

    r01618cc rd5671b1  
    231231
    232232In addition, services are provided to portably examine the
    233 three subcomponents of an RTEMS ID.  These services are
    234 prototyped as follows:
     233subcomponents of an RTEMS ID.  These services are
     234described in detail later in this manual but are prototyped
     235as follows:
    235236
    236237@cindex obtaining class from object ID
     
    240241@cindex get node from object ID
    241242@cindex get index from object ID
    242 @findex rtems_get_class
    243 @findex rtems_get_node
    244 @findex rtems_get_index
    245 
    246 @example
    247 uint32_t rtems_get_class( rtems_id );
    248 uint32_t rtems_get_node( rtems_id );
    249 uint32_t rtems_get_index( rtems_id );
     243@findex rtems_object_id_get_api
     244@findex rtems_object_id_get_class
     245@findex rtems_object_id_get_node
     246@findex rtems_object_id_get_index
     247
     248@example
     249uint32_t rtems_object_id_get_api( rtems_id );
     250uint32_t rtems_object_id_get_class( rtems_id );
     251uint32_t rtems_object_id_get_node( rtems_id );
     252uint32_t rtems_object_id_get_index( rtems_id );
    250253@end example
    251254
  • doc/user/conf.t

    r01618cc rd5671b1  
    1010@c
    1111@c CONFIGURE_NEWLIB_EXTENSION - probably not needed
    12 @c CONFIGURE_MALLOC_REGION - probably not needed
    13 @c CONFIGURE_LIBIO_SEMAPHORES - implicitly discussed.
    14 @c CONFIGURE_GNAT_RTEMS
    15 @c     CONFIGURE_GNAT_MUTEXES
    16 @c     CONFIGURE_GNAT_KEYS
    17 @c     CONFIGURE_MAXIMUM_ADA_TASKS
    18 @c     CONFIGURE_MAXIMUM_FAKE_ADA_TASKS
    19 @c     CONFIGURE_ADA_TASKS_STACK
    2012@c
    2113@c In addition, there should be examples of defining your own
     
    140132
    141133@itemize @bullet
     134@findex CONFIGURE_MALLOC_STATISTICS
     135@item @code{CONFIGURE_MALLOC_STATISTICS} is defined when the application
     136wishes to enable the gathering of more detailed statistics on the
     137C Malloc Family of routines.
     138
     139@findex CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
     140@item @code{CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK} is defined by a BSP
     141to indicate that it does not allocate all available memory to the
     142C Program Heap used by the Malloc Family of routines.  If defined,
     143when @code{malloc()} is unable to allocate memory, it will call
     144the BSP supplied @code{sbrk()} to obtain more memory.
     145
    142146@findex CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
    143147@item @code{CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS} is set to the
  • doc/user/dirstat.texi

    r01618cc rd5671b1  
    88
    99@ifinfo
    10 @node Directive Status Codes, Example Application, CPU Usage Statistics cpu_usage_reset - Reset CPU Usage Statistics, Top
     10@node Directive Status Codes, Example Application, Object Services OBJECT_GET_CLASS_INFORMATION - Obtain Class Information, Top
    1111@end ifinfo
    1212@chapter Directive Status Codes
  • doc/user/stackchk.t

    r01618cc rd5671b1  
    162162@c
    163163@page
    164 @subsection stack_checker_is_blown - Has Current Task Blown Its Stack
     164@subsection STACK_CHECKER_IS_BLOWN - Has Current Task Blown Its Stack
    165165
    166166@subheading CALLING SEQUENCE:
     
    196196
    197197@page
    198 @subsection stack_checker_report_usage - Report Task Stack Usage
     198@subsection STACK_CHECKER_REPORT_USAGE - Report Task Stack Usage
    199199
    200200@subheading CALLING SEQUENCE:
  • doc/user/task.t

    r01618cc rd5671b1  
    18181818@example
    18191819rtems_status_code rtems_task_variable_delete(
    1820   rtems_id  tid,
     1820  rtems_id  id,
    18211821  void    **task_variable
    18221822);
  • doc/user/userext.t

    r01618cc rd5671b1  
    151151@example
    152152@group
    153 index = rtems_get_index(extension_id);
     153index = rtems_object_id_get_index(extension_id);
    154154@end group
    155155@end example
Note: See TracChangeset for help on using the changeset viewer.