summaryrefslogtreecommitdiffstats
path: root/share/man/man9/vfs_busy.9
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-07-11 10:31:49 +0000
committerru <ru@FreeBSD.org>2001-07-11 10:31:49 +0000
commit6468798b098d2713b5746101dc5f3e3d0798ecf8 (patch)
treea9efe8598802d472399b0cdf05f3614f98de1649 /share/man/man9/vfs_busy.9
parenta6a8d8e94c3416ac2be5564086b6711fab5cf1fb (diff)
downloadFreeBSD-src-6468798b098d2713b5746101dc5f3e3d0798ecf8.zip
FreeBSD-src-6468798b098d2713b5746101dc5f3e3d0798ecf8.tar.gz
mdoc(7) police: fixed markup and some content typos.
Diffstat (limited to 'share/man/man9/vfs_busy.9')
-rw-r--r--share/man/man9/vfs_busy.975
1 files changed, 49 insertions, 26 deletions
diff --git a/share/man/man9/vfs_busy.9 b/share/man/man9/vfs_busy.9
index 9427b77..b715b19 100644
--- a/share/man/man9/vfs_busy.9
+++ b/share/man/man9/vfs_busy.9
@@ -31,47 +31,70 @@
.Os
.Sh NAME
.Nm vfs_busy
-.Nd "Marks a mount point as busy."
+.Nd "marks a mount point as busy"
.Sh SYNOPSIS
-.Fd #include <sys/param.h>
-.Fd #include <sys/mount.h>
+.In sys/param.h
+.In sys/mount.h
.Ft int
.Fn vfs_busy "struct mount *mp" "int flags" "struct mtx *interlkp" "struct proc *p"
.Sh DESCRIPTION
The
-.Nm
-function marks a mount point as busy. The purpose of this
-function is to synchronize access to a mount point. It also
-delays unmounting by sleeping on mp if the MNTK_UNMOUNT flag
-is set in mp->mnt_kern_flag and the LK_NOWAIT flag is NOT set.
+.Fn vfs_busy
+function marks a mount point as busy.
+The purpose of this
+function is to synchronize access to a mount point.
+It also delays unmounting by sleeping on mp if the
+.Dv MNTK_UNMOUNT
+flag is set in
+.Fa mp->mnt_kern_flag
+and the
+.Dv LK_NOWAIT
+flag is
+.Em not
+set.
.Pp
Its arguments are:
-.Bl -tag -width interlkp
-.It Ar mp
+.Bl -tag -xwidth ".Fa interlkp"
+.It Fa mp
The mount point to busy.
-.It Ar flags
+.It Fa flags
Flags controlling the operation of
-.Nm
-.
-.Pp
-LK_NOWAIT - do not sleep if MNTK_UNMOUNT is set.
-.It Ar interlkp
-The interlock mutex for mp->mount_lock. If there is any chance
-the mount point is being unmounted and LK_NOWAIT is not set then
+.Fn vfs_busy .
+.Bl -tag -xwidth ".Dv LK_NOWAIT"
+.It Dv LK_NOWAIT
+do not sleep if
+.Dv MNTK_UNMOUNT
+is set.
+.El
+.It Fa interlkp
+The interlock mutex for
+.Fa mp->mount_lock .
+If there is any chance
+the mount point is being unmounted and
+.Dv LK_NOWAIT
+is not set then
interlock must be valid locked mutex.
-.It Ar p
+.It Fa p
The process responsible for this call.
.El
.Sh LOCKS
-If interlkp is a valid pointer it must be locked on entry,
+If
+.Fa interlkp
+is a valid pointer it must be locked on entry,
and it will not be unlocked even on error.
.Sh RETURN VALUES
-A 0 value is returned on success. If the mount point is being
-unmounted ENOENT will always be returned.
+A 0 value is returned on success.
+If the mount point is being
+unmounted
+.Er ENOENT
+will always be returned.
.Sh ERRORS
-.Bl -tag
-.It Bq ENOENT
-The mount point is being unmounted (MNTK_UNMOUNT is set).
+.Bl -tag -width Er
+.It Bq Er ENOENT
+The mount point is being unmounted
+.Dv ( MNTK_UNMOUNT
+is set).
.El
.Sh AUTHORS
-This man page was written by Chad David.
+This man page was written by
+.An Chad David .
OpenPOWER on IntegriCloud