Add a note that the "whiteout inode", DT_WHT, is an implementation detail

and should not be seen in normal user applications.
This commit is contained in:
jruoho 2010-05-16 08:56:17 +00:00
parent fb6ead4add
commit 120678dcc8
1 changed files with 10 additions and 11 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: dir.5,v 1.23 2010/05/15 15:38:41 jruoho Exp $ .\" $NetBSD: dir.5,v 1.24 2010/05/16 08:56:17 jruoho Exp $
.\" .\"
.\" Copyright (c) 1983, 1991, 1993 .\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved. .\" The Regents of the University of California. All rights reserved.
@ -29,7 +29,7 @@
.\" .\"
.\" @(#)dir.5 8.3 (Berkeley) 4/19/94 .\" @(#)dir.5 8.3 (Berkeley) 4/19/94
.\" .\"
.Dd May 15, 2010 .Dd May 16, 2010
.Dt DIRENT 5 .Dt DIRENT 5
.Os .Os
.Sh NAME .Sh NAME
@ -147,6 +147,11 @@ domain socket
dummy dummy
.Dq whiteout inode .Dq whiteout inode
.El .El
.Pp
The
.Dv DT_WHT
type is internal to the implementation and
should not be seen in user applications.
.It .It
The The
.Fa d_name .Fa d_name
@ -181,6 +186,9 @@ operator.
.Xr fs 5 , .Xr fs 5 ,
.Xr inode 5 .Xr inode 5
.\" .Sh STANDARDS .\" .Sh STANDARDS
.\"
.\" XXX: Conformance is unclear, cf. PR lib/43310.
.\"
.\" Given the noted limitations, the .\" Given the noted limitations, the
.\".In dirent.h .\".In dirent.h
.\" header conforms to .\" header conforms to
@ -193,12 +201,3 @@ The
.Em dirent .Em dirent
structure appeared in structure appeared in
.Nx 1.3 . .Nx 1.3 .
.\"
.\" XXX: Unclear, cf. PR lib/43310.
.\"
.\" .Sh BUGS
.\" The
.\" .Nx
.\" implementation uses a statically allocated buffer for the
.\" .Va d_name
.\" entry.