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

* user/barrier.t, 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@dea.inpe.br>
This commit is contained in:
Joel Sherrill
2008-07-15 21:49:31 +00:00
parent 18e6e824a6
commit 4dc6a4684f
11 changed files with 23 additions and 16 deletions

View File

@@ -1,3 +1,10 @@
2008-07-15 Joel Sherrill <joel.sherrill@OARcorp.com>
* user/barrier.t, 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@dea.inpe.br>
2008-07-10 Joel Sherrill <joel.sherrill@OARcorp.com> 2008-07-10 Joel Sherrill <joel.sherrill@OARcorp.com>
* user/.cvsignore: Add chains.texi. * user/.cvsignore: Add chains.texi.

View File

@@ -200,7 +200,7 @@ procedure Barrier_Create (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - barrier created successfully@* @code{@value{RPREFIX}SUCCESSFUL} - barrier created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid task name@* @code{@value{RPREFIX}INVALID_NAME} - invalid barrier name@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
@code{@value{RPREFIX}TOO_MANY} - too many barriers created@ @code{@value{RPREFIX}TOO_MANY} - too many barriers created@

View File

@@ -270,7 +270,7 @@ procedure Clock_Set (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - date and time set successfully@* @code{@value{RPREFIX}SUCCESSFUL} - date and time set successfully@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL@*
@code{@value{RPREFIX}INVALID_TIME_OF_DAY} - invalid time of day @code{@value{RPREFIX}INVALID_CLOCK} - invalid time of day
@subheading DESCRIPTION: @subheading DESCRIPTION:

View File

@@ -137,7 +137,7 @@ procedure Port_Create (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - port created successfully@* @code{@value{RPREFIX}SUCCESSFUL} - port created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid task name@* @code{@value{RPREFIX}INVALID_NAME} - invalid port name@*
@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@* @code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
@code{@value{RPREFIX}TOO_MANY} - too many DP memory areas created @code{@value{RPREFIX}TOO_MANY} - too many DP memory areas created

View File

@@ -254,7 +254,7 @@ procedure Message_Queue_Create (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - queue created successfully@* @code{@value{RPREFIX}SUCCESSFUL} - queue created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid task name@* @code{@value{RPREFIX}INVALID_NAME} - invalid queue name@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
@code{@value{RPREFIX}INVALID_NUMBER} - invalid message count@* @code{@value{RPREFIX}INVALID_NUMBER} - invalid message count@*
@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@* @code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*

View File

@@ -170,7 +170,7 @@ procedure Partition_Create (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - partition created successfully@* @code{@value{RPREFIX}SUCCESSFUL} - partition created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid task name@* @code{@value{RPREFIX}INVALID_NAME} - invalid partition name@*
@code{@value{RPREFIX}TOO_MANY} - too many partitions created@* @code{@value{RPREFIX}TOO_MANY} - too many partitions created@*
@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@* @code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@*
@@ -186,7 +186,7 @@ procedure Partition_Create (
This directive creates a partition of fixed size This directive creates a partition of fixed size
buffers from a physically contiguous memory space which starts buffers from a physically contiguous memory space which starts
at starting_address and is length bytes in size. Each allocated at starting_address and is length bytes in size. Each allocated
buffer is to be of buffer_length in bytes. The assigned buffer is to be of @code{buffer_size} in bytes. The assigned
partition id is returned in id. This partition id is used to partition id is returned in id. This partition id is used to
access the partition with other partition related directives. access the partition with other partition related directives.
For control and maintenance of the partition, RTEMS allocates a For control and maintenance of the partition, RTEMS allocates a

View File

@@ -96,7 +96,7 @@ desired option components. The set of valid options for the
listed in the following table: listed in the following table:
@itemize @bullet @itemize @bullet
@item @code{@value{RPREFIX}WAIT} - task will wait for semaphore (default) @item @code{@value{RPREFIX}WAIT} - task will wait for segment (default)
@item @code{@value{RPREFIX}NO_WAIT} - task should not wait @item @code{@value{RPREFIX}NO_WAIT} - task should not wait
@end itemize @end itemize
@@ -272,7 +272,7 @@ procedure Region_Create (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - region created successfully@* @code{@value{RPREFIX}SUCCESSFUL} - region created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid task name@* @code{@value{RPREFIX}INVALID_NAME} - invalid region name@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@*
@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@* @code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
@@ -300,9 +300,9 @@ Specifying @code{@value{RPREFIX}FIFO} in attribute_set or selecting
@code{@value{RPREFIX}DEFAULT_ATTRIBUTES} will cause waiting tasks to @code{@value{RPREFIX}DEFAULT_ATTRIBUTES} will cause waiting tasks to
be serviced in First In-First Out order. be serviced in First In-First Out order.
The starting_address parameter must be aligned on a The @code{starting_address} parameter must be aligned on a
four byte boundary. The page_size parameter must be a multiple four byte boundary. The @code{page_size} parameter must be a multiple
of four greater than or equal to four. of four greater than or equal to eight.
@subheading NOTES: @subheading NOTES:

View File

@@ -963,7 +963,7 @@ procedure Rate_Monotonic_Create (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - rate monotonic period created successfully@* @code{@value{RPREFIX}SUCCESSFUL} - rate monotonic period created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid task name@* @code{@value{RPREFIX}INVALID_NAME} - invalid period name@*
@code{@value{RPREFIX}TOO_MANY} - too many periods created @code{@value{RPREFIX}TOO_MANY} - too many periods created
@subheading DESCRIPTION: @subheading DESCRIPTION:

View File

@@ -409,7 +409,7 @@ procedure Semaphore_Create (
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - semaphore created successfully@* @code{@value{RPREFIX}SUCCESSFUL} - semaphore created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid task name@* @code{@value{RPREFIX}INVALID_NAME} - invalid semaphore name@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@* @code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
@code{@value{RPREFIX}TOO_MANY} - too many semaphores created@* @code{@value{RPREFIX}TOO_MANY} - too many semaphores created@*
@code{@value{RPREFIX}NOT_DEFINED} - invalid attribute set@* @code{@value{RPREFIX}NOT_DEFINED} - invalid attribute set@*

View File

@@ -1212,8 +1212,8 @@ procedure Task_Is_Suspended (
@end ifset @end ifset
@subheading DIRECTIVE STATUS CODES: @subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - task is suspended@* @code{@value{RPREFIX}SUCCESSFUL} - task is NOT suspended@*
@code{@value{RPREFIX}ALREADY_SUSPENDED} - task is not suspended@* @code{@value{RPREFIX}ALREADY_SUSPENDED} - task is currently suspended@*
@code{@value{RPREFIX}INVALID_ID} - task id invalid@* @code{@value{RPREFIX}INVALID_ID} - task id invalid@*
@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks

View File

@@ -68,7 +68,7 @@ in task rather than interrupt space, the application is
allowed a bit more flexibility in what operations a timer allowed a bit more flexibility in what operations a timer
service routine can perform. For example, the Timer Server service routine can perform. For example, the Timer Server
can be configured to have a floating point context in which case can be configured to have a floating point context in which case
it would be save to perform floating point operations it would be safe to perform floating point operations
from a task-based timer. Most of the time, executing floating from a task-based timer. Most of the time, executing floating
point instructions from an interrupt service routine point instructions from an interrupt service routine
is not considered safe. However, since the Timer Server task is not considered safe. However, since the Timer Server task