diff options
Diffstat (limited to 'lib/libc/gen/directory.3')
-rw-r--r-- | lib/libc/gen/directory.3 | 51 |
1 files changed, 4 insertions, 47 deletions
diff --git a/lib/libc/gen/directory.3 b/lib/libc/gen/directory.3 index 263dfdd6eb95..a92d51980aab 100644 --- a/lib/libc/gen/directory.3 +++ b/lib/libc/gen/directory.3 @@ -25,14 +25,13 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd August 1, 2020 +.Dd September 5, 2025 .Dt DIRECTORY 3 .Os .Sh NAME .Nm opendir , .Nm fdopendir , .Nm readdir , -.Nm readdir_r , .Nm telldir , .Nm seekdir , .Nm rewinddir , @@ -50,8 +49,6 @@ .Fn fdopendir "int fd" .Ft struct dirent * .Fn readdir "DIR *dirp" -.Ft int -.Fn readdir_r "DIR *dirp" "struct dirent *entry" "struct dirent **result" .Ft long .Fn telldir "DIR *dirp" .Ft void @@ -65,15 +62,6 @@ .Ft int .Fn dirfd "DIR *dirp" .Sh DESCRIPTION -.Bf -symbolic -The -.Fn readdir_r -interface is deprecated -because it cannot be used correctly unless -.Brq Va NAME_MAX -is a fixed value. -.Ef -.Pp The .Fn opendir function @@ -112,7 +100,6 @@ or to modify the state of the associated description other than by means of .Fn closedir , .Fn readdir , -.Fn readdir_r , or .Fn rewinddir , the behavior is undefined. @@ -144,34 +131,6 @@ may be set to any of the values documented for the system call. .Pp The -.Fn readdir_r -function -provides the same functionality as -.Fn readdir , -but the caller must provide a directory -.Fa entry -buffer to store the results in. -The buffer must be large enough for a -.Vt struct dirent -with a -.Va d_name -array with -.Brq Va NAME_MAX -+ 1 elements. -If the read succeeds, -.Fa result -is pointed at the -.Fa entry ; -upon reaching the end of the directory -.Fa result -is set to -.Dv NULL . -The -.Fn readdir_r -function -returns 0 on success or an error number to indicate failure. -.Pp -The .Fn telldir function returns a token representing the current location associated with the named @@ -305,9 +264,7 @@ is not associated with a directory. .Pp The .Fn readdir -and -.Fn readdir_r -functions may also fail and set +function may also fail and set .Va errno for any of the errors specified for the routine .Xr getdents 2 . @@ -338,7 +295,6 @@ The .Fn fdopendir , .Fn opendir , .Fn readdir , -.Fn readdir_r , .Fn rewinddir , .Fn seekdir and @@ -391,7 +347,8 @@ will always set the correct location to return the same value as that last .Fn readdir performed. This is enough for some applications which want to -"push back the last entry read", e.g., Samba. +.Dq push back the last entry read , +e.g. Samba. Seeks back to any other location, other than the beginning of the directory, may result in unexpected behaviour if deletes are present. |