pthread_mutexattr(3): document pthread_mutexattr_set/getpshared

Reviewed by:	markj
Sponsored by:	The FreeBSD Foundation
MFC after:	3 days
Differential revision:	https://reviews.freebsd.org/D32243
This commit is contained in:
Konstantin Belousov 2021-10-01 03:46:16 +03:00
parent 9f3b6cdbe8
commit 0a6e5fc29b

View File

@ -26,7 +26,7 @@
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.Dd August 17, 2018 .Dd October 1, 2021
.Dt PTHREAD_MUTEXATTR 3 .Dt PTHREAD_MUTEXATTR 3
.Os .Os
.Sh NAME .Sh NAME
@ -36,6 +36,8 @@
.Nm pthread_mutexattr_getprioceiling , .Nm pthread_mutexattr_getprioceiling ,
.Nm pthread_mutexattr_setprotocol , .Nm pthread_mutexattr_setprotocol ,
.Nm pthread_mutexattr_getprotocol , .Nm pthread_mutexattr_getprotocol ,
.Nm pthread_mutexattr_setpshared ,
.Nm pthread_mutexattr_getpshared ,
.Nm pthread_mutexattr_setrobust , .Nm pthread_mutexattr_setrobust ,
.Nm pthread_mutexattr_getrobust , .Nm pthread_mutexattr_getrobust ,
.Nm pthread_mutexattr_settype , .Nm pthread_mutexattr_settype ,
@ -64,6 +66,14 @@
.Fa "const pthread_mutexattr_t *restrict attr" "int *restrict protocol" .Fa "const pthread_mutexattr_t *restrict attr" "int *restrict protocol"
.Fc .Fc
.Ft int .Ft int
.Fo pthread_mutexattr_setpshared
.Fa "pthread_mutexattr_t *attr" "int shared"
.Fc
.Ft int
.Fo pthread_mutexattr_getpshared
.Fa "const pthread_mutexattr_t *attr" "int *shared"
.Fc
.Ft int
.Fn pthread_mutexattr_setrobust "pthread_mutexattr_t *attr" "int robust" .Fn pthread_mutexattr_setrobust "pthread_mutexattr_t *attr" "int robust"
.Ft int .Ft int
.Fn pthread_mutexattr_getrobust "pthread_mutexattr_t *attr" "int *robust" .Fn pthread_mutexattr_getrobust "pthread_mutexattr_t *attr" "int *robust"
@ -161,6 +171,26 @@ Invalid value for
.El .El
.Pp .Pp
The The
.Fn pthread_mutexattr_setpshared
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr ,
or invalid value for
.Fa shared .
.El
.Pp
The
.Fn pthread_mutexattr_getpshared
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
The
.Fn pthread_mutexattr_settype .Fn pthread_mutexattr_settype
function will fail if: function will fail if:
.Bl -tag -width Er .Bl -tag -width Er
@ -214,6 +244,8 @@ The
.Fn pthread_mutexattr_getprioceiling , .Fn pthread_mutexattr_getprioceiling ,
.Fn pthread_mutexattr_setprotocol , .Fn pthread_mutexattr_setprotocol ,
.Fn pthread_mutexattr_getprotocol , .Fn pthread_mutexattr_getprotocol ,
.Fn pthread_mutexattr_setpshared ,
.Fn pthread_mutexattr_getpshared ,
.Fn pthread_mutexattr_settype , .Fn pthread_mutexattr_settype ,
and and
.Fn pthread_mutexattr_gettype .Fn pthread_mutexattr_gettype