From fullermd@over-yonder.net  Tue Oct  7 01:31:56 2008
Return-Path: <fullermd@over-yonder.net>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id AB1FE1065690
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  7 Oct 2008 01:31:56 +0000 (UTC)
	(envelope-from fullermd@over-yonder.net)
Received: from thyme.infocus-llc.com (server.infocus-llc.com [206.156.254.44])
	by mx1.freebsd.org (Postfix) with ESMTP id 84A798FC22
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  7 Oct 2008 01:31:56 +0000 (UTC)
	(envelope-from fullermd@over-yonder.net)
Received: from draco.over-yonder.net (c-75-64-197-185.hsd1.ms.comcast.net [75.64.197.185])
	(using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by thyme.infocus-llc.com (Postfix) with ESMTPSA id 2102937B4F7
	for <FreeBSD-gnats-submit@freebsd.org>; Mon,  6 Oct 2008 20:31:55 -0500 (CDT)
Received: by draco.over-yonder.net (Postfix, from userid 100)
	id DBEEF61C41; Mon,  6 Oct 2008 20:31:53 -0500 (CDT)
Message-Id: <20081007013153.DBEEF61C41@draco.over-yonder.net>
Date: Mon,  6 Oct 2008 20:31:53 -0500 (CDT)
From: Matthew D. Fuller <fullermd@over-yonder.net>
Reply-To: Matthew D. Fuller <fullermd@over-yonder.net>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] readdir(3) error documentation
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         127908
>Category:       docs
>Synopsis:       [patch] readdir(3) error documentation
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    eadler
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Oct 07 01:40:01 UTC 2008
>Closed-Date:    Fri Feb 17 01:21:39 UTC 2012
>Last-Modified:  Fri Feb 17 01:21:39 UTC 2012
>Originator:     Matthew D. Fuller
>Release:        FreeBSD 7.0-BETA4 i386
>Organization:
>Environment:
System: FreeBSD draco.over-yonder.net 7.0-BETA4 FreeBSD 7.0-BETA4 #0: Sun Dec 9 18:37:58 CST 2007 root@draco.over-yonder.net:/bsd/obj/bsd/src/sys/DRACO i386


	
>Description:
	The manpage for readdir(3) doesn't document the possible error
	returns.  The only mention it makes in fact is misleading, since it
	doesn't describe something that can happen.

	The rest of the functions really should have their errno values
	documented as well, probably with the addition of a ERRORS section to
	the manpage.  But this patch gets one step closer, anyway.

>How-To-Repeat:
	
>Fix:


Index: directory.3
===================================================================
RCS file: /usr/cvs/src/lib/libc/gen/directory.3,v
retrieving revision 1.17
diff -u -r1.17 directory.3
--- directory.3	16 Apr 2008 18:59:36 -0000	1.17
+++ directory.3	7 Oct 2008 01:26:30 -0000
@@ -122,9 +122,12 @@
 returns a pointer to the next directory entry.
 It returns
 .Dv NULL
-upon reaching the end of the directory or detecting an invalid
-.Fn seekdir
-operation.
+upon reaching the end of the directory or on error.
+In the event of an error,
+.Va errno
+may be set to any of the values documented for the
+.Xr getdirentries 2
+system call.
 .Pp
 The
 .Fn readdir_r

>Release-Note:
>Audit-Trail:

From: "Matthew D. Fuller" <fullermd@over-yonder.net>
To: FreeBSD-gnats-submit@FreeBSD.org
Cc:  
Subject: Re: docs/127908: [PATCH] readdir(3) error documentation
Date: Sat, 9 Oct 2010 05:09:18 -0500

 > >Arrival-Date:   Tue Oct 07 01:40:01 UTC 2008
 
 In celebration of the 2 year anniversary of this 6-line manpage patch
 a couple days ago, can somebody take a quick look at it?  The code
 still seems to support the change...
 
 
 -- 
 Matthew Fuller     (MF4839)   |  fullermd@over-yonder.net
 Systems/Network Administrator |  http://www.over-yonder.net/~fullermd/
            On the Internet, nobody can hear you scream.
