xnu-6153.11.26.tar.gz

[apple/xnu.git] / bsd / man / man2 / getdirentries.2

diff --git a/bsd/man/man2/getdirentries.2 b/bsd/man/man2/getdirentries.2
index a513ea8e879eb3994c9abec0f1bb65d98e3c1337..f465c57901a8f9248743d9ef80f8fe3835f58205 100644 (file)
--- a/bsd/man/man2/getdirentries.2
+++ b/bsd/man/man2/getdirentries.2
@@ -46,7 +46,7 @@
 .Ft int
 .Fn getdirentries "int fd" "char *buf" "int nbytes" "long *basep"
 .Sh DESCRIPTION
-.Fn Getdirentries
+.Fn getdirentries
 reads directory entries from the directory
 referenced by the file descriptor
 .Fa fd
@@ -68,7 +68,11 @@ with buffers smaller than this size.
 The data in the buffer is a series of
 .Em dirent
 structures (see
-.Xr dir 5 )
+.Xr dir 5)
+The order of the directory entries vended out via 
+.Fn getdirentries
+is not specified. Some filesystems may return entries in lexicographic sort order
+and others may not. 
 .Pp
 The
 .Fa d_fileno
@@ -129,7 +133,7 @@ The pointer may not advance by the number of bytes returned by
 A value of zero is returned when
 the end of the directory has been reached.
 .Pp
-.Fn Getdirentries
+.Fn getdirentries
 writes the position of the block read into the location pointed to by
 .Fa basep .
 Alternatively, the current position pointer may be set and retrieved by
@@ -171,7 +175,7 @@ Otherwise, -1 is returned and the global variable
 .Va errno
 is set to indicate the error.
 .Sh ERRORS
-.Fn Getdirentries
+.Fn getdirentries
 will fail if:
 .Bl -tag -width Er
 .It Bq Er EBADF