2008-08-08 Sebastian Huber <sebastian.huber@embedded-brains.de>

* user/msg.t, user/sem.t, user/task.t: Update to new parameter types.
	Emphasize that you can use a pointer for task arguments.

doc/ChangeLog

@@ -1,3 +1,8 @@
+2008-08-08     Sebastian Huber <sebastian.huber@embedded-brains.de>
+
+	* user/msg.t, user/sem.t, user/task.t: Update to new parameter types.
+	Emphasize that you can use a pointer for task arguments.
+
 2008-08-07	Joel Sherrill <joel.sherrill@OARcorp.com>
 
 	* user/datatypes.t: Add rtems_name. Add comment about

doc/user/msg.t

@@ -232,7 +232,7 @@ constants, usage, and status codes.
 rtems_status_code rtems_message_queue_create(
   rtems_name        name,
   uint32_t          count,
-  uint32_t          max_message_size,
+  size_t            max_message_size,
   rtems_attribute   attribute_set,
   rtems_id         *id
 );
@@ -455,7 +455,7 @@ reclaimed when the message queue is deleted.
 @example
 rtems_status_code rtems_message_queue_send(
   rtems_id   id,
-  void     *buffer,
+  cons void *buffer,
   size_t     size
 );
 @end example
@@ -520,7 +520,7 @@ proxy used to represent the task is reclaimed.
 @example
 rtems_status_code rtems_message_queue_urgent(
   rtems_id    id,
-  void     *buffer,
+  const void *buffer,
   size_t      size
 );
 @end example
@@ -586,7 +586,7 @@ proxy used to represent the task is reclaimed.
 @example
 rtems_status_code rtems_message_queue_broadcast(
   rtems_id    id,
-  void     *buffer,
+  const void *buffer,
   size_t      size,
   uint32_t   *count
 );
@@ -659,7 +659,7 @@ rtems_status_code rtems_message_queue_receive(
   rtems_id        id,
   void           *buffer,
   size_t         *size,
-  uint32_t        option_set,
+  rtems_option    option_set,
   rtems_interval  timeout
 );
 @end example
@@ -696,7 +696,8 @@ wait for a message to become available or return immediately.
 For either option, if there is at least one message in the
 queue, then it is copied to buffer, size is set to return the
 length of the message in bytes, and this directive returns
-immediately with a successful return code.
+immediately with a successful return code.  The buffer has to be big enough to
+receive a message of the maximum length with respect to this message queue.
 
 If the calling task chooses to return immediately and
 the queue is empty, then a status code indicating this condition

doc/user/sem.t

@@ -628,7 +628,7 @@ reclaimed when the semaphore is deleted.
 @example
 rtems_status_code rtems_semaphore_obtain(
   rtems_id        id,
-  uint32_t        option_set,
+  rtems_option    option_set,
   rtems_interval  timeout
 );
 @end example
@@ -812,7 +812,7 @@ id.  Since there are tasks blocked on the semaphore, the semaphore's
 count is not changed by this directive and thus is zero before and
 after this directive is executed.  Tasks which are unblocked as the
 result of this directive will return from the 
-@code{@value{DIRPREFIX}semaphore_release} directive with a
+@code{@value{DIRPREFIX}semaphore_obtain} directive with a
 status code of @code{@value{RPREFIX}UNSATISFIED} to indicate
 that the semaphore was not obtained.
 

doc/user/task.t

@@ -948,8 +948,11 @@ This directive readies the task, specified by tid, for execution
 based on the priority and execution mode specified when the task
 was created.  The starting address of the task is given in
 entry_point.  The task's starting argument is contained in
-argument.  This argument can be a single value or used as an
+argument.  This argument can be a single value or used as an index into an
-index into an array of parameter blocks.
+array of parameter blocks.  The type of this numeric argument is an unsigned
+integer type with the property that any valid pointer to void can be converted
+to this type and then converted back to a pointer to void.  The result will
+compare equal to the original pointer.
 
 @subheading NOTES:
 The calling task will be preempted if its preemption mode is
@@ -1001,9 +1004,12 @@ the task is currently blocked, RTEMS automatically makes the
 task ready.  A task can be restarted from any state, except the
 dormant state.
 
-The task's starting argument is contained in argument.  This
+The task's starting argument is contained in argument.  This argument can be a
-argument can be a single value or an index into an array of
+single value or an index into an array of parameter blocks.  The type of this
-parameter blocks.  This new argument may be used to distinguish
+numeric argument is an unsigned integer type with the property that any valid
+pointer to void can be converted to this type and then converted back to a
+pointer to void.  The result will compare equal to the original pointer.  This
+new argument may be used to distinguish
 between the initial @code{@value{DIRPREFIX}task_start}
 of the task and any ensuing calls
 to @code{@value{DIRPREFIX}task_restart}