[src/trunk]: src/share/man/man9 Misc fixes.

[soren <soren%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/5d02cb5ba24f
branches:  trunk
changeset: 535313:5d02cb5ba24f
user:      soren <soren%NetBSD.org@localhost>
date:      Wed Aug 14 18:50:48 2002 +0000

description:
Misc fixes.
Cross-reference v*ops.9.

diffstat:

 share/man/man9/vfs.9      |   3 +-
 share/man/man9/vfsops.9   |  21 +++++++++----
 share/man/man9/vnode.9    |  71 +++++++++++++++++++++-------------------------
 share/man/man9/vnodeops.9 |  11 +++---
 4 files changed, 54 insertions(+), 52 deletions(-)

diffs (truncated from 331 to 300 lines):

diff -r 2b11a6f1c350 -r 5d02cb5ba24f share/man/man9/vfs.9
--- a/share/man/man9/vfs.9      Wed Aug 14 18:31:36 2002 +0000
+++ b/share/man/man9/vfs.9      Wed Aug 14 18:50:48 2002 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: vfs.9,v 1.2 2001/10/22 08:21:33 wiz Exp $
+.\"     $NetBSD: vfs.9,v 1.3 2002/08/14 18:50:48 soren Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -59,3 +59,4 @@
 .Xr intro 9 ,
 .Xr vfsops 9 ,
 .Xr vnode 9
+.Xr vnodeops 9
diff -r 2b11a6f1c350 -r 5d02cb5ba24f share/man/man9/vfsops.9
--- a/share/man/man9/vfsops.9   Wed Aug 14 18:31:36 2002 +0000
+++ b/share/man/man9/vfsops.9   Wed Aug 14 18:50:48 2002 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: vfsops.9,v 1.4 2002/02/13 08:18:54 ross Exp $
+.\"     $NetBSD: vfsops.9,v 1.5 2002/08/14 18:50:48 soren Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -123,7 +123,7 @@
 int  (*vfs_quotactl)() VFS_QUOTACTL    Query/modify space quotas
 int  (*vfs_statfs)()   VFS_STATFS      Get file system statistics
 int  (*vfs_sync)()     VFS_SYNC        Flush file system buffers
-int  (*vfs_vget)()     VFS_VGET        Get vnode from file ID
+int  (*vfs_vget)()     VFS_VGET        Get vnode from file id
 int  (*vfs_fhtovp)()   VFS_FHTOVP      NFS file handle to vnode lookup
 int  (*vfs_vptofh)()   VFS_VPTOFH      Vnode to NFS file handle lookup
 void (*vfs_init)()     -       Initialise file system
@@ -131,7 +131,7 @@
 void (*vfs_done)()     -       Cleanup unmounted file system
 int  (*vfs_sysctl)()   -       Query/modify kernel state
 int  (*vfs_mountroot)()        -       Mount the root file system
-int  (*vfs_checkexp)() VFS_CHECKEXP    Check if fs is exported
+int  (*vfs_checkexp)() VFS_CHECKEXP    Check if file system is exported
 .fi
 .Pp
 Some additional non-function members of the vfsops structure are the
@@ -144,6 +144,11 @@
 suitable function to do the minimum required of it.  In most cases,
 such functions either do nothing or return an error value to the
 effect that it is not supported.
+.Em vfs_reinit
+and
+.Em vfs_mountroot
+may
+be NULL.
 .Pp
 At system boot, each file system with an entry in
 .Va vfs_list_initial
@@ -235,7 +240,7 @@
 .Fa mp
 operational.  The argument
 .Fa p
-is the calling processing.  The argument
+is the calling process.  The argument
 .Fa flags
 is a set of flags for controlling the operation of
 .Fn VOP_START .
@@ -291,7 +296,7 @@
 .Fa mp .
 The argument
 .Fa p
-is the calling processing.  A statfs structure filled with the
+is the calling process.  A statfs structure filled with the
 statistics is returned in
 .Fa sbp .
 .Fn VFS_STATFS
@@ -325,7 +330,7 @@
 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
 READDIRPLUS nfs call.  If the file system does not support this
-invoked, it should return EOPNOTSUPP.
+function, it should return EOPNOTSUPP.
 .It Fn VFS_FHTOVP "mp" "fhp" "vpp"
 Get the vnode for the NFS file specified by the file handle
 .Fa fhp
@@ -345,7 +350,7 @@
 The file handle is returned in
 .Fa fhp .
 The contents of the file handle are defined by the file system and are
-not examined by an eother subsystems.  It should contain enough
+not examined by any other subsystems.  It should contain enough
 information to uniquely identify a file within the file system as well
 as noticing when a file has been removed and the file system resources
 have been recycled for a new file.
@@ -384,7 +389,9 @@
 .Xr intro 9 ,
 .Xr namei 9 ,
 .Xr vfs 9 ,
+.Xr vfsops 9 ,
 .Xr vnode 9
+.Xr vnodeops 9
 .Sh HISTORY
 The vfs operations vector, its functions and the corresponding macros
 appeared in
diff -r 2b11a6f1c350 -r 5d02cb5ba24f share/man/man9/vnode.9
--- a/share/man/man9/vnode.9    Wed Aug 14 18:31:36 2002 +0000
+++ b/share/man/man9/vnode.9    Wed Aug 14 18:50:48 2002 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: vnode.9,v 1.7 2002/06/11 23:56:21 wiz Exp $
+.\"     $NetBSD: vnode.9,v 1.8 2002/08/14 18:50:48 soren Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -125,15 +125,16 @@
 The vnode is the focus of all file activity in
 .Nx .
 There is a unique vnode allocated for each active file, directory,
-mounted-on file, fifo, domain socket, symbolic link and device.  The
-kernel has no concept of a file's structure and so it relies on the
+mounted-on file, fifo, domain socket, symbolic link and device.  The kernel
+has no concept of a file's underlying structure and so it relies on the
 information stored in the vnode to describe the file.  Thus, the vnode
 associated with a file holds all the administration information
 pertaining to it.
 .Pp
-When a process requests an operation on a file, the vfs interface
-passes control to a file system type dependent function to carry out
-the operation.  If the file system type dependent function finds that
+When a process requests an operation on a file, the
+.Xr vfs 9
+interface passes control to a file system type dependent function to carry
+out the operation.  If the file system type dependent function finds that
 a vnode representing the file is not in main memory, it dynamically
 allocates a new vnode from the system main memory pool.  Once
 allocated, the vnode is attached to the data structure pointer
@@ -203,13 +204,12 @@
 .It VROOT
 This vnode is the root of its file system.
 .It VTEXT
-This vnode is a pure text prototype
+This vnode is a pure text prototype.
 .It VEXECMAP
-This vnode has executable mappings
+This vnode has executable mappings.
 .It VSYSTEM
-This vnode being used by kernel; only used to skip the
-.Fn vflush
-operation quota files.
+This vnode being used by kernel; only used to skip quota files in
+.Fn vflush .
 .It VISTTY
 This vnode represents a tty; used when reading dead vnodes.
 .It VXLOCK
@@ -224,7 +224,7 @@
 This vnode is involved in a directory operation.  This flag is used
 exclusively by LFS.
 .It VLAYER
-This vnode is on a layer file system.
+This vnode is on a layered file system.
 .It VONWORKLST
 This vnode is on syncer work-list.
 .It VDIRTY
@@ -290,8 +290,8 @@
 It is used by
 .Xr fsync 2
 to wait for all writes to complete before returning to the user.  Its
-value must only be modified at splbio.  See
-.Xr spl 9 .
+value must only be modified at splbio (see
+.Xr spl 9 ).
 It does not track the number of dirty buffers attached to the
 vnode.
 .Pp
@@ -371,7 +371,7 @@
 .Em v_tag
 member is read-only.  Valid tag types are:
 .Pp
-.Bl -tag -offset indent -width VT_FILECORE -compact
+.Bl -tag -offset indent -width "VT_FILECORE " -compact
 .It VT_NON
 non file system
 .It VT_UFS
@@ -393,7 +393,7 @@
 .It VT_NULL
 null file system layer
 .It VT_UMAP
-sample file system layer
+uid/gid remapping file system layer
 .It VT_KERNFS
 kernel interface file system
 .It VT_PROCFS
@@ -401,7 +401,7 @@
 .It VT_AFS
 AFS file system
 .It VT_ISOFS
-ISO file system(s)
+ISO 9660 file system(s)
 .It VT_UNION
 union file system
 .It VT_ADOSFS
@@ -418,6 +418,8 @@
 virtual file system
 .It VT_OVERLAY
 overlay file system
+.It VT_SMBFS
+SMB file system
 .El
 .Pp
 All vnode locking operations use
@@ -468,8 +470,6 @@
 Each file system underlying a vnode allocates its own private area and
 hangs it from
 .Em v_data .
-If non-null, this area is freed by
-.Fn getnewvnode .
 .Pp
 Most functions discussed in this page that operate on vnodes cannot be
 called from interrupt context.  The members
@@ -594,7 +594,7 @@
 .Fa vops
 is the vnode operations vector of the file system requesting the new
 vnode.  If a vnode is successfully retrieved zero is returned,
-otherwise and appropriate error code is returned.
+otherwise an appropriate error code is returned.
 .It Fn ungetnewvnode "vp"
 Undo the operation of
 .Fn getnewvnode .
@@ -628,17 +628,11 @@
 system error).  If MNT_FORCE is specified, active vnodes that are
 found are detached.
 .It Fn vaccess "type" "file_mode" "uid" "gid" "acc_mode" "cred"
