summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-07-13 08:14:54 +0000
committerru <ru@FreeBSD.org>2001-07-13 08:14:54 +0000
commitebc943289bbbaf44b5f7581e9bb569a3fe9cbe82 (patch)
tree17cffa64cee9360f6e973369ec9da47fd2d5c272 /share/man
parent7ae8ee33fd00797bbcf398316a3f39724894c486 (diff)
downloadFreeBSD-src-ebc943289bbbaf44b5f7581e9bb569a3fe9cbe82.zip
FreeBSD-src-ebc943289bbbaf44b5f7581e9bb569a3fe9cbe82.tar.gz
Merge Chad's fixes.
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/BUF_LOCK.92
-rw-r--r--share/man/man9/BUF_LOCKFREE.94
-rw-r--r--share/man/man9/BUF_LOCKINIT.92
-rw-r--r--share/man/man9/BUF_REFCNT.96
-rw-r--r--share/man/man9/BUF_TIMELOCK.96
-rw-r--r--share/man/man9/BUF_UNLOCK.92
-rw-r--r--share/man/man9/cdevsw_add.92
-rw-r--r--share/man/man9/cdevsw_remove.92
-rw-r--r--share/man/man9/devsw.911
-rw-r--r--share/man/man9/lockcount.92
-rw-r--r--share/man/man9/lockdestroy.96
-rw-r--r--share/man/man9/lockmgr.94
-rw-r--r--share/man/man9/lockmgr_printinfo.92
-rw-r--r--share/man/man9/lockstatus.92
-rw-r--r--share/man/man9/vfs_busy.913
-rw-r--r--share/man/man9/vfs_mount.913
-rw-r--r--share/man/man9/vfs_unbusy.94
-rw-r--r--share/man/man9/vinvalbuf.97
-rw-r--r--share/man/man9/vn_isdisk.916
19 files changed, 60 insertions, 46 deletions
diff --git a/share/man/man9/BUF_LOCK.9 b/share/man/man9/BUF_LOCK.9
index 9cb929b..6686ba4 100644
--- a/share/man/man9/BUF_LOCK.9
+++ b/share/man/man9/BUF_LOCK.9
@@ -69,4 +69,4 @@ information on non-zero return values.
.Xr lockmgr 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/BUF_LOCKFREE.9 b/share/man/man9/BUF_LOCKFREE.9
index 62b0848..423d25d 100644
--- a/share/man/man9/BUF_LOCKFREE.9
+++ b/share/man/man9/BUF_LOCKFREE.9
@@ -31,7 +31,7 @@
.Os
.Sh NAME
.Nm BUF_LOCKFREE
-.Nd "destroys the buffers lock"
+.Nd "destroys a buffer's lock"
.Sh SYNOPSIS
.In sys/param.h
.In sys/buf.h
@@ -57,4 +57,4 @@ The buffer whose lock is to be destroyed.
.Xr lockdestroy 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/BUF_LOCKINIT.9 b/share/man/man9/BUF_LOCKINIT.9
index 0c61559..a5f388c 100644
--- a/share/man/man9/BUF_LOCKINIT.9
+++ b/share/man/man9/BUF_LOCKINIT.9
@@ -56,4 +56,4 @@ The buffer whose lock it to be initialized.
.Xr lockmgr 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/BUF_REFCNT.9 b/share/man/man9/BUF_REFCNT.9
index 9794f8c..7a6aea8 100644
--- a/share/man/man9/BUF_REFCNT.9
+++ b/share/man/man9/BUF_REFCNT.9
@@ -31,7 +31,7 @@
.Os
.Sh NAME
.Nm BUF_REFCNT
-.Nd "returns the reference count of the buffer lock"
+.Nd "returns the reference count on a buffer's lock"
.Sh SYNOPSIS
.In sys/param.h
.In sys/buf.h
@@ -40,7 +40,7 @@
.Sh DESCRIPTION
The
.Fn BUF_REFCNT
-function returns the reference count of the buffer lock.
+function returns the reference count on a buffer's lock.
.Pp
Its argument is:
.Bl -tag -xwidth ".Fa bp"
@@ -55,4 +55,4 @@ The buffer whose lock reference count is to be returned.
.Xr lockcount 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/BUF_TIMELOCK.9 b/share/man/man9/BUF_TIMELOCK.9
index cb029ee..8fcba58 100644
--- a/share/man/man9/BUF_TIMELOCK.9
+++ b/share/man/man9/BUF_TIMELOCK.9
@@ -45,7 +45,7 @@ will sleep to
.Fa timo
and OR's
.Fa catch
-into the sleep priority.
+into the sleep's priority.
.Fa wmesg
is the wmesg used in the sleep.
.Pp
@@ -61,7 +61,7 @@ for details.
.It Fa wmesg
The wmesg used in any sleeps while aquiring the lock.
.It Fa catch
-Priority OR'd into the sleep priority.
+Priority OR'd into the sleep's priority.
.It Fa timo
The timeout for any sleeps encountered during the lock.
.El
@@ -77,4 +77,4 @@ for details on non-zero return values.
.Xr lockmgr 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/BUF_UNLOCK.9 b/share/man/man9/BUF_UNLOCK.9
index 2dad9d1..500e1ab 100644
--- a/share/man/man9/BUF_UNLOCK.9
+++ b/share/man/man9/BUF_UNLOCK.9
@@ -58,4 +58,4 @@ The buffer must already be locked.
.Xr lockmgr 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/cdevsw_add.9 b/share/man/man9/cdevsw_add.9
index 1a09a7f..2c2b520 100644
--- a/share/man/man9/cdevsw_add.9
+++ b/share/man/man9/cdevsw_add.9
@@ -62,4 +62,4 @@ is returned
indicating that the major number is not in the valid range.
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/cdevsw_remove.9 b/share/man/man9/cdevsw_remove.9
index 969f44b..deed55e 100644
--- a/share/man/man9/cdevsw_remove.9
+++ b/share/man/man9/cdevsw_remove.9
@@ -62,4 +62,4 @@ is returned
indicating that the major number is not in the valid range.
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/devsw.9 b/share/man/man9/devsw.9
index a697dab..d2e23a9 100644
--- a/share/man/man9/devsw.9
+++ b/share/man/man9/devsw.9
@@ -31,7 +31,9 @@
.Os
.Sh NAME
.Nm devsw
-.Nd "checks if the vnode represents a disk"
+.Nd returns the
+.Vt cdevsw
+structure
.Sh SYNOPSIS
.In sys/conf.h
.Ft "struct cdevsw *"
@@ -63,6 +65,11 @@ entry should be returned.
A pointer to a
.Vt cdevsw
structure.
+.Sh SEE ALSO
+.Xr major 9 ,
+.Xr minor 9 ,
+.Xr umajor 9 ,
+.Xr uminor 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/lockcount.9 b/share/man/man9/lockcount.9
index 4c3d624..b51ad53 100644
--- a/share/man/man9/lockcount.9
+++ b/share/man/man9/lockcount.9
@@ -58,4 +58,4 @@ An integer greater than or equal to zero.
.Xr lockstatus 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/lockdestroy.9 b/share/man/man9/lockdestroy.9
index 70f7c8e..5142f26 100644
--- a/share/man/man9/lockdestroy.9
+++ b/share/man/man9/lockdestroy.9
@@ -43,10 +43,10 @@ The
function destroys the given lock.
(Currently is does nothing!)
.Pp
-Its arguments are:
+Its argument is:
.Bl -tag -xwidth ".Fa lkp"
.It Fa lkp
-The lock to destroy
+The lock to destroy.
.El
.Sh SEE ALSO
.Xr lockcount 9 ,
@@ -55,4 +55,4 @@ The lock to destroy
.Xr lockstatus 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/lockmgr.9 b/share/man/man9/lockmgr.9
index 7d5ca4b..e3a942d 100644
--- a/share/man/man9/lockmgr.9
+++ b/share/man/man9/lockmgr.9
@@ -86,7 +86,7 @@ Waits for all activity on the lock to end, and then marks it decommissioned.
This is used before freeing a lock that is part of a piece of memory that is about to
be freed.
(As documented in
-.Pa lockmgr.h . )
+.Pa sys/lockmgr.h . )
.It Dv LK_SLEEPFAIL
If we had to sleep for the lock then fail.
.It Dv LK_NOWAIT
@@ -152,4 +152,4 @@ was set and we slept.
.Xr mutex 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/lockmgr_printinfo.9 b/share/man/man9/lockmgr_printinfo.9
index 9027daf..4bb72f8 100644
--- a/share/man/man9/lockmgr_printinfo.9
+++ b/share/man/man9/lockmgr_printinfo.9
@@ -57,4 +57,4 @@ This function seems to only exist for debugging purposes.
.Xr lockstatus 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/lockstatus.9 b/share/man/man9/lockstatus.9
index 436c907..a6d5e4c 100644
--- a/share/man/man9/lockstatus.9
+++ b/share/man/man9/lockstatus.9
@@ -80,4 +80,4 @@ The lock is not held by anyone.
.Xr lockmgr_printinfo 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/vfs_busy.9 b/share/man/man9/vfs_busy.9
index b715b19..c04071d 100644
--- a/share/man/man9/vfs_busy.9
+++ b/share/man/man9/vfs_busy.9
@@ -43,7 +43,9 @@ The
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
+It also delays unmounting by sleeping on
+.Fa mp
+if the
.Dv MNTK_UNMOUNT
flag is set in
.Fa mp->mnt_kern_flag
@@ -58,8 +60,9 @@ Its arguments are:
.It Fa mp
The mount point to busy.
.It Fa flags
-Flags controlling the operation of
-.Fn vfs_busy .
+Flags controlling how
+.Fn vfs_busy
+should act.
.Bl -tag -xwidth ".Dv LK_NOWAIT"
.It Dv LK_NOWAIT
do not sleep if
@@ -81,7 +84,7 @@ The process responsible for this call.
If
.Fa interlkp
is a valid pointer it must be locked on entry,
-and it will not be unlocked even on error.
+and it will not be unlocked even in the case of an error.
.Sh RETURN VALUES
A 0 value is returned on success.
If the mount point is being
@@ -97,4 +100,4 @@ is set).
.El
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/vfs_mount.9 b/share/man/man9/vfs_mount.9
index bb76ef4..7e7ee4e 100644
--- a/share/man/man9/vfs_mount.9
+++ b/share/man/man9/vfs_mount.9
@@ -67,13 +67,13 @@ for details.
.Dv MNT_EXPORTED , MNT_NOSUID , MNT_NODEV , MNT_UPDATE , MNT_RELOAD ,
.Dv MNT_FORCE , MNT_ASYNC , MNT_SYNCHRONOUS , MNT_UNION , MNT_NOATIME ,
.Dv MNT_SNAPSHOT , MNT_NOCLUSTERR , MNT_NOCLUSTERW , MNT_IGNORE ,
-.Dv MNT_UNION , MNT_NOSYMFOLLOW .
+.Dv MNT_UNION , MNT_NOSYMFOLLOW
.It Fa fsdata
Filesystem specific data structure.
It is in userspace
when passed to
.Fn vfs_mount
-and is left untouched when passed to filesystems
+and is left untouched when passed to filesystem's
.Fn mount .
.El
.Sh RETURN VALUES
@@ -112,19 +112,18 @@ or was unable to find the specified
module.
.El
.Pp
-Other errors can be returned by the filesystems
+Other errors can be returned by the filesystem's
.Fn mount
and
you should check the specific filesystem for details.
Also
this call relies on a large number of other kernel services
-whose errors it returns so this list my not be exhaustive.
+whose errors it returns so this list may not be exhaustive.
.Sh SEE ALSO
.Xr mount 2 ,
-.Xr mount 8 ,
-.Xr ffs_mount 9
+.Xr mount 8
.Pp
.Va vfs.usermount
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/vfs_unbusy.9 b/share/man/man9/vfs_unbusy.9
index 67efaaa..8ff53e2 100644
--- a/share/man/man9/vfs_unbusy.9
+++ b/share/man/man9/vfs_unbusy.9
@@ -40,7 +40,7 @@
.Sh DESCRIPTION
The
.Fn vfs_unbusy
-function unbusies (unlocks) a mount point by unlocking
+function unbusies a mount point by unlocking
.Fa mp->mnt_lock .
The lock is typically aquired by calling
.Xr vfs_busy 9
@@ -63,4 +63,4 @@ this function, and it will be unlocked upon return.
.Xr vfs_busy 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/vinvalbuf.9 b/share/man/man9/vinvalbuf.9
index ebc8c61..c7cbef4 100644
--- a/share/man/man9/vinvalbuf.9
+++ b/share/man/man9/vinvalbuf.9
@@ -55,7 +55,7 @@ A pointer to the vnode whose buffers will be invalidated.
.It Fa flags
The only supported flag is
.Dv V_SAVE
-and it indicates that dirty buffers should by synced.
+and it indicates that dirty buffers should be synced with the disk.
.It Fa cred
The user credentials that are used to
.Xr VOP_FSYNC 9
@@ -72,7 +72,8 @@ The timeout for any sleeps in the function.
.Sh LOCKS
The vnode is assumed to be locked prior to the call and remains locked upon return.
.Pp
-Giant must be held by prior to the call and remains locked upon return.
+.Va Giant
+must be held by prior to the call and remains locked upon return.
.Sh RETURN VALUES
A 0 value is returned on success.
.Sh PSEUDOCODE
@@ -117,4 +118,4 @@ set in
.Xr VOP_FSYNC 9
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
diff --git a/share/man/man9/vn_isdisk.9 b/share/man/man9/vn_isdisk.9
index 71fa7ed..b47a322 100644
--- a/share/man/man9/vn_isdisk.9
+++ b/share/man/man9/vn_isdisk.9
@@ -31,7 +31,7 @@
.Os
.Sh NAME
.Nm vn_isdisk
-.Nd "checks if the vnode represents a disk"
+.Nd "checks if a vnode represents a disk"
.Sh SYNOPSIS
.In sys/param.h
.In sys/vnode.h
@@ -40,9 +40,13 @@
.Sh DESCRIPTION
The
.Fn vn_isdisk
-function checks to see if the vnode represents a disk.
-In order for the vnode to be a disk it must be a character
-device,
+function checks to see if
+.Fa vp
+represents a disk.
+In order for
+.Fa vp
+to be a disk,
+it must be a character device,
.Va v_rdev
must be valid, and the
.Vt cdevsw
@@ -60,10 +64,10 @@ The vnode to check.
An integer pointer to store the error number in if the call fails.
.El
.Sh RETURN VALUES
-If the vnode represents a disk, 1 is returned; otherwise, zero
+If the vnode represents a disk, 1 is returned; otherwise, 0
is returned and
.Fa errp
will contain the error number.
.Sh AUTHORS
This man page was written by
-.An Chad David .
+.An Chad David Aq davidc@acns.ab.ca .
OpenPOWER on IntegriCloud