From d9a48d766a496ad7f37bdc5f9859d405f18782c1 Mon Sep 17 00:00:00 2001
From: Bjoern Walk <bwalk@linux.ibm.com>
Date: Mon, 6 Apr 2020 15:13:27 +0200
Subject: [PATCH] docs: documentation for virtio packed option
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Reviewed-by: Boris Fiuczynski <fiuczy@linux.ibm.com>
Signed-off-by: Bjoern Walk <bwalk@linux.ibm.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
Signed-off-by: Ján Tomko <jtomko@redhat.com>
---
 docs/formatdomain.html.in | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index d56600dc18..47e10a836c 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -4372,6 +4372,16 @@
       Possible values are <code>on</code> or <code>off</code>.
       <span class="since">Since 3.5.0</span>
     </p>
+    <p>
+      The attribute <code>packed</code> controls if QEMU should try to use
+      packed virtqueues. Compared to regular split queues, packed queues
+      consist of only a single descriptor ring replacing available and used
+      ring, index and descriptor buffer. This can result in better cache
+      utilization and performance. If packed virtqueues are actually used
+      depends on the feature negotiation between QEMU, vhost backends and guest
+      drivers. Possible values are <code>on</code> or <code>off</code>.
+      <span class="since">Since 6.3.0 (QEMU and KVM only)</span>
+    </p>
 
     <h4><a id="elementsVirtioTransitional">Virtio transitional devices</a></h4>
 
-- 
2.47.2