summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2012-10-02 11:45:09 -0500
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-10-02 11:45:09 -0500
commit880e2f370f6350d38f5bf539d1d1f0ddd9e0b1a6 (patch)
treecb9f88bd20fe39ae6f7c521b50bcfe32403623ad /doc
parentnfsclient: Format changes (diff)
downloadrtems-880e2f370f6350d38f5bf539d1d1f0ddd9e0b1a6.tar.bz2
User's Guide: Correct typos in return status bullets
Diffstat (limited to 'doc')
-rw-r--r--doc/user/barrier.t6
-rw-r--r--doc/user/sem.t8
-rw-r--r--doc/user/task.t10
-rw-r--r--doc/user/userext.t6
4 files changed, 15 insertions, 15 deletions
diff --git a/doc/user/barrier.t b/doc/user/barrier.t
index c55d9d9c3b..6c8e733717 100644
--- a/doc/user/barrier.t
+++ b/doc/user/barrier.t
@@ -15,7 +15,7 @@ and be unblocked as a set. The directives provided by the
barrier manager are:
@itemize @bullet
-@item @code{@value{DIRPREFIX}barrier_create} - Create a barrier
+@item @code{@value{DIRPREFIX}barrier_create} - Create a barrier
@item @code{@value{DIRPREFIX}barrier_ident} - Get ID of a barrier
@item @code{@value{DIRPREFIX}barrier_delete} - Delete a barrier
@item @code{@value{DIRPREFIX}barrier_wait} - Wait at a barrier
@@ -324,7 +324,7 @@ procedure Barrier_Delete (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - barrier deleted successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - barrier deleted successfully@*
@code{@value{RPREFIX}INVALID_ID} - invalid barrier id@
@subheading DESCRIPTION:
@@ -379,7 +379,7 @@ procedure Barrier_Wait (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - barrier obtained successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - barrier released and task unblocked@*
@code{@value{RPREFIX}UNSATISFIED} - barrier not available@*
@code{@value{RPREFIX}TIMEOUT} - timed out waiting for barrier@*
@code{@value{RPREFIX}OBJECT_WAS_DELETED} - barrier deleted while waiting@*
diff --git a/doc/user/sem.t b/doc/user/sem.t
index 05569def8e..9c380523ba 100644
--- a/doc/user/sem.t
+++ b/doc/user/sem.t
@@ -18,7 +18,7 @@ exclusion capabilities. The directives provided by the
semaphore manager are:
@itemize @bullet
-@item @code{@value{DIRPREFIX}semaphore_create} - Create a semaphore
+@item @code{@value{DIRPREFIX}semaphore_create} - Create a semaphore
@item @code{@value{DIRPREFIX}semaphore_ident} - Get ID of a semaphore
@item @code{@value{DIRPREFIX}semaphore_delete} - Delete a semaphore
@item @code{@value{DIRPREFIX}semaphore_obtain} - Acquire a semaphore
@@ -605,10 +605,10 @@ procedure Semaphore_Delete (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - semaphore deleted successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - semaphore deleted successfully@*
@code{@value{RPREFIX}INVALID_ID} - invalid semaphore id@*
-@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote semaphore@*
-@code{@value{RPREFIX}RESOURCE_IN_USE} - binary semaphore is in use
+@code{@value{RPREFIX}RESOURCE_IN_USE} - binary semaphore is in use@*
+@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote semaphore
@subheading DESCRIPTION:
diff --git a/doc/user/task.t b/doc/user/task.t
index 4acf1feb0e..b55d9b74df 100644
--- a/doc/user/task.t
+++ b/doc/user/task.t
@@ -1054,7 +1054,7 @@ procedure Task_Delete (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - task restarted successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - task deleted successfully@*
@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot restart remote task
@@ -1114,7 +1114,7 @@ procedure Task_Suspend (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - task restarted successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - task suspended successfully@*
@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
@code{@value{RPREFIX}ALREADY_SUSPENDED} - task already suspended
@@ -1166,7 +1166,7 @@ procedure Task_Resume (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - task restarted successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - task resumed successfully@*
@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
@code{@value{RPREFIX}INCORRECT_STATE} - task not suspended
@@ -1811,7 +1811,7 @@ procedure Task_Variable_Get (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - per task variable added successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - per task variable obtained successfully@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable} is NULL@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable_value} is NULL@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable} is not found@*
@@ -1863,7 +1863,7 @@ procedure Task_Variable_Delete (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - per task variable added successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - per task variable deleted successfully@*
@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable} is NULL@*
diff --git a/doc/user/userext.t b/doc/user/userext.t
index 3ae0081801..97628bdb20 100644
--- a/doc/user/userext.t
+++ b/doc/user/userext.t
@@ -603,7 +603,7 @@ procedure Extension_Create (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - extension set created successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - extension set created successfully@*
@code{@value{RPREFIX}INVALID_NAME} - invalid extension set name@*
@code{@value{RPREFIX}TOO_MANY} - too many extension sets created
@@ -653,7 +653,7 @@ procedure Extension_Ident (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - extension set identified successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - extension set identified successfully@*
@code{@value{RPREFIX}INVALID_NAME} - extension set name not found
@subheading DESCRIPTION:
@@ -700,7 +700,7 @@ procedure Extension_Delete (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{@value{RPREFIX}SUCCESSFUL} - extension set deleted successfully@*
+@code{@value{RPREFIX}SUCCESSFUL} - extension set deleted successfully@*
@code{@value{RPREFIX}INVALID_ID} - invalid extension set id
@subheading DESCRIPTION: