From d5d4b0c8bb2edb6f7aa771a7a060bf7c9a5f864a Mon Sep 17 00:00:00 2001
From: mstsirkin <mstsirkin@0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652>
Date: Wed, 25 Mar 2015 17:06:22 +0000
Subject: document idx field in virtqueue used ring

Section 2.4.8 The Virtqueue Used Ring
lists the idx field, but never documents it.

VIRTIO-136.

Reported-by: Jason Wang <jasowang@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>

git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@486 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
---
 content.tex | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'content.tex')

diff --git a/content.tex b/content.tex
index d34685d..c9440a4 100644
--- a/content.tex
+++ b/content.tex
@@ -595,6 +595,9 @@ for drivers using untrusted buffers: if you do not know exactly
 how much has been written by the device, you usually have to zero
 the buffer to ensure no data leakage occurs.
 
+\field{idx} field indicates where the driver would put the next descriptor
+entry in the ring (modulo the queue size). This starts at 0, and increases.
+
 \begin{note}
 The legacy \hyperref[intro:Virtio PCI Draft]{[Virtio PCI Draft]}
 referred to these structures as vring_used and vring_used_elem, and
-- 
cgit v1.2.3

