d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pull some changes (mostly cosmetic) from libc_r manpages

Browse Source 
in preparation for the merge.
This commit is contained in:
Ruslan Ermilov 2003-12-30 14:59:10 +00:00
parent 73d7ddbc56
commit cd31d44075
30 changed files with 143 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/libpthread/man/pthread_equal.3
View File

@ -63,6 +63,7 @@ None.
.Xr pthread_create 3 ,
.Xr pthread_exit 3
.Sh STANDARDS
The
.Fn pthread_equal
conforms to
function conforms to
.St -p1003.1-96 .

3
lib/libpthread/man/pthread_exit.3
View File

@ -99,6 +99,7 @@ None.
.Xr pthread_create 3 ,
.Xr pthread_join 3
.Sh STANDARDS
The
.Fn pthread_exit
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_getspecific.3
View File

@ -61,8 +61,9 @@ has been deleted with
.Fn pthread_key_delete
is undefined.
.Pp
The
.Fn pthread_getspecific
may be called from a thread-specific data destructor function.
function may be called from a thread-specific data destructor function.
.Sh RETURN VALUES
The
.Fn pthread_getspecific
@ -78,6 +79,7 @@ None.
.Xr pthread_key_delete 3 ,
.Xr pthread_setspecific 3
.Sh STANDARDS
The
.Fn pthread_getspecific
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_join.3
View File

@ -79,8 +79,9 @@ function will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_join
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The implementation has detected that the value specified by
@ -99,6 +100,7 @@ specifies the calling thread.
.Xr wait 2 ,
.Xr pthread_create 3
.Sh STANDARDS
The
.Fn pthread_join
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_key_create.3
View File

@ -87,8 +87,9 @@ and returns zero.
Otherwise an error number will be returned to indicate
the error.
.Sh ERRORS
The
.Fn pthread_key_create
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
The system lacked the necessary resources to create another thread-specific
@ -102,6 +103,7 @@ Insufficient memory exists to create the key.
.Xr pthread_key_delete 3 ,
.Xr pthread_setspecific 3
.Sh STANDARDS
The
.Fn pthread_key_create
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_key_delete.3
View File

@ -80,8 +80,9 @@ function will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_key_delete
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The
@ -93,6 +94,7 @@ value is invalid.
.Xr pthread_key_create 3 ,
.Xr pthread_setspecific 3
.Sh STANDARDS
The
.Fn pthread_key_delete
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_kill.3
View File

@ -55,8 +55,9 @@ If successful,
returns 0.
Otherwise, an error number is returned.
.Sh ERRORS
The
.Fn pthread_kill
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
.Fa thread
@ -70,6 +71,7 @@ is an invalid or unsupported signal number.
.Xr pthread_self 3 ,
.Xr raise 3
.Sh STANDARDS
The
.Fn pthread_kill
conforms to
function conforms to
.St -p1003.1-96

6
lib/libpthread/man/pthread_mutex_destroy.3
View File

@ -50,8 +50,9 @@ If successful,
will return zero, otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_mutex_destroy
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@ -67,6 +68,7 @@ is locked by another thread.
.Xr pthread_mutex_trylock 3 ,
.Xr pthread_mutex_unlock 3
.Sh STANDARDS
The
.Fn pthread_mutex_destroy
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_mutex_init.3
View File

@ -54,8 +54,9 @@ will return zero and put the new mutex id into
.Fa mutex ,
otherwise an error number will be returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_mutex_init
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@ -70,6 +71,7 @@ The process cannot allocate enough memory to create another mutex.
.Xr pthread_mutex_trylock 3 ,
.Xr pthread_mutex_unlock 3
.Sh STANDARDS
The
.Fn pthread_mutex_init
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_mutex_lock.3
View File

@ -52,8 +52,9 @@ If successful,
will return zero, otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_mutex_lock
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@ -69,6 +70,7 @@ A deadlock would occur if the thread blocked waiting for
.Xr pthread_mutex_trylock 3 ,
.Xr pthread_mutex_unlock 3
.Sh STANDARDS
The
.Fn pthread_mutex_lock
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_mutex_trylock.3
View File

