From 559eb8d2e3f5b22fda7535e64f86c7862c763eab Mon Sep 17 00:00:00 2001 From: Hiten Pandya Date: Thu, 23 Oct 2003 02:33:03 +0000 Subject: [PATCH] Mdoc Janitor: * Fix hard sentence breaks. --- share/man/man9/cd.9 | 31 +++++++++++++++++++------------ share/man/man9/extattr.9 | 3 ++- share/man/man9/inittodr.9 | 12 ++++++------ share/man/man9/random.9 | 3 ++- share/man/man9/resettodr.9 | 3 ++- share/man/man9/sleep.9 | 9 ++++++--- share/man/man9/spl.9 | 19 ++++++++++++------- share/man/man9/suser.9 | 7 ++++--- share/man/man9/time.9 | 10 ++++++---- 9 files changed, 59 insertions(+), 38 deletions(-) diff --git a/share/man/man9/cd.9 b/share/man/man9/cd.9 index 49c2eded36f1..934037f79a83 100644 --- a/share/man/man9/cd.9 +++ b/share/man/man9/cd.9 @@ -43,25 +43,27 @@ and WORM drives .Tn ( SCSI type 4) that support CDROM type commands. -Some drives don't behave as the driver expects. See the section -QUIRKS for info on possible flags. +Some drives don't behave as the driver expects. +See the section QUIRKS for info on possible flags. .Sh QUIRKS Each .Tn CD-ROM device can have different interpretations of the .Tn SCSI -spec. This can lead to drives requiring special handling in the driver. The -following is a list of quirks that the driver recognize. +spec. +This can lead to drives requiring special handling in the driver. +The following is a list of quirks that the driver recognize. .Bl -tag -width CD_Q_BCD_TRACKS .It Dv CD_Q_NO_TOUCH This flag tell the driver not to probe the drive at attach time to see if -there is a disk in the drive and find out what size it is. This flag is -currently unimplemented in the CAM +there is a disk in the drive and find out what size it is. +This flag is currently unimplemented in the CAM .Nm driver. .It Dv CD_Q_BCD_TRACKS This flag is for broken drives that return the track numbers in packed BCD -instead of straight decimal. If the drive seems to skip tracks +instead of straight decimal. +If the drive seems to skip tracks (tracks 10-15 are skipped) then you have a drive that is in need of this flag. .It Dv CD_Q_NO_CHANGER @@ -71,22 +73,27 @@ part of a changer. .It Dv CD_Q_CHANGER This flag tells the driver that the given device is a multi-lun changer. In general, the driver will figure this out automatically when it sees a -LUN greater than 0. Setting this flag only has the effect of telling the +LUN greater than 0. +Setting this flag only has the effect of telling the driver to run the initial read capacity command for LUN 0 of the changer through the changer scheduling code. .It Dv CD_Q_10_BYTE_ONLY This flag tells the driver that the given device only accepts 10 byte MODE -SENSE/MODE SELECT commands. In general these types of quirks should not be +SENSE/MODE SELECT commands. +In general these types of quirks should not be added to the .Xr cd 4 -driver. The reason is that the driver does several things to attempt to -determine whether the drive in question needs 10 byte commands. First, it +driver. +The reason is that the driver does several things to attempt to +determine whether the drive in question needs 10 byte commands. +First, it issues a CAM Path Inquiry command to determine whether the protocol that the drive speaks typically only allows 10 byte commands. (ATAPI and USB are two prominent examples of protocols where you generally only want to send 10 byte commands.) Then, if it gets an ILLEGAL REQUEST error back from a 6 byte MODE SENSE or MODE SELECT command, it attempts to send the 10 -byte version of the command instead. The only reason you would need a +byte version of the command instead. +The only reason you would need a quirk is if your drive uses a protocol (e.g. .Tn SCSI ) that typically doesn't have a problem with 6 byte commands. diff --git a/share/man/man9/extattr.9 b/share/man/man9/extattr.9 index 808d250b30f6..77384ea688f5 100644 --- a/share/man/man9/extattr.9 +++ b/share/man/man9/extattr.9 @@ -72,7 +72,8 @@ specific new attributes may be defined. .Pp Extended attributes are named using a null-terminated character string. Depending on underlying file system semantics, this name may or may not be -case-sensitive. Appropriate vnode extended attribute calls are: +case-sensitive. +Appropriate vnode extended attribute calls are: .Xr VOP_GETEXTATTR 9 , .Xr VOP_LISTEXTATTR 9 , and diff --git a/share/man/man9/inittodr.9 b/share/man/man9/inittodr.9 index 39dd7416b9d9..61524f206296 100644 --- a/share/man/man9/inittodr.9 +++ b/share/man/man9/inittodr.9 @@ -85,8 +85,8 @@ variable. The .Fn inittodr function prints diagnostic messages if it has trouble figuring -out the system time. Conditions that can cause diagnostic -messages to be printed include: +out the system time. +Conditions that can cause diagnostic messages to be printed include: .Bl -bullet .It The battery-backed clock's time appears nonsensical. @@ -109,8 +109,8 @@ has to convert from a time expressed in terms of year, month, day, hours, minutes, and seconds to .Va time , -expressed in seconds. Many of the implementations could share code, -but do not. +expressed in seconds. +Many of the implementations could share code, but do not. .Pp Each system's heuristics for picking the correct time are slightly different. @@ -119,5 +119,5 @@ The .Fx implementation should do a better job of validating the time provided in .Fa base -when the battery-backed clock is unusable. Currently it unconditionally -sets the system clock to this value. +when the battery-backed clock is unusable. +Currently it unconditionally sets the system clock to this value. diff --git a/share/man/man9/random.9 b/share/man/man9/random.9 index e8f365f4f059..de41aa5fc0de 100644 --- a/share/man/man9/random.9 +++ b/share/man/man9/random.9 @@ -105,7 +105,8 @@ All the bits generated by .Fn arc4rand and .Fn read_random -are usable. For example, +are usable. +For example, .Sq Li random()&01 will produce a random binary value. .Pp diff --git a/share/man/man9/resettodr.9 b/share/man/man9/resettodr.9 index 95c842ad08bd..9818c8fd435b 100644 --- a/share/man/man9/resettodr.9 +++ b/share/man/man9/resettodr.9 @@ -58,4 +58,5 @@ On many systems, has to convert from .Va time to a time expressed in terms of year, month, day, hours, minutes, -and seconds. Many of the implementations could share code, but do not. +and seconds. +Many of the implementations could share code, but do not. diff --git a/share/man/man9/sleep.9 b/share/man/man9/sleep.9 index f3b5f6c92df8..0a3cdb3e5c14 100644 --- a/share/man/man9/sleep.9 +++ b/share/man/man9/sleep.9 @@ -58,7 +58,8 @@ external event, it is put on sleep by The parameter .Fa ident is an arbitrary address that uniquely identifies the event on which -the process is being asleep. All processes sleeping on a single +the process is being asleep. +All processes sleeping on a single .Fa ident are woken up later by .Fn wakeup , @@ -77,7 +78,8 @@ The function is used to make the first process in the queue that is sleeping on the parameter .Fa ident -runnable. This can prevent the system from becoming saturated +runnable. +This can prevent the system from becoming saturated when a large number of processes are sleeping on the same address, but only one of them can actually do any useful work when made runnable. @@ -98,7 +100,8 @@ If includes the .Dv PCATCH flag, signals are checked before and after sleeping, else signals are -not checked. Returns 0 if awakened, +not checked. +Returns 0 if awakened, .Er EWOULDBLOCK if the timeout expires. If diff --git a/share/man/man9/spl.9 b/share/man/man9/spl.9 index 235b48bbd8ca..f819af7b198a 100644 --- a/share/man/man9/spl.9 +++ b/share/man/man9/spl.9 @@ -82,7 +82,8 @@ function family sets the interrupt priority .Dq level of the CPU. This prevents interrupt handlers of the blocked priority level from -being run. This is used in the +being run. +This is used in the .Dq synchronous part of a driver (the part that runs on behalf of the user process) to examine or modify data areas that might be examined or modified by @@ -97,7 +98,8 @@ device foo0 at isa? port 0x0815 irq 12 tty .Pp assigns interrupt 12 to the .Dq tty -priority group. The system automatically arranges for interrupts in +priority group. +The system automatically arranges for interrupts in the .Em xxx group to be called at a priority >= @@ -106,7 +108,8 @@ group to be called at a priority >= .Pp The function .Fn splx -sets the interrupt priority to an absolute value. The intent is that +sets the interrupt priority to an absolute value. +The intent is that the value returned by the other functions should be saved in a local variable, and later passed to .Fn splx @@ -186,7 +189,8 @@ foointr(...) .Ed Note that the interrupt handler should .Em never -reduce the priority level. It is automatically called as it had +reduce the priority level. +It is automatically called as it had raised the interrupt priority to its own level, i.e. further interrupts of the same group are being blocked. .Sh HISTORY @@ -194,8 +198,8 @@ The interrupt priority levels appeared in a very early version of .Ux . They have been traditionally known by number instead of by names, and were inclusive up to higher priority levels (i.e., priority -5 has been blocking everything up to level 5). This is no longer the -case in +5 has been blocking everything up to level 5). +This is no longer the case in .Fx . The traditional name .Ql level @@ -204,7 +208,8 @@ for them is still reflected in the letter of the respective functions and variables, although they are not really levels anymore, but rather different (partially inclusive) sets of functions to be blocked during some periods of the life of -the system. The historical number scheme can be considered as a +the system. +The historical number scheme can be considered as a simple linearly ordered set of interrupt priority groups. .Sh AUTHORS This man page was written by diff --git a/share/man/man9/suser.9 b/share/man/man9/suser.9 index c8b7af28c0a4..94c9b30ccd57 100644 --- a/share/man/man9/suser.9 +++ b/share/man/man9/suser.9 @@ -74,9 +74,10 @@ be done by setting the .Dv PRISON_ROOT bit in the flags argument to the .Nm suser_cred -function. It is important to review carefully in each case that -this does not weaken the prison. Generally only where the action -is protected by the +function. +It is important to review carefully in each case that +this does not weaken the prison. +Generally only where the action is protected by the .Xr chroot 2 implicit in .Xr jail 2 diff --git a/share/man/man9/time.9 b/share/man/man9/time.9 index 6a60549f27c9..0c14d749cab2 100644 --- a/share/man/man9/time.9 +++ b/share/man/man9/time.9 @@ -65,7 +65,8 @@ system call and by periodic clock interrupts. .Pp The .Va boottime -variable holds the system boot time. It is set from +variable holds the system boot time. +It is set from .Va time at system boot, and is updated when the system time is adjusted with @@ -87,7 +88,8 @@ function, rather than being copied from .Pp The .Va mono_time -variable is a monotonically increasing system clock. It is set +variable is a monotonically increasing system clock. +It is set from .Va time at boot, and is updated by the periodic timer interrupt. (It is @@ -109,8 +111,8 @@ The .Xr gettime 9 function can be used to read the .Va time -variable in an atomic manner. There is no equivalent -function for accessing +variable in an atomic manner. +There is no equivalent function for accessing .Va mono_time . The .Va boottime