svn commit: r310424 - head/share/man/man4

John Baldwin jhb at FreeBSD.org
Thu Dec 22 18:05:24 UTC 2016 

Author: jhb
Date: Thu Dec 22 18:05:22 2016
New Revision: 310424
URL: https://svnweb.freebsd.org/changeset/base/310424

Log:
  Replace passive voice with active voice and other tweaks.
  
  - Drop uses of 'will'.
  - Replace 'to use' with active voice.
  - Tidy language around interrupt types and clarify that INTx doesn't
    work on VFs.
  - Drop leading articles from sysctl/tunable descriptions.
  - Tweak the wording of several sysctl/tunable descriptions.
  
  Submitted by:	wblock (1, 2, 4)
  Sponsored by:	Chelsio Communications
  MFC after:	3 days
  Differential Revision:	https://reviews.freebsd.org/D8812

Modified:
  head/share/man/man4/cxgbe.4
  head/share/man/man4/cxgbev.4

Modified: head/share/man/man4/cxgbe.4
==============================================================================
--- head/share/man/man4/cxgbe.4	Thu Dec 22 17:51:44 2016	(r310423)
+++ head/share/man/man4/cxgbe.4	Thu Dec 22 18:05:22 2016	(r310424)
@@ -31,7 +31,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 5, 2016
+.Dd December 22, 2016
 .Dt CXGBE 4
 .Os
 .Sh NAME
@@ -80,9 +80,9 @@ driver uses different names for devices 
 Loader tunables with the hw.cxgbe prefix apply to all cards.
 The driver provides sysctl MIBs for both ports and parent devices using
 the names above.
-For example, a T5 adapter will provide port MIBs under dev.cxl and
+For example, a T5 adapter provides port MIBs under dev.cxl and
 adapter-wide MIBs under dev.t5nex.
-References to sysctl MIBs in the remainder of this page will use
+References to sysctl MIBs in the remainder of this page use
 dev.<port> for port MIBs and dev.<nexus> for adapter-wide MIBs.
 .Pp
 For more information on configuring this device, see
@@ -169,38 +169,38 @@ prompt before booting the kernel or stor
 .Xr loader.conf 5 .
 .Bl -tag -width indent
 .It Va hw.cxgbe.ntxq10g
-The number of tx queues to use for a 10Gb or higher-speed port.
+Number of tx queues used for a 10Gb or higher-speed port.
 The default is 16 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nrxq10g
-The number of rx queues to use for a 10Gb or higher-speed port.
+Number of rx queues used for a 10Gb or higher-speed port.
 The default is 8 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.ntxq1g
-The number of tx queues to use for a 1Gb port.
+Number of tx queues used for a 1Gb port.
 The default is 4 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nrxq1g
-The number of rx queues to use for a 1Gb port.
+Number of rx queues used for a 1Gb port.
 The default is 2 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nofldtxq10g
-The number of TOE tx queues to use for a 10Gb or higher-speed port.
+Number of TOE tx queues used for a 10Gb or higher-speed port.
 The default is 8 or the
 number of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nofldrxq10g
-The number of TOE rx queues to use for a 10Gb or higher-speed port.
+Number of TOE rx queues used for a 10Gb or higher-speed port.
 The default is 2 or the
 number of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nofldtxq1g
-The number of TOE tx queues to use for a 1Gb port.
+Number of TOE tx queues used for a 1Gb port.
 The default is 2 or the
 number of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nofldrxq1g
-The number of TOE rx queues to use for a 1Gb port.
+Number of TOE rx queues used for a 1Gb port.
 The default is 1.
 .It Va hw.cxgbe.num_vis
-The number of virtual interfaces (VIs) created for each port.
+Number of virtual interfaces (VIs) created for each port.
 Each virtual interface creates a separate network interface.
 The first virtual interface on each port is required and represents
 the primary network interface on the port.
@@ -211,7 +211,7 @@ for rx and tx as well an additional pair
 The default is 1.
 .It Va hw.cxgbe.holdoff_timer_idx_10G
 .It Va hw.cxgbe.holdoff_timer_idx_1G
-The timer index value to use to delay interrupts.
+Timer index value used to delay interrupts.
 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 by default (all values are in microseconds) and the index selects a
 value from this list.
@@ -220,8 +220,8 @@ Different interfaces can be assigned dif
 dev.<port>.X.holdoff_tmr_idx sysctl.
 .It Va hw.cxgbe.holdoff_pktc_idx_10G
 .It Va hw.cxgbe.holdoff_pktc_idx_1G
