From: Roman Bogorodskiy <bogorodskiy@gmail.com>
Date: Wed, 29 Oct 2025 17:58:47 +0000 (+0100)
Subject: docs: drvbhyve: document NVMe device
X-Git-Tag: v11.9.0-rc2~2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=63e989cc26af153e78843a770febdf2ddfc83614;p=thirdparty%2Flibvirt.git

docs: drvbhyve: document NVMe device

Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
---

diff --git a/docs/drvbhyve.rst b/docs/drvbhyve.rst
index 0962bccef4..9db17e55e3 100644
--- a/docs/drvbhyve.rst
+++ b/docs/drvbhyve.rst
@@ -638,3 +638,24 @@ Example:
 Note: there's no direct way to check if the actual ``bhyve`` binary supports
 the TCP console. Thus, libvirt always assumes it's supported. Please
 refer to the ``bhyve(1)`` manual page to make sure.
+
+NVMe device
+~~~~~~~~~~~
+:since:`Since 11.9.0`, it's possible to use NVMe device.
+
+Example:
+
+::
+
+   ...
+     <disk type='file'>
+       <driver name='file' type='raw'/>
+       <source file='/tmp/freebsd.img'/>
+       <target dev='nvme0n1' bus='nvme'/>
+     </disk>
+    ...
+
+As ``bhyve(1)`` uses one NVMe device per PCI address, it's modeled in a way
+that there is one device per controller. That is, if using more than one
+NVMe device, for device name users should increment controller number rather
+than namespace number, i.e.: ``nvme0n1``, ``nvme1n1``, etc.