diff options
| author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-07-22 17:18:09 +0000 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-07-22 17:18:09 +0000 |
| commit | e5c0540d6aa94583ca59b7e1cfe346e576069d38 (patch) | |
| tree | 1426a2a556aeee413214c5ad664839d0501d61e5 | |
| parent | 2008-07-18 Joel Sherrill <joel.sherrill@oarcorp.com> (diff) | |
| download | rtems-e5c0540d6aa94583ca59b7e1cfe346e576069d38.tar.bz2 | |
2008-07-22 Joel Sherrill <joel.sherrill@OARcorp.com>
pr1291/cpukit
* posix_users/mutex.t: Add ETIMEDOUT.
* posix_users/semaphores.t: Clarify text to say absolute timeout.
| -rw-r--r-- | doc/ChangeLog | 6 | ||||
| -rw-r--r-- | doc/posix_users/mutex.t | 4 | ||||
| -rw-r--r-- | doc/posix_users/semaphores.t | 18 |
3 files changed, 20 insertions, 8 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index bda962ee52..33f7ef6c7a 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2008-07-22 Joel Sherrill <joel.sherrill@OARcorp.com> + + pr1291/cpukit + * posix_users/mutex.t: Add ETIMEDOUT. + * posix_users/semaphores.t: Clarify text to say absolute timeout. + 2008-07-15 Joel Sherrill <joel.sherrill@OARcorp.com> * user/barrier.t, user/clock.t, user/dpmem.t, user/msg.t, user/part.t, diff --git a/doc/posix_users/mutex.t b/doc/posix_users/mutex.t index c818ee5ce2..502fa786f6 100644 --- a/doc/posix_users/mutex.t +++ b/doc/posix_users/mutex.t @@ -630,6 +630,10 @@ ceiling. @item EDEADLK The current thread already owns the mutex. +@item ETIMEDOUT +The calling thread was unable to obtain the mutex within the specified +timeout period. + @end table @subheading DESCRIPTION: diff --git a/doc/posix_users/semaphores.t b/doc/posix_users/semaphores.t index f58c1533dc..9ad7f24899 100644 --- a/doc/posix_users/semaphores.t +++ b/doc/posix_users/semaphores.t @@ -463,7 +463,7 @@ Multiprocessing is not supported in this implementation. @example int sem_timedwait( sem_t *sem, - const struct timespec *timeout + const struct timespec *abstime ); @end example @end ifset @@ -484,13 +484,15 @@ The @code{sem} argument does not refewr to a valid semaphore @end table @subheading DESCRIPTION: -This function attemtps to lock a semaphore specified by @code{sem}, and will -wait for the semaphore for an interval specified by @code{timeout}. If the -semaphore is available, then the semaphore is locked (i.e., the semaphore -value is decremented) and the function returns a value of 0. The semaphore -remains locked until released by a @code{sem_post()} call. If the semaphore -is unavailable, then the function will wait for the semaphore to become -available for the amount of time specified by @code{timeout}. + +This function attemtps to lock a semaphore specified by @code{sem}, +and will wait for the semaphore until the absolute time specified by +@code{abstime}. If the semaphore is available, then the semaphore is +locked (i.e., the semaphore value is decremented) and the function +returns a value of 0. The semaphore remains locked until released by +a @code{sem_post()} call. If the semaphore is unavailable, then the +function will wait for the semaphore to become available for the amount +of time specified by @code{timeout}. If the semaphore does not become available within the interval specified by @code{timeout}, then the function returns -1 and sets @code{errno} to EAGAIN. |