summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorphk <phk@FreeBSD.org>2005-03-14 15:38:34 +0000
committerphk <phk@FreeBSD.org>2005-03-14 15:38:34 +0000
commit50400e94bb7651dd75c90c26b869fb648ab4f5b4 (patch)
tree82e6daada4d49e2f2ca7c0eeae74456b83b6468d
parentddc0cb6817f86bd4f73d449193a4e250936085b4 (diff)
downloadFreeBSD-src-50400e94bb7651dd75c90c26b869fb648ab4f5b4.zip
FreeBSD-src-50400e94bb7651dd75c90c26b869fb648ab4f5b4.tar.gz
Mangle a manpage.
-rw-r--r--share/man/man9/VFS_VGET.923
1 files changed, 13 insertions, 10 deletions
diff --git a/share/man/man9/VFS_VGET.9 b/share/man/man9/VFS_VGET.9
index 4a4ce97..ae545e6 100644
--- a/share/man/man9/VFS_VGET.9
+++ b/share/man/man9/VFS_VGET.9
@@ -43,30 +43,33 @@
.Sh DESCRIPTION
The
.Fn VFS_VGET
-macro converts an inode number into a locked vnode.
+looks up or creates a vnode from a (mount, inode#) tupple.
.Pp
Its arguments are:
.Bl -tag -width ".Fa flags"
.It Fa mp
-The file system.
+The mountpoint.
.It Fa ino
The inode representing the file.
+This is a unique number assigned by the filesystem when vnodes are first
+created.
.It Fa flags
-Additional locking flags to pass through.
+Additional locking flags to pass through to
+.Xr vget 9
.It Fa vpp
Return parameter for the vnode.
.El
.Pp
-This is an optional file system entry-point for file systems which have a
-unique id number for every file in the file system.
-It is used
-internally by the UFS file system and also by the NFSv3 server to
-implement the
-.Dv READDIRPLUS
-nfs call.
+This is an optional file system entry-point for file systems mainly
+intended for NFS server use, but many filesystems
+use it internally in
+.Xr VOP_LOOKUP 9
+and similar.
.Pp
If the file system does not support this call, then it should return
.Er EOPNOTSUPP .
+.Pp
+Please see sys/ufs/ffs/ffs_vfsops.c::ffs_vget() for the canonical example.
.Sh SEE ALSO
.Xr VFS 9 ,
.Xr vget 9 ,
OpenPOWER on IntegriCloud