summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-07-15 21:49:31 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-07-15 21:49:31 +0000
commit4dc6a4684f59ec33e621895e5296e924238d89c8 (patch)
treebcb9e92c11c025c2a68e6a002e6cf59fccba0414 /doc
parentSpacing. (diff)
downloadrtems-4dc6a4684f59ec33e621895e5296e924238d89c8.tar.bz2
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog7
-rw-r--r--doc/user/barrier.t2
-rw-r--r--doc/user/clock.t2
-rw-r--r--doc/user/dpmem.t2
-rw-r--r--doc/user/msg.t2
-rw-r--r--doc/user/part.t4
-rw-r--r--doc/user/region.t10
-rw-r--r--doc/user/rtmon.t2
-rw-r--r--doc/user/sem.t2
-rw-r--r--doc/user/task.t4
-rw-r--r--doc/user/timer.t2
11 files changed, 23 insertions, 16 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 9297148188..304f86a88a 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -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>
* user/.cvsignore: Add chains.texi.
diff --git a/doc/user/barrier.t b/doc/user/barrier.t
index 606d825942..f5c00ff56b 100644
--- a/doc/user/barrier.t
+++ b/doc/user/barrier.t
@@ -200,7 +200,7 @@ procedure Barrier_Create (
@subheading DIRECTIVE STATUS CODES:
@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}TOO_MANY} - too many barriers created@
diff --git a/doc/user/clock.t b/doc/user/clock.t
index 4c5829fbcf..7a356c6d2a 100644
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -270,7 +270,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:
diff --git a/doc/user/dpmem.t b/doc/user/dpmem.t
index a6359c43ca..1d90e0c6e0 100644
--- a/doc/user/dpmem.t
+++ b/doc/user/dpmem.t
@@ -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
diff --git a/doc/user/msg.t b/doc/user/msg.t
index 501424f21d..d5ab528547 100644
--- a/doc/user/msg.t
+++ b/doc/user/msg.t
@@ -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@*
diff --git a/doc/user/part.t b/doc/user/part.t
index fbb4ed4197..a2c06bc5f1 100644
--- a/doc/user/part.t
+++ b/doc/user/part.t
@@ -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
diff --git a/doc/user/region.t b/doc/user/region.t
index 78686976fd..e7d770aa43 100644
--- a/doc/user/region.t
+++ b/doc/user/region.t
@@ -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:
diff --git a/doc/user/rtmon.t b/doc/user/rtmon.t
index 3fe3ce6dad..d02bf4c758 100644
--- a/doc/user/rtmon.t
+++ b/doc/user/rtmon.t
@@ -963,7 +963,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:
diff --git a/doc/user/sem.t b/doc/user/sem.t
index 8bd3bbd611..29876a5d15 100644
--- a/doc/user/sem.t
+++ b/doc/user/sem.t
@@ -409,7 +409,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@*
diff --git a/doc/user/task.t b/doc/user/task.t
index e8a3390665..49fa0a9273 100644
--- a/doc/user/task.t
+++ b/doc/user/task.t
@@ -1212,8 +1212,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
diff --git a/doc/user/timer.t b/doc/user/timer.t
index 3b929a6e40..de9dc5a04a 100644
--- a/doc/user/timer.t
+++ b/doc/user/timer.t
@@ -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