docs/60679: pthreads documentation does not describe "attr"

[Peter Pentchev]

The following reply was made to PR docs/60679; it has been noted by GNATS.

From: Peter Pentchev <roam at ringlet.net>
To: Alfred Perlstein <bright at elvis.mu.org>
Cc: bug-followup at FreeBSD.org
Subject: Re: docs/60679: pthreads documentation does not describe "attr"
Date: Fri, 5 Nov 2004 19:58:27 +0200

 On Sun, Dec 28, 2003 at 09:54:21PM -0800, Alfred Perlstein wrote:
 > 
 > >Number:         60679
 > >Category:       docs
 > >Synopsis:       pthreads documentation does not describe "attr"
 [snip]
 > 
 > >Description:
 > The pthreads manpages do not describe the nor link properly
 > to the pages describing attrs:
 > example:
 >  PTHREAD_MUTEX_INIT(3) does not xref PTHREAD_MUTEXATTR(3)
 
 These ones are trivially fixed; patch attached, at least for
 pthread_create(3), pthread_mutex_init(3) and pthread_cond_init(3).
 pthread_rwlock_init(3) already references pthread_rwlockattr_init(3),
 and the weirdly named pthread_barrier_destroy(3) references its
 pthread_barrierattr(3).
 
 > also:
 >  PTHREAD_MUTEXATTR(3) describes several functions:
 >     pthread_mutexattr_setprotocol, pthread_mutexattr_settype, etc
 >     but does not explain what the values used for these functions do or imply.
 
 ISTR something about us being allowed to use SUSv3 and/or POSIX text
 in our manual pages; is this true?  If so, would it be a good idea to
 just copy the relevant descriptions from the POSIX standard?
 
 Index: src/share/man/man3/pthread_cond_init.3
 ===================================================================
 RCS file: /home/ncvs/src/share/man/man3/pthread_cond_init.3,v
 retrieving revision 1.15
 diff -u -r1.15 pthread_cond_init.3
 --- src/share/man/man3/pthread_cond_init.3	15 Jan 2004 15:59:00 -0000	1.15
 +++ src/share/man/man3/pthread_cond_init.3	5 Nov 2004 17:49:32 -0000
 @@ -76,7 +76,8 @@
  .Xr pthread_cond_destroy 3 ,
  .Xr pthread_cond_signal 3 ,
  .Xr pthread_cond_timedwait 3 ,
 -.Xr pthread_cond_wait 3
 +.Xr pthread_cond_wait 3 ,
 +.Xr pthread_condattr 3
  .Sh STANDARDS
  The
  .Fn pthread_cond_init
 Index: src/share/man/man3/pthread_create.3
 ===================================================================
 RCS file: /home/ncvs/src/share/man/man3/pthread_create.3,v
 retrieving revision 1.19
 diff -u -r1.19 pthread_create.3
 --- src/share/man/man3/pthread_create.3	3 Jul 2004 18:29:20 -0000	1.19
 +++ src/share/man/man3/pthread_create.3	5 Nov 2004 17:56:20 -0000
 @@ -116,6 +116,7 @@
  .El
  .Sh SEE ALSO
  .Xr fork 2 ,
 +.Xr pthread_attr 3 ,
  .Xr pthread_cleanup_pop 3 ,
  .Xr pthread_cleanup_push 3 ,
  .Xr pthread_exit 3 ,
 Index: src/share/man/man3/pthread_mutex_init.3
 ===================================================================
 RCS file: /home/ncvs/src/share/man/man3/pthread_mutex_init.3,v
 retrieving revision 1.15
 diff -u -r1.15 pthread_mutex_init.3
 --- src/share/man/man3/pthread_mutex_init.3	15 Jan 2004 15:59:00 -0000	1.15
 +++ src/share/man/man3/pthread_mutex_init.3	5 Nov 2004 17:49:20 -0000
 @@ -71,7 +71,8 @@
  .Xr pthread_mutex_destroy 3 ,
  .Xr pthread_mutex_lock 3 ,
  .Xr pthread_mutex_trylock 3 ,
 -.Xr pthread_mutex_unlock 3
 +.Xr pthread_mutex_unlock 3 ,
 +.Xr pthread_mutexattr 3
  .Sh STANDARDS
  The
  .Fn pthread_mutex_init
 
 G'luck,
 Peter
 
 -- 
 Peter Pentchev	roam at ringlet.net    roam at cnsys.bg    roam at FreeBSD.org
 PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
 Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
 Nostalgia ain't what it used to be.