summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbrooks <brooks@FreeBSD.org>2012-07-05 17:02:20 +0000
committerbrooks <brooks@FreeBSD.org>2012-07-05 17:02:20 +0000
commitcb94d55db1288d2a92d7b4edfdc96bccbc64cebc (patch)
tree87c05e43bf4d424b5f7d3aa4b12271acacffb630
parentae58a8f50f8af74da19de7ae43a62cdc57425d77 (diff)
downloadFreeBSD-src-cb94d55db1288d2a92d7b4edfdc96bccbc64cebc.zip
FreeBSD-src-cb94d55db1288d2a92d7b4edfdc96bccbc64cebc.tar.gz
Document the behavior (from 4.4-lite) that tokens returned by telldir() are
single use. Sponsored by: DARPA, AFRL MFC after: 3 days
-rw-r--r--lib/libc/gen/directory.317
1 files changed, 15 insertions, 2 deletions
diff --git a/lib/libc/gen/directory.3 b/lib/libc/gen/directory.3
index 1c568fc..0fd5bba 100644
--- a/lib/libc/gen/directory.3
+++ b/lib/libc/gen/directory.3
@@ -28,7 +28,7 @@
.\" @(#)directory.3 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
-.Dd April 16, 2008
+.Dd July 5, 2012
.Dt DIRECTORY 3
.Os
.Sh NAME
@@ -153,7 +153,7 @@ returns 0 on success or an error number to indicate failure.
The
.Fn telldir
function
-returns the current location associated with the named
+returns a token representing the current location associated with the named
.Em directory stream .
Values returned by
.Fn telldir
@@ -179,6 +179,13 @@ The new position reverts to the one associated with the
when the
.Fn telldir
operation was performed.
+State associated with the token returned by
+.Fn telldir is freed when it is passed to
+.Fn seekdir .
+If you wish return to the same location again,
+then you must create a new token with another
+.Fn telldir
+call.
.Pp
The
.Fn rewinddir
@@ -245,3 +252,9 @@ The
.Fn fdopendir
function appeared in
.Fx 8.0 .
+.Sh BUGS
+The invalidation of
+.Fn telldir
+tokens when calling
+.Fn seekdir
+is non-standard.
OpenPOWER on IntegriCloud