From 1576672bcd530f91af6e5e4d0342d9e825254a0d Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Tue, 15 Jul 2008 21:51:03 +0000 Subject: 2008-07-15 Joel Sherrill MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * clock.t, dpmem.t, msg.t, part.t, region.t, rtmon.t, sem.t, task.t, timer.t: Correct documentation typos noticed and thankfully reported by Fabrício de Novaes Kucinskis --- doc/user/ChangeLog | 6 ++++++ doc/user/clock.t | 2 +- doc/user/dpmem.t | 2 +- doc/user/msg.t | 2 +- doc/user/part.t | 4 ++-- doc/user/region.t | 10 +++++----- doc/user/rtmon.t | 2 +- doc/user/sem.t | 2 +- doc/user/task.t | 4 ++-- doc/user/timer.t | 2 +- 10 files changed, 21 insertions(+), 15 deletions(-) diff --git a/doc/user/ChangeLog b/doc/user/ChangeLog index 9adb590e6a..b702f03635 100644 --- a/doc/user/ChangeLog +++ b/doc/user/ChangeLog @@ -1,3 +1,9 @@ +2008-07-15 Joel Sherrill + + * clock.t, dpmem.t, msg.t, part.t, region.t, rtmon.t, sem.t, task.t, + timer.t: Correct documentation typos noticed and thankfully reported + by Fabrício de Novaes Kucinskis + 2006-09-07 Ken Peters PR 1171/doc diff --git a/doc/user/clock.t b/doc/user/clock.t index 24721ebe8c..e2bc16fb2b 100644 --- a/doc/user/clock.t +++ b/doc/user/clock.t @@ -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: diff --git a/doc/user/dpmem.t b/doc/user/dpmem.t index b842b519b2..294a579d09 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 3b8775995b..4657a41638 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 eef41e6308..35328b0a03 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 4b90443049..36329ee1d7 100644 --- a/doc/user/region.t +++ b/doc/user/region.t @@ -95,7 +95,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 @@ -262,7 +262,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@* @@ -290,9 +290,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 adbb7f5d36..d83daf2a65 100644 --- a/doc/user/rtmon.t +++ b/doc/user/rtmon.t @@ -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: diff --git a/doc/user/sem.t b/doc/user/sem.t index dd51266892..8b776d2b6a 100644 --- a/doc/user/sem.t +++ b/doc/user/sem.t @@ -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@* diff --git a/doc/user/task.t b/doc/user/task.t index 115536eb22..01998cc05e 100644 --- a/doc/user/task.t +++ b/doc/user/task.t @@ -1153,8 +1153,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 88c59d7306..43476bb5de 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 -- cgit v1.2.3