@ -53,8 +53,9 @@ If successful,
will return zero, otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_mutex_trylock
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@ -70,6 +71,7 @@ is already locked.
.Xr pthread_mutex_lock 3 ,
.Xr pthread_mutex_unlock 3
.Sh STANDARDS
The
.Fn pthread_mutex_trylock
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_mutex_unlock.3
View File

@ -52,8 +52,9 @@ If successful,
will return zero, otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_mutex_unlock
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@ -69,6 +70,7 @@ The current thread does not hold a lock on
.Xr pthread_mutex_lock 3 ,
.Xr pthread_mutex_trylock 3
.Sh STANDARDS
The
.Fn pthread_mutex_unlock
conforms to
function conforms to
.St -p1003.1-96 .

30
lib/libpthread/man/pthread_mutexattr.3
View File

@ -89,23 +89,26 @@ to the location pointed to by the second function parameter.
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_mutexattr_init
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Out of memory.
.El
.Pp
The
.Fn pthread_mutexattr_destroy
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
The
.Fn pthread_mutexattr_setprioceiling
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@ -114,16 +117,18 @@ or invalid value for
.Fa prioceiling .
.El
.Pp
The
.Fn pthread_mutexattr_getprioceiling
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
The
.Fn pthread_mutexattr_setprotocol
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@ -132,16 +137,18 @@ or invalid value for
.Fa protocol .
.El
.Pp
The
.Fn pthread_mutexattr_getprotocol
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
The
.Fn pthread_mutexattr_settype
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@ -150,8 +157,9 @@ or invalid value for
.Fa type .
.El
.Pp
The
.Fn pthread_mutexattr_gettype
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@ -160,12 +168,14 @@ Invalid value for
.Sh SEE ALSO
.Xr pthread_mutex_init 3
.Sh STANDARDS
The
.Fn pthread_mutexattr_init
and
.Fn pthread_mutexattr_destroy
conform to
functions conform to
.St -p1003.1-96
.Pp
The
.Fn pthread_mutexattr_setprioceiling ,
.Fn pthread_mutexattr_getprioceiling ,
.Fn pthread_mutexattr_setprotocol ,
@ -173,5 +183,5 @@ conform to
.Fn pthread_mutexattr_settype ,
and
.Fn pthread_mutexattr_gettype
conform to
functions conform to
.St -susv2

3
lib/libpthread/man/pthread_once.3
View File

@ -100,6 +100,7 @@ indicate the error.
.Sh ERRORS
None.
.Sh STANDARDS
The
.Fn pthread_once
conforms to
function conforms to
.St -p1003.1-96 .

1
lib/libpthread/man/pthread_rwlock_wrlock.3
View File

@ -61,6 +61,7 @@ and
functions will return zero. Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlock_init 3 ,
.Xr pthread_rwlock_rdlock 3 ,
.Xr pthread_rwlock_tryrdlock 3 ,
.Xr pthread_rwlock_unlock 3

3
lib/libpthread/man/pthread_rwlockattr_destroy.3
View File

@ -55,8 +55,9 @@ The
function is expected to conform to
.St -susv2 .
.Sh ERRORS
The
.Fn pthread_rwlockattr_destroy
may fail if:
function may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by

3
lib/libpthread/man/pthread_rwlockattr_getpshared.3
View File

@ -67,8 +67,9 @@ The
function is expected to conform to
.St -susv2 .
.Sh ERRORS
The
.Fn pthread_rwlockattr_getpshared
may fail if:
function may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by

3
lib/libpthread/man/pthread_rwlockattr_init.3
View File

@ -56,8 +56,9 @@ The
function is expected to conform to
.St -susv2 .
.Sh ERRORS
The
.Fn pthread_rwlockattr_init
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient memory exists to initialize the attribute object.

6
lib/libpthread/man/pthread_rwlockattr_setpshared.3
View File

