public inbox for qemu-devel@nongnu.org
 help / color / mirror / Atom feed
From: Daniil Tatianin <d-tatianin@yandex-team.ru>
To: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Daniil Tatianin <d-tatianin@yandex-team.ru>,
	Stefano Garzarella <sgarzare@redhat.com>,
	Pierrick Bouvier <pierrick.bouvier@linaro.org>,
	qemu-devel@nongnu.org, yc-core@yandex-team.ru
Subject: [PATCH] docs/vhost-user: clarify the semantics of VHOST_USER_SET_VRING_ENABLE
Date: Wed, 25 Mar 2026 13:43:29 +0300	[thread overview]
Message-ID: <20260325104329.154875-1-d-tatianin@yandex-team.ru> (raw)

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.

Signed-off-by: Daniil Tatianin <d-tatianin@yandex-team.ru>
---
 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..79690c73b25 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.
+  Note that 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



             reply	other threads:[~2026-03-25 10:44 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-25 10:43 Daniil Tatianin [this message]
2026-03-25 11:31 ` [PATCH] docs/vhost-user: clarify the semantics of VHOST_USER_SET_VRING_ENABLE Vladimir Sementsov-Ogievskiy

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260325104329.154875-1-d-tatianin@yandex-team.ru \
    --to=d-tatianin@yandex-team.ru \
    --cc=mst@redhat.com \
    --cc=pierrick.bouvier@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=sgarzare@redhat.com \
    --cc=yc-core@yandex-team.ru \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox