From d4d112e34a28aee2571da46afaf93e2469f6a1be Mon Sep 17 00:00:00 2001 From: Joel Dahl Date: Sun, 23 Nov 2014 21:00:00 +0000 Subject: [PATCH] Misc mdoc fixes: - Remove superfluous paragraph macros. - Remove/fix empty or incorrect macros. - Sort sections into conventional order. - Terminate quoted strings properly. - Remove EOL whitespace. --- lib/libc/sys/poll.2 | 1 - lib/libdpv/dpv.3 | 2 +- sbin/ipfw/ipfw.8 | 3 +-- share/man/man4/gre.4 | 2 -- share/man/man4/man4.arm/cgem.4 | 35 +++++++++++++-------------- share/man/man4/me.4 | 1 - share/man/man4/netmap.4 | 2 +- share/man/man9/get_cyclecount.9 | 1 - share/man/man9/malloc.9 | 12 ++++----- share/man/man9/sleepqueue.9 | 1 - sys/boot/common/zfsloader.8 | 3 --- sys/boot/i386/gptzfsboot/gptzfsboot.8 | 6 ++--- usr.bin/dpv/dpv.1 | 30 +++++++++++------------ 13 files changed, 43 insertions(+), 56 deletions(-) diff --git a/lib/libc/sys/poll.2 b/lib/libc/sys/poll.2 index a1c7ada4ff36..466523be8c9a 100644 --- a/lib/libc/sys/poll.2 +++ b/lib/libc/sys/poll.2 @@ -180,7 +180,6 @@ specifies a signal mask which is set while waiting for input. When .Fn ppoll returns, the original signal mask is restored. -.Pp .Bd -literal struct timespec { time_t tv_sec; /* seconds */ diff --git a/lib/libdpv/dpv.3 b/lib/libdpv/dpv.3 index 8c04ac31c07f..37e1f0759fd0 100644 --- a/lib/libdpv/dpv.3 +++ b/lib/libdpv/dpv.3 @@ -502,7 +502,7 @@ This does not effect .Xr Xdialog 1 , which renders the color escape sequences as plain text. See -.Do Li +.Do embedded "\\Z" sequences .Dc in diff --git a/sbin/ipfw/ipfw.8 b/sbin/ipfw/ipfw.8 index 0c6edb2be3c2..7aa81bf2e0d9 100644 --- a/sbin/ipfw/ipfw.8 +++ b/sbin/ipfw/ipfw.8 @@ -1642,7 +1642,6 @@ be specified as: .Pp Note that the ampersand character has a special meaning in many shells and should generally be escaped. -.Pp .El Note that the order of MAC addresses (destination first, source second) is @@ -1991,7 +1990,7 @@ It may be possible to check what entry will be found on particular .Ar table-key using .Cm lookup -.Ae table-key +.Ar table-key command. This functionality is optional and may be unsupported in some algorithms. .Pp diff --git a/share/man/man4/gre.4 b/share/man/man4/gre.4 index 86e136671dd4..b8b47b10905a 100644 --- a/share/man/man4/gre.4 +++ b/share/man/man4/gre.4 @@ -91,7 +91,6 @@ Enables checksum calculation for outgoing packets. Enables use of sequence number field in the GRE header for outgoing packets. .El .Sh EXAMPLES -.Pp .Bd -literal 192.168.1.* --- Router A -------tunnel-------- Router B --- 192.168.2.* \\ / @@ -151,7 +150,6 @@ A description of GRE encapsulation can be found in RFC 2784 and RFC 2890. .An Andrey V. Elsukov Aq Mt ae@FreeBSD.org .An Heiko W.Rupp Aq Mt hwr@pilhuhn.de .Sh BUGS -.Pp The current implementation uses the key only for outgoing packets. Incoming packets with a different key or without a key will be treated as if they would belong to this interface. diff --git a/share/man/man4/man4.arm/cgem.4 b/share/man/man4/man4.arm/cgem.4 index 8af1b2ab90c4..01e2921b9d3c 100644 --- a/share/man/man4/man4.arm/cgem.4 +++ b/share/man/man4/man4.arm/cgem.4 @@ -248,6 +248,23 @@ checksum offloading is enabled. Counter of frames discarded due to an incorrect UDP checksum when checksum offloading is enabled. .El +.Sh SEE ALSO +.Xr miibus 4 , +.Xr ifconfig 8 +.Rs +.%T "Zynq-7000 SoC Technical Reference Manual (Xilinx doc UG585)" +.%U http://www.xilinx.com/support/documentation/user_guides/\:ug585-Zynq-7000-TRM.pdf +.Re +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 10.0 . +.Sh AUTHORS +The +.Nm +driver and this manual page was written by +.An Thomas Skibo Aq Mt thomasskibo@yahoo.com . .Sh BUGS The GEM can perform TCP/UDP/IP checksum offloading. However, when transmit checksum offloading is enabled, the GEM generates and @@ -277,21 +294,3 @@ If the bug does not exist in other versions of this device, the work-around can be disabled by setting the dev.cgem.%d.rxhangwar .Xr sysctl 8 variable to 0. -.Pp -.Sh SEE ALSO -.Xr miibus 4 , -.Xr ifconfig 8 -.Rs -.%T "Zynq-7000 SoC Technical Reference Manual (Xilinx doc UG585)" -.%U http://www.xilinx.com/support/documentation/user_guides/\:ug585-Zynq-7000-TRM.pdf -.Re -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 10.0 . -.Sh AUTHORS -The -.Nm -driver and this manual page was written by -.An Thomas Skibo Aq Mt thomasskibo@yahoo.com . diff --git a/share/man/man4/me.4 b/share/man/man4/me.4 index e1be5c806c15..668d346791ea 100644 --- a/share/man/man4/me.4 +++ b/share/man/man4/me.4 @@ -67,7 +67,6 @@ IP header is modified and the modifications are inserted between the so modified header and the original payload. The protocol number 55 is used for outer header. .Sh NOTES -.Pp For correct operation, the .Nm device needs a route to the decapsulating host that does not run over the tunnel, diff --git a/share/man/man4/netmap.4 b/share/man/man4/netmap.4 index 1943ebc95ba7..9d985610d843 100644 --- a/share/man/man4/netmap.4 +++ b/share/man/man4/netmap.4 @@ -614,7 +614,7 @@ In the example below, "netmap:foo" is any valid netmap port name. (default) all hardware ring pairs .It NR_REG_SW "netmap:foo^" the ``host rings'', connecting to the host stack. -.It NR_REG_NIC_SW "netmap:foo+ +.It NR_REG_NIC_SW "netmap:foo+" all hardware rings and the host rings .It NR_REG_ONE_NIC "netmap:foo-i" only the i-th hardware ring pair, where the number is in diff --git a/share/man/man9/get_cyclecount.9 b/share/man/man9/get_cyclecount.9 index ed57e4e065e9..eb8a5c5a2f3e 100644 --- a/share/man/man9/get_cyclecount.9 +++ b/share/man/man9/get_cyclecount.9 @@ -77,7 +77,6 @@ and processors use the .Li TSC register. -.Pp .Sh SEE ALSO .Xr binuptime 9 .Sh HISTORY diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index 07fb7581d9bb..a2978af3a802 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -208,12 +208,6 @@ one must include .In sys/types.h ) and .In sys/kernel.h . -.Sh IMPLEMENTATION NOTES -The memory allocator allocates memory in chunks that have size a power -of two for requests up to the size of a page of memory. -For larger requests, one or more pages is allocated. -While it should not be relied upon, this information may be useful for -optimizing the efficiency of memory use. .Sh CONTEXT .Fn malloc , .Fn realloc @@ -244,6 +238,12 @@ when holding a .Xr vnode 9 interlock, will cause a LOR (Lock Order Reversal) due to the intertwining of VM Objects and Vnodes. +.Sh IMPLEMENTATION NOTES +The memory allocator allocates memory in chunks that have size a power +of two for requests up to the size of a page of memory. +For larger requests, one or more pages is allocated. +While it should not be relied upon, this information may be useful for +optimizing the efficiency of memory use. .Sh RETURN VALUES The .Fn malloc , diff --git a/share/man/man9/sleepqueue.9 b/share/man/man9/sleepqueue.9 index 7f6269b95ed9..46f6539c05ae 100644 --- a/share/man/man9/sleepqueue.9 +++ b/share/man/man9/sleepqueue.9 @@ -246,7 +246,6 @@ allows to pass additional .Fn callout_reset_sbt flags. .Pp -.Pp Once the thread is ready to suspend, one of the wait functions is called to put the current thread to sleep until it is awakened and to context switch to another thread. diff --git a/sys/boot/common/zfsloader.8 b/sys/boot/common/zfsloader.8 index 9bb74a475171..fd437d9399c1 100644 --- a/sys/boot/common/zfsloader.8 +++ b/sys/boot/common/zfsloader.8 @@ -62,7 +62,6 @@ refers to a ZFS filesystem, then will instruct kernel to use that filesystem as the root filesystem. .Sh ZFS COMMAND EXTENSIONS .Bl -tag -width Ds -compact -.Pp .It Ic lsdev Op Fl v Lists ZFS pools in addition to disks and partitions. Adding @@ -87,11 +86,9 @@ itself. .El .Sh EXAMPLES Set the default device used for loading a kernel from a ZFS filesystem: -.Pp .Bd -literal -offset indent set currdev=zfs:tank/ROOT/knowngood: .Ed -.Pp .Sh SEE ALSO .Xr gptzfsboot 8 , .Xr loader 8 , diff --git a/sys/boot/i386/gptzfsboot/gptzfsboot.8 b/sys/boot/i386/gptzfsboot/gptzfsboot.8 index 20c285608cab..66feb6d35055 100644 --- a/sys/boot/i386/gptzfsboot/gptzfsboot.8 +++ b/sys/boot/i386/gptzfsboot/gptzfsboot.8 @@ -176,6 +176,9 @@ gpart bootcode -p /boot/gptzfsboot -i 1 ada0 .Sh HISTORY .Nm appeared in FreeBSD 7.3. +.Sh AUTHORS +This manual page was written by +.An Andriy Gapon Aq avg@FreeBSD.org . .Sh BUGS .Nm looks for ZFS meta-data only in MBR partitions @@ -188,6 +191,3 @@ found at the fixed offsets relative to a slice, then .Nm will recognize the partition as a part of a ZFS pool, but this is not guaranteed to happen. -.Sh AUTHORS -This manual page was written by -.An Andriy Gapon Aq avg@FreeBSD.org . diff --git a/usr.bin/dpv/dpv.1 b/usr.bin/dpv/dpv.1 index c8d321bea895..dacfdf96f5b2 100644 --- a/usr.bin/dpv/dpv.1 +++ b/usr.bin/dpv/dpv.1 @@ -104,7 +104,7 @@ Do not use the default interface of .Xr dialog 3 , but instead spawn an instance of .Xr dialog 1 . -The path to +The path to .Xr dialog 1 is taken from the .Ev DIALOG @@ -308,7 +308,6 @@ is required. .It Pa $HOME/.dialogrc .El .Sh EXAMPLES -.Pp Simple example to show how fast .Xr yes 1 produces lines @@ -358,7 +357,18 @@ Zeroing a disk: .Bd -literal -offset indent dpv -o /dev/md42 < /dev/zero .Ed -.Pp +.Sh SEE ALSO +.Xr dialog 1 , +.Xr dialog 3 , +.Xr sh 1 , +.Xr Xdialog 1 +.Sh HISTORY +A +.Nm +utility first appeared in +.Fx 11.0 . +.Sh AUTHORS +.An Devin Teske Aq dteske@FreeBSD.org .Sh BUGS .Xr Xdialog 1 , when given both @@ -410,21 +420,9 @@ This does not effect .Xr Xdialog 1 , which renders the color escape sequences as plain text. See -.Do Li +.Do embedded "\\Z" sequences .Dc in .Xr dialog 1 for additional information. -.Sh SEE ALSO -.Xr dialog 1 , -.Xr dialog 3 , -.Xr sh 1 , -.Xr Xdialog 1 -.Sh HISTORY -A -.Nm -utility first appeared in -.Fx 11.0 . -.Sh AUTHORS -.An Devin Teske Aq dteske@FreeBSD.org