@ -43,8 +43,9 @@ function sets the process shared attribute of
.Fa attr
to the value referenced by
.Fa pshared .
The
.Fa pshared
may be one of two values:
argument may be one of two values:
.Bl -tag -width PTHREAD_PROCESS_PRIVATE
.It Dv PTHREAD_PROCESS_SHARED
Any thread of any process that has access to the memory where the
@ -69,8 +70,9 @@ The
function is expected to conform to
.St -susv2 .
.Sh ERRORS
The
.Fn pthread_rwlockattr_setpshared
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by

9
lib/libpthread/man/pthread_schedparam.3
View File

@ -62,8 +62,9 @@ and no more than
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_setschedparam
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@ -75,16 +76,18 @@ Non-existent thread
.Va thread .
.El
.Pp
The
.Fn pthread_getschedparam
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
Non-existent thread
.Va thread .
.El
.Sh STANDARDS
The
.Fn pthread_setschedparam
and
.Fn pthread_getschedparam
conform to
functions conform to
.St -susv2

3
lib/libpthread/man/pthread_self.3
View File

@ -56,6 +56,7 @@ None.
.Xr pthread_create 3 ,
.Xr pthread_equal 3
.Sh STANDARDS
The
.Fn pthread_self
conforms to
function conforms to
.St -p1003.1-96 .

13
lib/libpthread/man/pthread_setspecific.3
View File

@ -64,18 +64,20 @@ has been deleted with
.Fn pthread_key_delete
is undefined.
.Pp
The
.Fn pthread_setspecific
may be called from a thread-specific data destructor function, however this
may result in lost storage or infinite loops.
function may be called from a thread-specific data destructor function,
however this may result in lost storage or infinite loops.
.Sh RETURN VALUES
If successful, the
If successful, the
.Fn pthread_setspecific
function will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_setspecific
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient memory exists to associate the value with the
@ -90,6 +92,7 @@ value is invalid.
.Xr pthread_key_create 3 ,
.Xr pthread_key_delete 3
.Sh STANDARDS
The
.Fn pthread_setspecific
conforms to
function conforms to
.St -p1003.1-96 .

6
lib/libpthread/man/pthread_sigmask.3
View File

@ -77,8 +77,9 @@ If successful,
returns 0.
Otherwise, an error is returned.
.Sh ERRORS
The
.Fn pthread_sigmask
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa how
@ -91,6 +92,7 @@ is not one of the defined values.
.Xr sigsuspend 2 ,
.Xr sigsetops 3
.Sh STANDARDS
The
.Fn pthread_sigmask
conforms to
function conforms to
.St -p1003.1-96

3
lib/libpthread/man/pthread_testcancel.3
View File

@ -197,8 +197,9 @@ or
.Sh SEE ALSO
.Xr pthread_cancel 3
.Sh STANDARDS
The
.Fn pthread_testcancel
conforms to
function conforms to
.St -p1003.1-96 .
.Sh AUTHORS
This man page was written by

9
lib/libpthread/man/sem_destroy.3
View File

@ -51,8 +51,9 @@ is unusable until re-initialized by another call to
.Sh RETURN VALUES
.Rv -std sem_destroy
.Sh ERRORS
The
.Fn sem_destroy
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa sem
@ -63,10 +64,12 @@ There are currently threads blocked on the semaphore that
points to.
.El
.Sh SEE ALSO
.Xr sem_init 3
.Xr sem_init 3 ,
.Xr sem 4
.Sh STANDARDS
The
.Fn sem_destroy
conforms to
function conforms to
.St -p1003.1-96 .
.Pp
POSIX does not define the behavior of

11
lib/libpthread/man/sem_getvalue.3
View File

