[v1] docs/vhost-user: clarify the semantics of VHOST_USER_SET_VRING_ENABLE

[PATCH v1] docs/vhost-user: clarify the semantics of VHOST_USER_SET_VRING_ENABLE

Daniil Tatianin posted 1 patch 1 week, 1 day ago

Diff against v1
Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20260325113644.175108-1-d-tatianin@yandex-team.ru

Maintainers: "Michael S. Tsirkin" <mst@redhat.com>, Stefano Garzarella <sgarzare@redhat.com>, Pierrick Bouvier <pierrick.bouvier@linaro.org>

docs/interop/vhost-user.rst | 2 ++
1 file changed, 2 insertions(+)

Expand all Fold all

[PATCH v1] docs/vhost-user: clarify the semantics of VHOST_USER_SET_VRING_ENABLE

Posted by Daniil Tatianin 1 week, 1 day ago

Documentation didn't really make it clear that the payload contains any
sort of desired state field, you could only derive that by looking at
the QEMU implementation of this request. Add an extra note to make that
clear.

Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Signed-off-by: Daniil Tatianin <d-tatianin@yandex-team.ru>
---

Changes since v0:
- Remove 'Note that' (suggested by Vladimir)

---
 docs/interop/vhost-user.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index 137c9f3669d..e29eb291f11 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -1346,6 +1346,8 @@ Front-end message types
   :reply payload: N/A
 
   Signal the back-end to enable or disable corresponding vring.
+  The ``num`` field contains the target vring state where 0 means disabled,
+  and any other value means enabled.
 
   This request should be sent only when
   ``VHOST_USER_F_PROTOCOL_FEATURES`` has been negotiated.
-- 
2.34.1