git: 746b9102ed06 - main - virtio_scsi.4: Canonicalize

From: Alexander Ziaee <ziaee_at_FreeBSD.org>
Date: Sat, 29 Aug 2026 19:24:58 UTC
The branch main has been updated by ziaee:

URL: https://cgit.FreeBSD.org/src/commit/?id=746b9102ed063bf5f87d8dc7649e3d0fab455c31

commit 746b9102ed063bf5f87d8dc7649e3d0fab455c31
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2026-08-29 18:14:36 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-08-29 19:24:10 +0000

    virtio_scsi.4: Canonicalize
    
    + Tag SPDX
    + Canonicalize SYNOPSIS and HARDWARE
    + Canonicalize SYSCTL VARIABLES, adding the sysctl to apropos
    + Canonicalize AUTHORS and HISTORY, which were combined
    + Use more traditional and consistent %d instead of less clear X
    
    MFC after:      3 days
---
 share/man/man4/virtio_scsi.4 | 60 +++++++++++++++++++++++---------------------
 1 file changed, 31 insertions(+), 29 deletions(-)

diff --git a/share/man/man4/virtio_scsi.4 b/share/man/man4/virtio_scsi.4
index 0e62cd8f7ac9..715834025386 100644
--- a/share/man/man4/virtio_scsi.4
+++ b/share/man/man4/virtio_scsi.4
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
 .\" Copyright (c) 2012 Bryan Venteicher
 .\" All rights reserved.
 .\"
@@ -22,27 +25,26 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd June 24, 2012
+.Dd August 29, 2026
 .Dt VIRTIO_SCSI 4
 .Os
 .Sh NAME
 .Nm virtio_scsi
 .Nd VirtIO SCSI 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 virtio_scsi"
-.Ed
+.Cd device virtio_scsi
 .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
-virtio_scsi_load="YES"
-.Ed
-.Sh DESCRIPTION
+.Cd hw.vtscsi.bus_reset_disable
+.Cd virtio_scsi_load="YES"
+.Pp
+In
+.Xr loader.conf 5
+or
+.Xr sysctl.conf 5 :
+.Cd hw.vtscsi.%d.debug_level
+.Sh HARDWARE
 The
 .Nm
 device driver provides support for VirtIO SCSI devices.
@@ -59,20 +61,19 @@ bus reset ineffective.
 This tunable disables attempts to issue reset bus commands.
 The default value is 1.
 .El
-.Sh DEBUGGING
-To enable debugging prints from the
-.Nm
-driver, set the
-.Bd -literal -offset indent
-hw.vtscsi.X.debug_level
-.Ed
-.Pp
-variable, where X is the adapter number, either in
-.Xr loader.conf 5
-or via
-.Xr sysctl 8 .
+.Sh SYSCTL VARIABLES
+The following variables can be entered at the
+.Xr loader 8
+prompt, set in
+.Xr loader.conf 5 ,
+.Xr sysctl.conf 5 ,
+or changed at runtime with
+.Xr sysctl 8 :
+.Bl -tag -width indent
+.It Va hw.vtscsi.%d.debug_level
+Enable debugging prints.
 The following bits have the described effects:
-.Bl -tag -width 6n -offset indent
+.Bl -tag -width indent -offset indent
 .It 0x01
 Enable informational prints.
 .It 0x02
@@ -80,12 +81,13 @@ Enable prints for driver errors.
 .It 0x04
 Enable tracing prints.
 .El
+.El
 .Sh SEE ALSO
 .Xr virtio 4
 .Sh HISTORY
 The
 .Nm
-driver was written by
-.An Bryan Venteicher Aq Mt bryanv@FreeBSD.org .
-It first appeared in
+driver first appeared in
 .Fx 10.0 .
+.Sh AUTHORS
+.An Bryan Venteicher Aq Mt bryanv@FreeBSD.org .