svn commit: r347032 - head/lib/libc/gen

[Alan Somers]

Author: asomers
Date: Thu May  2 19:59:37 2019
New Revision: 347032
URL: https://svnweb.freebsd.org/changeset/base/347032

Log:
  directory.3: add a STANDARDS section
  
  Reviewed by:	jilles, ngie
  MFC after:	2 weeks
  Sponsored by:	The FreeBSD Foundation
  Differential Revision:	https://reviews.freebsd.org/D20111

Modified:
  head/lib/libc/gen/directory.3

Modified: head/lib/libc/gen/directory.3
==============================================================================
--- head/lib/libc/gen/directory.3	Thu May  2 19:13:31 2019	(r347031)
+++ head/lib/libc/gen/directory.3	Thu May  2 19:59:37 2019	(r347032)
@@ -28,7 +28,7 @@
 .\"     @(#)directory.3	8.1 (Berkeley) 6/4/93
 .\" $FreeBSD$
 .\"
-.Dd May 22, 2017
+.Dd April 30, 2019
 .Dt DIRECTORY 3
 .Os
 .Sh NAME
@@ -264,6 +264,30 @@ return (NOT_FOUND);
 .Xr open 2 ,
 .Xr read 2 ,
 .Xr dir 5
+.Sh STANDARDS
+The
+.Fn closedir ,
+.Fn dirfd ,
+.Fn fdopendir ,
+.Fn opendir ,
+.Fn readdir ,
+.Fn readdir_r ,
+.Fn rewinddir ,
+.Fn seekdir
+and
+.Fn telldir
+functions are expected to conform to
+.St -p1003.1-2008 .
+The
+.Fn fdclosedir
+function and the
+.Fa d_off ,
+.Fa d_reclen
+and
+.Fa d_type
+fields of
+.Vt struct dirent
+are non-standard, and should not be used in portable programs.
 .Sh HISTORY
 The
 .Fn opendir ,