summaryrefslogtreecommitdiffstats
path: root/share/man/man9/vfs_getvfs.9
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-12-14 09:11:13 +0000
committerru <ru@FreeBSD.org>2001-12-14 09:11:13 +0000
commit5cbdc3fd68f69652ae7680ccce867f54dcfeddd7 (patch)
tree61ed68fe6d5c7568f5fc0295ecebad6da8de3536 /share/man/man9/vfs_getvfs.9
parent1e98a2bc17719c5f5e790cc6121376192638812b (diff)
downloadFreeBSD-src-5cbdc3fd68f69652ae7680ccce867f54dcfeddd7.zip
FreeBSD-src-5cbdc3fd68f69652ae7680ccce867f54dcfeddd7.tar.gz
mdoc(7) police: markup, grammar and spelling nits.
Reviewed by: davidc
Diffstat (limited to 'share/man/man9/vfs_getvfs.9')
-rw-r--r--share/man/man9/vfs_getvfs.927
1 files changed, 16 insertions, 11 deletions
diff --git a/share/man/man9/vfs_getvfs.9 b/share/man/man9/vfs_getvfs.9
index 273d3c9..664470c 100644
--- a/share/man/man9/vfs_getvfs.9
+++ b/share/man/man9/vfs_getvfs.9
@@ -31,42 +31,47 @@
.Os
.Sh NAME
.Nm vfs_getvfs
-.Nd "returns a mount point given its fsid"
+.Nd "returns a mount point given its filesystem identifier"
.Sh SYNOPSIS
.In sys/param.h
.In sys/mount.h
-.Ft struct mount *
+.Ft "struct mount *"
.Fn vfs_getvfs "fsid_t *fsid"
.Sh DESCRIPTION
The
.Fn vfs_getvfs
function returns the mount point structure for a filesystem given its filesystem
-identifier. The filesystem id should have been allocated by calling
-.Fn vfs_getnewfsid ;
+identifier.
+The filesystem ID should have been allocated by calling
+.Xr vfs_getnewfsid 9 ;
otherwise, it will not be found.
.Pp
A major user of
.Fn vfs_getvfs
-is NFS, which uses the fsid as part of file handles in order to determine the
+is NFS, which uses the
+.Vt fsid
+as part of file handles in order to determine the
filesystem a given RPC is for.
If
.Fn vfs_getvfs
fails to find the mount point related to
-.Fa fsid
+.Fa fsid ,
the filesystem is considered stale.
.Sh RETURN VALUES
If
.Fa fsid
-is found the mount point for the id is returned; otherwise,
+is found, the mount point for the ID is returned; otherwise,
.Dv NULL
is returned.
.Sh PSEUDOCODE
.Bd -literal
- if ((mp = vfs_getvfs(&fhp->fh_fsid)) == NULL) {
- error = ESTALE;
- goto out;
- }
+if ((mp = vfs_getvfs(&fhp->fh_fsid)) == NULL) {
+ error = ESTALE;
+ goto out;
+}
.Ed
+.Sh SEE ALSO
+.Xr vfs_getnewfsid 9
.Sh AUTHORS
This man page was written by
.An Chad David Aq davidc@acns.ab.ca .
OpenPOWER on IntegriCloud