diff options
29 files changed, 290 insertions, 225 deletions
diff --git a/share/man/man3/tree.3 b/share/man/man3/tree.3 index 2d43ac1f09b..234be208de9 100644 --- a/share/man/man3/tree.3 +++ b/share/man/man3/tree.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tree.3,v 1.7 2002/06/12 01:09:20 provos Exp $ +.\" $OpenBSD: tree.3,v 1.8 2002/11/08 08:08:46 mpech Exp $ .\"/* .\" * Copyright 2002 Niels Provos <provos@citi.umich.edu> .\" * All rights reserved. @@ -163,17 +163,18 @@ or .Li RB_GENERATE . See the examples below for further explanation of how these macros are used. .Sh SPLAY TREES -A splay tree is a self-organizing data structure. Every operation -on the tree causes a splay to happen. The splay moves the requested -node to the root of the tree and partly rebalances it. +A splay tree is a self-organizing data structure. +Every operation on the tree causes a splay to happen. +The splay moves the requested node to the root of the tree and partly +rebalances it. .Pp This has the benefit that request locality causes faster lookups as -the requested nodes move to the top of the tree. On the other hand, -every lookup causes memory writes. +the requested nodes move to the top of the tree. +On the other hand, every lookup causes memory writes. .Pp The Balance Theorem bounds the total access time for m operations -and n inserts on an initially empty tree as O((m + n)lg n). The -amortized cost for a sequence of m accesses to a splay tree is O(lg n); +and n inserts on an initially empty tree as O((m + n)lg n). +The amortized cost for a sequence of m accesses to a splay tree is O(lg n); .Pp A splay tree is headed by a structure defined by the .Fn SPLAY_HEAD @@ -213,7 +214,8 @@ argument is the name of the element defined by .Pp The function bodies are generated with the .Fn SPLAY_GENERATE -macro. It takes the same arguments as the +macro. +It takes the same arguments as the .Fn SPLAY_PROTOTYPE macro, but should be used only once. .Pp @@ -221,12 +223,14 @@ Finally, the .Fa CMP argument is the name of a function used to compare tree noded -with each other. The function takes two arguments of type +with each other. +The function takes two arguments of type .Fa "struct TYPE *" . If the first argument is smaller than the second, the function returns a -value smaller than zero. If they are equal, the function returns zero. -Otherwise, it should return a value greater than zero. The compare -function defines the order of the tree elements. +value smaller than zero. +If they are equal, the function returns zero. +Otherwise, it should return a value greater than zero. +The compare function defines the order of the tree elements. .Pp The .Fn SPLAY_INIT @@ -283,10 +287,10 @@ SPLAY_FOREACH(np, NAME, head) The .Fn SPLAY_EMPTY macro should be used to check whether a splay tree is empty. -.Pp .Sh RED-BLACK TREES A red-black tree is a binary search tree with the node color as an -extra attribute. It fulfills a set of conditions: +extra attribute. +It fulfills a set of conditions: .Bl -enum -compact -offset indent .It every search path from the root to a leaf consists of the same number of @@ -338,7 +342,8 @@ argument is the name of the element defined by .Pp The function bodies are generated with the .Fn RB_GENERATE -macro. It takes the same arguments as the +macro. +It takes the same arguments as the .Fn RB_PROTOTYPE macro, but should be used only once. .Pp @@ -346,12 +351,14 @@ Finally, the .Fa CMP argument is the name of a function used to compare tree noded -with each other. The function takes two arguments of type +with each other. +The function takes two arguments of type .Fa "struct TYPE *" . If the first argument is smaller than the second, the function returns a -value smaller than zero. If they are equal, the function returns zero. -Otherwise, it should return a value greater than zero. The compare -function defines the order of the tree elements. +value smaller than zero. +If they are equal, the function returns zero. +Otherwise, it should return a value greater than zero. +The compare function defines the order of the tree elements. .Pp The .Fn RB_INIT @@ -408,7 +415,6 @@ RB_FOREACH(np, NAME, head) The .Fn RB_EMPTY macro should be used to check whether a splay tree is empty. -.Pp .Sh NOTES Trying to free a tree in the following way is a common error: .Bd -literal -offset indent diff --git a/share/man/man4/ahc.4 b/share/man/man4/ahc.4 index 17d3683e84b..765d632a21c 100644 --- a/share/man/man4/ahc.4 +++ b/share/man/man4/ahc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ahc.4,v 1.21 2002/09/26 07:55:39 miod Exp $ +.\" $OpenBSD: ahc.4,v 1.22 2002/11/08 08:08:46 mpech Exp $ .\" $NetBSD: ahc.4,v 1.1.2.1 1996/08/25 17:22:14 thorpej Exp $ .\" .\" Copyright (c) 1995, 1996 @@ -110,8 +110,8 @@ and .Tn 3985, .Pp Driver features include support for twin and wide busses, -fast, ultra, ultra2 and ultra160 synchronous transfers depending on controller type, -tagged queuing, and SCB paging. +fast, ultra, ultra2 and ultra160 synchronous transfers depending on +controller type, tagged queuing, and SCB paging. .Pp Memory mapped I/O can be enabled for PCI devices with the .Dq Dv AHC_ALLOW_MEMIO @@ -253,7 +253,9 @@ sequencer-code assembler, and the firmware running on the aic7xxx chips were written by .An Justin T. Gibbs . .Pp -The OpenBSD platform dependant code was written by Steve P. Murphree, Jr. +The +.Ox +platform dependant code was written by Steve P. Murphree, Jr. .Sh BUGS Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an .Tn AIC7870 @@ -263,5 +265,5 @@ run slightly above 10MHz. This confuses the drive and hangs the bus. Setting a maximum synchronous negotiation rate of 8MHz in the .Tn SCSI-Select -utility will allow normal operation. Some disks that don't do tagged queuing -will fail. +utility will allow normal operation. +Some disks that don't do tagged queuing will fail. diff --git a/share/man/man4/crypto.4 b/share/man/man4/crypto.4 index c204c164a42..71cbfc8582f 100644 --- a/share/man/man4/crypto.4 +++ b/share/man/man4/crypto.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: crypto.4,v 1.4 2002/09/12 07:15:03 deraadt Exp $ +.\" $OpenBSD: crypto.4,v 1.5 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2001 Theo de Raadt .\" All rights reserved. @@ -66,7 +66,6 @@ Free a previously established session. .It Dv CIOCCRYPT Perform a crypto operation against a previously setup session. .El -.Pp .Sh FEATURES Depending on hardware being present, the following symmetric and assymetric cryptographic features are potentially available from @@ -93,7 +92,6 @@ assymetric cryptographic features are potentially available from .It CRK_DSA_VERIFY .It CRK_DH_COMPUTE_KEY .El -.Pp .Sh FILES .Bl -tag -width /dev/crypto -compact .It Pa /dev/crypto diff --git a/share/man/man4/dc.4 b/share/man/man4/dc.4 index 6e9f5b76980..54420670750 100644 --- a/share/man/man4/dc.4 +++ b/share/man/man4/dc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dc.4,v 1.27 2002/10/21 20:31:39 henning Exp $ +.\" $OpenBSD: dc.4,v 1.28 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 1997, 1998, 1999 .\" Bill Paul <wpaul@ee.columbia.edu>. All rights reserved. @@ -76,7 +76,8 @@ Xircom X3201-based CardBus All of these chips have the same general register layout, DMA descriptor format and method of operation. All of the clone chips are based on the 21143 design with -various modifications. (The 21140 is an older version of the 21143.) +various modifications. +(The 21140 is an older version of the 21143.) The 21143 itself has support for 10baseT, BNC, AUI, MII and symbol media attachments, 10 and 100Mbps speeds in full or half duplex, built in NWAY autonegotiation and wake on LAN. diff --git a/share/man/man4/eisa.4 b/share/man/man4/eisa.4 index 41a113e1e07..ad973069e88 100644 --- a/share/man/man4/eisa.4 +++ b/share/man/man4/eisa.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: eisa.4,v 1.4 2002/09/26 07:55:39 miod Exp $ +.\" $OpenBSD: eisa.4,v 1.5 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: eisa.4,v 1.10 2001/09/11 22:52:52 wiz Exp $ .\" .\" Copyright (c) 1997 Jonathan Stone @@ -38,14 +38,16 @@ .Sh SYNOPSIS Machine-dependent; depends on the bus topology and .Tn EISA -bus interface of your system. Typical +bus interface of your system. +Typical .Tn EISA buses are either connected directly to the main system bus, or via an .Tn PCI to .Tn EISA -bridge. See the +bridge. +See the .Xr intro 4 documentation for your system for details. .Sh INTRODUCTION @@ -129,7 +131,8 @@ These are listed in .Xr isa 4 , or .Xr isapnp 4 , -respectively. The manual pages for each individual driver also lists the +respectively. +The manual pages for each individual driver also lists the supported bus variants. .Sh SEE ALSO .Xr ahb 4 , diff --git a/share/man/man4/gre.4 b/share/man/man4/gre.4 index 6d36546d871..741ef0f692b 100644 --- a/share/man/man4/gre.4 +++ b/share/man/man4/gre.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gre.4,v 1.13 2002/06/10 23:08:41 itojun Exp $ +.\" $OpenBSD: gre.4,v 1.14 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: gre.4,v 1.10 1999/12/22 14:55:49 kleink Exp $ .\" .\" Copyright 1998 (c) The NetBSD Foundation, Inc. @@ -182,7 +182,8 @@ option to .Xr sysctl 8 . .Pp The GRE interface will accept WCCPv1-style GRE encapsulated packets -from a Cisco router. Some magic with the packet filter configuration +from a Cisco router. +Some magic with the packet filter configuration and a caching proxy like squid are needed to do anything useful with these packets. .Sh SEE ALSO @@ -200,7 +201,8 @@ A description of GRE encapsulation can be found in RFC 1701, RFC 1702. A description of MOBILE encapsulation can be found in RFC 2004. .Pp A description of WCCPv1 can be found in draft-ietf-wrec-web-pro-00.txt, -and WCCPv2 in draft-wilson-wrec-wccp-v2-00.txt. Both of these documents +and WCCPv2 in draft-wilson-wrec-wccp-v2-00.txt. +Both of these documents can be found at http://www.wrec.org/ (at the time of this writing). .Sh BUGS The compute_route() code in net/if_gre.c toggles the last bit of the diff --git a/share/man/man4/isp.4 b/share/man/man4/isp.4 index 2e31fe37745..438e01b5415 100644 --- a/share/man/man4/isp.4 +++ b/share/man/man4/isp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: isp.4,v 1.11 2002/09/26 07:55:40 miod Exp $ +.\" $OpenBSD: isp.4,v 1.12 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 1998, 1999 .\" Matthew Jacob, for NASA/Ames Research Center @@ -63,7 +63,8 @@ requires tagging). An optional .Tn option ISP_COMPILE_FW=1 ensures that known good firmware will be downloaded to the driver -at attach time. This is recommended. +at attach time. +This is recommended. .Sh BUGS None known at this time. .Sh SEE ALSO diff --git a/share/man/man4/man4.sparc64/uperf.4 b/share/man/man4/man4.sparc64/uperf.4 index c055561d961..abde5d3c00b 100644 --- a/share/man/man4/man4.sparc64/uperf.4 +++ b/share/man/man4/man4.sparc64/uperf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uperf.4,v 1.6 2002/10/01 21:03:28 miod Exp $ +.\" $OpenBSD: uperf.4,v 1.7 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2002 Jason L. Wright (jason@thought.net) .\" All rights reserved. @@ -137,7 +137,8 @@ The and .Fa cnt_val1 contain the values fetched for the counters. -Software using this interface should be prepared to handle the counters rolling over. +Software using this interface should be prepared to handle the counters +rolling over. .Pp The .Nm diff --git a/share/man/man4/options.4 b/share/man/man4/options.4 index 05af662b5e4..6f39fb4140f 100644 --- a/share/man/man4/options.4 +++ b/share/man/man4/options.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: options.4,v 1.109 2002/09/26 07:55:40 miod Exp $ +.\" $OpenBSD: options.4,v 1.110 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: options.4,v 1.21 1997/06/25 03:13:00 thorpej Exp $ .\" .\" Copyright (c) 1998 Theo de Raadt @@ -1022,8 +1022,9 @@ Size of kernel malloc area in PAGE_SIZE-sized logical pages. This area is covered by the kernel submap .Em kmem_map . The kernel attempts to auto-size this map based on the amount of -physical memory in the system. Platform-specific code may place -bounds on this computed size, which may be viewed with the +physical memory in the system. +Platform-specific code may place bounds on this computed size, +which may be viewed with the .Xr sysctl 8 variable .Em vm.nkmempages . diff --git a/share/man/man4/pciide.4 b/share/man/man4/pciide.4 index 0c8e4ff758d..7e3f1d882e2 100644 --- a/share/man/man4/pciide.4 +++ b/share/man/man4/pciide.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pciide.4,v 1.25 2002/10/14 20:35:31 gluk Exp $ +.\" $OpenBSD: pciide.4,v 1.26 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: pciide.4,v 1.8 1999/03/16 01:19:17 garbled Exp $ .\" .\" Copyright (c) 1998 Manuel Bouyer. @@ -112,8 +112,8 @@ This will be a problem only if the controller has been disabled in the BIOS and another controller has been installed which uses the ISA legacy I/O ports and interrupts. .Pp -The CMD0646U is reportedly unable to operate properly in UDMA mode. UDMA -will not be enabled on this controller unless +The CMD0646U is reportedly unable to operate properly in UDMA mode. +UDMA will not be enabled on this controller unless .Dv PCIIDE_CMD0646U_ENABLEUDMA is specified in the kernel config file. .Pp diff --git a/share/man/man4/radio.4 b/share/man/man4/radio.4 index 33d368c8cbf..7be661aa3d8 100644 --- a/share/man/man4/radio.4 +++ b/share/man/man4/radio.4 @@ -1,5 +1,5 @@ .\" $RuOBSD: radio.4,v 1.4 2001/10/26 05:38:43 form Exp $ -.\" $OpenBSD: radio.4,v 1.14 2002/09/26 07:55:40 miod Exp $ +.\" $OpenBSD: radio.4,v 1.15 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2001 Vladimir Popov .\" All rights reserved. @@ -31,7 +31,6 @@ .Nm radio .Nd device-independent radio driver layer .Sh SYNOPSIS -.Pp .Cd "radio* at az?" .Cd "radio* at bktr?" .Cd "radio* at fms?" @@ -154,7 +153,6 @@ Informs whether the device receives a stereo or mono signal. .El .El .Sh CHIPSETS -.Pp LM700x is a frequency synthesizer IC. The LM700x is programmed through a 24-bit write-only shift register. The first 14 bits are frequency data. diff --git a/share/man/man4/raid.4 b/share/man/man4/raid.4 index 1a54592d7f1..89348a3e74e 100644 --- a/share/man/man4/raid.4 +++ b/share/man/man4/raid.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: raid.4,v 1.21 2002/10/16 18:41:17 deraadt Exp $ +.\" $OpenBSD: raid.4,v 1.22 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: raid.4,v 1.20 2001/09/22 16:03:58 wiz Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. @@ -76,7 +76,8 @@ driver provides RAID 0, 1, 4, and 5 (and more!) capabilities to .Ox . This document assumes that the reader has at least some familiarity with RAID -and RAID concepts. The reader is also assumed to know how to configure +and RAID concepts. +The reader is also assumed to know how to configure disks and pseudo-devices into kernels, how to generate kernels, and how to partition disks. .Pp @@ -102,13 +103,14 @@ to the RAIDframe documentation mentioned in the section for more detail on these various RAID configurations. .Pp Depending on the parity level configured, the device driver can -support the failure of component drives. The number of failures -allowed depends on the parity level selected. If the driver is able -to handle drive failures, and a drive does fail, then the system is -operating in "degraded mode". In this mode, all missing data must be -reconstructed from the data and parity present on the other -components. This results in much slower data accesses, but -does mean that a failure need not bring the system to a complete halt. +support the failure of component drives. +The number of failures allowed depends on the parity level selected. +If the driver is able to handle drive failures, and a drive does fail, +then the system is operating in "degraded mode". +In this mode, all missing data must be reconstructed from the data and +parity present on the other components. +This results in much slower data accesses, but does mean that a failure +need not bring the system to a complete halt. .Pp The RAID driver supports and enforces the use of .Sq component labels . @@ -121,10 +123,10 @@ the RAID set, and whether the data (and parity) on the component is If the driver determines that the labels are very inconsistent with respect to each other (e.g. two or more serial numbers do not match) or that the component label is not consistent with it's assigned place -in the set (e.g. the component label claims the component should be +in the set (e.g., the component label claims the component should be the 3rd one a 6-disk set, but the RAID set has it as the 3rd component -in a 5-disk set) then the device will fail to configure. If the -driver determines that exactly one component label seems to be +in a 5-disk set) then the device will fail to configure. +If the driver determines that exactly one component label seems to be incorrect, and the RAID set is being configured as a set that supports a single failure, then the RAID set will be allowed to configure, but the incorrectly labeled component will be marked as @@ -134,27 +136,33 @@ If all of the components are consistent among themselves, the RAID set will configure normally. .Pp Component labels are also used to support the auto-detection and -auto-configuration of RAID sets. A RAID set can be flagged as -auto-configurable, in which case it will be configured automatically -during the kernel boot process. RAID filesystems which are +auto-configuration of RAID sets. +A RAID set can be flagged as auto-configurable, in which case it will be +configured automatically during the kernel boot process. +RAID filesystems which are automatically configured are also eligible to be the root filesystem. There is currently no support for booting a kernel directly from a RAID -set. To use a RAID set as the root filesystem, a kernel is usually +set. +To use a RAID set as the root filesystem, a kernel is usually obtained from a small non-RAID partition, after which any -auto-configuring RAID set can be used for the root filesystem. See +auto-configuring RAID set can be used for the root filesystem. +See .Xr raidctl 8 for more information on auto-configuration of RAID sets. .Pp The driver supports .Sq hot spares , disks which are on-line, but are not actively used in an existing -filesystem. Should a disk fail, the driver is capable of reconstructing +filesystem. +Should a disk fail, the driver is capable of reconstructing the failed disk onto a hot spare or back onto a replacement drive. If the components are hot swapable, the failed disk can then be removed, a new disk put in its place, and a copyback operation -performed. The copyback operation, as its name indicates, will copy +performed. +The copyback operation, as its name indicates, will copy the reconstructed data from the hot spare to the previously failed -(and now replaced) disk. Hot spares can also be hot-added using +(and now replaced) disk. +Hot spares can also be hot-added using .Xr raidctl 8 . .Pp If a component cannot be detected when the RAID device is configured, @@ -169,11 +177,12 @@ Most importantly, .Xr raidctl 8 must be used with the .Fl i -option to initialize all RAID sets. In particular, this -initialization includes re-building the parity data. This rebuilding -of parity data is also required when either a) a new RAID device is -brought up for the first time or b) after an un-clean shutdown of a -RAID device. By using the +option to initialize all RAID sets. +In particular, this initialization includes re-building the parity data. +This rebuilding of parity data is also required when either a) a new RAID +device is brought up for the first time or b) after an un-clean shutdown of a +RAID device. +By using the .Fl P option to .Xr raidctl 8 , @@ -182,21 +191,23 @@ before doing a .Xr fsck 8 or a .Xr newfs 8 , -filesystem integrity and parity integrity can be ensured. It bears -repeating again that parity recomputation is +filesystem integrity and parity integrity can be ensured. +It bears repeating again that parity recomputation is .Ar required -before any filesystems are created or used on the RAID device. If the -parity is not correct, then missing data cannot be correctly recovered. +before any filesystems are created or used on the RAID device. +If the parity is not correct, then missing data cannot be correctly recovered. .Pp -RAID levels may be combined in a hierarchical fashion. For example, a RAID 0 -device can be constructed out of a number of RAID 5 devices (which, in turn, -may be constructed out of the physical disks, or of other RAID devices). +RAID levels may be combined in a hierarchical fashion. +For example, a RAID 0 device can be constructed out of a number of RAID 5 +devices (which, in turn, may be constructed out of the physical disks, +or of other RAID devices). .Pp It is important that drives be hard-coded at their respective -addresses (i.e. not left free-floating, where a drive with SCSI ID of +addresses (i.e., not left free-floating, where a drive with SCSI ID of 4 can end up as /dev/sd0c) for well-behaved functioning of the RAID -device. This is true for all types of drives, including IDE, HP-IB, -etc. For normal SCSI drives, for example, the following can be used +device. +This is true for all types of drives, including IDE, HP-IB, etc. +For normal SCSI drives, for example, the following can be used to fix the device addresses: .Bd -unfilled -offset indent sd0 at scsibus0 target 0 lun ? # SCSI disk drives @@ -210,29 +221,34 @@ sd6 at scsibus0 target 6 lun ? # SCSI disk drives .Pp See .Xr sd 4 -for more information. The rationale for fixing the device addresses -is as follows: Consider a system with three SCSI drives at SCSI ID's -4, 5, and 6, and which map to components /dev/sd0e, /dev/sd1e, and -/dev/sd2e of a RAID 5 set. If the drive with SCSI ID 5 fails, and the -system reboots, the old /dev/sd2e will show up as /dev/sd1e. The RAID -driver is able to detect that component positions have changed, and -will not allow normal configuration. If the device addresses are hard +for more information. +The rationale for fixing the device addresses is as follows: +Consider a system with three SCSI drives at SCSI ID's 4, 5, and 6, +and which map to components /dev/sd0e, /dev/sd1e, and +/dev/sd2e of a RAID 5 set. +If the drive with SCSI ID 5 fails, and the system reboots, +the old /dev/sd2e will show up as /dev/sd1e. +The RAID driver is able to detect that component positions have changed, and +will not allow normal configuration. +If the device addresses are hard coded, however, the RAID driver would detect that the middle component -is unavailable, and bring the RAID 5 set up in degraded mode. Note -that the auto-detection and auto-configuration code does not care -about where the components live. The auto-configuration code will +is unavailable, and bring the RAID 5 set up in degraded mode. +Note that the auto-detection and auto-configuration code does not care +about where the components live. +The auto-configuration code will correctly configure a device even after any number of the components have been re-arranged. .Pp The first step to using the .Nm -driver is to ensure that it is suitably configured in the kernel. This is -done by adding a line similar to: +driver is to ensure that it is suitably configured in the kernel. +This is done by adding a line similar to: .Bd -unfilled -offset indent pseudo-device raid 4 # RAIDframe disk device .Ed .Pp -to the kernel configuration file. The +to the kernel configuration file. +The .Sq count argument ( .Sq 4 , @@ -247,13 +263,15 @@ to the kernel configuration file. .Pp All component partitions must be of the type .Dv FS_BSDFFS -(e.g. 4.2BSD) or +(e.g., 4.2BSD) or .Dv FS_RAID -(e.g. RAID). The use of the latter is strongly encouraged, and is -required if auto-configuration of the RAID set is desired. Since -RAIDframe leaves room for disklabels, RAID components can be simply -raw disks, or partitions which use an entire disk. Note that some -platforms (such as SUN) do not allow using the FS_RAID partition type. +(e.g., RAID). +The use of the latter is strongly encouraged, and is +required if auto-configuration of the RAID set is desired. +Since RAIDframe leaves room for disklabels, RAID components can be simply +raw disks, or partitions which use an entire disk. +Note that some platforms (such as SUN) do not allow using the FS_RAID +partition type. On these platforms, the .Nm driver can still auto-configure from FS_BSDFFS partitions. @@ -265,20 +283,19 @@ device is found in It is highly recommended that the steps to reconstruct, copyback, and re-compute parity are well understood by the system administrator(s) .Ar before -a component failure. Doing the wrong thing when a component fails may -result in data loss. +a component failure. +Doing the wrong thing when a component fails may result in data loss. .Pp Additional debug information can be sent to the console by specifying: .Bd -unfilled -offset indent option RAIDDEBUG .Ed -.Pp .Sh WARNINGS Certain RAID levels (1, 4, 5, 6, and others) can protect against some -data loss due to component failure. However the loss of two -components of a RAID 4 or 5 system, or the loss of a single component -of a RAID 0 system, will result in the entire filesystems on that RAID -device being lost. +data loss due to component failure. +However the loss of two components of a RAID 4 or 5 system, or the loss +of a single component of a RAID 0 system, will result in the entire +filesystems on that RAID device being lost. RAID is .Ar NOT a substitute for good backup practices. @@ -286,12 +303,13 @@ a substitute for good backup practices. Recomputation of parity .Ar MUST be performed whenever there is a chance that it may have been -compromised. This includes after system crashes, or before a RAID -device has been used for the first time. Failure to keep parity -correct will be catastrophic should a component ever fail -- it is -better to use RAID 0 and get the additional space and speed, than it -is to use parity, but not keep the parity correct. At least with RAID -0 there is no perception of increased data security. +compromised. +This includes after system crashes, or before a RAID +device has been used for the first time. +Failure to keep parity correct will be catastrophic should a component +ever fail -- it is better to use RAID 0 and get the additional space and +speed, than it is to use parity, but not keep the parity correct. +At least with RAID 0 there is no perception of increased data security. .Sh FILES .Bl -tag -width /dev/XXrXraidX -compact .It Pa /dev/{,r}raid* @@ -315,10 +333,12 @@ driver in .Ox is a port of RAIDframe, a framework for rapid prototyping of RAID structures developed by the folks at the Parallel Data Laboratory at -Carnegie Mellon University (CMU). RAIDframe, as originally distributed +Carnegie Mellon University (CMU). +RAIDframe, as originally distributed by CMU, provides a RAID simulator for a number of different architectures, and a user-level device driver and a kernel device -driver for Digital Unix. The +driver for Digital Unix. +The .Nm driver is a kernelized version of RAIDframe v1.1. .Pp diff --git a/share/man/man4/rtii.4 b/share/man/man4/rtii.4 index 212a312cd97..09db8c9c3ed 100644 --- a/share/man/man4/rtii.4 +++ b/share/man/man4/rtii.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rtii.4,v 1.5 2002/09/26 07:55:40 miod Exp $ +.\" $OpenBSD: rtii.4,v 1.6 2002/11/08 08:08:47 mpech Exp $ .\" $RuOBSD: rtii.4,v 1.3 2001/10/26 05:38:44 form Exp $ .\" .\" Copyright (c) 2001 Vladimir Popov <jumbo@narod.ru> @@ -52,8 +52,9 @@ The Radiotrack II cards take only one I/O port. The I/O port is set by the driver to the value specified in the configuration file and must be either 0x20c or 0x30c. .Pp -The flags control the driver behavior. For example, with flags 0x01 the driver -will assume that there is a TEA5759 chip is used. +The flags control the driver behavior. +For example, with flags 0x01 the driver will assume that there is a TEA5759 +chip is used. .Sh SEE ALSO .Xr intro 4 , .Xr isa 4 , diff --git a/share/man/man4/sbus.4 b/share/man/man4/sbus.4 index 60f2f37dc46..76042fcb37c 100644 --- a/share/man/man4/sbus.4 +++ b/share/man/man4/sbus.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sbus.4,v 1.10 2002/09/26 07:55:40 miod Exp $ +.\" $OpenBSD: sbus.4,v 1.11 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: sbus.4,v 1.5 2002/01/21 17:54:10 wiz Exp $ .\" .\" Copyright (c) 2001 The NetBSD Foundation, Inc. @@ -47,14 +47,15 @@ .Cd "sbus* at xbox?" .Pp These -.Nm +.Nm sbus attachments are specific to the sparc and sparc64 ports. .Sh DESCRIPTION .Nm is a I/O interconnect bus mostly found in .Tn SPARC -workstations and small to medium server class systems. It supports both -on-board peripherals and extension boards. The +workstations and small to medium server class systems. +It supports both on-board peripherals and extension boards. +The .Nm specifications define the bus protocol as well as the electrical and mechanical properties of the extension slots. @@ -160,5 +161,5 @@ The machine-independent .Nm sbus subsystem appeared in .Nx 1.3 . -OpenBSD support first appeared in +.Ox support first appeared in .Ox 2.0 . diff --git a/share/man/man4/sf2r.4 b/share/man/man4/sf2r.4 index 6e1abe46ec3..ce4b9daa5c6 100644 --- a/share/man/man4/sf2r.4 +++ b/share/man/man4/sf2r.4 @@ -1,5 +1,5 @@ .\" $RuOBSD: sf2r.4,v 1.3 2001/10/26 05:38:44 form Exp $ -.\" $OpenBSD: sf2r.4,v 1.7 2002/10/15 16:27:49 mickey Exp $ +.\" $OpenBSD: sf2r.4,v 1.8 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2001 Vladimir Popov .\" All rights reserved. @@ -51,7 +51,8 @@ The SF16-FMR2 cards take only one I/O port. The I/O port is set by the driver to the value specified in the configuration file and must be 0x384. .Pp -The flags control the driver behavior. For example, with flags 0x01 the driver +The flags control the driver behavior. +For example, with flags 0x01 the driver will assume that there is a TEA5759 chip is used. .Pp MediaForte made two variants of the SF16-FMR2 cards, the first one has diff --git a/share/man/man4/ubsec.4 b/share/man/man4/ubsec.4 index 9d9d9676fed..542ddae281e 100644 --- a/share/man/man4/ubsec.4 +++ b/share/man/man4/ubsec.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ubsec.4,v 1.19 2002/10/10 17:51:06 jason Exp $ +.\" $OpenBSD: ubsec.4,v 1.20 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2000 Jason L. Wright (jason@thought.net) .\" All rights reserved. @@ -43,7 +43,8 @@ The driver supports cards containing any of the following chips: .Bl -tag -width "Broadcom BCM5821" -offset indent .It Bluesteel 5501 -The original chipset, no longer made. This extremely rare unit +The original chipset, no longer made. +This extremely rare unit was not very fast, lacked a RNG, and had a number of other bugs. .It Bluesteel 5601 A faster and fixed version of the original, with a random number diff --git a/share/man/man4/uhidev.4 b/share/man/man4/uhidev.4 index 8a25e53fe7a..0705b38e3d3 100644 --- a/share/man/man4/uhidev.4 +++ b/share/man/man4/uhidev.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uhidev.4,v 1.2 2002/09/26 22:09:53 miod Exp $ +.\" $OpenBSD: uhidev.4,v 1.3 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: uhidev.4,v 1.2 2001/12/29 03:06:41 augustss Exp $ .\" .\" Copyright (c) 2001 The NetBSD Foundation, Inc. @@ -49,10 +49,11 @@ .Sh DESCRIPTION The .Nm -driver handles all Human Interface Devices. Each HID device -can have several components, e.g., a keyboard and a mouse. +driver handles all Human Interface Devices. +Each HID device can have several components, e.g., a keyboard and a mouse. These components use different report identifiers (a byte) to -distinguish which one data is coming from. The +distinguish which one data is coming from. +The .Nm driver has other drivers attached that handle particular kinds of devices and diff --git a/share/man/man5/bsd.port.mk.5 b/share/man/man5/bsd.port.mk.5 index 4c757abad06..ef7d20a20eb 100644 --- a/share/man/man5/bsd.port.mk.5 +++ b/share/man/man5/bsd.port.mk.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bsd.port.mk.5,v 1.76 2002/10/29 08:29:37 pvalchev Exp $ +.\" $OpenBSD: bsd.port.mk.5,v 1.77 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2000 Marc Espie .\" @@ -340,7 +340,8 @@ Flags to pass to build each target in .Ev BULK_TARGETS . .It Ev BULK_TARGETS Targets to run after each bulk package build before cleaning up the -working directory. Defaults to +working directory. +Defaults to .Ar ftp-packages , .Ar cdrom-packages . .It Ev BZIP2 @@ -1267,7 +1268,8 @@ See .It Ev NEED_VERSION Used to set a requirement on a specific revision of .Nm -needed by a port. No longer needed as +needed by a port. +No longer needed as .Nm should always be kept up-to-date. .It Ev NO_CONFIGURE diff --git a/share/man/man5/pf.conf.5 b/share/man/man5/pf.conf.5 index 0df0cee0d21..1f37a2071c4 100644 --- a/share/man/man5/pf.conf.5 +++ b/share/man/man5/pf.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pf.conf.5,v 1.103 2002/11/06 00:30:04 henning Exp $ +.\" $OpenBSD: pf.conf.5,v 1.104 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2002, Daniel Hartmeier .\" All rights reserved. @@ -177,7 +177,6 @@ One can unset the loginterface using .Bd -literal set loginterface none .Ed -.Pp .Ss limit Sets hard limits on the memory pools used by the packet filter. See diff --git a/share/man/man8/genassym.sh.8 b/share/man/man8/genassym.sh.8 index d37f21b075f..5b4773a88a9 100644 --- a/share/man/man8/genassym.sh.8 +++ b/share/man/man8/genassym.sh.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: genassym.sh.8,v 1.3 2001/11/14 20:18:43 ho Exp $ +.\" $OpenBSD: genassym.sh.8,v 1.4 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: genassym.sh.8,v 1.5 1999/03/17 20:31:19 garbled Exp $ .\" .\" Copyright (c) 1997 Matthias Pfaller. @@ -84,8 +84,8 @@ to create slightly different code, generate an executable from this code and run it. In both cases the assym.h file is written to stdout. .Sh DIAGNOSTICS Either self-explanatory, or generated by one of the programs -called from the script. The script will exit with the return code -from the compiler, or, in the +called from the script. +The script will exit with the return code from the compiler, or, in the .Fl c case, with the return code from the generated executable. .Sh SEE ALSO diff --git a/share/man/man8/man8.macppc/boot_macppc.8 b/share/man/man8/man8.macppc/boot_macppc.8 index 634caf08e97..d887ad657ba 100644 --- a/share/man/man8/man8.macppc/boot_macppc.8 +++ b/share/man/man8/man8.macppc/boot_macppc.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_macppc.8,v 1.3 2002/10/17 23:18:51 miod Exp $ +.\" $OpenBSD: boot_macppc.8,v 1.4 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. @@ -78,10 +78,12 @@ The bootstrap program is named .Dq ofwboot . It can be installed either in a HFS partition or in a -MSDOS partition on the disk. If MBR partitioning is chosen for +MSDOS partition on the disk. +If MBR partitioning is chosen for the disk, the bootstrap program will be installed automatically during the .Ox -installation procedure. For HFS shared disks, the +installation procedure. +For HFS shared disks, the .Pa ofwboot file must be installed manually. The ofwboot program can be loaded from any openfirmware recognized diff --git a/share/man/man9/autoconf.9 b/share/man/man9/autoconf.9 index 013a439c322..2bf873ca497 100644 --- a/share/man/man9/autoconf.9 +++ b/share/man/man9/autoconf.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: autoconf.9,v 1.1 2002/08/27 01:15:34 wcobb Exp $ +.\" $OpenBSD: autoconf.9,v 1.2 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: autoconf.9,v 1.9 2002/02/13 08:18:35 ross Exp $ .\" .\" Copyright (c) 2001 The NetBSD Foundation, Inc. @@ -89,7 +89,6 @@ giving a unique address for each instance. The .Fn config_init function initializes autoconfiguration data structures. -.Pp .Sh INDIRECT CONFIGURATION .nr nS 1 .Ft "void *" diff --git a/share/man/man9/bus_dma.9 b/share/man/man9/bus_dma.9 index ac1396eff29..f60c1b94284 100644 --- a/share/man/man9/bus_dma.9 +++ b/share/man/man9/bus_dma.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bus_dma.9,v 1.12 2002/06/12 07:10:36 aaron Exp $ +.\" $OpenBSD: bus_dma.9,v 1.13 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: bus_dma.9,v 1.14 2000/06/14 06:49:19 cgd Exp $ .\" .\" Copyright (c) 1996, 1997, 1998 The NetBSD Foundation, Inc. @@ -319,8 +319,8 @@ bus-dependent functionality. By default, the .Nm API assumes that there is coherency between memory and the device -performing the DMA transaction. Some platforms, however, have -special hardware, such as an +performing the DMA transaction. +Some platforms, however, have special hardware, such as an .Dq I/O cache , which may improve performance of some types of DMA transactions, but which break the assumption diff --git a/share/man/man9/hash.9 b/share/man/man9/hash.9 index e58305bd530..e8350e6e153 100644 --- a/share/man/man9/hash.9 +++ b/share/man/man9/hash.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hash.9,v 1.2 2002/06/21 19:14:14 weingart Exp $ +.\" $OpenBSD: hash.9,v 1.3 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2001 Tobias Weingartner .\" All rights reserved. @@ -131,7 +131,6 @@ sample_use(char *str, int len) hashtbl[hash & mask] = len; } .Ed -.Pp .Sh SEE ALSO .\" Not written yet, comming I hope .Xr free 9 diff --git a/share/man/man9/kern.9 b/share/man/man9/kern.9 index dfb35fb0006..bda4a311ecc 100644 --- a/share/man/man9/kern.9 +++ b/share/man/man9/kern.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: kern.9,v 1.1 2002/08/24 03:31:42 wcobb Exp $ +.\" $OpenBSD: kern.9,v 1.2 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2002 CubeSoft Communications, Inc. <http://www.csoft.org> .\" @@ -35,7 +35,6 @@ The .Nm library implements a set of useful functions and macros inside the kernel. -.Pp .Sh MATH .nr nS 1 .Ft int @@ -196,7 +195,6 @@ Those functions have the same semantics as their libc counterparts, and .Xr strncasecmp 3 . .Sh RANDOM NUMBER GENERATION -.Pp .nr nS 1 .Ft u_long .Fn random "void" @@ -233,7 +231,6 @@ The result is writte into which is assumed to be .Fa size bytes long. -.Pp .Sh SEE ALSO .Xr arc4random 9 , .Xr string 3 , diff --git a/share/man/man9/lock.9 b/share/man/man9/lock.9 index fb2fda00f50..b98ea28affd 100644 --- a/share/man/man9/lock.9 +++ b/share/man/man9/lock.9 @@ -70,34 +70,39 @@ The .Nm functions provide synchronisation in the kernel by preventing multiple processes from simultaneously executing critical sections of code -accessing shared data. A number of different locks are available: +accessing shared data. +A number of different locks are available: .Pp .Bl -tag -width compact .It struct simplelock -Provides a simple spinning mutex. A processor will busy-wait while -trying to acquire a simplelock. The simplelock operations are +Provides a simple spinning mutex. +A processor will busy-wait while trying to acquire a simplelock. +The simplelock operations are implemented with machine-dependent locking primitives. .Pp Simplelocks are usually used only by the high-level lock manager and -to protect short, critical sections of code. Simplelocks are the only -locks that can be be used inside an interrupt handler. For a -simplelock to be used in an interrupt handler, care must be taken to +to protect short, critical sections of code. +Simplelocks are the only +locks that can be be used inside an interrupt handler. +For a simplelock to be used in an interrupt handler, care must be taken to disable the interrupt, acquire the lock, do any processing, release -the simplelock and re-enable the interrupt. This procedure is -necessary to avoid deadlock between the interrupt handler and other -processes executing on the same processor. +the simplelock and re-enable the interrupt. +This procedure is necessary to avoid deadlock between the interrupt handler +and other processes executing on the same processor. .It struct lock Provides a high-level lock supporting sleeping/spinning until the lock -can be acquired. The lock manager supplies both exclusive-access and +can be acquired. +The lock manager supplies both exclusive-access and shared-access locks, with recursive exclusive-access locks within a -single process. It also allows upgrading a shared-access lock to an +single process. +It also allows upgrading a shared-access lock to an exclusive-access lock, as well as downgrading an exclusive-access lock to a shared-access lock. .El .Pp If the kernel option LOCKDEBUG is enabled, additional facilities -are provided to record additional lock information. These facilities are -provided to assist in determining deadlock occurrences. +are provided to record additional lock information. +These facilities are provided to assist in determining deadlock occurrences. .Sh FUNCTIONS The functions which operate on simplelocks are: .Pp @@ -105,33 +110,39 @@ The functions which operate on simplelocks are: .It Fn simple_lock_init "slock" The simplelock .Fa slock -is initialised to the unlocked state. A statically allocated simplelock -also can be initialised with the macro SIMPLELOCK_INITIALIZER. The -effect is the same as the dynamic initialisation by a call to -simple_lock_init. For example, +is initialised to the unlocked state. +A statically allocated simplelock also can be initialised with the macro +SIMPLELOCK_INITIALIZER. +The effect is the same as the dynamic initialisation by a call to +simple_lock_init. +For example, .Pp struct simplelock slock = SIMPLELOCK_INITIALIZER; .It Fn simple_lock "slock" The simplelock .Fa slock -is locked. If the simplelock is held then execution will -spin until the simplelock is acquired. Care must be taken that the -calling process does not already hold the simplelock. In this case, the -simplelock can never be acquired. If kernel option LOCKDEBUG is enabled, -a "locking against myself" panic will occur. +is locked. +If the simplelock is held then execution will +spin until the simplelock is acquired. +Care must be taken that the calling process does not already hold +the simplelock. +In this case, the simplelock can never be acquired. +If kernel option LOCKDEBUG is enabled, a "locking against myself" panic +will occur. .It Fn simple_lock_try "slock" Try to acquire the simplelock .Fa slock -without spinning. If the simplelock is held by another process -then the return value is 0. If the simplelock was acquired -successfully then the return value is 1. +without spinning. +If the simplelock is held by another process then the return value is 0. +If the simplelock was acquired successfully then the return value is 1. .It Fn simple_unlock "slock" The simplelock .Fa slock -is unlocked. The simplelock must be locked and the calling process must -be the one that last acquired the simplelock. If the calling -process does not hold the simplelock, the simplelock will be released -but the kernel behaviour is undefined. +is unlocked. +The simplelock must be locked and the calling process must +be the one that last acquired the simplelock. +If the calling process does not hold the simplelock, the simplelock +will be released but the kernel behaviour is undefined. .El .Pp The functions which operate on locks are: @@ -140,8 +151,8 @@ The functions which operate on locks are: .It Fn lockinit "lock" "prio" "wmesg" "timo" "flags" The lock .Fa lock -is initialised according to the parameters provided. Arguments are as -follows: +is initialised according to the parameters provided. +Arguments are as follows: .Bl -tag -width compact .It Fa lock The lock. @@ -151,11 +162,13 @@ The process priority when it is woken up after sleeping on the lock. A sleep message used when a process goes to sleep waiting for the lock, so that the exact reason it is sleeping can easily be identified. .It Fa timo -The maximum sleep time. Used by +The maximum sleep time. +Used by .Xr tsleep 9 . .It Fa flags Flags to specify the lock behaviour permanently over the lifetime of -the lock. Valid lock flags are: +the lock. +Valid lock flags are: .Bl -tag -width compact .It LK_NOWAIT Processes should not sleep when attempting to acquire the lock. @@ -172,23 +185,25 @@ Arguments are as follows: .It Fa lock The lock. .It Fa slock -Simplelock interlock. If the flag LK_INTERLOCK is set in +Simplelock interlock. +If the flag LK_INTERLOCK is set in .Fa flags , .Fa slock -is a simplelock held by the caller. When the lock +is a simplelock held by the caller. +When the lock .Fa lock -is acquired, the simplelock is released. If the flag LK_INTERLOCK is -not set, +is acquired, the simplelock is released. +If the flag LK_INTERLOCK is not set, .Fa slock is ignored. .It Fa flags -Flags to specify the lock request type. In addition to the flags -specified above, the following flags are valid: +Flags to specify the lock request type. +In addition to the flags specified above, the following flags are valid: .Bl -tag -width compact .It LK_SHARED -Get one of many possible shared-access locks. If a process holding an -exclusive-access lock requests a shared-access lock, the -exclusive-access lock is downgraded to a shared-access lock. +Get one of many possible shared-access locks. +If a process holding an exclusive-access lock requests a shared-access lock, +the exclusive-access lock is downgraded to a shared-access lock. .It LK_EXCLUSIVE Stop further shared-access locks, when they are cleared, grant a pending upgrade if it exists, then grant an exclusive-access lock. @@ -199,19 +214,23 @@ the lock request, or if the LK_CANRECURSE flag was set when the lock was initialised. .It LK_UPGRADE The process must hold a shared-access lock that it wants to have -upgraded to an exclusive-access lock. Other processes may get exclusive +upgraded to an exclusive-access lock. +Other processes may get exclusive access to the protected resource between the time that the upgrade is requested and the time that it is granted. .It LK_EXCLUPGRADE The process must hold a shared-access lock that it wants to have -upgraded to an exclusive-access lock. If the request succeeds, no +upgraded to an exclusive-access lock. +If the request succeeds, no other processes will have acquired exclusive access to the protected resource between the time that the upgrade is requested and the time -that it is granted. However, if another process has already requested +that it is granted. +However, if another process has already requested an upgrade, the request will fail. .It LK_DOWNGRADE The process must hold an exclusive-access lock that it wants to have -downgraded to a shared-access lock. If the process holds multiple +downgraded to a shared-access lock. +If the process holds multiple (recursive) exclusive-access locks, they will all be downgraded to shared-access locks. .It LK_RELEASE @@ -221,7 +240,8 @@ Wait for all activity on the lock to end, then mark it decommissioned. This feature is used before freeing a lock that is part of a piece of memory that is about to be freed. .It LK_REENABLE -Lock is to be re-enabled after drain. The LK_REENABLE flag may be set +Lock is to be re-enabled after drain. +The LK_REENABLE flag may be set only at the release of a lock obtained by a drain. .It LK_SETRECURSE Other locks while we have it OK. @@ -245,11 +265,11 @@ Print out information about state of lock .Fa lock . .El .Sh RETURN VALUES -Successfully acquired locks return 0. A failed lock attempt always -returns a non-zero error value. No lock is held after an error -return (in particular, a failed LK_UPGRADE or LK_FORCEUPGRADE will -have released its shared-access lock). Locks will always succeed -unless one of the following is true: +Successfully acquired locks return 0. +A failed lock attempt always returns a non-zero error value. +No lock is held after an error return (in particular, a failed LK_UPGRADE or +LK_FORCEUPGRADE will have released its shared-access lock). +Locks will always succeed unless one of the following is true: .Bl -tag -width Er .It Bq Er EBUSY LK_FORCEUPGRADE is requested and some other process has already @@ -270,7 +290,8 @@ Non-null lock timeout and timeout expires. This section describes places within the .Nx source tree where actual code implementing or utilising the locking -framework can be found. All pathnames are relative to +framework can be found. +All pathnames are relative to .Pa /usr/src . .Pp The locking framework itself is implemented within the file diff --git a/share/man/man9/rasops.9 b/share/man/man9/rasops.9 index 94024843155..4ca8610cc16 100644 --- a/share/man/man9/rasops.9 +++ b/share/man/man9/rasops.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rasops.9,v 1.1 2002/08/16 17:51:44 jason Exp $ +.\" $OpenBSD: rasops.9,v 1.2 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: rasops.9,v 1.4 2002/02/13 08:18:50 ross Exp $ .\" .\" Copyright (c) 2001 The NetBSD Foundation, Inc. @@ -155,21 +155,25 @@ completed successfully .It Fn rasops_init "ri" "wantrows" "wantcols" Initialise a .Em rasops_info -desriptor. The arguments +desriptor. +The arguments .Fa wantrows and .Fa wantcols -are the number of rows and columns we'd like. In terms of +are the number of rows and columns we'd like. +In terms of optimization, fonts that are a multiple of 8 pixels wide work the best. .It Fn rasops_reconfig "ri" "wantrows" "wantcols" Reconfigure a .Em rasops_info -descriptor because parameters have changed in some way. The arguments +descriptor because parameters have changed in some way. +The arguments .Fa wantrows and .Fa wantcols -are the number of rows and columns we'd like. If calling +are the number of rows and columns we'd like. +If calling .Fn rasops_reconfig to change the font and ri_wsfcookie \*[Ge] 0, you must call .Fn wsfont_unlock @@ -179,7 +183,8 @@ on it, and reset it to -1 (or a new, valid cookie). This section describes places within the .Ox source tree where actual code implementing or utilising the rasops -subsystem can be found. All pathnames are relative to +subsystem can be found. +All pathnames are relative to .Pa /usr/src . .Pp The rasops subsystem is implemented within the directory diff --git a/share/man/man9/uvm.9 b/share/man/man9/uvm.9 index 63c075ee1b9..f55930b4b0b 100644 --- a/share/man/man9/uvm.9 +++ b/share/man/man9/uvm.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uvm.9,v 1.14 2002/09/02 04:12:04 wcobb Exp $ +.\" $OpenBSD: uvm.9,v 1.15 2002/11/08 08:08:47 mpech Exp $ .\" $NetBSD: uvm.9,v 1.14 2000/06/29 06:08:44 mrg Exp $ .\" .\" Copyright (c) 1998 Matthew R. Green @@ -1030,7 +1030,6 @@ were named so uvm could coexist with BSD VM during the early development stages. They will be renamed to .Dq uvm_ . -.Pp .Sh HISTORY UVM is a new VM system developed at Washington University in St. Louis (Missouri). diff --git a/share/man/man9/vnode.9 b/share/man/man9/vnode.9 index 792d6bfef7f..01c0a784f20 100644 --- a/share/man/man9/vnode.9 +++ b/share/man/man9/vnode.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vnode.9,v 1.9 2002/08/26 20:18:07 art Exp $ +.\" $OpenBSD: vnode.9,v 1.10 2002/11/08 08:08:47 mpech Exp $ .\" .\" Copyright (c) 2001 Constantine Sapuntzakis .\" All rights reserved. @@ -36,7 +36,8 @@ directories, FIFOs, domain sockets, block devices, character devices. .Pp Each vnode has a set of methods which start with string 'VOP_'. These methods include VOP_OPEN, VOP_READ, VOP_WRITE, VOP_RENAME, VOP_CLOSE, -VOP_MKDIR. Many of these methods correspond closely to the equivalent +VOP_MKDIR. +Many of these methods correspond closely to the equivalent file system call--open, read, write, rename, etc. Each file system (FFS, NFS, etc.) provides implementations for these methods. .Pp @@ -45,7 +46,8 @@ File systems cannot allocate their own vnodes; they must use the functions provided by the VFS to create and manage vnodes. .Ss Vnode state Vnodes have a reference count which corresponds to the number of kernel -objects that hold references to the vnode. A positive reference count keeps +objects that hold references to the vnode. +A positive reference count keeps the vnode off of the free list, which prevents the vnode from being recycled to refer to a different file. .Pp @@ -107,7 +109,8 @@ They can be called on both active and inactive vnodes. .Pp While transitioning a vnode to the "reclaimed" state, the VFS will call .Xr vop_reclaim 9 -method. File systems use this method to free any file-system specific data +method. +File systems use this method to free any file-system specific data they attached to the vnode. .Ss Vnode locks The vnode actually has three different types of lock: the vnode lock, @@ -137,7 +140,8 @@ Many file systems rely on it to prevent race conditions in updating file system specific data structures (as opposed to having their own locks). .Pp The implementation of the vnode lock is the responsibility of the individual -file systems. Not all file system implement it. +file systems. +Not all file system implement it. .Pp To prevent deadlocks, when acquiring locks on multiple vnodes, the lock of parent directory must be acquired before the lock on the child directory. |