svn commit: r274925 - in head: lib/libc/sys lib/libdpv sbin/ipfw share/man/man4 share/man/man4/man4.arm share/man/man9 sys/boot/common sys/boot/i386/gptzfsboot usr.bin/dpv

Joel Dahl joel at FreeBSD.org
Sun Nov 23 21:00:04 UTC 2014 

Author: joel (doc committer)
Date: Sun Nov 23 21:00:00 2014
New Revision: 274925
URL: https://svnweb.freebsd.org/changeset/base/274925

Log:
  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.

Modified:
  head/lib/libc/sys/poll.2
  head/lib/libdpv/dpv.3
  head/sbin/ipfw/ipfw.8
  head/share/man/man4/gre.4
  head/share/man/man4/man4.arm/cgem.4
  head/share/man/man4/me.4
  head/share/man/man4/netmap.4
  head/share/man/man9/get_cyclecount.9
  head/share/man/man9/malloc.9
  head/share/man/man9/sleepqueue.9
  head/sys/boot/common/zfsloader.8
  head/sys/boot/i386/gptzfsboot/gptzfsboot.8
  head/usr.bin/dpv/dpv.1

Modified: head/lib/libc/sys/poll.2
==============================================================================
--- head/lib/libc/sys/poll.2	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/lib/libc/sys/poll.2	Sun Nov 23 21:00:00 2014	(r274925)
@@ -180,7 +180,6 @@ specifies a signal mask which is set whi
 When 
 .Fn ppoll
 returns, the original signal mask is restored.
-.Pp
 .Bd -literal
 struct timespec {
 	time_t  tv_sec;         /* seconds */

Modified: head/lib/libdpv/dpv.3
==============================================================================
--- head/lib/libdpv/dpv.3	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/lib/libdpv/dpv.3	Sun Nov 23 21:00:00 2014	(r274925)
@@ -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

Modified: head/sbin/ipfw/ipfw.8
==============================================================================
--- head/sbin/ipfw/ipfw.8	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/sbin/ipfw/ipfw.8	Sun Nov 23 21:00:00 2014	(r274925)
@@ -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 w
 .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

Modified: head/share/man/man4/gre.4
==============================================================================
--- head/share/man/man4/gre.4	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/share/man/man4/gre.4	Sun Nov 23 21:00:00 2014	(r274925)
@@ -91,7 +91,6 @@ Enables checksum calculation for outgoin
 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 b
 .An Andrey V. Elsukov Aq Mt ae at FreeBSD.org
 .An Heiko W.Rupp Aq Mt hwr at 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.

Modified: head/share/man/man4/man4.arm/cgem.4
==============================================================================
--- head/share/man/man4/man4.arm/cgem.4	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/share/man/man4/man4.arm/cgem.4	Sun Nov 23 21:00:00 2014	(r274925)
@@ -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 at 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 versi
 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 at yahoo.com .

Modified: head/share/man/man4/me.4
==============================================================================
--- head/share/man/man4/me.4	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/share/man/man4/me.4	Sun Nov 23 21:00:00 2014	(r274925)
@@ -67,7 +67,6 @@ IP header is modified and the modificati
 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,

Modified: head/share/man/man4/netmap.4
==============================================================================
--- head/share/man/man4/netmap.4	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/share/man/man4/netmap.4	Sun Nov 23 21:00:00 2014	(r274925)
@@ -614,7 +614,7 @@ In the example below, "netmap:foo" is an
 (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

Modified: head/share/man/man9/get_cyclecount.9
==============================================================================
--- head/share/man/man9/get_cyclecount.9	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/share/man/man9/get_cyclecount.9	Sun Nov 23 21:00:00 2014	(r274925)
@@ -77,7 +77,6 @@ and
 processors use the
 .Li TSC
 register.
-.Pp
 .Sh SEE ALSO
 .Xr binuptime 9
 .Sh HISTORY

Modified: head/share/man/man9/malloc.9
==============================================================================
--- head/share/man/man9/malloc.9	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/share/man/man9/malloc.9	Sun Nov 23 21:00:00 2014	(r274925)
@@ -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 ,

Modified: head/share/man/man9/sleepqueue.9
==============================================================================
--- head/share/man/man9/sleepqueue.9	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/share/man/man9/sleepqueue.9	Sun Nov 23 21:00:00 2014	(r274925)
@@ -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.

Modified: head/sys/boot/common/zfsloader.8
==============================================================================
--- head/sys/boot/common/zfsloader.8	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/sys/boot/common/zfsloader.8	Sun Nov 23 21:00:00 2014	(r274925)
@@ -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 ,

Modified: head/sys/boot/i386/gptzfsboot/gptzfsboot.8
==============================================================================
--- head/sys/boot/i386/gptzfsboot/gptzfsboot.8	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/sys/boot/i386/gptzfsboot/gptzfsboot.8	Sun Nov 23 21:00:00 2014	(r274925)
@@ -176,6 +176,9 @@ gpart bootcode -p /boot/gptzfsboot -i 1 
 .Sh HISTORY
 .Nm
 appeared in FreeBSD 7.3.
+.Sh AUTHORS
+This manual page was written by
+.An Andriy Gapon Aq avg at 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
 .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 at FreeBSD.org .

Modified: head/usr.bin/dpv/dpv.1
==============================================================================
--- head/usr.bin/dpv/dpv.1	Sun Nov 23 19:13:17 2014	(r274924)
+++ head/usr.bin/dpv/dpv.1	Sun Nov 23 21:00:00 2014	(r274925)
@@ -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 at 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 at FreeBSD.org

More information about the svn-src-head mailing list