Responsible-Changed-From-To: freebsd-doc->eadler 
Responsible-Changed-By: eadler 
Responsible-Changed-When: Wed Jan 18 13:12:37 UTC 2012 
Responsible-Changed-Why:  
I'll take it. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/127908: commit references a PR
Date: Thu,  9 Feb 2012 20:49:15 +0000 (UTC)

 Author: eadler
 Date: Thu Feb  9 20:49:03 2012
 New Revision: 231299
 URL: http://svn.freebsd.org/changeset/base/231299
 
 Log:
   More accurately document what happens on error.
   
   PR:		docs/127908
   Submitted by:	Matthew D. Fuller <fullermd@over-yonder.net>
   Approved by:	cperciva
   MFC after:	1 week
 
 Modified:
   head/lib/libc/gen/directory.3
 
 Modified: head/lib/libc/gen/directory.3
 ==============================================================================
 --- head/lib/libc/gen/directory.3	Thu Feb  9 20:44:20 2012	(r231298)
 +++ head/lib/libc/gen/directory.3	Thu Feb  9 20:49:03 2012	(r231299)
 @@ -122,9 +122,12 @@ function
  returns a pointer to the next directory entry.
  It returns
  .Dv NULL
 -upon reaching the end of the directory or detecting an invalid
 -.Fn seekdir
 -operation.
 +upon reaching the end of the directory or on error.
 +In the event of an error,
 +.Va errno
 +may be set to any of the values documented for the
 +.Xr getdirentries 2
 +system call.
  .Pp
  The
  .Fn readdir_r
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->patched 
State-Changed-By: eadler 
State-Changed-When: Thu Feb 9 20:54:15 UTC 2012 
State-Changed-Why:  
committed in r231299 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/127908: commit references a PR
Date: Fri, 17 Feb 2012 00:55:36 +0000 (UTC)

 Author: eadler
 Date: Fri Feb 17 00:55:26 2012
 New Revision: 231847
 URL: http://svn.freebsd.org/changeset/base/231847
 
 Log:
   MFC r231299:
   	 - More accurately document what happens on error.
   
   PR:		docs/127908
   Approved by:	cperciva
 
 Modified:
   stable/9/lib/libc/gen/directory.3
 Directory Properties:
   stable/9/lib/libc/   (props changed)
 
 Modified: stable/9/lib/libc/gen/directory.3
 ==============================================================================
 --- stable/9/lib/libc/gen/directory.3	Fri Feb 17 00:27:48 2012	(r231846)
 +++ stable/9/lib/libc/gen/directory.3	Fri Feb 17 00:55:26 2012	(r231847)
 @@ -122,9 +122,12 @@ function
  returns a pointer to the next directory entry.
  It returns
  .Dv NULL
 -upon reaching the end of the directory or detecting an invalid
 -.Fn seekdir
 -operation.
 +upon reaching the end of the directory or on error.
 +In the event of an error,
 +.Va errno
 +may be set to any of the values documented for the
 +.Xr getdirentries 2
 +system call.
  .Pp
  The
  .Fn readdir_r
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/127908: commit references a PR
Date: Fri, 17 Feb 2012 00:56:27 +0000 (UTC)

 Author: eadler
 Date: Fri Feb 17 00:56:17 2012
 New Revision: 231848
 URL: http://svn.freebsd.org/changeset/base/231848
 
 Log:
   MFC r231299:
   	 - More accurately document what happens on error.
   
   PR:		docs/127908
   Approved by:	cperciva
 
 Modified:
   stable/7/lib/libc/gen/directory.3
 Directory Properties:
   stable/7/lib/libc/   (props changed)
 
 Modified: stable/7/lib/libc/gen/directory.3
 ==============================================================================
 --- stable/7/lib/libc/gen/directory.3	Fri Feb 17 00:55:26 2012	(r231847)
 +++ stable/7/lib/libc/gen/directory.3	Fri Feb 17 00:56:17 2012	(r231848)
 @@ -122,9 +122,12 @@ function
  returns a pointer to the next directory entry.
  It returns
  .Dv NULL
 -upon reaching the end of the directory or detecting an invalid
 -.Fn seekdir
 -operation.
 +upon reaching the end of the directory or on error.
 +In the event of an error,
 +.Va errno
 +may be set to any of the values documented for the
 +.Xr getdirentries 2
 +system call.
  .Pp
  The
  .Fn readdir_r
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: eadler 
State-Changed-When: Fri Feb 17 01:21:38 UTC 2012 
State-Changed-Why:  
Committed. Thanks! 

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