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

Benedict Reuschling bcr at FreeBSD.org
Fri May 1 10:02:41 UTC 2020 

Author: bcr (doc committer)
Date: Fri May  1 10:02:38 2020
New Revision: 360527
URL: https://svnweb.freebsd.org/changeset/base/360527

Log:
  Fix a number of the following issues in man4:
  - Inconsistencies in .Dd like abbreviated month names,
  "th" after numbers, or leading zeros
  - No line breaks after a sentence stop
  - Whitespace at the end of the line
  - Use macros for BSD OS names instead of hardcoded names
  - CAVEATS instead of CAVEAT in section name
  
  No actual content change in terms of additions were made, so
  no bump of the .Dd for these man pages.
  All of these issues were found and fixed by Gordon Bergling.
  
  Submitted by:	    gbergling_gmail.com
  Approved by:	    bcr
  Differential Revision:	https://reviews.freebsd.org/D24648

Modified:
  head/share/man/man4/acpi_wmi.4
  head/share/man/man4/bhndb.4
  head/share/man/man4/bnxt.4
  head/share/man/man4/bridge.4
  head/share/man/man4/bwi.4
  head/share/man/man4/bxe.4
  head/share/man/man4/cyapa.4
  head/share/man/man4/hv_vss.4
  head/share/man/man4/ig4.4
  head/share/man/man4/pchtherm.4
  head/share/man/man4/ppbus.4

Modified: head/share/man/man4/acpi_wmi.4
==============================================================================
--- head/share/man/man4/acpi_wmi.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/acpi_wmi.4	Fri May  1 10:02:38 2020	(r360527)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd Sep 5, 2019
+.Dd September 5, 2019
 .Dt ACPI_WMI 4
 .Os
 .Sh NAME

Modified: head/share/man/man4/bhndb.4
==============================================================================
--- head/share/man/man4/bhndb.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/bhndb.4	Fri May  1 10:02:38 2020	(r360527)
@@ -28,7 +28,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd October 16th, 2017
+.Dd October 16, 2017
 .Dt BHNDB 4
 .Os
 .Sh NAME

Modified: head/share/man/man4/bnxt.4
==============================================================================
--- head/share/man/man4/bnxt.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/bnxt.4	Fri May  1 10:02:38 2020	(r360527)
@@ -208,10 +208,12 @@ reasons to ignore Ethernet frames.
 .It Va dev.bnxt.X.hwstats.rxq0.tpa_*
 statistics related to HW LRO.
 .It Va dev.bnxt.X.hw_lro.*
-Enable / Disable HW LRO feature. Defaults to disable.
+Enable / Disable HW LRO feature.
+Defaults to disable.
 Enabling HW LRO could cause issues when forwarding is enabled on host.
 .It Va dev.bnxt.X.fc
-Enable / Disable Flow Control feature. Defaults to Enable
+Enable / Disable Flow Control feature.
+Defaults to Enable
 .El
 .Sh DIAGNOSTICS
 .Bl -diag
@@ -245,8 +247,8 @@ device driver first appeared in
 The
 .Nm
 driver was written by
-.An Jack Vogel Aq Mt jfvogel at gmail.com 
-and 
+.An Jack Vogel Aq Mt jfvogel at gmail.com
+and
 .An Stephen Hurd Aq Mt shurd at freebsd.org ,
 and is currently maintained by
 .An Broadcom Limited Aq Mt freebsd.pdl at broadcom.com .

Modified: head/share/man/man4/bridge.4
==============================================================================
--- head/share/man/man4/bridge.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/bridge.4	Fri May  1 10:02:38 2020	(r360527)
@@ -35,7 +35,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd February 01, 2020
+.Dd February 1, 2020
 .Dt IF_BRIDGE 4
 .Os
 .Sh NAME

Modified: head/share/man/man4/bwi.4
==============================================================================
--- head/share/man/man4/bwi.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/bwi.4	Fri May  1 10:02:38 2020	(r360527)
@@ -140,7 +140,9 @@ driver first appeared in
 .An -nosplit
 The
 .Nm
-driver was written for DragonFly BSD by
+driver was written for
+.Dx
+by
 .An Sepherosa Ziehau
 and subsequently ported to
 .Fx .