-The packet-count index value to use to delay interrupts.
-The packet-count list has the values 1, 8, 16, and 32 by default
+Packet-count index value used to delay interrupts.
+The packet-count list has the values 1, 8, 16, and 32 by default,
 and the index selects a value from this list.
 The default value is -1 which means packet counting is disabled and interrupts
 are generated based solely on the holdoff timer value.
@@ -230,8 +230,7 @@ dev.<port>.X.holdoff_pktc_idx sysctl.
 This sysctl works only when the interface has never been marked up (as done by
 ifconfig up).
 .It Va hw.cxgbe.qsize_txq
-The size, in number of entries, of the descriptor ring used for a tx
-queue.
+Number of entries in a transmit queue's descriptor ring.
 A buf_ring of the same size is also allocated for additional
 software queuing.
 See
@@ -242,19 +241,17 @@ dev.<port>.X.qsize_txq sysctl.
 This sysctl works only when the interface has never been marked up (as done by
 ifconfig up).
 .It Va hw.cxgbe.qsize_rxq
-The size, in number of entries, of the descriptor ring used for an
-rx queue.
+Number of entries in a receive queue's descriptor ring.
 The default value is 1024.
 Different interfaces can be assigned different values via the
 dev.<port>.X.qsize_rxq sysctl.
 This sysctl works only when the interface has never been marked up (as done by
 ifconfig up).
 .It Va hw.cxgbe.interrupt_types
-The interrupt types that the driver is allowed to use.
-Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X.
+Permitted interrupt types.
+Bit 0 represents INTx (line interrupts), bit 1 MSI, and bit 2 MSI-X.
 The default is 7 (all allowed).
-The driver will select the best possible type out of the allowed types by
-itself.
+The driver selects the best possible type out of the allowed types.
 .It Va hw.cxgbe.fw_install
 0 prohibits the driver from installing a firmware on the card.
 1 allows the driver to install a new firmware if internal driver
@@ -265,7 +262,7 @@ long as it is compatible with the driver
 the one already on the card.
 The default is 1.
 .It Va hw.cxgbe.fl_pktshift
-The number of bytes of padding inserted before the beginning of an Ethernet
+Number of padding bytes inserted before the beginning of an Ethernet
 frame in the receive buffer.
 The default value of 2 ensures that the Ethernet payload (usually the IP header)
 is at a 4 byte aligned address.
