git: 5a38418d80f4 - stable/15 - tws.4: Canonicalize SYNOPSIS + nits

The branch stable/15 has been updated by ziaee:

URL: https://cgit.FreeBSD.org/src/commit/?id=5a38418d80f42102d9b6daed1a2e5dd951d1c19a

commit 5a38418d80f42102d9b6daed1a2e5dd951d1c19a
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2026-09-04 14:42:37 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-09-16 12:03:44 +0000

    tws.4: Canonicalize SYNOPSIS + nits
    
    + wrap some long lines
    + escape some ? wildcards
    + no macros in width specifiers
    + mention the speed in HARDWARE (bumps date)
    + use the hyperlink macro for... the defunct LSI website...
    + write out a symbol heavy error message format string in mdoc
    
    MFC after:      3 days
    Event:          Berlin Hackathon 202609
    
    (cherry picked from commit ef3239cd4a3f591434daa72747c49adc1263eb04)
---
 share/man/man4/tws.4 | 46 +++++++++++++++++++++++-----------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/share/man/man4/tws.4 b/share/man/man4/tws.4
index 35ac30910cd1..d3516168a501 100644
--- a/share/man/man4/tws.4
+++ b/share/man/man4/tws.4
@@ -1,4 +1,6 @@
 .\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
 .\"Copyright (c) 2010, 2011 iXsystems, Inc.
 .\"All rights reserved.
 .\" written by: Xin LI <delphij@FreeBSD.org>
@@ -24,38 +26,35 @@
 .\"OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\"SUCH DAMAGE.
 .\"
-.Dd October 4, 2011
+.Dd September 4, 2026
 .Dt TWS 4
 .Os
 .Sh NAME
 .Nm tws
 .Nd 3ware 9750 SATA+SAS 6Gb/s RAID controller card driver
 .Sh SYNOPSIS
-To compile this driver into the kernel,
-place the following lines in your
-kernel configuration file:
-.Bd -ragged -offset indent
-.Cd "device scbus"
-.Cd "device tws"
-.Ed
+.Cd device scbus
+.Cd device tws
 .Pp
-Alternatively, to load the driver as a
-module at boot time, place the following line in
+In
 .Xr loader.conf 5 :
-.Bd -literal -offset indent
-tws_load="YES"
-.Ed
+.Cd hw.tws.cam_depth
+.Cd hw.tws.enable_msi
+.Cd hw.tws.queue_depth
+.Cd hw.tws.use_32bit_sgls
+.Cd tws_load="YES"
 .Sh DESCRIPTION
 The
 .Nm
-driver provides support for LSI's 3ware 9750 SATA+SAS 6Gb/s RAID controller cards.
+driver provides support for LSI's 3ware 9750 SATA+SAS 6Gb/s RAID controllers.
 .Pp
 These controllers feature the LSISAS2108 6Gb/s SAS RAID-on-Chip (ROC)
 and are available in 4- and 8-port configurations, supports RAID levels
-0, 1, 5, 6, 10, 50 and single disk, with 96 SATA and/or SAS hard drives and SSDs.
+0, 1, 5, 6, 10, 50 and single disk,
+with 96 SATA and/or SAS hard drives and SSDs.
 .Pp
 For further hardware information, see
-.Pa http://www.lsi.com/.
+.Lk http://www.lsi.com/ .
 .Sh HARDWARE
 The
 .Nm
@@ -64,6 +63,7 @@ driver supports the following SATA/SAS RAID controller:
 .Bl -bullet -compact
 .It
 LSI's 3ware SAS 9750 series
+.Pq 6Gb/s SATA+SAS
 .El
 .Sh LOADER TUNABLES
 Tunables can be set at the
@@ -75,7 +75,7 @@ prompt before booting the kernel or stored in
 The maximum queued CAM SIM requests for one controller.
 The default value is 256.
 .It Va hw.tws.enable_msi
-This tunable enables MSI support on the controller if set to a non-zero value.
+Enable MSI support on the controller if set to a non-zero value.
 The default value is 0.
 .It Va hw.tws.queue_depth
 The maximum queued requests for one controller.
@@ -85,16 +85,16 @@ system is running in 64-bit mode.
 The default value is 0.
 .El
 .Sh FILES
-.Bl -tag -width ".Pa /dev/tws?" -compact
-.It Pa /dev/da?
+.Bl -tag -width "/dev/tws?" -compact
+.It Pa /dev/da?\&
 array/logical disk interface
-.It Pa /dev/tws?
+.It Pa /dev/tws?\&
 management interface
 .El
 .Sh DIAGNOSTICS
-Whenever the driver encounters a command failure, it prints out an error code in
-the format:
-.Qq Li "ERROR: (<error source>: <error code>):" ,
+Whenever the driver encounters a command failure,
+it prints out an error code in the format:
+.Do Li ERROR\&: Po Ao error source Ac : Ao error code Ac Pc : Dc ,
 followed by a text description of the error.
 There are other error messages and warnings that the
 driver prints out, depending on the kinds of errors that it encounters.