Changeset 5e60f15 in rtems


Ignore:
Timestamp:
Jul 15, 2008, 9:50:40 PM (11 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Children:
d17c114
Parents:
3ed9ad9b
Message:

2008-07-15 Joel Sherrill <joel.sherrill@…>

  • user/clock.t, user/dpmem.t, user/msg.t, user/part.t, user/region.t, user/rtmon.t, user/sem.t, user/task.t, user/timer.t: Correct documentation typos noticed and thankfully reported by Fabrício de Novaes Kucinskis <fabricio@…>
Location:
doc
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r3ed9ad9b r5e60f15  
     12008-07-15      Joel Sherrill <joel.sherrill@OARcorp.com>
     2
     3        * user/clock.t, user/dpmem.t, user/msg.t, user/part.t, user/region.t,
     4        user/rtmon.t, user/sem.t, user/task.t, user/timer.t: Correct
     5        documentation typos noticed and thankfully reported by Fabrício de
     6        Novaes Kucinskis <fabricio@dea.inpe.br>
     7
    182008-06-20      Joel Sherrill <joel.sherrill@OARcorp.com>
    29
  • doc/user/clock.t

    r3ed9ad9b r5e60f15  
    264264@code{@value{RPREFIX}SUCCESSFUL} - date and time set successfully@*
    265265@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL@*
    266 @code{@value{RPREFIX}INVALID_TIME_OF_DAY} - invalid time of day
     266@code{@value{RPREFIX}INVALID_CLOCK} - invalid time of day
    267267
    268268@subheading DESCRIPTION:
  • doc/user/dpmem.t

    r3ed9ad9b r5e60f15  
    138138@subheading DIRECTIVE STATUS CODES:
    139139@code{@value{RPREFIX}SUCCESSFUL} - port created successfully@*
    140 @code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     140@code{@value{RPREFIX}INVALID_NAME} - invalid port name@*
    141141@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
    142142@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
  • doc/user/msg.t

    r3ed9ad9b r5e60f15  
    255255@subheading DIRECTIVE STATUS CODES:
    256256@code{@value{RPREFIX}SUCCESSFUL} - queue created successfully@*
    257 @code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     257@code{@value{RPREFIX}INVALID_NAME} - invalid queue name@*
    258258@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    259259@code{@value{RPREFIX}INVALID_NUMBER} - invalid message count@*
  • doc/user/part.t

    r3ed9ad9b r5e60f15  
    171171@subheading DIRECTIVE STATUS CODES:
    172172@code{@value{RPREFIX}SUCCESSFUL} - partition created successfully@*
    173 @code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     173@code{@value{RPREFIX}INVALID_NAME} - invalid partition name@*
    174174@code{@value{RPREFIX}TOO_MANY} - too many partitions created@*
    175175@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
     
    187187buffers from a physically contiguous memory space which starts
    188188at starting_address and is length bytes in size.  Each allocated
    189 buffer is to be of buffer_length in bytes.  The assigned
     189buffer is to be of @code{buffer_size} in bytes.  The assigned
    190190partition id is returned in id.  This partition id is used to
    191191access the partition with other partition related directives.
  • doc/user/region.t

    r3ed9ad9b r5e60f15  
    9797
    9898@itemize @bullet
    99 @item @code{@value{RPREFIX}WAIT} - task will wait for semaphore (default)
     99@item @code{@value{RPREFIX}WAIT} - task will wait for segment (default)
    100100@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
    101101@end itemize
     
    273273
    274274@code{@value{RPREFIX}SUCCESSFUL} - region created successfully@*
    275 @code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     275@code{@value{RPREFIX}INVALID_NAME} - invalid region name@*
    276276@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    277277@code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@*
     
    301301be serviced in First In-First Out order.
    302302
    303 The starting_address parameter must be aligned on a
    304 four byte boundary.  The page_size parameter must be a multiple
    305 of four greater than or equal to four.
     303The @code{starting_address} parameter must be aligned on a
     304four byte boundary.  The @code{page_size} parameter must be a multiple
     305of four greater than or equal to eight.
    306306
    307307@subheading NOTES:
  • doc/user/rtmon.t

    r3ed9ad9b r5e60f15  
    887887@subheading DIRECTIVE STATUS CODES:
    888888@code{@value{RPREFIX}SUCCESSFUL} - rate monotonic period created successfully@*
    889 @code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     889@code{@value{RPREFIX}INVALID_NAME} - invalid period name@*
    890890@code{@value{RPREFIX}TOO_MANY} - too many periods created
    891891
  • doc/user/sem.t

    r3ed9ad9b r5e60f15  
    409409@subheading DIRECTIVE STATUS CODES:
    410410@code{@value{RPREFIX}SUCCESSFUL} - semaphore created successfully@*
    411 @code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     411@code{@value{RPREFIX}INVALID_NAME} - invalid semaphore name@*
    412412@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    413413@code{@value{RPREFIX}TOO_MANY} - too many semaphores created@*
  • doc/user/task.t

    r3ed9ad9b r5e60f15  
    11551155
    11561156@subheading DIRECTIVE STATUS CODES:
    1157 @code{@value{RPREFIX}SUCCESSFUL} - task is suspended@*
    1158 @code{@value{RPREFIX}ALREADY_SUSPENDED} - task is not suspended@*
     1157@code{@value{RPREFIX}SUCCESSFUL} - task is NOT suspended@*
     1158@code{@value{RPREFIX}ALREADY_SUSPENDED} - task is currently suspended@*
    11591159@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
    11601160@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks
  • doc/user/timer.t

    r3ed9ad9b r5e60f15  
    6969service routine can perform.  For example, the Timer Server
    7070can be configured to have a floating point context in which case
    71 it would be save to perform floating point operations
     71it would be safe to perform floating point operations
    7272from a task-based timer.  Most of the time, executing floating
    7373point instructions from an interrupt service routine
Note: See TracChangeset for help on using the changeset viewer.