@@ -309,8 +306,8 @@ Each of these must be set to one of the 
 (usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater
 than or equal to safest_rx_cluster.
 The defaults are 16384 and 4096 respectively.
-The driver will never attempt to allocate a receive buffer larger than
-largest_rx_cluster and will fall back to allocating buffers of
+The driver never attempts to allocate a receive buffer larger than
+largest_rx_cluster and falls back to allocating buffers of
 safest_rx_cluster size if an allocation larger than safest_rx_cluster fails.
 Note that largest_rx_cluster merely establishes a ceiling -- the driver is
 allowed to allocate buffers of smaller sizes.

Modified: head/share/man/man4/cxgbev.4
==============================================================================
--- head/share/man/man4/cxgbev.4	Thu Dec 22 17:51:44 2016	(r310423)
+++ head/share/man/man4/cxgbev.4	Thu Dec 22 18:05:22 2016	(r310424)
@@ -31,7 +31,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 5, 2016
+.Dd December 22, 2016
 .Dt CXGBEV 4
 .Os
 .Sh NAME
@@ -81,9 +81,9 @@ The Physical Function driver for Chelsio
 tunables.
 The driver provides sysctl MIBs for both ports and parent devices using
 the names above.
-For example, a T5 VF will provide port MIBs under dev.cxlv and
+For example, a T5 VF provides port MIBs under dev.cxlv and
 parent device MIBs under dev.t5vf.
-References to sysctl MIBs in the remainder of this page will use
+References to sysctl MIBs in the remainder of this page use
 dev.<port> for port MIBs and dev.<nexus> for parent device MIBs.
 .Pp
 For more information on configuring this device, see
@@ -173,24 +173,24 @@ prompt before booting the kernel or stor
 .Xr loader.conf 5 .
 .Bl -tag -width indent
 .It Va hw.cxgbe.ntxq10g
-The number of tx queues to use for a 10Gb or higher-speed port.
+Number of tx queues used for a 10Gb or higher-speed port.
 The default is 16 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nrxq10g
-The number of rx queues to use for a 10Gb or higher-speed port.
+Number of rx queues used for a 10Gb or higher-speed port.
 The default is 8 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.ntxq1g
-The number of tx queues to use for a 1Gb port.
+Number of tx queues used for a 1Gb port.
 The default is 4 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.nrxq1g
-The number of rx queues to use for a 1Gb port.
+Number of rx queues used for a 1Gb port.
 The default is 2 or the number
 of CPU cores in the system, whichever is less.
 .It Va hw.cxgbe.holdoff_timer_idx_10G
 .It Va hw.cxgbe.holdoff_timer_idx_1G
-The timer index value to use to delay interrupts.
+Timer index value used to delay interrupts.
 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 by default (all values are in microseconds) and the index selects a
 value from this list.
@@ -199,8 +199,8 @@ Different interfaces can be assigned dif
 dev.<port>.X.holdoff_tmr_idx sysctl.
 .It Va hw.cxgbe.holdoff_pktc_idx_10G
 .It Va hw.cxgbe.holdoff_pktc_idx_1G
-The packet-count index value to use to delay interrupts.
-The packet-count list has the values 1, 8, 16, and 32 by default
+Packet-count index value used to delay interrupts.
+The packet-count list has the values 1, 8, 16, and 32 by default,
 and the index selects a value from this list.
 The default value is -1 which means packet counting is disabled and interrupts
 are generated based solely on the holdoff timer value.
@@ -209,8 +209,7 @@ dev.<port>.X.holdoff_pktc_idx sysctl.
 This sysctl works only when the interface has never been marked up (as done by
 ifconfig up).
 .It Va hw.cxgbe.qsize_txq
-The size, in number of entries, of the descriptor ring used for a tx
-queue.
+Number of entries in a transmit queue's descriptor ring.
 A buf_ring of the same size is also allocated for additional
 software queuing.
 See
@@ -221,21 +220,21 @@ dev.<port>.X.qsize_txq sysctl.
 This sysctl works only when the interface has never been marked up (as done by
 ifconfig up).
 .It Va hw.cxgbe.qsize_rxq
-The size, in number of entries, of the descriptor ring used for an
-rx queue.
+Number of entries in a receive queue's descriptor ring.
 The default value is 1024.
 Different interfaces can be assigned different values via the
 dev.<port>.X.qsize_rxq sysctl.
 This sysctl works only when the interface has never been marked up (as done by
 ifconfig up).
 .It Va hw.cxgbe.interrupt_types
-The interrupt types that the driver is allowed to use.
-Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X.
+Permitted interrupt types.
+Bit 0 represents INTx (line interrupts), bit 1 MSI, and bit 2 MSI-X.
 The default is 7 (all allowed).
-The driver will select the best possible type out of the allowed types by
-itself.
+The driver selects the best possible type out of the allowed types.
+Note that Virtual Functions do not support INTx interrupts and fail
+to attach if neither MSI nor MSI-X are enabled.
 .It Va hw.cxgbe.fl_pktshift
-The number of bytes of padding inserted before the beginning of an Ethernet
+Number of padding bytes inserted before the beginning of an Ethernet
 frame in the receive buffer.
 The default value of 2 ensures that the Ethernet payload (usually the IP header)
 is at a 4 byte aligned address.
@@ -262,8 +261,8 @@ Each of these must be set to one of the 
 (usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater
 than or equal to safest_rx_cluster.
 The defaults are 16384 and 4096 respectively.
-The driver will never attempt to allocate a receive buffer larger than
-largest_rx_cluster and will fall back to allocating buffers of
+The driver never attempts to allocate a receive buffer larger than
+largest_rx_cluster and falls back to allocating buffers of
 safest_rx_cluster size if an allocation larger than safest_rx_cluster fails.
 Note that largest_rx_cluster merely establishes a ceiling -- the driver is
 allowed to allocate buffers of smaller sizes.
@@ -271,8 +270,8 @@ allowed to allocate buffers of smaller s
 .Pp
 Certain settings and resources for Virtual Functions are dictated
 by the parent Physical Function driver.
-For example, the Physical Function driver limits the number of queues a
-Virtual Function is permitted to use.
+For example, the Physical Function driver limits the number of queues
+available to a Virtual Function.
 Some of these limits can be adjusted in the firmware configuration file
 used with the Physical Function driver.
 .Pp
@@ -290,7 +289,7 @@ to 1
 .Pc .
 .Pp
 The VF driver currently depends on the PF driver.
-As a result, loading the VF driver will also load the PF driver as a
+As a result, loading the VF driver also loads the PF driver as a
 dependency.
 .Sh SUPPORT
 For general information and support,

More information about the svn-src-all mailing list