Date: Sat, 2 Sep 2017 11:57:08 +0000 (UTC) From: Alexander Motin <mav@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r323127 - head/share/man/man4 Message-ID: <201709021157.v82Bv83X074569@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: mav Date: Sat Sep 2 11:57:08 2017 New Revision: 323127 URL: https://svnweb.freebsd.org/changeset/base/323127 Log: Some NTB man pages polishing. MFC after: 12 days Modified: head/share/man/man4/if_ntb.4 head/share/man/man4/ntb.4 head/share/man/man4/ntb_transport.4 Modified: head/share/man/man4/if_ntb.4 ============================================================================== --- head/share/man/man4/if_ntb.4 Sat Sep 2 11:56:16 2017 (r323126) +++ head/share/man/man4/if_ntb.4 Sat Sep 2 11:57:08 2017 (r323127) @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 30, 2017 +.Dd September 2, 2017 .Dt IF_NTB 4 .Os .Sh NAME @@ -50,7 +50,7 @@ The following tunables are settable from the .Xr loader 8 : .Bl -ohang .It Va hw.if_ntb.num_queues -Number of transport queues to use per interface. +Limits maximal number of queues per interface. Default is unlimited. .El .Sh DESCRIPTION @@ -58,12 +58,10 @@ The .Nm driver attaches on top of the .Xr ntb_transport 4 -driver to utilize its resources to create virtual Ethernet network interface -between the systems. -It supports as many tx/rx queues as provided by underlying -.Xr ntb_transport 4 . -Typical MTU is about 64KB to reduce overhead. -The MAC address for interface is randomly generated. +driver to utilize one or more of its packet queues to create virtual +Ethernet network interface between the systems. +Typical MTU for the interface is about 64KB to reduce overhead. +Default MAC address for the interface is randomly generated. .Pp The .Nm Modified: head/share/man/man4/ntb.4 ============================================================================== --- head/share/man/man4/ntb.4 Sat Sep 2 11:56:16 2017 (r323126) +++ head/share/man/man4/ntb.4 Sat Sep 2 11:57:08 2017 (r323127) @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 30, 2017 +.Dd September 2, 2017 .Dt NTB 4 .Os .Sh NAME @@ -51,19 +51,19 @@ The following tunables are settable from the Driver debug level. The default value is 0, higher means more verbose. .It Va hint.ntb_hw. Ns Ar X Ns Va .config -Configures NTB resources split between several consumer devices. -Configuration of multiple consumer devices separated by commas. -Each device can be configured as: "[<name>][:<mw>[:<spad>[:<db>]]]", where: +Configures a set of NTB functions, separated by commas, +and their resource allocation. +Each function can be configured as: "[<name>][:<mw>[:<spad>[:<db>]]]", where: .Va name -is a name of the driver which should attach the device (empty means any), +is a name of the driver to attach (empty means any), .Va mw is a number of memory windows to allocate (empty means all available), .Va spad is a number of scratchpad registers to allocate (empty means all available), .Va db is a number of doorbells to allocate (empty means all available). -The default configuration is empty string, which means single device -with all available resources allowing any driver attachment. +The default configuration is empty string, which means single function +with all available resources, allowing any driver to attach. .El .Sh DESCRIPTION Non-Transparent Bridges allow to connect two computer systems with PCIe @@ -72,7 +72,7 @@ scratchpad registers and interrupts. The .Nm subsystem uses those resources provided in generic way by hardware drivers -and splits them between multiple consumer drivers, according to specified +and splits them between several functions, according to specified configuration. .Sh SEE ALSO .Xr if_ntb 4 , Modified: head/share/man/man4/ntb_transport.4 ============================================================================== --- head/share/man/man4/ntb_transport.4 Sat Sep 2 11:56:16 2017 (r323126) +++ head/share/man/man4/ntb_transport.4 Sat Sep 2 11:57:08 2017 (r323127) @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 30, 2017 +.Dd September 2, 2017 .Dt NTB_TRANSPORT 4 .Os .Sh NAME @@ -52,23 +52,23 @@ The following tunables are settable from the Driver debug level. The default value is 0, higher means more verbose. .It Va hint.ntb_transport. Ns Ar X Ns Va .config -Configures queues allocation for consumer devices, separated by commas. -Each device can be configured as: "[<name>][:<queues>]", where: +Configures a set of the transport consumers, separated by commas. +Each consumer can be configured as: "[<name>][:<queues>]", where: .Va name -is a name of the driver which should attach the device (empty means any), +is a name of the driver to attach (empty means any), .Va queues is a number of queues to allocate (empty means automatic). -The default configuration is empty string, which means single device -with one queue per memory window allowing any driver attachment. +The default configuration is empty string, which means single consumer +with one queue per memory window, allowing any driver to attach. .El .Sh DESCRIPTION The .Nm driver attaches on top of the .Nm ntb -driver to utilize its resources to create set of bidirectional queues, +driver to utilize its resources to create a set of bidirectional queues, delivering packets between the systems. -The primary purpose of this is to be used by +The primary purpose of this driver is to be used by .Nm if_ntb network interface, but other consumers may also be developed using KPI. .Pp
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201709021157.v82Bv83X074569>