From 88f86411180858c659b44a4139ca3d7d3963d6b3 Mon Sep 17 00:00:00 2001 From: riastradh Date: Sat, 18 Mar 2017 19:01:01 +0000 Subject: [PATCH] Use `\(em', not `--'. Refill sentences and tweak wording where appropriate while here. --- share/man/man9/bufferio.9 | 6 +++--- share/man/man9/fstrans.9 | 4 ++-- share/man/man9/kauth.9 | 10 +++++----- share/man/man9/ltsleep.9 | 7 ++++--- share/man/man9/memcpy.9 | 6 +++--- share/man/man9/namei.9 | 4 ++-- share/man/man9/secmodel.9 | 12 ++++++------ share/man/man9/sysctl.9 | 12 ++++++------ share/man/man9/uvm.9 | 12 ++++++------ share/man/man9/wapbl.9 | 20 ++++++++++---------- 10 files changed, 47 insertions(+), 46 deletions(-) diff --git a/share/man/man9/bufferio.9 b/share/man/man9/bufferio.9 index 331ee84c2e65..393c023c096d 100644 --- a/share/man/man9/bufferio.9 +++ b/share/man/man9/bufferio.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: bufferio.9,v 1.16 2015/03/30 14:09:04 riastradh Exp $ +.\" $NetBSD: bufferio.9,v 1.17 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 2015 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -125,7 +125,7 @@ vnode lock between incrementing .Fa vp Ns Li "->v_numoutput" and submitting .Fa bp -to a block device -- doing so will likely cause deadlock with the +to a block device \(em doing so will likely cause deadlock with the syncer. .Pp Block I/O transfer completion may be notified by the @@ -354,7 +354,7 @@ To be called by a user requesting the I/O transfer. .Pp May not be called if .Fa bp -has a callback or is asynchronous -- that is, if +has a callback or is asynchronous \(em that is, if .Fa bp Ns Li "->b_iodone" is set, or if .Dv B_ASYNC diff --git a/share/man/man9/fstrans.9 b/share/man/man9/fstrans.9 index eff8610a67bd..04af468f125a 100644 --- a/share/man/man9/fstrans.9 +++ b/share/man/man9/fstrans.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: fstrans.9,v 1.20 2015/03/31 21:08:06 riastradh Exp $ +.\" $NetBSD: fstrans.9,v 1.21 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 2007 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -373,7 +373,7 @@ subsystem was written by .Aq hannken@NetBSD.org . .Sh BUGS .Nm -is useful only for temporary suspension -- it does not help to +is useful only for temporary suspension \(em it does not help to permanently block file system operations for unmounting, because .Fn fstrans_start cannot fail. diff --git a/share/man/man9/kauth.9 b/share/man/man9/kauth.9 index e85c9aaa2bab..50ec7d5a513f 100644 --- a/share/man/man9/kauth.9 +++ b/share/man/man9/kauth.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: kauth.9,v 1.106 2017/02/26 15:44:15 riastradh Exp $ +.\" $NetBSD: kauth.9,v 1.107 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 2005, 2006 Elad Efrat .\" All rights reserved. @@ -1928,8 +1928,8 @@ It is enough for one listener to deny the request in order for the request to be denied; but all listeners are called during an authorization process none-the-less. All listeners are required to allow the request for it to be granted, -and in a case where all listeners defer the request -- leaving the decision -for other listeners -- the request is denied. +and in a case where all listeners defer the request \(em leaving the +decision for other listeners \(em the request is denied. .Pp The following KPI is provided for the management of listeners: .Bl -tag -width compact @@ -1962,8 +1962,8 @@ the listener, possibly freeing any allocated data it used. .Pp The common method to do the above is by having a reference count to each listener. -On entry to the listener, this reference count should be raised, and -on exit -- lowered. +On entry to the listener, this reference count should be raised; on +exit, lowered. .Pp During the removal of a listener, first .Fn kauth_scope_unlisten diff --git a/share/man/man9/ltsleep.9 b/share/man/man9/ltsleep.9 index 37a36db1ab14..6259992816e8 100644 --- a/share/man/man9/ltsleep.9 +++ b/share/man/man9/ltsleep.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: ltsleep.9,v 1.17 2014/03/22 11:35:03 wiz Exp $ +.\" $NetBSD: ltsleep.9,v 1.18 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 1996, 2002, 2007 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -78,8 +78,9 @@ The function .Fn wakeup is used to notify sleeping processes of possible changes to the condition that caused them to go to sleep. -Typically, an awakened process will -- after it has acquired a context -again -- retry the action that blocked its operation to see if the +Typically, an awakened process will \(em after it has acquired a +context again \(em retry the action that blocked its operation to see +if the .Dq blocking condition has cleared. .Pp diff --git a/share/man/man9/memcpy.9 b/share/man/man9/memcpy.9 index 90ab969c57ab..be3e454a14e5 100644 --- a/share/man/man9/memcpy.9 +++ b/share/man/man9/memcpy.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: memcpy.9,v 1.9 2012/01/02 18:07:21 wiz Exp $ +.\" $NetBSD: memcpy.9,v 1.10 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -53,8 +53,8 @@ bytes from string .Fa src to string .Fa dst . -The arguments must not overlap -- behavior if the arguments overlap is -undefined. +The arguments must not overlap \(em behavior if the arguments overlap +is undefined. To copy byte strings that overlap, use .Xr memmove 9 . .Sh RETURN VALUES diff --git a/share/man/man9/namei.9 b/share/man/man9/namei.9 index 9aaedfbfef56..fbd9b2082841 100644 --- a/share/man/man9/namei.9 +++ b/share/man/man9/namei.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: namei.9,v 1.42 2017/03/18 18:55:49 riastradh Exp $ +.\" $NetBSD: namei.9,v 1.43 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 2001, 2005, 2006 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -214,7 +214,7 @@ mode for each directory component, and then finally calls .Xr VOP_LOOKUP 9 in the caller-specified mode for the last component. .El -Each mode can fail in different ways -- for example, +Each mode can fail in different ways \(em for example, .Dv LOOKUP mode fails with .Er ENOENT diff --git a/share/man/man9/secmodel.9 b/share/man/man9/secmodel.9 index e34a3bd8ee5b..b89b925a8371 100644 --- a/share/man/man9/secmodel.9 +++ b/share/man/man9/secmodel.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: secmodel.9,v 1.20 2014/03/18 18:20:40 riastradh Exp $ +.\" $NetBSD: secmodel.9,v 1.21 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 2006 Elad Efrat .\" All rights reserved. @@ -56,8 +56,8 @@ and above-super-user restrictions known as .Em securelevel ) while decoupling it easily from the system. .Pp -It is possible to modify the security model -- either slightly or using an -entirely different model -- by attaching/detaching +It is possible to modify the security model \(em either slightly or +using an entirely different model \(em by attaching/detaching .Xr kauth 9 listeners. This can be done via the @@ -296,7 +296,7 @@ security model, even if it would allow the request, it could still be denied. .It If you attach this listener as the only listener for the network scope, there are many other requests that will be deferred and, eventually, -denied -- which may not be desired. +denied \(em which may not be desired. .El .Pp That's why before implementing listeners, it should be clear whether they @@ -321,8 +321,8 @@ locks. This is a requirement from kernel code to allow designing security models where the request should be dispatched to userspace or a different host. .It -Private listener data -- such as internal data-structures -- is entirely -under the responsibility of the developer. +Private listener data \(em such as internal data structures \(em is +entirely under the responsibility of the developer. Locking, synchronization, and garbage collection are all things that .Xr kauth 9 does diff --git a/share/man/man9/sysctl.9 b/share/man/man9/sysctl.9 index 490714efbd31..addeef1c96fc 100644 --- a/share/man/man9/sysctl.9 +++ b/share/man/man9/sysctl.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: sysctl.9,v 1.18 2011/12/04 18:34:20 jym Exp $ +.\" $NetBSD: sysctl.9,v 1.19 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 2004 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -622,18 +622,18 @@ during the following stages of a machine's lifetime: .Pp .Bl -bullet -compact .It -initialization -- when the kernel is booting +initialization \(em when the kernel is booting .It -autoconfiguration -- when devices are being probed at boot time +autoconfiguration \(em when devices are being probed at boot time .It .Dq plug and play -device attachment -- when a PC-Card, USB, or other device is plugged +device attachment \(em when a PC-Card, USB, or other device is plugged in or attached .It -module initialization -- when a module is being loaded +module initialization \(em when a module is being loaded .It .Dq run-time --- when a process creates a node via the +\(em when a process creates a node via the .Xr sysctl 3 interface .El diff --git a/share/man/man9/uvm.9 b/share/man/man9/uvm.9 index 114969fa4c08..b08cdd3e3a5f 100644 --- a/share/man/man9/uvm.9 +++ b/share/man/man9/uvm.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: uvm.9,v 1.112 2017/01/05 09:55:01 wiz Exp $ +.\" $NetBSD: uvm.9,v 1.113 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 1998 Matthew R. Green .\" All rights reserved. @@ -472,24 +472,24 @@ The flags can be any bitwise inclusive-or of: .It Dv UFP_ALL Zero pseudo-flag meaning return all pages. .It Dv UFP_NOWAIT -Don't sleep -- yield +Don't sleep \(em yield .Dv NULL for busy pages or for uncached pages for which allocation would sleep. .It Dv UFP_NOALLOC -Don't allocate -- yield +Don't allocate \(em yield .Dv NULL for uncached pages. .It Dv UFP_NOCACHE -Don't use cached pages -- yield +Don't use cached pages \(em yield .Dv NULL instead. .It Dv UFP_NORDONLY -Don't yield read-only pages -- yield +Don't yield read-only pages \(em yield .Dv NULL for pages marked .Dv PG_READONLY . .It Dv UFP_DIRTYONLY -Don't yield clean pages -- stop early at the first clean one. +Don't yield clean pages \(em stop early at the first clean one. As a side effect, mark yielded dirty pages clean. Caller must write them to permanent storage before unbusying. .It Dv UFP_BACKWARD diff --git a/share/man/man9/wapbl.9 b/share/man/man9/wapbl.9 index cfc476136bdd..87d1e1a9de85 100644 --- a/share/man/man9/wapbl.9 +++ b/share/man/man9/wapbl.9 @@ -1,4 +1,4 @@ -.\" $NetBSD: wapbl.9,v 1.14 2016/05/08 10:13:01 wiz Exp $ +.\" $NetBSD: wapbl.9,v 1.15 2017/03/18 19:01:01 riastradh Exp $ .\" .\" Copyright (c) 2015 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -136,7 +136,7 @@ Hence a consistent program-order view of the file system can be attained by resubmitting the writes that were successfully stored in the log using .Xr wapbl_replay 9 . -This may not be the same state just before interruption -- writes in +This may not be the same state just before interruption \(em writes in transactions that did not reach the disk will be excluded. .Pp For a file system to use @@ -199,8 +199,8 @@ values are .Sq inodes or .Sq quaggas -or anything else -- file systems may use this to list any objects keyed -by +or anything else \(em file systems may use this to list any objects +keyed by .Vt ino_t value in the log. .Pp @@ -436,7 +436,7 @@ and .Fn wapbl_end . .Pp There is no way to assert that the current transaction is not locked at -all -- i.e., that the caller may acquire a shared lock on the +all \(em i.e., that the caller may acquire a shared lock on the transaction with .Fn wapbl_begin without danger of deadlock. @@ -472,8 +472,8 @@ This manifests as the well-known garbage-data-appended-after-crash bug in FFS: when appending to a file, the pages containing new data may not reach the disk before the inode update reporting its new size. After a crash, the inode update will be on disk, but the new data will -not be -- instead, whatever garbage data in the free space will appear -to have been appended to the file. +not be \(em instead, whatever garbage data in the free space will +appear to have been appended to the file. .Nm exacerbates the problem by increasing the throughput of metadata writes, because it can issue many metadata writes asynchronously that @@ -500,9 +500,9 @@ and .Fn wapbl_unregister_inode . Consequently, for example, large writes appending to a file, which requires multiple disk block allocations and an inode update, must -occur in a single transaction -- there is no way to roll back the disk -block allocations if the write fails in the middle, e.g. because of a -fault in the middle of the user buffer. +occur in a single transaction \(em there is no way to roll back the +disk block allocations if the write fails in the middle, e.g. because +of a fault in the middle of the user buffer. .Pp .Fn wapbl_jlock_assert does not guarantee that the current thread has the current transaction