Modified: head/share/man/man4/bxe.4
==============================================================================
--- head/share/man/man4/bxe.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/bxe.4	Fri May  1 10:02:38 2020	(r360527)
@@ -164,7 +164,7 @@ Enable/Disable 4-tuple RSS for UDP: 0=DISABLED, 1=ENAB
 .Pp
 Special care must be taken when modifying the number of queues and receive
 buffers.
-FreeBSD imposes a limit on the maximum number of
+.Fx imposes a limit on the maximum number of
 .Xr mbuf 9
 allocations.
 If buffer allocations fail, the interface initialization will fail

Modified: head/share/man/man4/cyapa.4
==============================================================================
--- head/share/man/man4/cyapa.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/cyapa.4	Fri May  1 10:02:38 2020	(r360527)
@@ -210,7 +210,9 @@ file:
 .An -nosplit
 The original
 .Nm
-driver was written for DragonFly BSD by
+driver was written for
+.Dx
+by
 .An Matthew Dillon .
 .Pp
 It has been ported, modified, and enhanced for

Modified: head/share/man/man4/hv_vss.4
==============================================================================
--- head/share/man/man4/hv_vss.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/hv_vss.4	Fri May  1 10:02:38 2020	(r360527)
@@ -52,11 +52,14 @@ struct hv_vss_opt_msg {
 .Ed
 .Sh DESCRIPTION
 The freeze or thaw functionality of application is important to guarantee
-the application consistent backup. On windows platform, VSS is defined to do
-live backup. But for VM guest running on Hyper-V, the corresponding VSS is
-not defined yet. For example, a running database server instance, it knows when the
-applications' freeze/thaw should start or finish. But it is not aware of
-the freeze/thaw notification from Hyper-V host. The
+the application consistent backup.
+On windows platform, VSS is defined to do live backup.
+But for VM guest running on Hyper-V, the corresponding VSS is
+not defined yet.
+For example, a running database server instance, it knows when the
+applications' freeze/thaw should start or finish.
+But it is not aware of the freeze/thaw notification from Hyper-V host.
+The
 .Nm
 is designed to notify application freeze/thaw request.
 Thus, it plays a role of broker to forward the freeze/thaw command from Hyper-V host
@@ -67,23 +70,25 @@ VM, and sends the result back to Hyper-V host.
 Generally,
 .Xr hv_vss_daemon 8
 takes the responsibility to freeze/thaw UFS file system,
-and it is automatically launched after system boots. When Hyper-V host wants to
-take a snapshot of the
+and it is automatically launched after system boots.
+When Hyper-V host wants to take a snapshot of the
 .Fx
 VM, it will first send VSS capability check to
 .Fx
-VM. The
+VM.
+The
 .Nm
 received the request and forward the request to userland application if it is
-registered. Only after
+registered.
+Only after
 .Nm
 received the VSS_SUCCESS response from application, the
 .Xr hv_vss_daemon 8
-will be informed to check whether file system freeze/thaw is supported. Any error
-occurs during this period,
+will be informed to check whether file system freeze/thaw is supported.
+Any error occurs during this period,
 .Nm
-will inform Hyper-V host that VSS is not supported. In addition, there is a default
-timeout limit before sending response to Hyper-V host.
+will inform Hyper-V host that VSS is not supported.
+In addition, there is a default timeout limit before sending response to Hyper-V host.
 If the total response time from application and
 .Xr hv_vss_daemon 8
 exceeds this value, timeout
@@ -93,20 +98,20 @@ After Hyper-V host confirmed the
 .Fx
 VM supports VSS, it will send freeze request to VM, and
 .Nm
-will first forward it to application. After application finished freezing, it should
-inform
+will first forward it to application.
+After application finished freezing, it should inform
 .Nm
 and file system level freezing will be triggered by
-.Xr hv_vss_daemon 8 . After all freezing
-on both application and
+.Xr hv_vss_daemon 8 .
+After all freezing on both application and
 .Xr hv_vss_daemon 8
 were finished, the
 .Nm
-will inform Hyper-V host that freezing is done. Of course, there is a timeout limit as
-same as VSS capability is set to make sure freezing on
+will inform Hyper-V host that freezing is done.
+Of course, there is a timeout limit as same as VSS capability is set to make sure freezing on
 .Fx
-VM is not hang. If there is any error occurs or timeout happened, the freezing is failed
-on Hyper-V side.
+VM is not hang.
+If there is any error occurs or timeout happened, the freezing is failed on Hyper-V side.
 .Pp
 Hyper-V host will send thaw request after taking the snapshot, typically, this period is
 very short in order not to block the running application.
@@ -114,17 +119,20 @@ very short in order not to block the running applicati
 firstly thaw the file system by notifying
 .Xr hv_vss_daemon 8 ,
 then notifies user registered
-application. There is also a timeout check before sending response to Hyper-V host.
+application.
+There is also a timeout check before sending response to Hyper-V host.
 .Pp
 All the default timeout limit used in VSS capability check, freeze or thaw is the same.
 It is 15 seconds currently.
 .Sh NOTES
 .Nm
-only support UFS currently. If any of file system partition is non UFS, the VSS capability
-check will fail. If application does not register VSS,
+only support UFS currently.
+If any of file system partition is non UFS, the VSS capability check will fail.
+If application does not register VSS,
 .Nm
-only support backup for file system level consistent. The device should be closed before it
-was opened again. If you want to simultaneously open "/dev/hv_appvss_dev" two or more times,
+only support backup for file system level consistent.
+The device should be closed before it was opened again.
+If you want to simultaneously open "/dev/hv_appvss_dev" two or more times,
 an error (-1) will be returned, and errno was set.
 .Pp
 If

Modified: head/share/man/man4/ig4.4
==============================================================================
--- head/share/man/man4/ig4.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/ig4.4	Fri May  1 10:02:38 2020	(r360527)
@@ -71,7 +71,9 @@ device with the same unit number.
 .An -nosplit
 The
 .Nm
-driver was written for DragonFly BSD by
+driver was written for 
+.Dx
+by
 .An Matthew Dillon
 and subsequently ported to
 .Fx

Modified: head/share/man/man4/pchtherm.4
==============================================================================
--- head/share/man/man4/pchtherm.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/pchtherm.4	Fri May  1 10:02:38 2020	(r360527)
@@ -35,7 +35,7 @@
 .Sh DESCRIPTION
 The
 .Nm
-driver provides access to sensor data and configuration 
+driver provides access to sensor data and configuration
 installed in Intel PCH chipset.
 .Nm
 configuration register.
@@ -60,7 +60,7 @@ dev.pchtherm.0.%pnpinfo: vendor=0x8086 device=0x9d31 s
 dev.pchtherm.0.%location: slot=20 function=2 dbsf=pci0:0:20:2
 dev.pchtherm.0.%driver: pchtherm
 dev.pchtherm.0.%desc: Skylake PCH Thermal Subsystem
-dev.pchtherm.%parent: 
+dev.pchtherm.%parent:
 .Ed
 .Bl -tag -width ".Va dev.pchtherm.%d.pch_hot_level"
 .It Va dev.pchtherm.%d.temperature
@@ -99,7 +99,7 @@ This value is not appear when this feature is disabled
 .Pp
 Please check the PCH datasheets for more details.
 .Pp
-.Sh CAVEAT
+.Sh CAVEATS
 All values are read-only.
 And it do not support event interrupt for now.
 .Sh SEE ALSO

Modified: head/share/man/man4/ppbus.4
==============================================================================
--- head/share/man/man4/ppbus.4	Fri May  1 09:50:36 2020	(r360526)
+++ head/share/man/man4/ppbus.4	Fri May  1 10:02:38 2020	(r360527)
@@ -95,7 +95,7 @@ parallel port model.
 Consequently, for the i386 implementation of ppbus,
 most of the services provided by ppc are macros for inb()
 and outb() calls.
-But, for an other architecture, accesses to one of our logical
+But, for another architecture, accesses to one of our logical
 registers (data, status, control...) may require more than one I/O access.
 .Ss Description
 The parallel port may operate in the following modes:

More information about the svn-src-head mailing list