include/hw: start documenting the vhost API
commit27351992bf238f669dd08655d31ad111905bf899
authorAlex Bennée <alex.bennee@linaro.org>
Mon, 21 Mar 2022 15:30:34 +0000 (21 15:30 +0000)
committerMichael S. Tsirkin <mst@redhat.com>
Mon, 16 May 2022 08:38:40 +0000 (16 04:38 -0400)
treef996c8aa32330f4432057bc1d124cb7591ce323c
parentbcf317f8591083fc11c3167f8048c826475efc39
include/hw: start documenting the vhost API

While trying to get my head around the nest of interactions for vhost
devices I though I could start by documenting the key API functions.
This patch documents the main API hooks for creating and starting a
vhost device as well as how the configuration changes are handled.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Cc: Michael S. Tsirkin <mst@redhat.com>
Cc: Stefan Hajnoczi <stefanha@redhat.com>
Cc: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20220321153037.3622127-11-alex.bennee@linaro.org>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
include/hw/virtio/vhost.h