From bright@elvis.mu.org  Sun Dec 28 21:54:22 2003
Return-Path: <bright@elvis.mu.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 2D83C16A4CE
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 28 Dec 2003 21:54:22 -0800 (PST)
Received: from elvis.mu.org (elvis.mu.org [192.203.228.196])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 7C7B043D2D
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 28 Dec 2003 21:54:21 -0800 (PST)
	(envelope-from bright@elvis.mu.org)
Received: by elvis.mu.org (Postfix, from userid 1192)
	id 4BAB75C7D3; Sun, 28 Dec 2003 21:54:21 -0800 (PST)
Message-Id: <20031229055421.4BAB75C7D3@elvis.mu.org>
Date: Sun, 28 Dec 2003 21:54:21 -0800 (PST)
From: Alfred Perlstein <bright@elvis.mu.org>
Reply-To: Alfred Perlstein <bright@elvis.mu.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: pthreads documentation does not describe "attr"
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         60679
>Category:       docs
>Synopsis:       [patch] pthread(3): pthreads documentation does not describe "attr"
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Dec 28 22:00:37 PST 2003
>Closed-Date:    Wed May 28 00:06:31 UTC 2008
>Last-Modified:  Wed May 28 00:06:31 UTC 2008
>Originator:     Alfred Perlstein
>Release:        FreeBSD 4.9-MUORG-20031210 i386
>Organization:
RED Inc.
>Environment:
System: FreeBSD elvis.mu.org 4.9-MUORG-20031210 FreeBSD 4.9-MUORG-20031210 #4: Fri Dec 12 14:16:14 PST 2003 root@:/usr/src/sys/compile/h0h0magic i386

>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)
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.
The same deficiency exists for:
PTHREAD_COND_INIT(3) no xref to PTHREAD_CONDATTR(3)
PTHREAD_CONDATTR(3) lacks definitions

PTHREAD_CREATE(3) has no xref to PTHREAD_ATTR(3)
PTHREAD_ATTR(3) lacks definitions.

>How-To-Repeat:
	man pthread...
>Fix:
	add more docco?  UTSL?
	I may get to this eventually, but I'm hoping some brave and
helpful sole will get to it first.

>Release-Note:
>Audit-Trail:

From: Peter Pentchev <roam@ringlet.net>
To: Alfred Perlstein <bright@elvis.mu.org>
Cc: bug-followup@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@ringlet.net    roam@cnsys.bg    roam@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.
State-Changed-From-To: open->patched 
State-Changed-By: trhodes 
State-Changed-When: Sat Nov 4 10:08:40 UTC 2006 
State-Changed-Why:  
Slightly different version of the patch committed, there is 
also some documentation about the return values in the manual 
page.  Thanks! 


Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Sat Nov 4 10:08:40 UTC 2006 
Responsible-Changed-Why:  
Over to me, MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=60679 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/60679: commit references a PR
Date: Sat,  4 Nov 2006 10:08:29 +0000 (UTC)

 trhodes     2006-11-04 10:08:16 UTC
 
   FreeBSD src repository
 
   Modified files:
     share/man/man3       pthread_cond_init.3 pthread_create.3 
                          pthread_mutex_init.3 
   Log:
   Xref pthread_condattr.3, pthread_attr.3, and pthread_mutexattr.3.
   
   PR:             60679
   Submitted by:   roam (with minor modifications)
   
   Revision  Changes    Path
   1.17      +2 -1      src/share/man/man3/pthread_cond_init.3
   1.23      +2 -1      src/share/man/man3/pthread_create.3
   1.17      +2 -1      src/share/man/man3/pthread_mutex_init.3
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: gabor 
State-Changed-When: Wed May 28 00:05:58 UTC 2008 
State-Changed-Why:  
This MFC reminder is irrelevant now, let's close it. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=60679 
>Unformatted:
