[Midnightbsd-cvs] src [11728] trunk/share/man/man4: cleanup
laffer1 at midnightbsd.org
laffer1 at midnightbsd.org
Mon Jul 9 19:21:47 EDT 2018
Revision: 11728
http://svnweb.midnightbsd.org/src/?rev=11728
Author: laffer1
Date: 2018-07-09 19:21:46 -0400 (Mon, 09 Jul 2018)
Log Message:
-----------
cleanup
Modified Paths:
--------------
trunk/share/man/man4/xen.4
trunk/share/man/man4/xhci.4
trunk/share/man/man4/xl.4
trunk/share/man/man4/xnb.4
trunk/share/man/man4/zero.4
Modified: trunk/share/man/man4/xen.4
===================================================================
--- trunk/share/man/man4/xen.4 2018-07-09 23:07:12 UTC (rev 11727)
+++ trunk/share/man/man4/xen.4 2018-07-09 23:21:46 UTC (rev 11728)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2010 Robert N. M. Watson
.\" All rights reserved.
.\"
@@ -26,9 +27,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/xen.4 283306 2015-05-22 23:55:59Z jhb $
.\"
-.Dd December 17, 2010
+.Dd April 30, 2015
.Dt XEN 4
.Os
.Sh NAME
@@ -44,8 +45,8 @@
.Ed
.Pp
To compile hardware-assisted virtualization (HVM) Xen guest support with
-para-virtualized drivers into an amd64 kernel, place the following lines in
-your kernel configuration file:
+para-virtualized drivers into an amd64 or i386 kernel,
+place the following lines in your kernel configuration file:
.Bd -ragged -offset indent
.Cd "options XENHVM"
.Cd "device xenpci"
@@ -176,9 +177,6 @@
A fully para-virtualized (PV) kernel is only supported on i386, and not
amd64.
.Pp
-Para-virtualized drivers under hardware-assisted virtualization (HVM) kernel
-are only supported on amd64, not i386.
-.Pp
As of this release, Xen PV DomU support is not heavily tested; instability
has been reported during VM migration of PV kernels.
.Pp
Modified: trunk/share/man/man4/xhci.4
===================================================================
--- trunk/share/man/man4/xhci.4 2018-07-09 23:07:12 UTC (rev 11727)
+++ trunk/share/man/man4/xhci.4 2018-07-09 23:21:46 UTC (rev 11728)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2011 Hans Petter Selasky. All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/xhci.4 222019 2011-05-17 11:26:59Z ru $
.\"
.Dd May 17, 2011
.Dt XHCI 4
Modified: trunk/share/man/man4/xl.4
===================================================================
--- trunk/share/man/man4/xl.4 2018-07-09 23:07:12 UTC (rev 11727)
+++ trunk/share/man/man4/xl.4 2018-07-09 23:21:46 UTC (rev 11728)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1997, 1998
.\" Bill Paul <wpaul at ctr.columbia.edu>. All rights reserved.
.\"
@@ -28,7 +29,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/xl.4 235317 2012-05-12 03:25:46Z gjb $
.\"
.Dd January 23, 2008
.Dt XL 4
Modified: trunk/share/man/man4/xnb.4
===================================================================
--- trunk/share/man/man4/xnb.4 2018-07-09 23:07:12 UTC (rev 11727)
+++ trunk/share/man/man4/xnb.4 2018-07-09 23:21:46 UTC (rev 11728)
@@ -1,7 +1,7 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2012 Spectra Logic Corporation
-.\" All rights reserved.
+.\" All rights reserved.
.\"
-.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
@@ -13,7 +13,7 @@
.\" ("Disclaimer") and any redistribution must be conditioned upon
.\" including a substantially similar Disclaimer requirement for further
.\" binary redistribution.
-.\"
+.\"
.\" NO WARRANTY
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
@@ -26,15 +26,14 @@
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGES.
-.\"
+.\"
.\" Authors: Alan Somers (Spectra Logic Corporation)
-.\"
-.\" $MidnightBSD$
.\"
-
-.Dd January 6, 2012
+.\" $FreeBSD: stable/10/share/man/man4/xnb.4 291077 2015-11-19 16:36:20Z asomers $
+.\"
+.Dd June 6, 2014
.Dt XNB 4
-.Os
+.Os
.Sh NAME
.Nm xnb
.Nd "Xen Paravirtualized Backend Ethernet Driver"
@@ -50,24 +49,26 @@
.Nm
driver provides the back half of a paravirtualized
.Xr xen 4
-network connection. The netback and netfront drivers appear to their
-respective operating systems as Ethernet devices linked by a crossover cable.
+network connection.
+The netback and netfront drivers appear to their respective operating
+systems as Ethernet devices linked by a crossover cable.
Typically,
.Nm
will run on Domain 0 and the netfront driver will run on a guest domain.
However, it is also possible to run
.Nm
-on a guest domain. It may be bridged or routed to provide the netfront's
+on a guest domain.
+It may be bridged or routed to provide the netfront
domain access to other guest domains or to a physical network.
.Pp
In most respects, the
.Nm
-device appears to the OS as an other Ethernet device. It can be configured at
-runtime entirely with
-.Xr ifconfig 8
-\&. In particular, it supports MAC changing, arbitrary MTU sizes, checksum
-offload for IP, UDP, and TCP for both receive and transmit, and TSO. However,
-see
+device appears to the OS as any other Ethernet device.
+It can be configured at runtime entirely with
+.Xr ifconfig 8 .
+In particular, it supports MAC changing, arbitrary MTU sizes, checksum
+offload for IP, UDP, and TCP for both receive and transmit, and TSO.
+However, see
.Sx CAVEATS
before enabling txcsum, rxcsum, or tso.
.Sh SYSCTL VARIABLES
@@ -76,59 +77,65 @@
.Bl -tag -width indent
.It Va dev.xnb.%d.dump_rings
Displays information about the ring buffers used to pass requests between the
-netfront and netback. Mostly useful for debugging, but can also be used to
+netfront and netback.
+Mostly useful for debugging, but can also be used to
get traffic statistics.
.It Va dev.xnb.%d.unit_test_results
-Runs a builtin suite of unit tests and displays the results. Does not affect
-the operation of the driver in any way. Note that the test suite simulates
-error conditions; this will result in error messages being printed to the
-system system log.
-.Sh CAVEATS
-Packets sent through Xennet pass over shared memory, so the protocol includes
-no form of link-layer checksum or CRC. Furthermore, Xennet drivers always
-report to their hosts that they support receive and transmit checksum
-offloading. They "offload" the checksum calculation by simply skipping it.
-That works fine for packets that are exchanged between two domains on the same
-machine. However, when a Xennet interface is bridged to a physical interface,
-a correct checksum must be attached to any packets bound for that physical
-interface. Currently, FreeBSD lacks any mechanism for an ethernet device to
-inform the OS that newly received packets are valid even though their checksums
-are not. So if the netfront driver is configured to offload checksum
-calculations, it will pass non-checksumed packets to
-.Nm
-, which must then calculate the checksum in software before passing the packet
-to the OS.
-.Pp
-For this reason, it is recommended that if
-.Nm
-is bridged to a physcal interface, then transmit checksum offloading should be
-disabled on the netfront. The Xennet protocol does not have any mechanism for
-the netback to request the netfront to do this; the operator must do it
-manually.
+Runs a builtin suite of unit tests and displays the results.
+Does not affect the operation of the driver in any way.
+Note that the test suite simulates error conditions; this will result in
+error messages being printed to the system log.
+.El
.Sh SEE ALSO
.Xr arp 4 ,
.Xr netintro 4 ,
.Xr ng_ether 4 ,
-.Xr ifconfig 8 ,
-.Xr xen 4
+.Xr xen 4 ,
+.Xr ifconfig 8
.Sh HISTORY
The
.Nm
device driver first appeared in
-.Fx 10.0
-.
+.Fx 10.0 .
.Sh AUTHORS
The
.Nm
driver was written by
-.An Alan Somers
-.Aq alans at spectralogic.com
-and
-.An John Suykerbuyk
-.Aq johns at spectralogic.com .
+.An Alan Somers Aq Mt asomers at FreeBSD.org
+and John Suykerbuyk.
+.Sh CAVEATS
+Packets sent through Xennet pass over shared memory, so the protocol includes
+no form of link-layer checksum or CRC.
+Furthermore, Xennet drivers always report to their hosts that they support
+receive and transmit checksum offloading.
+They "offload" the checksum calculation by simply skipping it.
+That works fine for packets that are exchanged between two domains on the same
+machine.
+However, when a Xennet interface is bridged to a physical interface,
+a correct checksum must be attached to any packets bound for that physical
+interface.
+Currently,
+.Fx
+lacks any mechanism for an Ethernet device to
+inform the OS that newly received packets are valid even though their checksums
+are not.
+So if the netfront driver is configured to offload checksum calculations,
+it will pass non-checksumed packets to
+.Nm ,
+which must then calculate the checksum in software before passing the packet
+to the OS.
+.Pp
+For this reason, it is recommended that if
+.Nm
+is bridged to a physical interface, then transmit checksum offloading should be
+disabled on the netfront.
+The Xennet protocol does not have any mechanism for the netback to request
+the netfront to do this; the operator must do it manually.
.Sh BUGS
The
.Nm
driver does not properly checksum UDP datagrams that span more than one
-Ethernet frame. Nor does it correctly checksum IPv6 packets. To workaround
-that bug, disable transmit checksum offloading on the netfront driver.
+Ethernet frame.
+Nor does it correctly checksum IPv6 packets.
+To workaround that bug, disable transmit checksum offloading on the
+netfront driver.
Modified: trunk/share/man/man4/zero.4
===================================================================
--- trunk/share/man/man4/zero.4 2018-07-09 23:07:12 UTC (rev 11727)
+++ trunk/share/man/man4/zero.4 2018-07-09 23:21:46 UTC (rev 11728)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996
.\" Mike Pritchard <mpp at FreeBSD.org>. All rights reserved.
.\"
@@ -29,7 +30,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/zero.4 67627 2000-10-26 15:30:44Z asmodai $
.\"
.Dd April 7, 1996
.Dt ZERO 4
@@ -49,7 +50,6 @@
.It Pa /dev/zero
.El
.Sh SEE ALSO
-.Xr full 4
.Xr null 4
.Sh HISTORY
A
More information about the Midnightbsd-cvs
mailing list