summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authoreadler <eadler@FreeBSD.org>2012-02-09 20:49:03 +0000
committereadler <eadler@FreeBSD.org>2012-02-09 20:49:03 +0000
commit142a56c477c42800741ac2d5fab9b09558f09bbb (patch)
treecb7dd138cb1bc2196359bd7ccbb0bdedaeeb8edc /lib
parentafb7bb20cb3b86b1d92307b78f8dc5bc64f0425a (diff)
downloadFreeBSD-src-142a56c477c42800741ac2d5fab9b09558f09bbb.zip
FreeBSD-src-142a56c477c42800741ac2d5fab9b09558f09bbb.tar.gz
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
Diffstat (limited to 'lib')
-rw-r--r--lib/libc/gen/directory.39
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/libc/gen/directory.3 b/lib/libc/gen/directory.3
index 992d2fc..1c568fc 100644
--- a/lib/libc/gen/directory.3
+++ b/lib/libc/gen/directory.3
@@ -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
OpenPOWER on IntegriCloud