aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMicky Yun Chan <chanmickyyun@gmail.com>2019-12-09 09:53:31 +0800
committerMichael S. Tsirkin <mst@redhat.com>2020-01-05 07:03:03 -0500
commit6620801f39f0cd02b30ab5ad8729c92c78ce9fd3 (patch)
tree433a3d85eb8c541725403f166cb51d361e1367d9 /docs
parent9d7bd0826f2d19f88631ad7078662668148f7b5f (diff)
Implement backend program convention command for vhost-user-blk
This patch is to add standard commands defined in docs/interop/vhost-user.rst For vhost-user-* program Signed-off-by: Micky Yun Chan (michiboo) <chanmickyyun@gmail.com> Message-Id: <20191209015331.5455-1-chanmickyyun@gmail.com> Reviewed-by: Michael S. Tsirkin <mst@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/interop/vhost-user.json31
-rw-r--r--docs/interop/vhost-user.rst17
2 files changed, 48 insertions, 0 deletions
diff --git a/docs/interop/vhost-user.json b/docs/interop/vhost-user.json
index da6aaf51c8..ce0ef74db5 100644
--- a/docs/interop/vhost-user.json
+++ b/docs/interop/vhost-user.json
@@ -55,6 +55,37 @@
}
##
+# @VHostUserBackendBlockFeature:
+#
+# List of vhost user "block" features.
+#
+# @read-only: The --read-only command line option is supported.
+# @blk-file: The --blk-file command line option is supported.
+#
+# Since: 5.0
+##
+{
+ 'enum': 'VHostUserBackendBlockFeature',
+ 'data': [ 'read-only', 'blk-file' ]
+}
+
+##
+# @VHostUserBackendCapabilitiesBlock:
+#
+# Capabilities reported by vhost user "block" backends
+#
+# @features: list of supported features.
+#
+# Since: 5.0
+##
+{
+ 'struct': 'VHostUserBackendCapabilitiesBlock',
+ 'data': {
+ 'features': [ 'VHostUserBackendBlockFeature' ]
+ }
+}
+
+##
# @VHostUserBackendInputFeature:
#
# List of vhost user "input" features.
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index 7827b710aa..015ac08177 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -1376,3 +1376,20 @@ Command line options:
Enable virgl rendering support.
(optional)
+
+vhost-user-blk
+--------------
+
+Command line options:
+
+--blk-file=PATH
+
+ Specify block device or file path.
+
+ (optional)
+
+--read-only
+
+ Enable read-only.
+
+ (optional)