git: 098adfcc1e17 - main - virtio_blk.4: Canonicalize SYNOPSIS and HARDWARE
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sat, 29 Aug 2026 19:24:59 UTC
The branch main has been updated by ziaee:
URL: https://cgit.FreeBSD.org/src/commit/?id=098adfcc1e17899565d7a47fe5750a372663d547
commit 098adfcc1e17899565d7a47fe5750a372663d547
Author: Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2026-08-29 18:55:12 +0000
Commit: Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-08-29 19:24:10 +0000
virtio_blk.4: Canonicalize SYNOPSIS and HARDWARE
Also tag SPDX, and switch X to %d for consistency/clarity.
MFC after: 3 days
---
share/man/man4/virtio_blk.4 | 35 ++++++++++++++++++++---------------
1 file changed, 20 insertions(+), 15 deletions(-)
diff --git a/share/man/man4/virtio_blk.4 b/share/man/man4/virtio_blk.4
index 64be2164d52a..74c7d11f6976 100644
--- a/share/man/man4/virtio_blk.4
+++ b/share/man/man4/virtio_blk.4
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 2011 Bryan Venteicher
.\" All rights reserved.
.\"
@@ -29,20 +32,22 @@
.Nm virtio_blk
.Nd VirtIO Block 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_blk"
-.Ed
+.Cd device virtio_blk
.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_blk_load="YES"
-.Ed
-.Sh DESCRIPTION
+.Cd hw.vtblk.no_ident
+.Cd hw.vtblk. Ns Ar %d Ns Va .no_ident
+.Cd hw.vtblk.writecache_mode
+.Cd hw.vtblk. Ns Ar %d Ns Va .writecache_mode
+.Cd virtio_blk_load="YES"
+.Pp
+In
+.Xr loader.conf 5
+or
+.Xr sysctl.conf 5 :
+.Cd dev.vtblk. Ns Ar %d Ns Va .writecache_mode
+.Sh HARDWARE
The
.Nm
device driver provides support for VirtIO block devices.
@@ -53,13 +58,13 @@ prompt before booting the kernel or stored in
.Xr loader.conf 5 .
.Bl -tag -width indent
.It Va hw.vtblk.no_ident
-.It Va hw.vtblk. Ns Ar X Ns Va .no_ident
+.It Va hw.vtblk. Ns Ar %d Ns Va .no_ident
.Pp
These tunables disable retrieving the device identification string
from the hypervisor either globally or per-device.
The default value is 0.
.It Va hw.vtblk.writecache_mode
-.It Va hw.vtblk. Ns Ar X Ns Va .writecache_mode
+.It Va hw.vtblk. Ns Ar %d Ns Va .writecache_mode
.Pp
These tunables determine the write cache mode globally or per-device.
The mode can changed only if the ConfigWCE feature is negotiated.
@@ -72,7 +77,7 @@ The following variables are available as
.Xr sysctl 8
variables.
.Bl -tag -width indent
-.It Va dev.vtblk. Ns Ar X Ns Va .writecache_mode
+.It Va dev.vtblk. Ns Ar %d Ns Va .writecache_mode
.Pp
The write cache mode of the device can be either writethrough (0) or
writeback (1).