-Do access checking.  The arguments
-.Fa file_mode ,
-.Fa uid ,
-and
-.Fa gid
-are from the vnode to check.  The arguments
+Do access checking by comparing the file's permissions to the caller's
+desired access type
 .Fa acc_mode
-and
-.Fa cred
-are passed directly to
-.Xr VOP_ACCESS 9 .
+and credentials
+.Fa cred .
 .It Fn checkalias "vp" "nvp_rdev" "mp"
 Check to see if the new vnode
 .Fa vp
@@ -671,7 +665,7 @@
 .Em vp-\*[Gt]v_numoutput
 for the vnode
 .Em bp-\*[Gt]b_vp
-and do wakeup if requested and
+and do a wakeup if requested and
 .Em vp-\*[Gt]vflag
 has VBWAIT set.
 .It Fn vflushbuf "vp" "sync"
@@ -693,15 +687,14 @@
 .Fa p
 and
 .Fa cred
-specified the calling process and its credentials.
-The arguments
-.Fa flags ,
+specified the calling process and its credentials.  The
+.Xr sleep 9
+flag and timeout are specified by the arguments
 .Fa slpflag
 and
 .Fa slptimeo
-are ignored in the present implementation.  If the operation is
-successful zero is returned, otherwise and appropriate error code is
-returned.
+respectively.  If the operation is successful zero is returned,
+otherwise an appropriate error code is returned.
 .It Fn vtruncbuf "vp" "lbn" "slpflag" "slptimeo"
 Destroy any in-core buffers past the file truncation length for the
 locked vnode
@@ -716,10 +709,10 @@
 and
 .Fa slptimeo
 respectively.  If the operation is successful zero is returned,
-otherwise and appropriate error code is returned.
+otherwise an appropriate error code is returned.
 .It Fn vprint "label" "vp"
 This function is used by the kernel to dump vnode information during a
-panic.  It is only used if kernel option DIAGNOSTIC is compiled into
+panic.  It is only used if the kernel option DIAGNOSTIC is compiled into
 the kernel.  The argument
 .Fa label
 is a string to prefix the information dump of vnode
diff -r 2b11a6f1c350 -r 5d02cb5ba24f share/man/man9/vnodeops.9
--- a/share/man/man9/vnodeops.9 Wed Aug 14 18:31:36 2002 +0000
+++ b/share/man/man9/vnodeops.9 Wed Aug 14 18:50:48 2002 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: vnodeops.9,v 1.11 2002/07/19 17:28:29 yamt Exp $
+.\"     $NetBSD: vnodeops.9,v 1.12 2002/08/14 18:50:48 soren Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -248,9 +248,9 @@
 description of the element.
 .Pp
 .nf