Reorganize the file-system-related options; put options for each fs

type (or group of fs types) in its own subsection and put the
fs-independent options first.

Bump date.
This commit is contained in:
dholland 2013-10-13 21:09:35 +00:00
parent 69d0b9d44c
commit 722559797b

View File

@ -1,4 +1,4 @@
.\" $NetBSD: options.4,v 1.429 2013/10/04 16:50:18 wiz Exp $
.\" $NetBSD: options.4,v 1.430 2013/10/13 21:09:35 dholland Exp $
.\"
.\" Copyright (c) 1996
.\" Perry E. Metzger. All rights reserved.
@ -30,7 +30,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd October 4, 2013
.Dd October 13, 2013
.Dt OPTIONS 4
.Os
.Sh NAME
@ -932,6 +932,44 @@ See
and
.Xr nfsd 8
for details.
.It Cd options NVNODE=integer
This option sets the size of the cache used by the name-to-inode translation
routines, (a.k.a. the
.Fn namei
cache, though called by many other names in the kernel source).
By default, this cache has
.Dv NPROC
(set as 20 + 16 * MAXUSERS) * (80 + NPROC / 8) entries.
A reasonable way to derive a value of
.Dv NVNODE ,
should you notice a large number of namei cache misses with a tool such as
.Xr systat 1 ,
is to examine your system's current computed value with
.Xr sysctl 8 ,
(which calls this parameter "kern.maxvnodes") and to increase this value
until either the namei cache hit rate improves or it is determined that
your system does not benefit substantially from an increase in the size of
the namei cache.
.It Cd options NAMECACHE_ENTER_REVERSE
Causes the namei cache to always enter a reverse mapping (vnode -\*[Gt] name)
as well as a normal one.
Normally, this is already done for directory vnodes, to speed up the getcwd
operation.
This option will cause longer hash chains in the reverse cache, and thus
slow down getcwd somewhat.
However, it does make vnode -\*[Gt] path translations possible in some cases.
For now, only useful if strict /proc/#/maps emulation for Linux binaries is
required.
.El
.Ss Options for FFS/UFS File Systems
.Bl -ohang
.It Cd options WAPBL
Enable
.Dq Write Ahead Physical Block Logging file system journaling .
This provides rapid file system consistency checking after a system outage.
It also provides better general use performance over regular FFS.
See also
.Xr wapbl 4 .
.It Cd options QUOTA
Enables kernel support for file system quotas.
See
@ -977,41 +1015,12 @@ Maybe useful for install media kernels, small memory systems and
embedded systems which don't require the snapshot support.
.It Cd options UFS_EXTATTR
Enable extended attribute support for UFS1 filesystems.
.It Cd options WAPBL
Enable
.Dq Write Ahead Physical Block Logging file system journaling .
This provides rapid file system consistency checking after a system outage.
It also provides better general use performance over regular FFS.
See also
.Xr wapbl 4 .
.It Cd options NVNODE=integer
This option sets the size of the cache used by the name-to-inode translation
routines, (a.k.a. the
.Fn namei
cache, though called by many other names in the kernel source).
By default, this cache has
.Dv NPROC
(set as 20 + 16 * MAXUSERS) * (80 + NPROC / 8) entries.
A reasonable way to derive a value of
.Dv NVNODE ,
should you notice a large number of namei cache misses with a tool such as
.Xr systat 1 ,
is to examine your system's current computed value with
.Xr sysctl 8 ,
(which calls this parameter "kern.maxvnodes") and to increase this value
until either the namei cache hit rate improves or it is determined that
your system does not benefit substantially from an increase in the size of
the namei cache.
.It Cd options NAMECACHE_ENTER_REVERSE
Causes the namei cache to always enter a reverse mapping (vnode -\*[Gt] name)
as well as a normal one.
Normally, this is already done for directory vnodes, to speed up the getcwd
operation.
This option will cause longer hash chains in the reverse cache, and thus
slow down getcwd somewhat.
However, it does make vnode -\*[Gt] path translations possible in some cases.
For now, only useful if strict /proc/#/maps emulation for Linux binaries is
required.
.It Cd options UFS_DIRHASH
Increase lookup performance by maintaining in-core hash tables
for large directories.
.El
.Ss Options for ext2fs File Systems
.Bl -ohang
.It Cd options EXT2FS_SYSTEM_FLAGS
This option changes the behavior of the APPEND and IMMUTABLE flags
for a file on an
@ -1025,6 +1034,9 @@ See also
.Xr chflags 1
and
.Xr secmodel_securelevel 9 .
.El
.Ss Options for the NFS File System
.Bl -ohang
.It Cd options NFS_BOOT_BOOTP
Enable use of the BOOTP protocol (RFCs 951 and 1048) to get configuration
information if NFS is used to mount the root file system.
@ -1069,9 +1081,6 @@ for details.
Reduce the size of the NFS client code by omitting code that's only required
for NFSv3 and NQNFS support, leaving only that code required to use NFSv2
servers.
.It Cd options UFS_DIRHASH
Increase lookup performance by maintaining in-core hash tables
for large directories.
.El
.Ss Buffer queue strategy options
The following options enable alternative buffer queue strategies.