@ -37,7 +37,7 @@
.Sh SYNOPSIS
.In semaphore.h
.Ft int
.Fn sem_getvalue "sem_t *sem" "int *sval"
.Fn sem_getvalue "sem_t * restrict sem" "int * restrict sval"
.Sh DESCRIPTION
The
.Fn sem_getvalue
@ -51,8 +51,9 @@ is actually run.
.Sh RETURN VALUES
.Rv -std sem_getvalue
.Sh ERRORS
The
.Fn sem_getvalue
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa sem
@ -61,10 +62,12 @@ points to an invalid semaphore.
.Sh SEE ALSO
.Xr sem_post 3 ,
.Xr sem_trywait 3 ,
.Xr sem_wait 3
.Xr sem_wait 3 ,
.Xr sem 4
.Sh STANDARDS
The
.Fn sem_getvalue
conforms to
function conforms to
.St -p1003.1-96 .
.Pp
The value of the semaphore is never negative, even if there are threads blocked

22
lib/libpthread/man/sem_init.3
View File

@ -54,19 +54,21 @@ Following a successful call to
.Fn sem_init ,
.Fa sem
can be used as an argument in subsequent calls to
.Fa sem_wait ,
.Fa sem_trywait ,
.Fa sem_post ,
.Xr sem_wait 3 ,
.Xr sem_trywait 3 ,
.Xr sem_post 3 ,
and
.Fa sem_destroy .
.Xr sem_destroy 3 .
The
.Fa sem
is no longer valid after a successful call to
.Fa sem_destroy .
argument is no longer valid after a successful call to
.Xr sem_destroy 3 .
.Sh RETURN VALUES
.Rv -std sem_init
.Sh ERRORS
The
.Fn sem_init
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa value
@ -80,10 +82,12 @@ Unable to initialize a shared semaphore.
.Xr sem_destroy 3 ,
.Xr sem_post 3 ,
.Xr sem_trywait 3 ,
.Xr sem_wait 3
.Xr sem_wait 3 ,
.Xr sem 4
.Sh STANDARDS
The
.Fn sem_init
conforms to
function conforms to
.St -p1003.1-96 .
.Pp
This implementation does not support shared semaphores, and reports this fact

12
lib/libpthread/man/sem_post.3
View File

@ -49,13 +49,15 @@ is called, then the highest priority thread that has been blocked the longest on
the semaphore will be allowed to return from
.Fn sem_wait .
.Pp
The
.Fn sem_post
is signal-reentrant and may be called within signal handlers.
function is signal-reentrant and may be called within signal handlers.
.Sh RETURN VALUES
.Rv -std sem_post
.Sh ERRORS
The
.Fn sem_post
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa sem
@ -63,8 +65,10 @@ points to an invalid semaphore.
.El
.Sh SEE ALSO
.Xr sem_trywait 3 ,
.Xr sem_wait 3
.Xr sem_wait 3 ,
.Xr sem 4
.Sh STANDARDS
The
.Fn sem_post
conforms to
function conforms to
.St -p1003.1-96 .

9
lib/libpthread/man/sem_wait.3
View File

@ -59,10 +59,11 @@ an error is returned.
.Sh RETURN VALUES
.Rv -std
.Sh ERRORS
The
.Fn sem_wait
and
.Fn sem_trywait
will fail if:
functions will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa sem
@ -77,10 +78,12 @@ will fail if:
The semaphore value was zero, and thus could not be decremented.
.El
.Sh SEE ALSO
.Xr sem_post 3
.Xr sem_post 3 ,
.Xr sem 4
.Sh STANDARDS
The
.Fn sem_wait
and
.Fn sem_trywait
conform to
functions conform to
.St -p1003.1-96 .

6
lib/libpthread/man/sigwait.3
View File

@ -65,8 +65,9 @@ returns 0 and sets the location pointed to by
to the cleared signal number.
Otherwise, an error number is returned.
.Sh ERRORS
The
.Fn sigwait
will fail if:
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa set
@ -79,6 +80,7 @@ specifies one or more invalid signal numbers.
.Xr pause 3 ,
.Xr pthread_sigmask 3
.Sh STANDARDS
The
.Fn sigwait
conforms to
function conforms to
.St -p1003.1-96