Imagelibrary/rtems
1
0
Fork 1
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2025-11-16 12:34:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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:50:40 +00:00
parent 3ed9ad9b83
commit 5e60f15d23
10 changed files with 22 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/ChangeLog
View File

@@ -1,3 +1,10 @@
2008-07-15 Joel Sherrill <joel.sherrill@OARcorp.com>
* 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-06-20 Joel Sherrill <joel.sherrill@OARcorp.com>
* user/io.t: Fix typos for IO unregister reported by Catalin Morosan

2
doc/user/clock.t
View File

@@ -263,7 +263,7 @@ procedure Clock_Set (
@subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - date and time set successfully@*
@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:

2
doc/user/dpmem.t
View File

@@ -137,7 +137,7 @@ procedure Port_Create (
@subheading DIRECTIVE STATUS CODES:
@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} - @code{id} is NULL@*
@code{@value{RPREFIX}TOO_MANY} - too many DP memory areas created

2
doc/user/msg.t
View File

@@ -254,7 +254,7 @@ procedure Message_Queue_Create (
@subheading DIRECTIVE STATUS CODES:
@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_NUMBER} - invalid message count@*
@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*

4
doc/user/part.t
View File

@@ -170,7 +170,7 @@ procedure Partition_Create (
@subheading DIRECTIVE STATUS CODES:
@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}INVALID_ADDRESS} - address not on four byte boundary@*
@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
buffers from a physically contiguous memory space which starts
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
access the partition with other partition related directives.
For control and maintenance of the partition, RTEMS allocates a

10
doc/user/region.t
View File

@@ -96,7 +96,7 @@ desired option components. The set of valid options for the
listed in the following table:
@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
@end itemize
@@ -272,7 +272,7 @@ procedure Region_Create (
@subheading DIRECTIVE STATUS CODES:
@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{starting_address} is NULL@*
@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
be serviced in First In-First Out order.
The starting_address parameter must be aligned on a
four byte boundary. The page_size parameter must be a multiple
of four greater than or equal to four.
The @code{starting_address} parameter must be aligned on a
four byte boundary. The @code{page_size} parameter must be a multiple
of four greater than or equal to eight.
@subheading NOTES:

2
doc/user/rtmon.t
View File

@@ -886,7 +886,7 @@ procedure Rate_Monotonic_Create (
@subheading DIRECTIVE STATUS CODES:
@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
@subheading DESCRIPTION:

2
doc/user/sem.t
View File

@@ -408,7 +408,7 @@ procedure Semaphore_Create (
@subheading DIRECTIVE STATUS CODES:
@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}TOO_MANY} - too many semaphores created@*
@code{@value{RPREFIX}NOT_DEFINED} - invalid attribute set@*

4
doc/user/task.t
View File

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

2
doc/user/timer.t
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
service routine can perform. For example, the Timer Server
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
point instructions from an interrupt service routine
is not considered safe. However, since the Timer Server task