vhost-user.rst: Improve [GS]ET_VRING_BASE doc
authorHanna Czenczek <hreitz@redhat.com>
Mon, 16 Oct 2023 13:42:37 +0000 (15:42 +0200)
committerMichael S. Tsirkin <mst@redhat.com>
Tue, 7 Nov 2023 08:39:10 +0000 (03:39 -0500)
commitc7f21816612879efdae3d9b67f024a6671494c62
tree6fe6a9ffdd5a4fe1c611f86de6e4486536110a86
parent3e01f1147a16ca566694b97eafc941d62fa1e8d8
vhost-user.rst: Improve [GS]ET_VRING_BASE doc

GET_VRING_BASE does not mention that it stops the respective ring.  Fix
that.

Furthermore, it is not fully clear what the "base offset" these
commands' documentation refers to is; an offset could be many things.
Be more precise and verbose about it, especially given that these
commands use different payload structures depending on whether the vring
is split or packed.

Signed-off-by: Hanna Czenczek <hreitz@redhat.com>
Message-Id: <20231016134243.68248-2-hreitz@redhat.com>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
docs/interop/vhost-user.rst