From b1b785b27d0780759d6e9e67322e9fb3e16bf39f Mon Sep 17 00:00:00 2001 From: Poul-Henning Kamp Date: Mon, 14 Mar 2005 15:38:34 +0000 Subject: [PATCH] Mangle a manpage. --- share/man/man9/VFS_VGET.9 | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/share/man/man9/VFS_VGET.9 b/share/man/man9/VFS_VGET.9 index 4a4ce97d0983..ae545e607358 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 ,