From 7851d429a6e8f958a5cd7a3a16a78497e6741346 Mon Sep 17 00:00:00 2001 From: Edward Tomasz Napierala Date: Wed, 8 Jun 2016 09:19:47 +0000 Subject: [PATCH] Fix a bunch of "sentence not on new line" warnings in section 9. MFC after: 1 month --- share/man/man9/bpf.9 | 4 +-- share/man/man9/firmware.9 | 9 +++-- share/man/man9/lock.9 | 3 +- share/man/man9/locking.9 | 3 +- share/man/man9/sysctl.9 | 6 ++-- share/man/man9/timeout.9 | 6 ++-- share/man/man9/usbdi.9 | 69 +++++++++++++++++++++--------------- share/man/man9/vn_fullpath.9 | 3 +- share/man/man9/zone.9 | 6 ++-- 9 files changed, 66 insertions(+), 43 deletions(-) diff --git a/share/man/man9/bpf.9 b/share/man/man9/bpf.9 index ebf26cb593aa..cddff70daf9b 100644 --- a/share/man/man9/bpf.9 +++ b/share/man/man9/bpf.9 @@ -256,8 +256,8 @@ Pointer to .Pq Vt "struct ifnet *" is passed as the first argument, interface .Fa dlt -follows. Last argument indicates listener is attached (1) or -detached (0). +follows. +Last argument indicates listener is attached (1) or detached (0). Note that handler is invoked with .Nm global lock held, which implies restriction on sleeping and calling diff --git a/share/man/man9/firmware.9 b/share/man/man9/firmware.9 index f8c8b322d90d..d6006523e407 100644 --- a/share/man/man9/firmware.9 +++ b/share/man/man9/firmware.9 @@ -97,7 +97,8 @@ by calling the function .Fn firmware_get with the .Nm imagename -they want as an argument. If a matching image is not already registered, +they want as an argument. +If a matching image is not already registered, the firmware subsystem will try to load it using the mechanisms specified below (typically, a kernel module with @@ -127,7 +128,8 @@ pointer to the image requested. .Fn firmware_unregister tries to unregister the firmware image .Nm imagename -from the system. The function is successful and returns 0 +from the system. +The function is successful and returns 0 if there are no pending references to the image, otherwise it does not unregister the image and returns EBUSY. .Pp @@ -148,7 +150,8 @@ already mounted. On success, .Fn firmware_get returns a pointer to the image description and increases the reference count -for this image. On failure, the function returns NULL. +for this image. +On failure, the function returns NULL. .Pp .Fn firmware_put drops a reference to a firmware image. diff --git a/share/man/man9/lock.9 b/share/man/man9/lock.9 index 3ac23db944de..db99cad4abaa 100644 --- a/share/man/man9/lock.9 +++ b/share/man/man9/lock.9 @@ -215,7 +215,8 @@ The flag allows exclusive requests to preempt the current shared request even if the current thread owns shared locks. This is safe since shared lock is guaranteed to not recurse, and is used when thread is known to held unrelated shared locks, to not cause -unnecessary starvation. An example is +unnecessary starvation. +An example is .Dv vp locking in VFS .Xr lookup 9 , diff --git a/share/man/man9/locking.9 b/share/man/man9/locking.9 index 30d3b92526c2..06428e282117 100644 --- a/share/man/man9/locking.9 +++ b/share/man/man9/locking.9 @@ -335,7 +335,8 @@ running inside an interrupt thread. .El .Ss Interaction table The following table shows what you can and can not do while holding -one of the locking primitives discussed. Note that +one of the locking primitives discussed. +Note that .Dq sleep includes .Fn sema_wait , diff --git a/share/man/man9/sysctl.9 b/share/man/man9/sysctl.9 index 097cc97df877..6b9098df6c1c 100644 --- a/share/man/man9/sysctl.9 +++ b/share/man/man9/sysctl.9 @@ -628,7 +628,8 @@ system boot. .It Dv CTLFLAG_NOFETCH In case the node is marked as a tunable using the CTLFLAG_[XX]TUN, this flag will prevent fetching the initial value from the system -environment. Typically this flag should only be used for very early +environment. +Typically this flag should only be used for very early low level system setup code, and not by common drivers and modules. .El .Pp @@ -780,7 +781,8 @@ Use positive logic instead: .Va foobar_enable . .Pp A temporary sysctl node OID that should not be relied upon must be designated -as such by a leading underscore character in its name. For example: +as such by a leading underscore character in its name. +For example: .Va _dirty_hack . .Sh SEE ALSO .Xr sysctl 3 , diff --git a/share/man/man9/timeout.9 b/share/man/man9/timeout.9 index ee309429e80b..df8538ed02e5 100644 --- a/share/man/man9/timeout.9 +++ b/share/man/man9/timeout.9 @@ -268,7 +268,8 @@ then that lock must be held when this function is called. Note that when stopping multiple callouts that use the same lock it is possible to get multiple return's of zero and multiple calls to the .Fa drain -function, depending upon which CPU's the callouts are running. The +function, depending upon which CPU's the callouts are running. +The .Fa drain function itself is called from the context of the completing callout i.e. softclock or hardclock, just like a callout itself. @@ -813,7 +814,8 @@ and .Fn callout_drain functions return a value of one if the callout was still pending when it was called, a zero if the callout could not be stopped and a negative one is it -was either not running or haas already completed. The +was either not running or haas already completed. +The .Fn timeout function returns a .Ft struct callout_handle diff --git a/share/man/man9/usbdi.9 b/share/man/man9/usbdi.9 index a42626a7ccfb..588c79e501b3 100644 --- a/share/man/man9/usbdi.9 +++ b/share/man/man9/usbdi.9 @@ -157,7 +157,8 @@ available. .Fa udev is a pointer to "struct usb_device". .Fa ifaces -is an array of interface index numbers to use. See "if_index". +is an array of interface index numbers to use. +See "if_index". .Fa pxfer is a pointer to an array of USB transfer pointers that are initialized to NULL, and then pointed to allocated USB transfers. @@ -171,9 +172,10 @@ is the private softc pointer, which will be used to initialize "xfer->priv_sc". .Fa priv_mtx is the private mutex protecting the transfer structure and the -softc. This pointer is used to initialize "xfer->priv_mtx". -This function returns -zero upon success. A non-zero return value indicates failure. +softc. +This pointer is used to initialize "xfer->priv_mtx". +This function returns zero upon success. +A non-zero return value indicates failure. . .Pp . @@ -245,8 +247,8 @@ pointer. . The USB callback has three states. . -USB_ST_SETUP, USB_ST_TRANSFERRED and USB_ST_ERROR. USB_ST_SETUP is the -initial state. +USB_ST_SETUP, USB_ST_TRANSFERRED and USB_ST_ERROR. +USB_ST_SETUP is the initial state. . After the callback has been called with this state it will always be called back at a later stage in one of the other two states. @@ -323,7 +325,8 @@ The SETUP packet is always pointed to by frame 0 and the length is set by .Fn usbd_xfer_frame_len also if there should not be -sent any SETUP packet! If an USB control transfer has no DATA stage, +sent any SETUP packet! +If an USB control transfer has no DATA stage, then the number of frames should be set to 1. . Else the default number of frames is 2. @@ -440,10 +443,12 @@ Depending on the endpoint type, this field has different meaning: "0" use the default interrupt interval based on endpoint descriptor. "Else" use the given value for polling rate. .It UE_ISOCHRONOUS -"0" use default. "Else" the value is ignored. +"0" use default. +"Else" the value is ignored. .It UE_BULK .It UE_CONTROL -"0" no transfer pre-delay. "Else" a delay as given by this field in +"0" no transfer pre-delay. +"Else" a delay as given by this field in milliseconds is inserted before the hardware is started when "usbd_transfer_submit()" is called. .Pp @@ -453,14 +458,14 @@ pre-delay has elapsed! . .Pp .Fa timeout -field, if non-zero, will set the transfer timeout in milliseconds. If -the "timeout" field is zero and the transfer type is ISOCHRONOUS a +field, if non-zero, will set the transfer timeout in milliseconds. +If the "timeout" field is zero and the transfer type is ISOCHRONOUS a timeout of 250ms will be used. . .Pp .Fa frames -field sets the maximum number of frames. If zero is specified it will -yield the following results: +field sets the maximum number of frames. +If zero is specified it will yield the following results: .Bl -tag -width "UE_INTERRUPT" .It UE_BULK xfer->nframes = 1; @@ -469,7 +474,8 @@ xfer->nframes = 1; .It UE_CONTROL xfer->nframes = 2; .It UE_ISOCHRONOUS -Not allowed. Will cause an error. +Not allowed. +Will cause an error. .El . .Pp @@ -486,26 +492,29 @@ be used when setting up the given USB transfer. .Pp .Fa flags field has type "struct usb_xfer_flags" and allows one to set initial -flags an USB transfer. Valid flags are: +flags an USB transfer. +Valid flags are: .Bl -tag -width "force_short_xfer" .It force_short_xfer -This flag forces the last transmitted USB packet to be short. A short -packet has a length of less than "xfer->max_packet_size", which -derives from "wMaxPacketSize". This flag can be changed during -operation. +This flag forces the last transmitted USB packet to be short. +A short packet has a length of less than "xfer->max_packet_size", which +derives from "wMaxPacketSize". +This flag can be changed during operation. .It short_xfer_ok This flag allows the received transfer length, "xfer->actlen" to be -less than "xfer->sumlen" upon completion of a transfer. This flag can -be changed during operation. +less than "xfer->sumlen" upon completion of a transfer. +This flag can be changed during operation. .It short_frames_ok -This flag allows the reception of multiple short USB frames. This flag +This flag allows the reception of multiple short USB frames. +This flag only has effect for BULK and INTERRUPT endpoints and if the number of -frames received is greater than 1. This flag can be changed during -operation. +frames received is greater than 1. +This flag can be changed during operation. .It pipe_bof This flag causes a failing USB transfer to remain first in the PIPE queue except in the case of "xfer->error" equal to -"USB_ERR_CANCELLED". No other USB transfers in the affected PIPE queue +"USB_ERR_CANCELLED". +No other USB transfers in the affected PIPE queue will be started until either: .Bl -tag -width "X" .It 1 @@ -569,8 +578,8 @@ This flag can be changed during operation. . . .It no_pipe_ok -Setting this flag causes the USB_ERR_NO_PIPE error to be ignored. This -flag can not be changed during operation. +Setting this flag causes the USB_ERR_NO_PIPE error to be ignored. +This flag can not be changed during operation. . . .It stall_pipe @@ -614,7 +623,8 @@ request structure. . .Pp .Fa callback -pointer sets the USB callback. This field is mandatory. +pointer sets the USB callback. +This field is mandatory. . . .Sh USB LINUX COMPAT LAYER @@ -635,7 +645,8 @@ module complies with the USB 2.0 standard. The .Nm usb module has been inspired by the NetBSD USB stack initially written by -Lennart Augustsson. The +Lennart Augustsson. +The .Nm usb module was written by .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org . diff --git a/share/man/man9/vn_fullpath.9 b/share/man/man9/vn_fullpath.9 index 50c35c979f8c..f961fbbd1559 100644 --- a/share/man/man9/vn_fullpath.9 +++ b/share/man/man9/vn_fullpath.9 @@ -73,7 +73,8 @@ The thread performing the call; this pointer will be dereferenced to find the process and its file descriptor structure, in order to identify the root vnode to use. .It Fa vp -The vnode to search for. No need to be locked by the caller. +The vnode to search for. +No need to be locked by the caller. .It Fa retbuf Pointer to a .Vt "char *" diff --git a/share/man/man9/zone.9 b/share/man/man9/zone.9 index 5047107502f2..69d1f20b498e 100644 --- a/share/man/man9/zone.9 +++ b/share/man/man9/zone.9 @@ -320,8 +320,10 @@ The .Fn uma_zone_set_maxaction function sets a function that will be called when the given zone becomes full and fails to allocate an item. -The function will be called with the zone locked. Also, the function -that called the allocation function may have held additional locks. Therefore, +The function will be called with the zone locked. +Also, the function +that called the allocation function may have held additional locks. +Therefore, this function should do very little work (similar to a signal handler). .Pp The