From a477158490dcdbab0eb8eee45bd25502127108d1 Mon Sep 17 00:00:00 2001 From: phantom Date: Thu, 4 May 2000 08:05:45 +0000 Subject: mdoc(7) cleanup: . use real function names as `.Nm' macro argument in NAME section. It allows them to appear in apropos(1) or whatis(1) output. . replace empty lines with `.Pp' macro. . replace hardcoded standard names with their `.St' macro equivalents. . sort cross references in SEE ALSO section --- lib/libpthread/man/pthread_attr.3 | 52 ++++++++++++++++++++------------- lib/libpthread/man/pthread_condattr.3 | 17 ++++++----- lib/libpthread/man/pthread_kill.3 | 5 ++-- lib/libpthread/man/pthread_mutexattr.3 | 43 +++++++++++++++------------ lib/libpthread/man/pthread_schedparam.3 | 9 +++--- lib/libpthread/man/pthread_sigmask.3 | 5 ++-- lib/libpthread/man/sigwait.3 | 11 ++++--- 7 files changed, 79 insertions(+), 63 deletions(-) (limited to 'lib/libpthread') diff --git a/lib/libpthread/man/pthread_attr.3 b/lib/libpthread/man/pthread_attr.3 index 9e3bb74..773e423 100644 --- a/lib/libpthread/man/pthread_attr.3 +++ b/lib/libpthread/man/pthread_attr.3 @@ -30,7 +30,22 @@ .Dt PTHREAD_ATTR 3 .Os .Sh NAME -.Nm pthread_attr +.Nm pthread_attr_init , +.Nm pthread_attr_destroy , +.Nm pthread_attr_setstacksize , +.Nm pthread_attr_getstacksize , +.Nm pthread_attr_setstackaddr , +.Nm pthread_attr_getstackaddr , +.Nm pthread_attr_setdetachstate , +.Nm pthread_attr_getdetachstate , +.Nm pthread_attr_setinheritsched , +.Nm pthread_attr_getinheritsched , +.Nm pthread_attr_setschedparam , +.Nm pthread_attr_getschedparam , +.Nm pthread_attr_setschedpolicy , +.Nm pthread_attr_getschedpolicy , +.Nm pthread_attr_setscope , +.Nm pthread_attr_getscope .Nd thread attribute operations .Sh LIBRARY .Lb libc_r @@ -74,27 +89,26 @@ Thread attributes are used to specify parameters to One attribute object can be used in multiple calls to .Fn pthread_create , with or without modifications between calls. - +.Pp The .Fn pthread_attr_init function initializes .Fa attr with all the default thread attributes. - +.Pp The .Fn pthread_attr_destroy function destroys .Fa attr . - +.Pp The .Fn pthread_attr_set* functions set the attribute that corresponds to each function name. - +.Pp The .Fn pthread_attr_get* functions copy the value of the attribute that corresponds to each function name to the location pointed to by the second function parameter. - .Sh RETURN VALUES If successful, these functions return 0. Otherwise, an error number is returned to indicate the error. @@ -105,7 +119,7 @@ will fail if: .It Bq Er ENOMEM Out of memory. .El - +.Pp .Fn pthread_attr_destroy will fail if: .Bl -tag -width Er @@ -113,7 +127,7 @@ will fail if: Invalid value for .Fa attr . .El - +.Pp .Fn pthread_attr_setstacksize will fail if: .Bl -tag -width Er @@ -122,7 +136,7 @@ will fail if: is less than .Dv PTHREAD_STACK_MIN . .El - +.Pp .Fn pthread_attr_setdetachstate will fail if: .Bl -tag -width Er @@ -130,7 +144,7 @@ will fail if: Invalid value for .Fa detachstate . .El - +.Pp .Fn pthread_attr_setinheritsched will fail if: .Bl -tag -width Er @@ -138,7 +152,7 @@ will fail if: Invalid value for .Fa attr . .El - +.Pp .Fn pthread_attr_setschedparam will fail if: .Bl -tag -width Er @@ -149,7 +163,7 @@ Invalid value for Invalid value for .Fa param . .El - +.Pp .Fn pthread_attr_setschedpolicy will fail if: .Bl -tag -width Er @@ -160,7 +174,7 @@ Invalid value for Invalid or unsupported value for .Fa policy . .El - +.Pp .Fn pthread_attr_setscope will fail if: .Bl -tag -width Er @@ -171,7 +185,6 @@ Invalid value for Invalid or unsupported value for .Fa contentionscope . .El - .Sh SEE ALSO .Xr pthread_create 3 .Sh STANDARDS @@ -184,10 +197,9 @@ Invalid or unsupported value for .Fn pthread_attr_setdetachstate , and .Fn pthread_attr_getdetachstate -conform to ISO/IEC 9945-1 ANSI/IEEE -.Pq Dq Tn POSIX -Std 1003.1 1996 Edition. - +conform to +.St -iso9945-1 +.Pp .Fn pthread_attr_setinheritsched , .Fn pthread_attr_getinheritsched , .Fn pthread_attr_setschedparam , @@ -197,5 +209,5 @@ Std 1003.1 1996 Edition. .Fn pthread_attr_setscope , and .Fn pthread_attr_getscope -conform to the Single UNIX Specification, Version 2 -.Pq Dq Tn SUSv2 . +conform to +.St -susv2 diff --git a/lib/libpthread/man/pthread_condattr.3 b/lib/libpthread/man/pthread_condattr.3 index d65820f..ac8c48a 100644 --- a/lib/libpthread/man/pthread_condattr.3 +++ b/lib/libpthread/man/pthread_condattr.3 @@ -30,7 +30,8 @@ .Dt PTHREAD_CONDATTR 3 .Os .Sh NAME -.Nm pthread_condattr +.Nm pthread_condattr_init , +.Nm pthread_condattr_destroy .Nd condition attribute operations .Sh LIBRARY .Lb libc_r @@ -45,12 +46,13 @@ Condition attribute objects are used to specify parameters to .Fn pthread_cond_init . FreeBSD's implementation of conditions does not support any non-default attributes, so these functions are not very useful, though they are required to -to be present by POSIX. - +to be present by +.Tn POSIX . +.Pp The .Fn pthread_condattr_init function initializes a condition attribute object with the default attributes. - +.Pp The .Fn pthread_condattr_destroy function destroys a condition attribute object. @@ -64,7 +66,7 @@ will fail if: .It Bq Er ENOMEM Out of memory. .El - +.Pp .Fn pthread_condattr_destroy will fail if: .Bl -tag -width Er @@ -77,6 +79,5 @@ Invalid value for .Fn pthread_condattr_init and .Fn pthread_condattr_destroy -conform to ISO/IEC 9945-1 ANSI/IEEE -.Pq Dq Tn POSIX -Std 1003.1 1996 Edition. +conform to +.St -iso9945-1 diff --git a/lib/libpthread/man/pthread_kill.3 b/lib/libpthread/man/pthread_kill.3 index 1c9ed35..1b1f0ea 100644 --- a/lib/libpthread/man/pthread_kill.3 +++ b/lib/libpthread/man/pthread_kill.3 @@ -70,6 +70,5 @@ is an invalid or unsupported signal number. .Xr raise 3 .Sh STANDARDS .Fn pthread_kill -conforms to ISO/IEC 9945-1 ANSI/IEEE -.Pq Dq Tn POSIX -Std 1003.1 1996 Edition. +conforms to +.St -iso9945-1 diff --git a/lib/libpthread/man/pthread_mutexattr.3 b/lib/libpthread/man/pthread_mutexattr.3 index a60890c..d1004c7 100644 --- a/lib/libpthread/man/pthread_mutexattr.3 +++ b/lib/libpthread/man/pthread_mutexattr.3 @@ -30,7 +30,14 @@ .Dt PTHREAD_MUTEXATTR 3 .Os .Sh NAME -.Nm pthread_mutexattr +.Nm pthread_mutexattr_init , +.Nm pthread_mutexattr_destroy , +.Nm pthread_mutexattr_setprioceiling , +.Nm pthread_mutexattr_getprioceiling , +.Nm pthread_mutexattr_setprotocol , +.Nm pthread_mutexattr_getprotocol , +.Nm pthread_mutexattr_settype , +.Nm pthread_mutexattr_gettype .Nd mutex attribute operations .Sh LIBRARY .Lb libc_r @@ -58,27 +65,26 @@ Mutex attributes are used to specify parameters to One attribute object can be used in multiple calls to .Fn pthread_mutex_init , with or without modifications between calls. - +.Pp The .Fn pthread_mutexattr_init function initializes .Fa attr with all the default mutex attributes. - +.Pp The .Fn pthread_mutexattr_destroy function destroys .Fa attr . - +.Pp The .Fn pthread_mutexattr_set* functions set the attribute that corresponds to each function name. - +.Pp The .Fn pthread_mutexattr_get* functions copy the value of the attribute that corresponds to each function name to the location pointed to by the second function parameter. - .Sh RETURN VALUES If successful, these functions return 0. Otherwise, an error number is returned to indicacte the error. @@ -89,7 +95,7 @@ will fail if: .It Bq Er ENOMEM Out of memory. .El - +.Pp .Fn pthread_mutexattr_destroy will fail if: .Bl -tag -width Er @@ -97,7 +103,7 @@ will fail if: Invalid value for .Fa attr . .El - +.Pp .Fn pthread_mutexattr_setprioceiling will fail if: .Bl -tag -width Er @@ -107,7 +113,7 @@ Invalid value for or invalid value for .Fa prioceiling . .El - +.Pp .Fn pthread_mutexattr_getprioceiling will fail if: .Bl -tag -width Er @@ -115,7 +121,7 @@ will fail if: Invalid value for .Fa attr . .El - +.Pp .Fn pthread_mutexattr_setprotocol will fail if: .Bl -tag -width Er @@ -125,7 +131,7 @@ Invalid value for or invalid value for .Fa protocol . .El - +.Pp .Fn pthread_mutexattr_getprotocol will fail if: .Bl -tag -width Er @@ -133,7 +139,7 @@ will fail if: Invalid value for .Fa attr . .El - +.Pp .Fn pthread_mutexattr_settype will fail if: .Bl -tag -width Er @@ -143,7 +149,7 @@ Invalid value for or invalid value for .Fa type . .El - +.Pp .Fn pthread_mutexattr_gettype will fail if: .Bl -tag -width Er @@ -157,10 +163,9 @@ Invalid value for .Fn pthread_mutexattr_init and .Fn pthread_mutexattr_destroy -conform to ISO/IEC 9945-1 ANSI/IEEE -.Pq Dq Tn POSIX -Std 1003.1 1996 Edition. - +conform to +.St -iso9945-1 +.Pp .Fn pthread_mutexattr_setprioceiling , .Fn pthread_mutexattr_getprioceiling , .Fn pthread_mutexattr_setprotocol , @@ -168,5 +173,5 @@ Std 1003.1 1996 Edition. .Fn pthread_mutexattr_settype , and .Fn pthread_mutexattr_gettype -conform to the Single UNIX Specification, Version 2 -.Pq Dq Tn SUSv2 . +conform to +.St -susv2 diff --git a/lib/libpthread/man/pthread_schedparam.3 b/lib/libpthread/man/pthread_schedparam.3 index e24f5a5..bc70bac 100644 --- a/lib/libpthread/man/pthread_schedparam.3 +++ b/lib/libpthread/man/pthread_schedparam.3 @@ -30,7 +30,8 @@ .Dt PTHREAD_SCHEDPARAM 3 .Os .Sh NAME -.Nm pthread_schedparam +.Nm pthread_setschedparam , +.Nm pthread_getschedparam .Nd thread scheduling parameter manipulation .Sh LIBRARY .Lb libc_r @@ -73,7 +74,7 @@ Invalid value for scheduling parameters. Non-existent thread .Va thread . .El - +.Pp .Fn pthread_getschedparam will fail if: .Bl -tag -width Er @@ -85,5 +86,5 @@ Non-existent thread .Fn pthread_setschedparam and .Fn pthread_getschedparam -conform to the Single UNIX Specification, Version 2 -.Pq Dq Tn SUSv2 . +conform to +.St -susv2 diff --git a/lib/libpthread/man/pthread_sigmask.3 b/lib/libpthread/man/pthread_sigmask.3 index f0dfc94..754c897 100644 --- a/lib/libpthread/man/pthread_sigmask.3 +++ b/lib/libpthread/man/pthread_sigmask.3 @@ -91,6 +91,5 @@ is not one of the defined values. .Xr sigsuspend 2 .Sh STANDARDS .Fn pthread_sigmask -conforms to ISO/IEC 9945-1 ANSI/IEEE -.Pq Dq Tn POSIX -Std 1003.1 1996 Edition. +conforms to +.St -iso9945-1 diff --git a/lib/libpthread/man/sigwait.3 b/lib/libpthread/man/sigwait.3 index 3839d17..e7ca3a0 100644 --- a/lib/libpthread/man/sigwait.3 +++ b/lib/libpthread/man/sigwait.3 @@ -73,13 +73,12 @@ will fail if: specifies one or more invalid signal numbers. .El .Sh SEE ALSO -.Xr pause 3 , -.Xr pthread_sigmask 3 , .Xr sigaction 2 , .Xr sigpending 2 , -.Xr sigsuspend 2 +.Xr sigsuspend 2 , +.Xr pause 3 , +.Xr pthread_sigmask 3 .Sh STANDARDS .Fn sigwait -conforms to ISO/IEC 9945-1 ANSI/IEEE -.Pq Dq Tn POSIX -Std 1003.1 1996 Edition. +conforms to +.St -iso9945-1 -- cgit v1.1